EPOK RUNTIME

epok::sprite_detail::project_ratio

Function · 1 overload

Function

Sprite projection historically truncates toward zero (not mesh floor-rounding).

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

Declaration

inline int32_t project_ratio(int32_t coordinate,int scale,int32_t depth)

Sprite projection historically truncates toward zero (not mesh floor-rounding).

Parameter	Type	Meaning
`coordinate`	`int32_t`	Value supplied for coordinate. Keep referenced or pointed-to data valid for the complete call.
`scale`	`int`	Value supplied for scale. Keep referenced or pointed-to data valid for the complete call.
`depth`	`int32_t`	Value supplied for depth. Keep referenced or pointed-to data valid for the complete call.

Returns: int32_t. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example

#include "sprite_math.hpp"

// Assume these named values have been initialized with valid data:
// int32_t coordinate
// int scale
// int32_t depth

auto result = epok::sprite_detail::project_ratio(coordinate, scale, depth);

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

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/sprite_math.hpp:10

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function