C4 Engine
C4 Engine API Documentation

DataStructure::GetArrayDataElement

Defined in:  TSOpenDDL.h
Returns a pointer to a subarray stored in a data structure.
Prototype

const PrimType *GetArrayDataElement(int32 index) const;

Parameters
index The zero-based index of the subarray to retrieve.
Description
The GetArrayDataElement function returns a pointer to the first element in a subarray stored in a data structure. The legal values of the index parameter range from zero to n / s −1, inclusive, where n is the total count of data elements returned by the DataStructure::GetDataElementCount function, and s is the size of each subarray returned by the PrimitiveStructure::GetArraySize function. The elements of each subarray are stored contiguously in memory.

The PrimType type is defined by the class corresponding to the type template parameter associated with the particular specialization of the DataStructure class template.
See Also

DataStructure::GetDataElement

DataStructure::GetDataElementCount

DataStructure::GetArrayStateElement

PrimitiveStructure::GetArraySize