Epok Engine

EPOK RUNTIME

epok::RetainedGeometry::prepare_key

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 key` as part of the retained module.

Belongs to
epok::RetainedGeometry
Header
retained.hpp
Overloads
1

Declaration

Declaration
void prepare_key(size_t index,unsigned parity,const RetainedKey& key,bool allow_recolor)

Performs `prepare key` as part of the retained module.

ParameterTypeMeaning
indexsize_tNot documented; consult the linked header.
parityunsigned intNot documented; consult the linked header.
keyconst RetainedKey &Not documented; consult the linked header.
allow_recolorboolNot documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "retained.hpp"

// Assume these named values have been initialized with valid data:
// size_t index
// unsigned int parity
// const RetainedKey & key
// bool allow_recolor

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

object.prepare_key(index, parity, key, allow_recolor);

Trade-offs and warnings

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

Declared in runtime/retained.hpp:182

Related members