Epok Engine

EPOK RUNTIME

epok::HudRenderer::begin_node

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

Begins node as part of native HUD layout, drawing and focus navigation.

Belongs to
epok::HudRenderer
Header
hud.hpp
Overloads
1

Declaration

Declaration
bool begin_node(int owner,const hud_core::Rect& rect,const hud_core::Affine2& transform,const uint8_t* tint,bool outlined,HudStats& stats)

Begins node as part of native HUD layout, drawing and focus navigation.

ParameterTypeMeaning
ownerintNot documented; consult the linked header.
rectconst hud_core::Rect &Not documented; consult the linked header.
transformconst hud_core::Affine2 &Not documented; consult the linked header.
tintconst uint8_t *Not documented; consult the linked header.
outlinedboolNot documented; consult the linked header.
statsHudStats &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "hud.hpp"

// Assume these named values have been initialized with valid data:
// int owner
// const hud_core::Rect & rect
// const hud_core::Affine2 & transform
// const uint8_t * tint
// bool outlined
// HudStats & stats

epok::HudRenderer& object = /* obtain a valid instance */;

auto result = object.begin_node(owner, rect, transform, tint, outlined, stats);

Trade-offs and warnings

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

Declared in runtime/hud.hpp:86

Related members