Torque Game Engine Documentation
TGE Version 1.5.2

engine/ts/tsShapeAlloc.h File Reference

#include "platform/platform.h"
#include "math/mMath.h"

Data Structures

class TSShapeAlloc

Alloc structure used in the reading/writing of shapes. More...

Defines

Reading Operations:

get(): reads one or more entries of type from input buffer (doesn't affect output buffer)
copyToShape(): copies entries of type from input buffer to output buffer
allocShape(): creates room for entries of type in output buffer (no effect on input buffer)
getPointer(): gets pointer to next entries of type in input buffer (no effect on input buffer)

Note:
all operations advance current "position" of input and output buffers writing operations:
set(): adds one entry to appropriate buffer
copyToBuffer(): adds count entries to approrpiate buffer
getBuffer(): returns associated buffer (i.e., getBuffer32 gets 32bit buffer)
getBufferSize(): returns size of associated buffer

#define DECLARE_ALLOC(suffix, type)

Define Documentation

#define DECLARE_ALLOC	(	suffix,
		type		)

Value:

type get##suffix();                \
   void get##suffix(type*,S32);       \
   type * copyToShape##suffix(S32,bool returnSomething=false); \
   type * getPointer##suffix(S32);    \
   type * allocShape##suffix(S32);    \
   bool checkGuard##suffix();         \
   type getPrevGuard##suffix();       \
   type getSaveGuard##suffix();       \
   type * getBuffer##suffix();        \
   S32 getBufferSize##suffix();       \
   void setGuard##suffix();           \
   type * extend##suffix(S32);        \
   type set##suffix(type);            \
   void copyToBuffer##suffix(type*,S32);