Epok Engine

EPOK RUNTIME

epok::RetainedGeometry::allocate

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

`limit_slot` is the packet-buffer capacity.

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

Declaration

Declaration
bool allocate(size_t index,const MeshGeometry* geometry,size_t quads,uint32_t limit_slot)

`limit_slot` is the packet-buffer capacity.

ParameterTypeMeaning
indexsize_tNot documented; consult the linked header.
geometryconst MeshGeometry *Not documented; consult the linked header.
quadssize_tNot documented; consult the linked header.
limit_slotuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "retained.hpp"

// Assume these named values have been initialized with valid data:
// size_t index
// const MeshGeometry * geometry
// size_t quads
// uint32_t limit_slot

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

auto result = object.allocate(index, geometry, quads, limit_slot);

Trade-offs and warnings

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

Declared in runtime/retained.hpp:205

Related members