EPOK RUNTIME

epok::modulate_color

Function · 1 overload

Function

Performs `modulate color` as part of PSX polygon preparation, clipping and submission.

Belongs to: epok
Header: polygon.hpp
Overloads: 1

Declaration

inline uint32_t modulate_color(uint32_t packed)

Performs `modulate color` as part of PSX polygon preparation, clipping and submission.

Parameter	Type	Meaning
`packed`	`uint32_t`	Value supplied for packed. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example

#include "polygon.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t packed

auto result = epok::modulate_color(packed);

Why use it

It provides direct, allocation-conscious access to PSX polygon preparation, clipping and submission. 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/polygon.hpp:45

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