Epok Engine

EPOK RUNTIME

epok::hud_core::ImageReuseCache::prepare

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

Performs `prepare` as part of native HUD layout, drawing and focus navigation.

Belongs to
epok::hud_core::ImageReuseCache
Header
hud_core.hpp
Overloads
1

Declaration

const
Declaration
bool prepare(unsigned parity,const ActorData* entities,size_t count,const uint32_t* keys,uintptr_t textures,uintptr_t fonts, int width,int height,Patch (&patches)[Capacity],unsigned& patch_count)const

Performs `prepare` as part of native HUD layout, drawing and focus navigation.

ParameterTypeMeaning
parityunsigned intNot documented; consult the linked header.
entitiesconst ActorData *Not documented; consult the linked header.
countsize_tNot documented; consult the linked header.
keysconst uint32_t *Not documented; consult the linked header.
texturesuintptr_tNot documented; consult the linked header.
fontsuintptr_tNot documented; consult the linked header.
widthintNot documented; consult the linked header.
heightintNot documented; consult the linked header.
patchesPatch (&)[Capacity]Not documented; consult the linked header.
patch_countunsigned int &Not documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "hud_core.hpp"

// Assume these named values have been initialized with valid data:
// unsigned int parity
// const ActorData * entities
// size_t count
// const uint32_t * keys
// uintptr_t textures
// uintptr_t fonts
// int width
// int height
// Patch (&)[Capacity] patches
// unsigned int & patch_count

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

auto result = object.prepare(parity, entities, count, keys, textures, fonts, width, height, patches, patch_count);

Trade-offs and warnings

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

Declared in runtime/hud_core.hpp:237

Related members