beastapitypes.h File Reference

File Description

This header is the base for getting platform consistent types for the Beast API.

Data Structures
struct	ILBLinearRGB
struct	ILBLinearRGBA
struct	ILBMatrix4x4
struct	ILBVec2
struct	ILBVec2i
struct	ILBVec3

Typedefs
typedef int32	ILBBool
typedef unsigned short	ILBChar16
typedef unsigned int	ILBChar32
typedef char	ILBChar8
typedef const ILBCharType *	ILBConstString
typedef ILBCharType *	ILBString

Enumerations
enum	ILBLightLinkMode { ILB_LL_EXCLUDING = 0, ILB_LL_INCLUDING }
enum	ILBStatus {   ILB_ST_SUCCESS = 0, ILB_ST_INVALID_PARAMETER, ILB_ST_MEMORY_ALLOC_ERROR, ILB_ST_DUPLICATE_NAME_ERROR,   ILB_ST_FUNCTION_NOT_IMPLEMENTED, ILB_ST_INVALID_OBJECT_STATE, ILB_ST_INVALID_HANDLE, ILB_ST_FILE_IO_ERROR,   ILB_ST_UNKNOWN_OBJECT, ILB_ST_NOT_SUPPORTED, ILB_ST_UNHANDLED_EXCEPTION, ILB_ST_JOB_EXECUTION_FAILURE,   ILB_ST_ATLAS_EXECUTION_FAILURE, ILB_ST_INVALID_LICENSE, ILB_ST_LAST_ERROR }
enum	ILBStringEncoding { ILB_SE_ANSI, ILB_SE_UTF8, ILB_SE_UTF16, ILB_SE_UTF32 }

Typedef Documentation

typedef int32 ILBBool

Bool type with a well defined size to avoid compatibility-problems.

typedef unsigned short ILBChar16

Character type for 16 bit strings.

typedef unsigned int ILBChar32

Character type for 32 bit strings.

May need special treatment for native utf32 platforms (i.e wchar_t instead of int32)

typedef char ILBChar8

Character type for 8 bit strings.

typedef const ILBCharType* ILBConstString

Beast api const string type.

Represents different things depending on the selected string encoding to make sure it's compatible with string constants.

typedef ILBCharType* ILBString

Beast api string type.

Represents different things depending on the selected string encoding to make sure it's compatible with string constants.

Enumeration Type Documentation

enum ILBLightLinkMode

Enum defining if a light link is inclusive or exclusive.

Enumerator
ILB_LL_EXCLUDING	Excludes the supplied lights/objects.
ILB_LL_INCLUDING	Includes the supplied lights/objects.

enum ILBStatus

Status codes for Beast API calls.

Enumerator
ILB_ST_SUCCESS	The call was successfully completed!
ILB_ST_INVALID_PARAMETER	One or more parameters were not in valid range or in some other way not valid for this call.
ILB_ST_MEMORY_ALLOC_ERROR	Beast failed to allocate memory somewhere down the line of this call.
ILB_ST_DUPLICATE_NAME_ERROR	An object with the same name already existed.
ILB_ST_FUNCTION_NOT_IMPLEMENTED	This function is not implemented yet. Should only happen internally
ILB_ST_INVALID_OBJECT_STATE	The object the function was called on was in a state where the function isn't valid to call.
ILB_ST_INVALID_HANDLE	The object handle used is not valid.
ILB_ST_FILE_IO_ERROR	There was some kind of file problem (invalid filename, permission etc).
ILB_ST_UNKNOWN_OBJECT	A handle to an unknown object was requested.
ILB_ST_NOT_SUPPORTED	The requested functionality is not supported in the current configuration.
ILB_ST_UNHANDLED_EXCEPTION	The api generated an exception we didn't expect.
ILB_ST_JOB_EXECUTION_FAILURE	An external tool returned an error.
ILB_ST_ATLAS_EXECUTION_FAILURE	Atlasing failed.
ILB_ST_INVALID_LICENSE	A license error occurred.
ILB_ST_LAST_ERROR	Dummy entry to be able to loop over all errors.

enum ILBStringEncoding

Defines the different supported string encodings.

Enumerator
ILB_SE_ANSI	Ansi encoding, the one used by default for windows source files.
ILB_SE_UTF8	UTF-8 encoding.
ILB_SE_UTF16	UTF-16 encoding.
ILB_SE_UTF32	UTF-32 encoding. Currently not supported

Go to the source code of this file.