Epok Engine

EPOK RUNTIME

epok::SceneLibrary::screen_fade

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

The post-HUD fade to black, 0 clear to 255 opaque, clamped rather than rejected because every amount above the range has one nearest valid value.

Belongs to
epok::SceneLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static uint32_t screen_fade()

The post-HUD fade to black, 0 clear to 255 opaque, clamped rather than rejected because every amount above the range has one nearest valid value.

This overload takes no parameters.

Returns: uint32_t. Consult the linked header for its meaning.

Example sketch

C++ example
#include "gameplay_api.hpp"

auto result = epok::SceneLibrary::screen_fade();

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/gameplay_api.hpp:481

Related members