Epok Engine

EPOK RUNTIME

epok::Sprite2DComponent::source_rect

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 texel rectangle drawn this frame, given the texture size.

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

Declaration

const
Declaration
bool source_rect(uint16_t texture_width, uint16_t texture_height, uint16_t* out) const

The texel rectangle drawn this frame, given the texture size.

ParameterTypeMeaning
texture_widthuint16_tNot documented; consult the linked header.
texture_heightuint16_tNot documented; consult the linked header.
outuint16_t *Not documented; consult the linked header.

Returns: bool. 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:
// uint16_t texture_width
// uint16_t texture_height
// uint16_t * out

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

auto result = object.source_rect(texture_width, texture_height, out);

Trade-offs and warnings

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

Declared in runtime/world2d_components.hpp:219

Related members