module Basic Types

This is the documentation for Enlighten.

module Basic Types

Classes

Name

Description

Geo::GeoGuid

A 128 bit identifier used to uniquely identify objects in the precompute.

Variables

Name

Description

const float g_MaxNegFloat = -FLT_MAX

Largest representable negative float.

const float g_MaxPosFloat = FLT_MAX

Largest representable positive float.

const float g_MinFloat = FLT_MIN

Smallest representable positive float.

const float g_UnitEpsilon = FLT_EPSILON

Smallest float such that 1.f + g_UnitEpsilon != 1.f.

Functions

Name

Description

A()

Accessors to individual 32-bit components, corresponding to the args passed to Create.

B()

Accessors to individual 32-bit components, corresponding to the args passed to Create.

C()

Accessors to individual 32-bit components, corresponding to the args passed to Create.

Create(u64, u64)

Create a Guid from 2 u64 values.

Create(u32, u32, u64)

Create a Guid from 2 u32 values and 1 u64 value.

Create(u32, u32, u32, u32)

Create a Guid from 4 u32 values.

CreateFromHighFreqSystemClock(u64)

Creates a Guid from the high frequency system clock - this will be unique for this application instantiation.

D()

Accessors to individual 32-bit components, corresponding to the args passed to Create.

GeoGetCurrentPlatform()

Get the platform this code was compiled for.

GeoGetPlatformName(ePlatform)

Returns a text string containing the platform name.

GeoGuid()

Constructor.

High()

Returns the 1st 64 bit block.

Low()

Returns the 2nd 64 bit block.

operator!=(const GeoGuid &)

Value comparison operators.

operator<(const GeoGuid &)

Value comparison operators.

operator<=(const GeoGuid &)

Value comparison operators.

operator==(const GeoGuid &)

Value comparison operators.

Enums

Name

Description

ePlatform

Enumeration for those cases at runtime that we need to do separate functionality for each platform.

Typedefs

Name

Description

GeoString< char > GeoGuidString

String type that can contain a textual GeoGuid representation.

short s16

Signed 16-bit integer.

int s32

Signed 32-bit integer.

s32 s32a

Signed 32-bit integer.

__int64 s64

Signed 64-bit integer.

s64 s64a

Signed 64-bit integer.

char s8

Signed 8-bit integer.

unsigned short u16

Unsigned 16-bit integer.

unsigned int u32

Unsigned 32-bit integer.

u32 u32a

Unsigned 32-bit integer.

unsigned __int64 u64

Unsigned 64-bit integer.

u64 u64a

Unsigned 64-bit integer.

unsigned char u8

Unsigned 8-bit integer.

__m128 v128

A 4-float intrinsic vector type laid out as {x,y,z,w} - the same way you would lay out a structure.