Torque Game Engine Documentation
CVS Revision Label 1.3.x

types.h File Reference

Defines

#define __EQUAL_CONST_F   F32(0.000001)

Constant float epsilon used for F32 comparisons.

#define PNG_NO_READ_TIME

#define PNG_NO_WRITE_TIME

#define TORQUE_ENABLE_ASSERTS

#define makeFourCCTag(ch0, ch1, ch2, ch3)

#define BIT(x)   (1 << (x))

Returns value with bit x set (2^x).

#define _Offset_Normal(x, cls)   ((dsize_t)((const char *)&(((cls *)0)->x)-(const char *)0))

Offset macro: Calculates the location in memory of a given member x of class cls from the start of the class.

#define _Offset_Variant_1(x, cls)   ((int)(&((cls *)1)->x) - 1)

#define _Offset_Variant_2(x, cls)   offsetof(cls, x)

#define Offset(x, cls)   _Offset_Normal(x, cls)

#define OffsetNonConst(x, cls)   _Offset_Normal(x, cls)

Typedefs

typedef signed char S8

Compiler independent Signed Char.

typedef unsigned char U8

Compiler independent Unsigned Char.

typedef signed short S16

Compiler independent Signed 16-bit short.

typedef unsigned short U16

Compiler independent Unsigned 16-bit short.

typedef signed int S32

Compiler independent Signed 32-bit integer.

typedef unsigned int U32

Compiler independent Unsigned 32-bit integer.

typedef float F32

Compiler independent 32-bit float.

typedef double F64

Compiler independent 64-bit float.

typedef const char * StringTableEntry

Functions

U32 getNextPow2 (U32 io_num)

U32 getBinLog2 (U32 io_num)

bool isPow2 (const U32 in_num)

Determines if the given U32 is some 2^n.

U16 endianSwap (const U16 in_swap)

Convert the byte ordering on the U16 to and from big/little endian format.

U32 endianSwap (const U32 in_swap)

Convert the byte ordering on the U32 to and from big/little endian format.

U32 getMin (U32 a, U32 b)

Returns the lesser of the two parameters: a & b.

U16 getMin (U16 a, U16 b)

Returns the lesser of the two parameters: a & b.

U8 getMin (U8 a, U8 b)

Returns the lesser of the two parameters: a & b.

S32 getMin (S32 a, S32 b)

Returns the lesser of the two parameters: a & b.

S16 getMin (S16 a, S16 b)

Returns the lesser of the two parameters: a & b.

S8 getMin (S8 a, S8 b)

Returns the lesser of the two parameters: a & b.

float getMin (float a, float b)

Returns the lesser of the two parameters: a & b.

double getMin (double a, double b)

Returns the lesser of the two parameters: a & b.

U32 getMax (U32 a, U32 b)

Returns the greater of the two parameters: a & b.

U16 getMax (U16 a, U16 b)

Returns the greater of the two parameters: a & b.

U8 getMax (U8 a, U8 b)

Returns the greater of the two parameters: a & b.

S32 getMax (S32 a, S32 b)

Returns the greater of the two parameters: a & b.

S16 getMax (S16 a, S16 b)

Returns the greater of the two parameters: a & b.

S8 getMax (S8 a, S8 b)

Returns the greater of the two parameters: a & b.

float getMax (float a, float b)

Returns the greater of the two parameters: a & b.

double getMax (double a, double b)

Returns the greater of the two parameters: a & b.

Variables

static const F32 Float_One = F32(1.0)

Constant float 1.0.

static const F32 Float_Half = F32(0.5)

Constant float 0.5.

static const F32 Float_Zero = F32(0.0)

Constant float 0.0.

static const F32 Float_Pi = F32(3.14159265358979323846)

Constant float PI.

static const F32 Float_2Pi = F32(2.0 * 3.14159265358979323846)

Constant float 2*PI.

static const S8 S8_MIN = S8(-128)

Constant Min Limit S8.

static const S8 S8_MAX = S8(127)

Constant Max Limit S8.

static const U8 U8_MAX = U8(255)

Constant Max Limit U8.

static const S16 S16_MIN = S16(-32768)

Constant Min Limit S16.

static const S16 S16_MAX = S16(32767)

Constant Max Limit S16.

static const U16 U16_MAX = U16(65535)

Constant Max Limit U16.

static const S32 S32_MIN = S32(-2147483647 - 1)

Constant Min Limit S32.

static const S32 S32_MAX = S32(2147483647)

Constant Max Limit S32.

static const U32 U32_MAX = U32(0xffffffff)

Constant Max Limit U32.

static const F32 F32_MIN = F32(1.175494351e-38F)

Constant Min Limit F32.

static const F32 F32_MAX = F32(3.402823466e+38F)

Constant Max Limit F32.

Define Documentation

#define __EQUAL_CONST_F F32(0.000001)

Constant float epsilon used for F32 comparisons.

#define PNG_NO_READ_TIME

#define PNG_NO_WRITE_TIME

#define TORQUE_ENABLE_ASSERTS

#define makeFourCCTag ( ch0,
ch1,
ch2,
ch3 )

Value:
((U32(U8(ch0)) << 0) | \ (U32(U8(ch1)) << 8) | \ (U32(U8(ch2)) << 16) | \ (U32(U8(ch3)) << 24))

#define BIT ( x ) (1 << (x))

Returns value with bit x set (2^x).

#define _Offset_Normal ( x,
cls ) ((dsize_t)((const char *)&(((cls *)0)->x)-(const char *)0))

Offset macro: Calculates the location in memory of a given member x of class cls from the start of the class.
Need several definitions to account for various flavors of GCC.

#define _Offset_Variant_1 ( x,
cls ) ((int)(&((cls *)1)->x) - 1)

#define _Offset_Variant_2 ( x,
cls ) offsetof(cls, x)

#define Offset ( x,
cls ) _Offset_Normal(x, cls)

#define OffsetNonConst ( x,
cls ) _Offset_Normal(x, cls)

Typedef Documentation

typedef signed char S8

Compiler independent Signed Char.

typedef unsigned char U8

Compiler independent Unsigned Char.

typedef signed short S16

Compiler independent Signed 16-bit short.

typedef unsigned short U16

Compiler independent Unsigned 16-bit short.

typedef signed int S32

Compiler independent Signed 32-bit integer.

typedef unsigned int U32

Compiler independent Unsigned 32-bit integer.

typedef float F32

Compiler independent 32-bit float.

typedef double F64

Compiler independent 64-bit float.

typedef const char* StringTableEntry

Function Documentation

U32 getNextPow2 ( U32 io_num )

U32 getBinLog2 ( U32 io_num )

bool isPow2 ( const U32 in_num ) [inline]

Determines if the given U32 is some 2^n.

Parameters:

in_num Any U32

Returns:
true if in_num is a power of two, otherwise false

U16 endianSwap ( const U16 in_swap ) [inline]

Convert the byte ordering on the U16 to and from big/little endian format.

Parameters:

in_swap Any U16

Returns:
swaped U16.

U32 endianSwap ( const U32 in_swap ) [inline]

Convert the byte ordering on the U32 to and from big/little endian format.

Parameters:

in_swap Any U32

Returns:
swaped U32.

U32 getMin ( U32 a,

U32 b

) [inline]

Returns the lesser of the two parameters: a & b.

U16 getMin ( U16 a,

U16 b

) [inline]

Returns the lesser of the two parameters: a & b.

U8 getMin ( U8 a,

U8 b

) [inline]

Returns the lesser of the two parameters: a & b.

S32 getMin ( S32 a,

S32 b

) [inline]

Returns the lesser of the two parameters: a & b.

S16 getMin ( S16 a,

S16 b

) [inline]

Returns the lesser of the two parameters: a & b.

S8 getMin ( S8 a,

S8 b

) [inline]

Returns the lesser of the two parameters: a & b.

float getMin ( float a,

float b

) [inline]

Returns the lesser of the two parameters: a & b.

double getMin ( double a,

double b

) [inline]

Returns the lesser of the two parameters: a & b.

U32 getMax ( U32 a,

U32 b

) [inline]

Returns the greater of the two parameters: a & b.

U16 getMax ( U16 a,

U16 b

) [inline]

Returns the greater of the two parameters: a & b.

U8 getMax ( U8 a,

U8 b

) [inline]

Returns the greater of the two parameters: a & b.

S32 getMax ( S32 a,

S32 b

) [inline]

Returns the greater of the two parameters: a & b.

S16 getMax ( S16 a,

S16 b

) [inline]

Returns the greater of the two parameters: a & b.

S8 getMax ( S8 a,

S8 b

) [inline]

Returns the greater of the two parameters: a & b.

float getMax ( float a,

float b

) [inline]

Returns the greater of the two parameters: a & b.

double getMax ( double a,

double b

) [inline]

Returns the greater of the two parameters: a & b.

Variable Documentation

const F32 Float_One = F32(1.0) [static]

Constant float 1.0.

const F32 Float_Half = F32(0.5) [static]

Constant float 0.5.

const F32 Float_Zero = F32(0.0) [static]

Constant float 0.0.

const F32 Float_Pi = F32(3.14159265358979323846) [static]

Constant float PI.

const F32 Float_2Pi = F32(2.0 * 3.14159265358979323846) [static]

Constant float 2*PI.

const S8 S8_MIN = S8(-128) [static]

Constant Min Limit S8.

const S8 S8_MAX = S8(127) [static]

Constant Max Limit S8.

const U8 U8_MAX = U8(255) [static]

Constant Max Limit U8.

const S16 S16_MIN = S16(-32768) [static]

Constant Min Limit S16.

const S16 S16_MAX = S16(32767) [static]

Constant Max Limit S16.

const U16 U16_MAX = U16(65535) [static]

Constant Max Limit U16.

const S32 S32_MIN = S32(-2147483647 - 1) [static]

Constant Min Limit S32.

const S32 S32_MAX = S32(2147483647) [static]

Constant Max Limit S32.

const U32 U32_MAX = U32(0xffffffff) [static]

Constant Max Limit U32.

const F32 F32_MIN = F32(1.175494351e-38F) [static]

Constant Min Limit F32.

const F32 F32_MAX = F32(3.402823466e+38F) [static]

Constant Max Limit F32.