Epok Engine

EPOK RUNTIME

epok::world2d::root_of

Function · 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.

Function

The root SceneComponent2D of a component's owner, or null.

Belongs to
epok::world2d
Header
world2d_components.hpp
Overloads
1

Declaration

Declaration
inline SceneComponent2D* root_of(ActorComponent& component)

The root SceneComponent2D of a component's owner, or null.

ParameterTypeMeaning
componentActorComponent &Not documented; consult the linked header.

Returns: SceneComponent2D *. Consult the linked header for its meaning.

Example sketch

C++ example
#include "world2d_components.hpp"

// Assume these named values have been initialized with valid data:
// ActorComponent & component

auto result = epok::world2d::root_of(component);

Trade-offs and warnings

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

Declared in runtime/world2d_components.hpp:88

Related members