cml/libcm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cmStack.h : Added comments.

Browse Source
This commit is contained in:
kevin 2013-11-14 16:44:34 -05:00
parent 9928dc4f4a
commit 1431685ef3
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
cmStack.h
View File

@ -42,12 +42,15 @@ extern "C" {
const void* cmStackTop( cmStackH_t h ); const void* cmStackTop( cmStackH_t h );
// Set the value of 'dataEleCnt' elements on the stack. // Set the value of 'dataEleCnt' elements on the stack.
// The top element is at index cmStackCount() - 1.
cmStRC_t cmStackSet( cmStackH_t h, unsigned index, const void* data, unsigned dataEleCnt ); cmStRC_t cmStackSet( cmStackH_t h, unsigned index, const void* data, unsigned dataEleCnt );
// Copy 'dataEleCnt' elements into the buffer pointed to by 'data'. // Copy 'dataEleCnt' elements into the buffer pointed to by 'data'.
// The top element is at index cmStackCount() - 1.
cmStRC_t cmStackGetN( cmStackH_t h, unsigned index, void* data, unsigned dataEleCnt ); cmStRC_t cmStackGetN( cmStackH_t h, unsigned index, void* data, unsigned dataEleCnt );
// Return a pointer to a single element on the stack. // Return a pointer to a single element on the stack.
// The top element is at index cmStackCount() - 1.
const void* cmStackGet( cmStackH_t h, unsigned index ); const void* cmStackGet( cmStackH_t h, unsigned index );
// Convert the internal representation of the stack to a linear array and return // Convert the internal representation of the stack to a linear array and return