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. |
u32 Geo::GeoGuid::A
public: u32 A() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
u32 Geo::GeoGuid::B
public: u32 B() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
u32 Geo::GeoGuid::C
public: u32 C() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u64 a,
u64 b
)
Create a Guid from 2 u64 values.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u32 idA,
u32 idB,
u64 idC
)
Create a Guid from 2 u32 values and 1 u64 value.
GeoGuid Geo::GeoGuid::Create
public: GeoGuid Create
(
u32 idA,
u32 idB,
u32 idC,
u32 idD
)
Create a Guid from 4 u32 values.
GeoGuid Geo::GeoGuid::CreateFromHighFreqSystemClock
public: GeoGuid CreateFromHighFreqSystemClock
(
u64 type
)
Creates a Guid from the high frequency system clock - this will be unique for this application instantiation.
u32 Geo::GeoGuid::D
public: u32 D() const
Accessors to individual 32-bit components, corresponding to the args passed to Create.
ePlatform Geo::GeoGetCurrentPlatform
public: ePlatform GeoGetCurrentPlatform()
Get the platform this code was compiled for.
const char* GEO_CALL Geo::GeoGetPlatformName
public: const char *GEO_CALL GeoGetPlatformName
(
ePlatform platform
)
Returns a text string containing the platform name.
Geo::GeoGuid::GeoGuid
public: GeoGuid()
Constructor.
u64 Geo::GeoGuid::High
public: u64 High() const
Returns the 1st 64 bit block.
u64 Geo::GeoGuid::Low
public: u64 Low() const
Returns the 2nd 64 bit block.
bool Geo::GeoGuid::operator!=
public: bool operator!=
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator<
public: bool operator<
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator<=
public: bool operator<=
(
const GeoGuid & rhs
) const
Value comparison operators.
bool Geo::GeoGuid::operator==
public: bool operator==
(
const GeoGuid & rhs
) const
Value comparison operators.
ePlatform
public: enum ePlatform
{
GEO_PLATFORM_WINDOWS,
GEO_PLATFORM_OSX,
GEO_PLATFORM_LINUX,
GEO_PLATFORM_XBOX_ONE,
GEO_PLATFORM_XSX,
GEO_PLATFORM_PS4,
GEO_PLATFORM_IOS,
GEO_PLATFORM_ANDROID,
GEO_PLATFORM_LINUX_ARM,
GEO_PLATFORM_ANDROID_INTEL,
GEO_PLATFORM_SWITCH,
GEO_PLATFORM_STADIA,
GEO_PLATFORM_UNKNOWN
}
Enumeration for those cases at runtime that we need to do separate functionality for each platform.
enumerators
GEO_PLATFORM_WINDOWS | Windows-based PCs (x86, x64, vista, 7, etc) |
GEO_PLATFORM_OSX | Mac OSX (x86, x64) |
GEO_PLATFORM_LINUX | Linux-based desktop PC. |
GEO_PLATFORM_XBOX_ONE | Xbox One. |
GEO_PLATFORM_XSX | Xbox Series X. |
GEO_PLATFORM_PS4 | PlayStation 4. |
GEO_PLATFORM_IOS | iOS |
GEO_PLATFORM_ANDROID | Android (ARM) |
GEO_PLATFORM_LINUX_ARM | Linux-based ARM device. |
GEO_PLATFORM_ANDROID_INTEL | Android (x86) |
GEO_PLATFORM_SWITCH | Nintendo Switch. |
GEO_PLATFORM_STADIA | Google Stadia. |
GEO_PLATFORM_UNKNOWN | Unknown platform. |