Miscellaneous Enumerations

Miscellaneous enumeration items. More...

Collaboration diagram for Miscellaneous Enumerations:

Classes

class  Murl::IEnums::StaticEnumContainer
 The static enum container in the Murl::IEnums namespace. More...
 

Enumerations

enum  Murl::IEnums::TouchAreaShape { Murl::IEnums::TOUCH_AREA_SHAPE_RECTANGLE, Murl::IEnums::TOUCH_AREA_SHAPE_ELLIPSE, Murl::IEnums::TOUCH_AREA_SHAPE_MESH }
 Shapes of touch areas used in the input handler. More...
 
enum  Murl::IEnums::ProjectionType { Murl::IEnums::PROJECTION_TYPE_PERSPECTIVE, Murl::IEnums::PROJECTION_TYPE_ORTHOGRAPHIC }
 Projection types used for both rendering and input handling. More...
 
enum  Murl::IEnums::ResultCode {
  Murl::IEnums::RESULT_CODE_OK, Murl::IEnums::RESULT_CODE_UNSPECIFIED_ERROR, Murl::IEnums::RESULT_CODE_VERSION_ERROR, Murl::IEnums::RESULT_CODE_PARSING_ERROR,
  Murl::IEnums::RESULT_CODE_FILE_ERROR, Murl::IEnums::RESULT_CODE_UNSPECIFIED_WARNING
}
 Globally defined result codes. More...
 
enum  Murl::IEnums::FileAccessMode {
  Murl::IEnums::FILE_ACCESS_MODE_READ_ONLY, Murl::IEnums::FILE_ACCESS_MODE_WRITE_ONLY, Murl::IEnums::FILE_ACCESS_MODE_READ_AND_WRITE, Murl::IEnums::FILE_ACCESS_MODE_APPEND_ONLY,
  Murl::IEnums::FILE_ACCESS_MODE_READ_AND_APPEND
}
 Definition of the file access modes. More...
 
enum  Murl::IEnums::AuthorizationStatus { Murl::IEnums::AUTHORIZATION_NOT_DETERMINED, Murl::IEnums::AUTHORIZATION_RESTRICTED, Murl::IEnums::AUTHORIZATION_DENIED, Murl::IEnums::AUTHORIZATION_AUTHORIZED }
 Authorization status enumeration. More...
 
enum  Murl::IEnums::SocketError {
  Murl::IEnums::SOCKET_ERROR_NONE, Murl::IEnums::SOCKET_ERROR_NOT_CONNECTED, Murl::IEnums::SOCKET_ERROR_RESET_BY_PEER, Murl::IEnums::SOCKET_ERROR_SEND_FAILED,
  Murl::IEnums::SOCKET_ERROR_RECEIVE_FAILED, Murl::IEnums::SOCKET_ERROR_WOULD_BLOCK, Murl::IEnums::SOCKET_ERROR_IN_PROGRESS, Murl::IEnums::SOCKET_ERROR_FAILED
}
 Socket error status enumeration. More...
 
enum  Murl::IEnums::ResourceType {
  Murl::IEnums::RESOURCE_TYPE_DEFAULT, Murl::IEnums::RESOURCE_TYPE_BINARY, Murl::IEnums::RESOURCE_TYPE_ANIMATION, Murl::IEnums::RESOURCE_TYPE_ATLAS,
  Murl::IEnums::RESOURCE_TYPE_FONT, Murl::IEnums::RESOURCE_TYPE_GRAPH, Murl::IEnums::RESOURCE_TYPE_IMAGE, Murl::IEnums::RESOURCE_TYPE_MESH,
  Murl::IEnums::RESOURCE_TYPE_SHADER, Murl::IEnums::RESOURCE_TYPE_AUDIO, Murl::IEnums::RESOURCE_TYPE_ARCHIVE, Murl::IEnums::RESOURCE_TYPE_VIDEO,
  Murl::IEnums::RESOURCE_TYPE_SCRIPT, Murl::IEnums::RESOURCE_TYPE_UNKNOWN, Murl::IEnums::RESOURCE_TYPE_PACKAGE, Murl::IEnums::RESOURCE_TYPE_DICTIONARY,
  Murl::IEnums::RESOURCE_TYPE_GRID, Murl::IEnums::RESOURCE_TYPE_TEXT
}
 Available resource types. More...
 
enum  Murl::IEnums::FileType {
  Murl::IEnums::FILE_TYPE_DEFAULT, Murl::IEnums::FILE_TYPE_UNKNOWN, Murl::IEnums::FILE_TYPE_TXT, Murl::IEnums::FILE_TYPE_XML,
  Murl::IEnums::FILE_TYPE_MURL, Murl::IEnums::FILE_TYPE_PNG, Murl::IEnums::FILE_TYPE_JPG, Murl::IEnums::FILE_TYPE_WEBP,
  Murl::IEnums::FILE_TYPE_DDS, Murl::IEnums::FILE_TYPE_ETC1, Murl::IEnums::FILE_TYPE_PVR, Murl::IEnums::FILE_TYPE_TGA,
  Murl::IEnums::FILE_TYPE_TIF, Murl::IEnums::FILE_TYPE_WAV, Murl::IEnums::FILE_TYPE_OGG, Murl::IEnums::FILE_TYPE_MP3,
  Murl::IEnums::FILE_TYPE_MP4, Murl::IEnums::FILE_TYPE_WMV, Murl::IEnums::FILE_TYPE_GLSL, Murl::IEnums::FILE_TYPE_HLSL,
  Murl::IEnums::FILE_TYPE_BLEND, Murl::IEnums::FILE_TYPE_DAE, Murl::IEnums::FILE_TYPE_FBX, Murl::IEnums::FILE_TYPE_C4D,
  Murl::IEnums::FILE_TYPE_3DS, Murl::IEnums::FILE_TYPE_ASE, Murl::IEnums::FILE_TYPE_OBJ, Murl::IEnums::FILE_TYPE_MTL,
  Murl::IEnums::FILE_TYPE_LWO, Murl::IEnums::FILE_TYPE_LWS, Murl::IEnums::FILE_TYPE_X, Murl::IEnums::FILE_TYPE_MDL,
  Murl::IEnums::FILE_TYPE_MD2, Murl::IEnums::FILE_TYPE_MD3, Murl::IEnums::FILE_TYPE_MD5, Murl::IEnums::FILE_TYPE_PK3,
  Murl::IEnums::FILE_TYPE_BSP, Murl::IEnums::FILE_TYPE_MAP, Murl::IEnums::FILE_TYPE_TTF, Murl::IEnums::FILE_TYPE_OTF,
  Murl::IEnums::FILE_TYPE_ZIP, Murl::IEnums::FILE_TYPE_TGZ, Murl::IEnums::FILE_TYPE_BZ2, Murl::IEnums::FILE_TYPE_CSV,
  Murl::IEnums::FILE_TYPE_KTX, Murl::IEnums::FILE_TYPE_PKM, Murl::IEnums::FILE_TYPE_ASTC
}
 Available file types. More...
 
enum  Murl::IEnums::FontType { Murl::IEnums::FONT_TYPE_UNDEFINED, Murl::IEnums::FONT_TYPE_BITMAP, Murl::IEnums::FONT_TYPE_OUTLINE, Murl::IEnums::FONT_TYPE_SYSTEM }
 Available font types. More...
 
enum  Murl::IEnums::PropertySemantic {
  Murl::IEnums::PROPERTY_SEMANTIC_NONE, Murl::IEnums::PROPERTY_SEMANTIC_VALUE, Murl::IEnums::PROPERTY_SEMANTIC_ANGLE, Murl::IEnums::PROPERTY_SEMANTIC_MASK,
  Murl::IEnums::PROPERTY_SEMANTIC_OBJECT, Murl::IEnums::PROPERTY_SEMANTIC_ID, Murl::IEnums::PROPERTY_SEMANTIC_FILE_NAME, Murl::IEnums::PROPERTY_SEMANTIC_FILE_PATH,
  Murl::IEnums::PROPERTY_SEMANTIC_FOLDER_NAME, Murl::IEnums::PROPERTY_SEMANTIC_FOLDER_PATH
}
 Available property semantics. More...
 
enum  Murl::IEnums::CompressionLevel {
  Murl::IEnums::COMPRESSION_LEVEL_DEFAULT, Murl::IEnums::COMPRESSION_LEVEL_NONE, Murl::IEnums::COMPRESSION_LEVEL_SPEED, Murl::IEnums::COMPRESSION_LEVEL_2,
  Murl::IEnums::COMPRESSION_LEVEL_3, Murl::IEnums::COMPRESSION_LEVEL_4, Murl::IEnums::COMPRESSION_LEVEL_5, Murl::IEnums::COMPRESSION_LEVEL_6,
  Murl::IEnums::COMPRESSION_LEVEL_7, Murl::IEnums::COMPRESSION_LEVEL_8, Murl::IEnums::COMPRESSION_LEVEL_BEST
}
 The ZLib compression levels. More...
 

Functions

const Enum< TouchAreaShape > & Murl::IEnums::GetTouchAreaShapeEnum ()
 Get the TouchAreaShape enumeration string mapping. More...
 
const Enum< ProjectionType > & Murl::IEnums::GetProjectionTypeEnum ()
 Get the ProjectionType enumeration string mapping. More...
 
const Enum< ResultCode > & Murl::IEnums::GetResultCodeEnum ()
 Get the ResultCode enumeration string mapping. More...
 
const Enum< FileAccessMode > & Murl::IEnums::GetFileAccessModeEnum ()
 Get the FileAccessMode enumeration string mapping. More...
 
const Enum< AuthorizationStatus > & Murl::IEnums::GetAuthorizationStatusEnum ()
 Get the AuthorizationStatus enumeration string mapping. More...
 
const Enum< SocketError > & Murl::IEnums::GetSocketErrorEnum ()
 Get the SocketError enumeration string mapping. More...
 
const Enum< ResourceType > & Murl::IEnums::GetResourceTypeEnum ()
 Get the ResourceType enumeration string mapping. More...
 
const Enum< FileType > & Murl::IEnums::GetFileTypeEnum ()
 Get the FileType enumeration string mapping. More...
 
const Enum< FontType > & Murl::IEnums::GetFontTypeEnum ()
 Get the FontType enumeration string mapping. More...
 
const Enum< PropertySemantic > & Murl::IEnums::GetPropertySemanticEnum ()
 Get the PropertySemantic enumeration string mapping. More...
 

Detailed Description

Miscellaneous enumeration items.

Enumeration Type Documentation

◆ TouchAreaShape

Shapes of touch areas used in the input handler.

Enumerator
TOUCH_AREA_SHAPE_RECTANGLE 

A rectangular touch area.

String value: "RECTANGLE"

TOUCH_AREA_SHAPE_ELLIPSE 

An elliptical touch area.

String value: "ELLIPSE"

TOUCH_AREA_SHAPE_MESH 

A generic triangle mesh used for capturing input touches.

String value: "MESH"

◆ ProjectionType

Projection types used for both rendering and input handling.

Enumerator
PROJECTION_TYPE_PERSPECTIVE 

Perspective projection.

String value: "PERSPECTIVE"

PROJECTION_TYPE_ORTHOGRAPHIC 

Orthographic (i.e. parallel) projection.

String value: "ORTHOGRAPHIC"

◆ ResultCode

Globally defined result codes.

Enumerator
RESULT_CODE_OK 

No error (success).

String value: "OK"

RESULT_CODE_UNSPECIFIED_ERROR 

An unspecified (generic) error occurred.

String value: "UNSPECIFIED_ERROR"

RESULT_CODE_VERSION_ERROR 

A version error.

String value: "VERSION_ERROR"

RESULT_CODE_PARSING_ERROR 

Error during parsing a resource or file.

String value: "PARSING_ERROR"

RESULT_CODE_FILE_ERROR 

A general file error (not existing or read error).

String value: "FILE_ERROR"

RESULT_CODE_UNSPECIFIED_WARNING 

An unspecified (generic) warning occurred.

String value: "UNSPECIFIED_WARNING"

◆ FileAccessMode

Definition of the file access modes.

Enumerator
FILE_ACCESS_MODE_READ_ONLY 

Read only access.

The file must exist.String value: "READ_ONLY"

FILE_ACCESS_MODE_WRITE_ONLY 

Write only access.

Create an empty file or erase an already existing file.String value: "WRITE_ONLY"

FILE_ACCESS_MODE_READ_AND_WRITE 

Read and write access.

Create an empty file or erase an already existing file.String value: "READ_AND_WRITE"

FILE_ACCESS_MODE_APPEND_ONLY 

Append access.

Create an empty file if the file does not exist. All writing operations are performed at the end of the file.String value: "APPEND_ONLY"

FILE_ACCESS_MODE_READ_AND_APPEND 

Read and append access.

Create an empty file if the file does not exist. All writing operations are performed at the end of the file, the file position can be set to anywhere in the file for reading, writing operations will move the file position back to the end of file.String value: "READ_AND_APPEND"

◆ AuthorizationStatus

Authorization status enumeration.

Enumerator
AUTHORIZATION_NOT_DETERMINED 

Authorization not determined.

String value: "NOT_DETERMINED"

AUTHORIZATION_RESTRICTED 

Authorization is restricted by the system.

String value: "RESTRICTED"

AUTHORIZATION_DENIED 

Authorization is denied by user.

String value: "DENIED"

AUTHORIZATION_AUTHORIZED 

Authorization is authorized.

String value: "AUTHORIZED"

◆ SocketError

Socket error status enumeration.

Enumerator
SOCKET_ERROR_NONE 

No error.

String value: "NONE"

SOCKET_ERROR_NOT_CONNECTED 

Socket is not connected.

String value: "NOT_CONNECTED"

SOCKET_ERROR_RESET_BY_PEER 

Connection was reset by peer.

String value: "RESET_BY_PEER"

SOCKET_ERROR_SEND_FAILED 

Last send operation failed.

String value: "SEND_FAILED"

SOCKET_ERROR_RECEIVE_FAILED 

Last receive operation failed.

String value: "RECEIVE_FAILED"

SOCKET_ERROR_WOULD_BLOCK 

Resource temporarily unavailable.

String value: "WOULD_BLOCK"

SOCKET_ERROR_IN_PROGRESS 

Operation is in progress.

String value: "IN_PROGRESS"

SOCKET_ERROR_FAILED 

Last operation failed.

String value: "FAILED"

◆ ResourceType

Available resource types.

Enumerator
RESOURCE_TYPE_DEFAULT 

Default resource type, use any suitable.

String value: "DEFAULT"

RESOURCE_TYPE_BINARY 

Generic resource type, exposing raw binary contents.

String value: "BINARY"

RESOURCE_TYPE_ANIMATION 

Animation resource.

String value: "ANIMATION"

RESOURCE_TYPE_ATLAS 

Atlas resource.

String value: "ATLAS"

RESOURCE_TYPE_FONT 

Font resource.

String value: "FONT"

RESOURCE_TYPE_GRAPH 

Graph resource.

String value: "GRAPH"

RESOURCE_TYPE_IMAGE 

Image resource.

String value: "IMAGE"

RESOURCE_TYPE_MESH 

Mesh resource.

String value: "MESH"

RESOURCE_TYPE_SHADER 

Shader resource.

String value: "SHADER"

RESOURCE_TYPE_AUDIO 

Audio resource.

String value: "AUDIO"

RESOURCE_TYPE_ARCHIVE 

Generic resource type storing compressed binary contents.

String value: "ARCHIVE"

RESOURCE_TYPE_VIDEO 

Video resource.

String value: "VIDEO"

RESOURCE_TYPE_SCRIPT 

Script resource.

String value: "SCRIPT"

RESOURCE_TYPE_UNKNOWN 

Unknown resource.

String value: "UNKNOWN"

RESOURCE_TYPE_PACKAGE 

Package containing multiple resources and/or sub-packages.

String value: "PACKAGE"

RESOURCE_TYPE_DICTIONARY 

Dictionary resource containing multiple key/value pairs.

String value: "DICTIONARY"

RESOURCE_TYPE_GRID 

Grid resource.

String value: "GRID"

RESOURCE_TYPE_TEXT 

Text resource.

String value: "TEXT"

◆ FileType

Available file types.

Enumerator
FILE_TYPE_DEFAULT 

Default file type, use any suitable.

String value: "DEFAULT"

FILE_TYPE_UNKNOWN 

Unknown file type.

String value: "UNKNOWN"

FILE_TYPE_TXT 

A text file.

String value: "TXT"

FILE_TYPE_XML 

XML file type.

String value: "XML"

FILE_TYPE_MURL 

Native Murl binary.

String value: "MURL"

FILE_TYPE_PNG 

PNG image.

String value: "PNG"

FILE_TYPE_JPG 

JPEG image.

String value: "JPG"

FILE_TYPE_WEBP 

WEBP image.

String value: "WEBP"

FILE_TYPE_DDS 

DDS (DirectX) image.

String value: "DDS"

FILE_TYPE_ETC1 

ETC1 compressed image.

String value: "ETC1"

FILE_TYPE_PVR 

PVRTC compressed image.

String value: "PVR"

FILE_TYPE_TGA 

TGA image.

String value: "TGA"

FILE_TYPE_TIF 

TIFF image.

String value: "TIF"

FILE_TYPE_WAV 

Microsoft WAVE audio.

String value: "WAV"

FILE_TYPE_OGG 

OGG/Vorbis audio.

String value: "OGG"

FILE_TYPE_MP3 

MP3 audio.

String value: "MP3"

FILE_TYPE_MP4 

MP4 audio/video.

String value: "MP4"

FILE_TYPE_WMV 

WMV audio/video.

String value: "WMV"

FILE_TYPE_GLSL 

GLSL shader source.

String value: "GLSL"

FILE_TYPE_HLSL 

HLSL shader source or binary.

String value: "HLSL"

FILE_TYPE_BLEND 

Blender scene.

String value: "BLEND"

FILE_TYPE_DAE 

Collada scene.

String value: "DAE"

FILE_TYPE_FBX 

Autodesk FBX scene.

String value: "FBX"

FILE_TYPE_C4D 

Maxon Cinema4D scene.

String value: "C4D"

FILE_TYPE_3DS 

3D Studio scene.

String value: "3DS"

FILE_TYPE_ASE 

3D Studio Max ASCII export scene.

String value: "ASE"

FILE_TYPE_OBJ 

Wavefront object.

String value: "OBJ"

FILE_TYPE_MTL 

Wavefront material.

String value: "MTL"

FILE_TYPE_LWO 

Lightwave object.

String value: "LWO"

FILE_TYPE_LWS 

Lightwave scene.

String value: "LWS"

FILE_TYPE_X 

DirectX 3D object.

String value: "X"

FILE_TYPE_MDL 

Quake model.

String value: "MDL"

FILE_TYPE_MD2 

Quake II model.

String value: "MD2"

FILE_TYPE_MD3 

Quake III model.

String value: "MD3"

FILE_TYPE_MD5 

Doom 3 model.

String value: "MD5"

FILE_TYPE_PK3 

Quake III compressed Map/BSP package.

String value: "PK3"

FILE_TYPE_BSP 

Quake III BSP file.

String value: "BSP"

FILE_TYPE_MAP 

Quake III Map file.

String value: "MAP"

FILE_TYPE_TTF 

TrueType font.

String value: "TTF"

FILE_TYPE_OTF 

OpenType font.

String value: "OTF"

FILE_TYPE_ZIP 

ZIP archive.

String value: "ZIP"

FILE_TYPE_TGZ 

TAR/GZ archive.

String value: "TGZ"

FILE_TYPE_BZ2 

BZIP2 archive.

String value: "BZ2"

FILE_TYPE_CSV 

CSV file.

String value: "CSV"

FILE_TYPE_KTX 

KTX (Khronos texture) file.

String value: "KTX"

FILE_TYPE_PKM 

PKM image file.

String value: "PKM"

FILE_TYPE_ASTC 

ASTC image file.

String value: "ASTC"

◆ FontType

Available font types.

Enumerator
FONT_TYPE_UNDEFINED 

Undefined font type.

String value: "UNDEFINED"

FONT_TYPE_BITMAP 

Bitmap font, composed of a set of glyph descriptors and a bitmap image.

String value: "BITMAP"

FONT_TYPE_OUTLINE 

Outline font, containing individual vector outlines for each glyph.

String value: "OUTLINE"

FONT_TYPE_SYSTEM 

System font, to be retrieved and rendered via the OS.

String value: "SYSTEM"

◆ PropertySemantic

Available property semantics.

Enumerator
PROPERTY_SEMANTIC_NONE 

No semantic (property is not used).

String value: "NONE"

PROPERTY_SEMANTIC_VALUE 

A generic value.

String value: "VALUE"

PROPERTY_SEMANTIC_ANGLE 

An angle value.

String value: "ANGLE"

PROPERTY_SEMANTIC_MASK 

A bit mask.

String value: "MASK"

PROPERTY_SEMANTIC_OBJECT 

A generic object.

String value: "OBJECT"

PROPERTY_SEMANTIC_ID 

An ID string.

String value: "ID"

PROPERTY_SEMANTIC_FILE_NAME 

A string representing a single file name.

String value: "FILE_NAME"

PROPERTY_SEMANTIC_FILE_PATH 

A string representing a path to a single file.

String value: "FILE_PATH"

PROPERTY_SEMANTIC_FOLDER_NAME 

A string representing a single folder name.

String value: "FOLDER_NAME"

PROPERTY_SEMANTIC_FOLDER_PATH 

A string representing a path to a single folder.

String value: "FOLDER_PATH"

◆ CompressionLevel

The ZLib compression levels.

Enumerator
COMPRESSION_LEVEL_DEFAULT 

Default compression (ZLib Z_DEFAULT_COMPRESSION).

String value: "DEFAULT"

COMPRESSION_LEVEL_NONE 

No compression (ZLib Z_NO_COMPRESSION).

String value: "NONE"

COMPRESSION_LEVEL_SPEED 

Fastest compression (ZLib Z_BEST_SPEED).

String value: "SPEED"

COMPRESSION_LEVEL_2 

Compression level 2.

String value: "2"

COMPRESSION_LEVEL_3 

Compression level 3.

String value: "3"

COMPRESSION_LEVEL_4 

Compression level 4.

String value: "4"

COMPRESSION_LEVEL_5 

Compression level 5.

String value: "5"

COMPRESSION_LEVEL_6 

Compression level 6 (default ZLib compression).

String value: "6"

COMPRESSION_LEVEL_7 

Compression level 7.

String value: "7"

COMPRESSION_LEVEL_8 

Compression level 8.

String value: "8"

COMPRESSION_LEVEL_BEST 

Best compression (ZLib Z_BEST_COMPRESSION).

String value: "BEST"

Function Documentation

◆ GetTouchAreaShapeEnum()

const Enum< TouchAreaShape >& Murl::IEnums::GetTouchAreaShapeEnum ( )

Get the TouchAreaShape enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetProjectionTypeEnum()

const Enum< ProjectionType >& Murl::IEnums::GetProjectionTypeEnum ( )

Get the ProjectionType enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetResultCodeEnum()

const Enum< ResultCode >& Murl::IEnums::GetResultCodeEnum ( )

Get the ResultCode enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetFileAccessModeEnum()

const Enum< FileAccessMode >& Murl::IEnums::GetFileAccessModeEnum ( )

Get the FileAccessMode enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetAuthorizationStatusEnum()

const Enum< AuthorizationStatus >& Murl::IEnums::GetAuthorizationStatusEnum ( )

Get the AuthorizationStatus enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetSocketErrorEnum()

const Enum< SocketError >& Murl::IEnums::GetSocketErrorEnum ( )

Get the SocketError enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetResourceTypeEnum()

const Enum< ResourceType >& Murl::IEnums::GetResourceTypeEnum ( )

Get the ResourceType enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetFileTypeEnum()

const Enum< FileType >& Murl::IEnums::GetFileTypeEnum ( )

Get the FileType enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetFontTypeEnum()

const Enum< FontType >& Murl::IEnums::GetFontTypeEnum ( )

Get the FontType enumeration string mapping.

  • Returns
    The enumeration string mapping.

◆ GetPropertySemanticEnum()

const Enum< PropertySemantic >& Murl::IEnums::GetPropertySemanticEnum ( )

Get the PropertySemantic enumeration string mapping.

  • Returns
    The enumeration string mapping.


Copyright © 2011-2018 Spraylight GmbH.