Epok Engine

EPOK RUNTIME

epok::sprite_detail::plane

Function · 1 overload

Function

Performs `plane` as part of sprites, flipbooks and screen-facing rendering.

Belongs to
epok::sprite_detail
Header
sprites.hpp
Overloads
1

Declaration

Declaration
inline Affine<Fixed> plane(const Sprite& sprite,const Affine<Fixed>& world,const Affine<Fixed>& view)

Performs `plane` as part of sprites, flipbooks and screen-facing rendering.

ParameterTypeMeaning
spriteconst Sprite &Value supplied for sprite. Keep referenced or pointed-to data valid for the complete call.
worldconst Affine<Fixed> &Value supplied for world. Keep referenced or pointed-to data valid for the complete call.
viewconst Affine<Fixed> &Value supplied for view. Keep referenced or pointed-to data valid for the complete call.

Returns: Affine<Fixed>. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "sprites.hpp"

// Assume these named values have been initialized with valid data:
// const Sprite & sprite
// const Affine<Fixed> & world
// const Affine<Fixed> & view

auto result = epok::sprite_detail::plane(sprite, world, view);

Why use it

It provides direct, allocation-conscious access to sprites, flipbooks and screen-facing rendering. No exception-based error path is implied by the signature.

Trade-offs and warnings

Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/sprites.hpp:10

Related members