Graph items enumerations. More...
Typedefs | |
| using | Murl::IEnums::TextureFlagMask = UInt32 |
| Data type for combined texture flag mask bits, see Static Public Attributes | |
| using | Murl::IEnums::ColorBufferMask = UInt32 |
| Data type for combined color buffer mask bits, see Static Public Attributes | |
| using | Murl::IEnums::StencilBufferMask = UInt32 |
| Data type for combined stencil buffer mask bits, see Static Public Attributes | |
| using | Murl::IEnums::DepthBufferMask = UInt32 |
| Data type for combined depth buffer mask bits, see Static Public Attributes | |
Functions | |
| Bool | Murl::IEnums::IsPixelFormatCompressed (PixelFormat pixelFormat) |
| Query if a given pixel format uses hardware compression. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringLuminanceValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores luminance values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringChrominanceUValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores chrominance U values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringChrominanceVValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores chrominance V values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringRedValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores red values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringGreenValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores green values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringBlueValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores blue values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringAlphaValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores alpha values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringDepthValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores depth values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringStencilValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores stencil values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatLuminanceValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores luminance values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatChrominanceUValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores chrominance U values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatChrominanceVValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores chrominance V values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatRedValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores red values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatGreenValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores green values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatBlueValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores blue values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatAlphaValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores alpha values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatDepthValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores depth values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringFloatStencilValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores stencil values as floating-point numbers. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringColorValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores color and/or alpha values. More... | |
| Bool | Murl::IEnums::IsPixelFormatStoringLinearColorValues (PixelFormat pixelFormat) |
| Query if a given pixel format stores linear color values. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfLuminanceBits (PixelFormat pixelFormat) |
| Query the luminance bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfChrominanceUBits (PixelFormat pixelFormat) |
| Query the chrominance U bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfChrominanceVBits (PixelFormat pixelFormat) |
| Query the chrominance V bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfRedBits (PixelFormat pixelFormat) |
| Query the red bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfGreenBits (PixelFormat pixelFormat) |
| Query the green bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfBlueBits (PixelFormat pixelFormat) |
| Query the blue bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfAlphaBits (PixelFormat pixelFormat) |
| Query the alpha bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfDepthBits (PixelFormat pixelFormat) |
| Query the depth bit depth of a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfStencilBits (PixelFormat pixelFormat) |
| Query the stencil bit depth of a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatLuminanceBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the luminance component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatChrominanceUBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the chrominance U component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatChrominanceVBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the chrominance V component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatRedBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the red component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatGreenBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the green component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatBlueBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the blue component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatAlphaBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the alpha component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatDepthBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the depth component for a given pixel format. More... | |
| SInt32 | Murl::IEnums::GetPixelFormatStencilBitOffset (PixelFormat pixelFormat) |
| Query the bit offset of the stencil component for a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatByteSize (PixelFormat pixelFormat) |
| Query the number of bytes per pixel for a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatComponentByteSize (PixelFormat pixelFormat) |
| Query the size in bytes of a single color component for a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatNumberOfComponents (PixelFormat pixelFormat) |
| Query the number of color components per pixel for a given pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatBytesPerLine (PixelFormat pixelFormat, UInt32 sizeX) |
| Query the required number of bytes in a single line for a given width and pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatBytesPerSurface (PixelFormat pixelFormat, UInt32 sizeX, UInt32 sizeY) |
| Query the required number of surface data bytes for a given width, height and pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatMinNumberOfBlocksX (PixelFormat pixelFormat) |
| Query the minimum number of required horizontal blocks for a compressed pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatMinNumberOfBlocksY (PixelFormat pixelFormat) |
| Query the minimum number of required vertical blocks for a compressed pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatCompressedBlockSizeX (PixelFormat pixelFormat) |
| Query the horizontal block size in pixels for a compressed pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatCompressedBlockSizeY (PixelFormat pixelFormat) |
| Query the vertical block size in pixels for a compressed pixel format. More... | |
| UInt32 | Murl::IEnums::GetPixelFormatCompressedBytesPerBlock (PixelFormat pixelFormat) |
| Query the block size in bytes for a compressed pixel format. More... | |
| ColorBufferFormat | Murl::IEnums::GetColorBufferFormatFromPixelFormat (PixelFormat pixelFormat) |
| Select a color buffer format compatible to a given image pixel format. More... | |
| PixelFormat | Murl::IEnums::GetPixelFormatFromColorBufferFormat (ColorBufferFormat colorBufferFormat) |
| Select an image pixel format compatible to a given color buffer format. More... | |
| DepthBufferFormat | Murl::IEnums::GetDepthBufferFormatFromPixelFormat (PixelFormat pixelFormat) |
| Select a depth buffer format compatible to a given image pixel format. More... | |
| PixelFormat | Murl::IEnums::GetPixelFormatFromDepthBufferFormat (DepthBufferFormat depthBufferFormat) |
| Select an image pixel format compatible to a given depth buffer format. More... | |
| StencilBufferFormat | Murl::IEnums::GetStencilBufferFormatFromPixelFormat (PixelFormat pixelFormat) |
| Select a stencil buffer format compatible to a given image pixel format. More... | |
| PixelFormat | Murl::IEnums::GetPixelFormatFromStencilBufferFormat (StencilBufferFormat stencilBufferFormat) |
| Select an image pixel format compatible to a given stencil buffer format. More... | |
| const Char * | Murl::IEnums::GetIndexBufferItemName (IndexBufferItem indexBufferItem) |
| Query the name of a index buffer item. More... | |
| const Char * | Murl::IEnums::GetIndexBufferItemAlternativeName (IndexBufferItem indexBufferItem) |
| Query the alternative name of a index buffer item. More... | |
| UInt32 | Murl::IEnums::GetIndexTypeByteSize (IndexType indexType) |
| Query the number of bytes per element for a given index type. More... | |
| const Char * | Murl::IEnums::GetVertexBufferItemName (VertexBufferItem vertexBufferItem) |
| Query the name of a vertex buffer item. More... | |
| const Char * | Murl::IEnums::GetVertexBufferItemAlternativeName (VertexBufferItem vertexBufferItem) |
| Query the alternative name of a vertex buffer item. More... | |
| UInt32 | Murl::IEnums::GetAttributeTypeByteSize (AttributeType attributeType) |
| Query the total number of bytes per item for a given attribute type. More... | |
| UInt32 | Murl::IEnums::GetAttributeTypeComponentByteSize (AttributeType attributeType) |
| Query the number of bytes per item component for a given attribute type. More... | |
| UInt32 | Murl::IEnums::GetAttributeTypeNumberOfComponents (AttributeType attributeType) |
| Query the number of item components for a given attribute type. More... | |
| Bool | Murl::IEnums::GetAttributeTypeSign (AttributeType attributeType) |
| Query the number of item for being signed or unsigned. More... | |
| AttributeItem | Murl::IEnums::GetAttributeItem (const Char *name) |
| Query the predefined attribute item from a shader variable name. More... | |
| AttributeType | Murl::IEnums::GetAttributeItemDataType (AttributeItem attributeItem) |
| Query the shader variable data type for an attribute item. More... | |
| ShaderVariablePrecision | Murl::IEnums::GetAttributeItemDefaultPrecision (AttributeItem attributeItem) |
| Query the default variable precision for an attribute item. More... | |
| VertexBufferItem | Murl::IEnums::GetAttributeItemVertexBufferItem (AttributeItem attributeItem) |
| Query an attribute item's predefined vertex buffer item. More... | |
| const Char * | Murl::IEnums::GetAttributeItemName (AttributeItem attributeItem) |
| Query the shader variable name for an attribute item. More... | |
| const Char * | Murl::IEnums::GetAttributeItemAlternativeName (AttributeItem attributeItem) |
| Query the alternative shader variable name for an attribute item. More... | |
| UInt32 | Murl::IEnums::GetConstantTypeNumberOfComponents (ConstantType constantType) |
| Query the number of item components for a given constant type. More... | |
| ConstantBufferItem | Murl::IEnums::GetConstantBufferItem (const Char *name) |
| Query the predefined constant buffer item from a shader variable name. More... | |
| const Char * | Murl::IEnums::GetConstantBufferItemName (ConstantBufferItem constantBufferItem) |
| Query the name of a constant buffer item. More... | |
| const Char * | Murl::IEnums::GetConstantBufferItemAlternativeName (ConstantBufferItem constantBufferItem) |
| Query the alternative name of a constant buffer item. More... | |
| UInt32 | Murl::IEnums::GetUniformTypeByteSize (UniformType uniformType) |
| Query the total number of bytes per item for a given uniform type. More... | |
| UInt32 | Murl::IEnums::GetUniformTypeComponentByteSize (UniformType uniformType) |
| Query the number of bytes per item component for a given uniform type. More... | |
| UInt32 | Murl::IEnums::GetUniformTypeNumberOfComponents (UniformType uniformType) |
| Query the number of item components for a given uniform type. More... | |
| UniformItem | Murl::IEnums::GetUniformItem (const Char *name) |
| Query the predefined uniform item from a shader variable name. More... | |
| UniformType | Murl::IEnums::GetUniformItemDataType (UniformItem uniformItem) |
| Query the shader variable data type for a uniform item. More... | |
| ShaderVariablePrecision | Murl::IEnums::GetUniformItemDefaultPrecision (UniformItem uniformItem) |
| Query the default variable precision for a uniform item. More... | |
| ConstantBufferItem | Murl::IEnums::GetUniformItemConstantBufferItem (UniformItem uniformItem) |
| Query a uniform item's predefined constant buffer item. More... | |
| const Char * | Murl::IEnums::GetUniformItemName (UniformItem uniformItem) |
| Query the shader variable name for a uniform item. More... | |
| const Char * | Murl::IEnums::GetUniformItemAlternativeName (UniformItem uniformItem) |
| Query the alternative shader variable name for a uniform item. More... | |
| UInt32 | Murl::IEnums::GetConstantBufferItemNumberOfUniformItems (ConstantBufferItem constantBufferItem) |
| Query the number of uniform items for a predefined constant buffer. More... | |
| IEnums::UniformItem | Murl::IEnums::GetConstantBufferItemUniformItem (ConstantBufferItem constantBufferItem, UInt32 index) |
| Query the predefined uniform item for a predefined constant buffer at a given index. More... | |
| UInt32 | Murl::IEnums::GetConstantBufferItemUniformItemArraySize (ConstantBufferItem constantBufferItem, UInt32 index) |
| Query the array size of a predefined uniform item for a predefined constant buffer at a given index. More... | |
| UInt32 | Murl::IEnums::GetVaryingTypeByteSize (VaryingType varyingType) |
| Query the total number of bytes per item for a given varying type. More... | |
| UInt32 | Murl::IEnums::GetVaryingTypeComponentByteSize (VaryingType varyingType) |
| Query the number of bytes per item component for a given varying type. More... | |
| UInt32 | Murl::IEnums::GetVaryingTypeNumberOfComponents (VaryingType varyingType) |
| Query the number of item components for a given varying type. More... | |
Detailed Description
Graph items enumerations.
Enumeration Type Documentation
◆ Limits
| enum Murl::IEnums::Limits |
Limits for rendering slots.
◆ MipMapGenerationMode
Available mip-map level generators.
| Enumerator | |
|---|---|
| MIP_MAP_GENERATION_MODE_DEFAULT | Use default method. String value: |
| MIP_MAP_GENERATION_MODE_NONE | Do not create mip levels. String value: |
| MIP_MAP_GENERATION_MODE_FAST | Create mip levels by simple pixel averaging (fast, but not not gamma-correct). String value: |
| MIP_MAP_GENERATION_MODE_GAMMA_CORRECT | Perform gamma-correct mip-level generation (slower) String value: |
| MIP_MAP_GENERATION_MODE_REPLACE_FAST | Fast mode, replacing any present mip levels. String value: |
| MIP_MAP_GENERATION_MODE_REPLACE_GAMMA_CORRECT | Gamma-correct mode, replacing any present mip levels. String value: |
| MIP_MAP_GENERATION_MODE_PRESERVE_FAST | Fast mode, preserving any present mip levels (equivalent to FAST) String value: |
| MIP_MAP_GENERATION_MODE_PRESERVE_GAMMA_CORRECT | Gamma-correct mode, preserving any present mip levels (equivalent to GAMMA_CORRECT) String value: |
◆ PixelFormat
Available pixel formats to use for images and textures.
| Enumerator | |
|---|---|
| PIXEL_FORMAT_UNDEFINED | Undefined format. String value: |
| PIXEL_FORMAT_L8 | 8 bit integer luminance only. String value: |
| PIXEL_FORMAT_A8 | 8 bit integer alpha only. String value: |
| PIXEL_FORMAT_L8_A8 | 16 bit integer, with 8 luminance bits and 8 alpha bits. String value: |
| PIXEL_FORMAT_R8 | 8 bit integer red only. String value: |
| PIXEL_FORMAT_R8_G8 | 16 bit integer, with 8 red bits and 8 green bits. String value: |
| PIXEL_FORMAT_R8_G8_B8 | 24 bit integer RGB, with 8 bits per component. String value: |
| PIXEL_FORMAT_R5_G6_B5 | 16 bit integer RGB, with 5 red bits, 6 green bits and 5 blue bits. String value: |
| PIXEL_FORMAT_R8_G8_B8_A8 | 32 bit integer RGBA, with 8 bits per component (always available). String value: |
| PIXEL_FORMAT_B8_G8_R8_A8 | 32 bit integer BGRA, with 8 bits per component (on certain platforms). String value: |
| PIXEL_FORMAT_A8_B8_G8_R8 | 32 bit integer ABGR, with 8 bits per component (on certain platforms). String value: |
| PIXEL_FORMAT_A8_R8_G8_B8 | 32 bit integer ARGB, with 8 bits per component (on certain platforms). String value: |
| PIXEL_FORMAT_R5_G5_B5_A1 | 16 bit integer RGBA, with 5 red bits, 5 green bits, 5 blue bits and 1 alpha bit. String value: |
| PIXEL_FORMAT_R4_G4_B4_A4 | 16 bit integer RGBA, with 4 bits per component. String value: |
| PIXEL_FORMAT_SL8 | 8 bit integer luminance only in sRGB color space. String value: |
| PIXEL_FORMAT_SL8_A8 | 16 bit integer, with 8 bits luminance in sRGB color space and 8 bits alpha. String value: |
| PIXEL_FORMAT_SR8 | 8 bit integer red only in sRGB color space String value: |
| PIXEL_FORMAT_SR8_SG8 | 16 bit integer, with 8 red and 8 green bits in sRGB color space. String value: |
| PIXEL_FORMAT_SR8_SG8_SB8 | 24 bit integer sRGB, with 8 bits per component. String value: |
| PIXEL_FORMAT_SR8_SG8_SB8_A8 | 32 bit integer sRGB with Alpha, with 8 bits per component String value: |
| PIXEL_FORMAT_LF16 | 16 bit half-float luminance only. String value: |
| PIXEL_FORMAT_AF16 | 16 bit half-float alpha only. String value: |
| PIXEL_FORMAT_LF16_AF16 | 32 bit half-float, with 16 luminance bits and 16 alpha bits. String value: |
| PIXEL_FORMAT_RF16 | 16 bit half-float red only. String value: |
| PIXEL_FORMAT_RF16_GF16 | 32 bit half-float, with 16 red bits and 16 green bits. String value: |
| PIXEL_FORMAT_RF16_GF16_BF16 | 48 bit half-float RGB, with 16 bits per component. String value: |
| PIXEL_FORMAT_RF16_GF16_BF16_AF16 | 64 bit half-float RGBA, with 16 bits per component. String value: |
| PIXEL_FORMAT_LF32 | 32 bit float luminance only. String value: |
| PIXEL_FORMAT_AF32 | 32 bit float alpha only. String value: |
| PIXEL_FORMAT_LF32_AF32 | 64 bit float, with 32 luminance bits and 32 alpha bits. String value: |
| PIXEL_FORMAT_RF32 | 32 bit float red only. String value: |
| PIXEL_FORMAT_RF32_GF32 | 64 bit float, with 32 red bits and 32 green bits. String value: |
| PIXEL_FORMAT_RF32_GF32_BF32 | 96 bit float RGB, with 32 bits per component. String value: |
| PIXEL_FORMAT_RF32_GF32_BF32_AF32 | 128 bit float RGBA, with 32 bits per component. String value: |
| PIXEL_FORMAT_RF11_GF11_BF10 | String value: |
| PIXEL_FORMAT_D16 | 16 bit integer depth buffer format. String value: |
| PIXEL_FORMAT_D32 | 32 bit integer depth buffer format. String value: |
| PIXEL_FORMAT_DF32 | 32 bit float depth buffer format. String value: |
| PIXEL_FORMAT_S8 | 8 bit integer stencil buffer format. String value: |
| PIXEL_FORMAT_D24_S8 | 32 bit integer combined depth & stencil buffer format, with 24 depth bits and 8 stencil bits. String value: |
| PIXEL_FORMAT_DF32_S8 | 64 bit combined depth & stencil buffer format, with 32 float depth bits, 8 stencil bits and 24 unused bits. String value: |
| PIXEL_FORMAT_Y8 | String value: |
| PIXEL_FORMAT_U8 | String value: |
| PIXEL_FORMAT_V8 | String value: |
| PIXEL_FORMAT_U8_V8 | String value: |
| PIXEL_FORMAT_V8_U8 | String value: |
| PIXEL_FORMAT_PVRTC_RGB_4BPPV1 | PVR compressed RGB, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_RGB_2BPPV1 | PVR compressed RGB, with 2 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_RGBA_4BPPV1 | PVR compressed RGBA, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_RGBA_2BPPV1 | PVR compressed RGBA, with 2 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_SRGB_4BPPV1 | PVR compressed sRGB, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_SRGB_2BPPV1 | PVR compressed sRGB, with 2 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_SRGBA_4BPPV1 | PVR compressed sRGB+A, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_PVRTC_SRGBA_2BPPV1 | PVR compressed sRGB+A, with 2 bits per pixel. String value: |
| PIXEL_FORMAT_ETC1_RGB_4BPP | ETC1 compressed RGB, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_R11_4BPP | ETC2 compressed red only with 4 bits per pixel, representing 11 bit unsigned color values. String value: |
| PIXEL_FORMAT_ETC2_SIGNED_R11_4BPP | ETC2 compressed red only with 4 bits per pixel, representing 11 bit signed color values. String value: |
| PIXEL_FORMAT_ETC2_RG11_8BPP | ETC2 compressed red/green with 8 bits per pixel, representing 11 bit unsigned color values. String value: |
| PIXEL_FORMAT_ETC2_SIGNED_RG11_8BPP | ETC2 compressed red/green with 8 bits per pixel, representing 11 bit signed color values. String value: |
| PIXEL_FORMAT_ETC2_RGB8_4BPP | ETC2 compressed RGB, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_SRGB8_4BPP | ETC2 compressed sRGB, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1_4BPP | ETC2 compressed RGB plus 1 bit alpha, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1_4BPP | ETC2 compressed sRGB plus 1 bit alpha, with 4 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_RGBA8_8BPP | ETC2 compressed RGBA, with 8 bits per pixel. String value: |
| PIXEL_FORMAT_ETC2_SRGB8_ALPHA8_8BPP | ETC2 compressed sRGB plus Alpha, with 8 bits per pixel. String value: |
| PIXEL_FORMAT_ASTC_RGBA_4X4 | ASTC compressed LDR RGBA, with a 4x4 block footprint (8 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_5X4 | ASTC compressed LDR RGBA, with a 5x4 block footprint (6.4 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_5X5 | ASTC compressed LDR RGBA, with a 5x5 block footprint (5.12 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_6X5 | ASTC compressed LDR RGBA, with a 6x5 block footprint (4.27 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_6X6 | ASTC compressed LDR RGBA, with a 6x6 block footprint (3.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_8X5 | ASTC compressed LDR RGBA, with a 8x5 block footprint (3.2 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_8X6 | ASTC compressed LDR RGBA, with a 8x6 block footprint (2.67 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_8X8 | ASTC compressed LDR RGBA, with a 8x8 block footprint (2 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_10X5 | ASTC compressed LDR RGBA, with a 10x5 block footprint (2.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_10X6 | ASTC compressed LDR RGBA, with a 10x6 block footprint (2.13 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_10X8 | ASTC compressed LDR RGBA, with a 10x8 block footprint (1.6 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_10X10 | ASTC compressed LDR RGBA, with a 10x10 block footprint (1.28 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_12X10 | ASTC compressed LDR RGBA, with a 12x10 block footprint (1.07 bpp) String value: |
| PIXEL_FORMAT_ASTC_RGBA_12X12 | ASTC compressed LDR RGBA, with a 12x12 block footprint (0.89 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_4X4 | ASTC compressed LDR sRGB with Alpha, with a 4x4 block footprint (8 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_5X4 | ASTC compressed LDR sRGB with Alpha, with a 5x4 block footprint (6.4 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_5X5 | ASTC compressed LDR sRGB with Alpha, with a 5x5 block footprint (5.12 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_6X5 | ASTC compressed LDR sRGB with Alpha, with a 6x5 block footprint (4.27 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_6X6 | ASTC compressed LDR sRGB with Alpha, with a 6x6 block footprint (3.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_8X5 | ASTC compressed LDR sRGB with Alpha, with a 8x5 block footprint (3.2 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_8X6 | ASTC compressed LDR sRGB with Alpha, with a 8x6 block footprint (2.67 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_8X8 | ASTC compressed LDR sRGB with Alpha, with a 8x8 block footprint (2 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_10X5 | ASTC compressed LDR sRGB with Alpha, with a 10x5 block footprint (2.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_10X6 | ASTC compressed LDR sRGB with Alpha, with a 10x6 block footprint (2.13 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_10X8 | ASTC compressed LDR sRGB with Alpha, with a 10x8 block footprint (1.6 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_10X10 | ASTC compressed LDR sRGB with Alpha, with a 10x10 block footprint (1.28 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_12X10 | ASTC compressed LDR sRGB with Alpha, with a 12x10 block footprint (1.07 bpp) String value: |
| PIXEL_FORMAT_ASTC_SRGB8_ALPHA8_12X12 | ASTC compressed LDR sRGB with Alpha, with a 12x12 block footprint (0.89 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_4X4 | ASTC compressed HDR RGBA, with a 4x4 block footprint (8 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_5X4 | ASTC compressed HDR RGBA, with a 5x4 block footprint (6.4 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_5X5 | ASTC compressed HDR RGBA, with a 5x5 block footprint (5.12 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_6X5 | ASTC compressed HDR RGBA, with a 6x5 block footprint (4.27 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_6X6 | ASTC compressed HDR RGBA, with a 6x6 block footprint (3.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_8X5 | ASTC compressed HDR RGBA, with a 8x5 block footprint (3.2 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_8X6 | ASTC compressed HDR RGBA, with a 8x6 block footprint (2.67 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_8X8 | ASTC compressed HDR RGBA, with a 8x8 block footprint (2 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_10X5 | ASTC compressed HDR RGBA, with a 10x5 block footprint (2.56 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_10X6 | ASTC compressed HDR RGBA, with a 10x6 block footprint (2.13 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_10X8 | ASTC compressed HDR RGBA, with a 10x8 block footprint (1.6 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_10X10 | ASTC compressed HDR RGBA, with a 10x10 block footprint (1.28 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_12X10 | ASTC compressed HDR RGBA, with a 12x10 block footprint (1.07 bpp) String value: |
| PIXEL_FORMAT_ASTC_HDR_RGBA_12X12 | ASTC compressed HDR RGBA, with a 12x12 block footprint (0.89 bpp) String value: |
| PIXEL_FORMAT_BC1_RGB_4BPP | BC1 (a.k.a. DXT1) compressed RGB, with 8 bytes per block. String value: |
| PIXEL_FORMAT_BC1_SRGB_4BPP | BC1 (a.k.a. DXT1) compressed sRGB, with 8 bytes per block. String value: |
| PIXEL_FORMAT_BC1_RGBA_4BPP | BC1 (a.k.a. DXT1) compressed RGB plus 1 bit alpha, with 8 bytes per block. String value: |
| PIXEL_FORMAT_BC1_SRGBA_4BPP | BC1 (a.k.a. DXT1) compressed sRGB plus 1 bit alpha, with 8 bytes per block. String value: |
| PIXEL_FORMAT_BC2_RGBA_8BPP | BC2 (a.k.a. DXT3) compressed RGBA, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC2_SRGBA_8BPP | BC2 (a.k.a. DXT3) compressed sRGBA, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC3_RGBA_8BPP | BC3 (a.k.a. DXT5) compressed RGBA, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC3_SRGBA_8BPP | BC3 (a.k.a. DXT5) compressed sRGBA, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC4_R_4BPP | BC4 compressed red only, with 8 bytes per block. String value: |
| PIXEL_FORMAT_BC5_RG_8BPP | BC5 compressed red/green, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC6_RGB_SF_8BPP | BC6 compressed signed float RGB, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC6_RGB_UF_8BPP | BC6 compressed unsigned float RGB, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC7_RGBA_8BPP | BC7 compressed RGBA, with 16 bytes per block. String value: |
| PIXEL_FORMAT_BC7_SRGBA_8BPP | BC7 compressed sRGB plus Alpha, with 16 bytes per block. String value: |
| PIXEL_FORMAT_RGTC_R_U_4BPP | RGTC compressed unsigned red only, with 8 bytes per block. String value: |
| PIXEL_FORMAT_RGTC_R_S_4BPP | RGTC compressed signed red only, with 8 bytes per block. String value: |
| PIXEL_FORMAT_RGTC_RG_U_8BPP | RGTC compressed unsigned red/green, with 16 bytes per block. String value: |
| PIXEL_FORMAT_RGTC_RG_S_8BPP | RGTC compressed signed red/green, with 16 bytes per block. String value: |
◆ VideoStreamFormat
Available video stream formats.
| Enumerator | |
|---|---|
| VIDEO_STREAM_FORMAT_DEFAULT | The default formats. String value: |
| VIDEO_STREAM_FORMAT_RAW | Raw format, i.e. uncompressed pixel values. String value: |
| VIDEO_STREAM_FORMAT_JPG | JPEG format. String value: |
| VIDEO_STREAM_FORMAT_PNG | PNG format. String value: |
| VIDEO_STREAM_FORMAT_PVR | PowerVR texture compression format (PVRTC). String value: |
| VIDEO_STREAM_FORMAT_WEBP | WEBP format. String value: |
| VIDEO_STREAM_FORMAT_DDS | DirectX surface (DDS) format. String value: |
| VIDEO_STREAM_FORMAT_KTX | Khronos texture (KTX) format. String value: |
| VIDEO_STREAM_FORMAT_ASTC | ASTC format. String value: |
| VIDEO_STREAM_FORMAT_ZIP | Zipped raw format, i.e. zip-compressed pixel values. String value: |
◆ ColorBufferFormat
Available formats for stand-alone color buffers.
These formats are used only for stand-alone color buffers used in a multisample frame buffer. If rendering to a color texture is desired, one of the IEnums::PixelFormat enum values must be used for that texture.
| Enumerator | |
|---|---|
| COLOR_BUFFER_FORMAT_UNDEFINED | Undefined color buffer format. String value: |
| COLOR_BUFFER_FORMAT_NONE | No format. String value: |
| COLOR_BUFFER_FORMAT_GENERIC | Any suitable color buffer format. String value: |
| COLOR_BUFFER_FORMAT_R8 | Explicit 8 bit integer red only color buffer format. String value: |
| COLOR_BUFFER_FORMAT_R8_G8 | Explicit 8 bit integer red/green color buffer format. String value: |
| COLOR_BUFFER_FORMAT_R8_G8_B8 | Explicit 8 bit integer RGB color buffer format. String value: |
| COLOR_BUFFER_FORMAT_R5_G6_B5 | Explicit integer 5:6:5 RGB color buffer format. |
| COLOR_BUFFER_FORMAT_R8_G8_B8_A8 | Explicit 8 bit integer RGBA color buffer format. String value: |
| COLOR_BUFFER_FORMAT_R5_G5_B5_A1 | Explicit integer 5:5:5 RGB color buffer format with 1 bit alpha. |
| COLOR_BUFFER_FORMAT_R4_G4_B4_A4 | Explicit 4 bit integer RGBA color buffer format. |
| COLOR_BUFFER_FORMAT_SR8 | Explicit sRGB 8 bit integer red only color buffer format. String value: |
| COLOR_BUFFER_FORMAT_SR8_SG8 | Explicit sRGB 8 bit integer red/green color buffer format. String value: |
| COLOR_BUFFER_FORMAT_SR8_SG8_SB8 | Explicit sRGB 8 bit integer RGB color buffer format. String value: |
| COLOR_BUFFER_FORMAT_SR8_SG8_SB8_A8 | Explicit sRGB 8 bit integer RGBA color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF16 | Explicit 16 bit half float red only color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF16_GF16 | Explicit 16 bit half float red/green color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF16_GF16_BF16 | Explicit 16 bit half float RGB color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF16_GF16_BF16_AF16 | Explicit 16 bit half float RGBA color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF32 | Explicit 32 bit float red only color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF32_GF32 | Explicit 32 bit float red/green color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF32_GF32_BF32 | Explicit 32 bit float RGB color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF32_GF32_BF32_AF32 | Explicit 32 bit float RGBA color buffer format. String value: |
| COLOR_BUFFER_FORMAT_RF11_GF11_BF10 | Explicit floating point RGB color buffer format, packed into a single 32 bit value. String value: |
◆ DepthBufferFormat
Available formats for stand-alone depth buffers.
These formats are used only for stand-alone depth buffers; if rendering to a depth texture is desired, one of the IEnums::PixelFormat enum values must be used for that texture. To create a combined depth/stencil buffer, use the IEnums::DEPTH_BUFFER_FORMAT_D24_S8 and IEnums::STENCIL_BUFFER_FORMAT_D24_S8 formats (or their DF32 equivalents) in combination.
| Enumerator | |
|---|---|
| DEPTH_BUFFER_FORMAT_UNDEFINED | Undefined depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_NONE | No format; use this during frame buffer creation when no depth buffer is needed. String value: |
| DEPTH_BUFFER_FORMAT_GENERIC | Any suitable depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_D16 | Explicit 16 bit integer depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_D24 | Explicit 24 bit integer depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_D32 | Explicit 32 bit integer depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_DF32 | Explicit 32 bit float depth buffer format. String value: |
| DEPTH_BUFFER_FORMAT_D24_S8 | Explicit 32 bit integer combined depth & stencil buffer format. String value: |
| DEPTH_BUFFER_FORMAT_DF32_S8 | Explicit 64 bit combined depth & stencil buffer format. String value: |
◆ StencilBufferFormat
Available formats for stand-alone stencil buffers.
These formats are used only for stand-alone stencil buffers; if rendering to a stencil texture is desired, one of the IEnums::PixelFormat enum values must be used for that texture. To create a combined depth/stencil buffer, use the IEnums::DEPTH_BUFFER_FORMAT_D24_S8 and IEnums::STENCIL_BUFFER_FORMAT_D24_S8 formats (or their DF32 equivalents) in combination.
| Enumerator | |
|---|---|
| STENCIL_BUFFER_FORMAT_UNDEFINED | Undefined stencil buffer format. String value: |
| STENCIL_BUFFER_FORMAT_NONE | No format; use this during frame buffer creation when no stencil buffer is needed. String value: |
| STENCIL_BUFFER_FORMAT_GENERIC | Any suitable stencil buffer format. String value: |
| STENCIL_BUFFER_FORMAT_S8 | Explicit 8 bit integer stencil buffer format. String value: |
| STENCIL_BUFFER_FORMAT_D24_S8 | Explicit 32 bit integer combined depth & stencil buffer format. String value: |
| STENCIL_BUFFER_FORMAT_DF32_S8 | Explicit 64 bit combined depth & stencil buffer format. String value: |
◆ FilterType
Available filter types for e.g.
image scaling.
| Enumerator | |
|---|---|
| FILTER_TYPE_DEFAULT | Default filter type. String value: |
| FILTER_TYPE_NEAREST | Nearest neighbor filter. String value: |
| FILTER_TYPE_BOX | Nearest neighbor filter. String value: |
| FILTER_TYPE_BILINEAR | Nearest neighbor filter. String value: |
| FILTER_TYPE_GAUSSIAN | Nearest neighbor filter. String value: |
◆ ShaderVariableType
Available shader variable types.
| Enumerator | |
|---|---|
| SHADER_VARIABLE_TYPE_UNKNOWN | Unknown type. String value: |
| SHADER_VARIABLE_TYPE_CONSTANT | A simple constant to be used in both vertex and fragment shaders. String value: |
| SHADER_VARIABLE_TYPE_CONSTANT_BUFFER | A constant buffer containing one or more uniforms to be used in both vertex and fragment shaders. String value: |
| SHADER_VARIABLE_TYPE_UNIFORM | A single uniform variable. String value: |
| SHADER_VARIABLE_TYPE_ATTRIBUTE | A vertex attribute variable used in a vertex shader. String value: |
| SHADER_VARIABLE_TYPE_VARYING | A varying variable, used as output of a vertex shader and input of a fragment shader. String value: |
| SHADER_VARIABLE_TYPE_TEXTURE | A texture (sampler) variable. String value: |
◆ ShaderVariablePrecision
Available shader variable precision qualifiers.
| Enumerator | |
|---|---|
| SHADER_VARIABLE_PRECISION_DEFAULT | Default precision. String value: |
| SHADER_VARIABLE_PRECISION_LOW | Low precision. String value: |
| SHADER_VARIABLE_PRECISION_MEDIUM | Medium precision. String value: |
| SHADER_VARIABLE_PRECISION_HIGH | High precision. String value: |
◆ TextureWrapMode
Available texture wrap modes.
| Enumerator | |
|---|---|
| TEXTURE_WRAP_MODE_UNDEFINED | Undefined wrap mode. String value: |
| TEXTURE_WRAP_MODE_CLAMP_TO_EDGE | Textures are clamped at their edge, i.e. texture coordinates are always in the range 0.0-1.0. String value: |
| TEXTURE_WRAP_MODE_REPEAT | Textures are repeated (tiled). String value: |
| TEXTURE_WRAP_MODE_MIRRORED_REPEAT | Textures are repeated (tiled), with every second tile mirrored. String value: |
◆ TextureFilter
Available texture filter modes for magnification & minification.
| Enumerator | |
|---|---|
| TEXTURE_FILTER_UNDEFINED | Undefined texture filter. String value: |
| TEXTURE_FILTER_NONE | No filter. String value: |
| TEXTURE_FILTER_NEAREST | Nearest-neighbor filter. String value: |
| TEXTURE_FILTER_LINEAR | Linear filter. String value: |
◆ TextureType
Available texture types.
| Enumerator | |
|---|---|
| TEXTURE_TYPE_DEFAULT | Default texture type. String value: |
| TEXTURE_TYPE_FLAT | A 2D texture. String value: |
| TEXTURE_TYPE_CUBE | A cube map texture. String value: |
| TEXTURE_TYPE_VOLUME | A 3D volume texture. String value: |
| TEXTURE_TYPE_FLAT_ARRAY | An array of 2D textures. String value: |
| TEXTURE_TYPE_CUBE_ARRAY | An array of cube map textures. String value: |
◆ TextureFlagMaskBit
Mask bits for additional texture sampler parameters.
The values in this enumeration are specified as a bit field so they can be ORed together.
◆ TextureSemantic
Available texture semantics.
| Enumerator | |
|---|---|
| TEXTURE_SEMANTIC_UNDEFINED | Undefined semantic. String value: |
| TEXTURE_SEMANTIC_UNKNOWN | Unknown semantic. String value: |
| TEXTURE_SEMANTIC_NONE | No semantic at all. String value: |
| TEXTURE_SEMANTIC_DONT_CARE | Don't care. String value: |
| TEXTURE_SEMANTIC_AMBIENT_RED | Ambient lighting red component. String value: |
| TEXTURE_SEMANTIC_AMBIENT_GREEN | Ambient lighting green component. String value: |
| TEXTURE_SEMANTIC_AMBIENT_BLUE | Ambient lighting blue component. String value: |
| TEXTURE_SEMANTIC_AMBIENT_ALPHA | Ambient lighting alpha component. String value: |
| TEXTURE_SEMANTIC_AMBIENT_LUMINANCE | Ambient lighting luminance. String value: |
| TEXTURE_SEMANTIC_DIFFUSE_RED | Diffuse lighting red component. String value: |
| TEXTURE_SEMANTIC_DIFFUSE_GREEN | Diffuse lighting green component. String value: |
| TEXTURE_SEMANTIC_DIFFUSE_BLUE | Diffuse lighting blue component. String value: |
| TEXTURE_SEMANTIC_DIFFUSE_ALPHA | Diffuse lighting alpha component. String value: |
| TEXTURE_SEMANTIC_DIFFUSE_LUMINANCE | Diffuse lighting luminance. String value: |
| TEXTURE_SEMANTIC_SPECULAR_RED | Specular lighting red component. String value: |
| TEXTURE_SEMANTIC_SPECULAR_GREEN | Specular lighting green component. String value: |
| TEXTURE_SEMANTIC_SPECULAR_BLUE | Specular lighting blue component. String value: |
| TEXTURE_SEMANTIC_SPECULAR_ALPHA | Specular lighting alpha component. String value: |
| TEXTURE_SEMANTIC_SPECULAR_LUMINANCE | Specular lighting luminance. String value: |
| TEXTURE_SEMANTIC_EMISSIVE_RED | Emissive lighting red component. String value: |
| TEXTURE_SEMANTIC_EMISSIVE_GREEN | Emissive lighting green component. String value: |
| TEXTURE_SEMANTIC_EMISSIVE_BLUE | Emissive lighting blue component. String value: |
| TEXTURE_SEMANTIC_EMISSIVE_ALPHA | Emissive lighting alpha component. String value: |
| TEXTURE_SEMANTIC_EMISSIVE_LUMINANCE | Emissive lighting luminance. String value: |
| TEXTURE_SEMANTIC_REFLECTION_RED | Reflection map red component. String value: |
| TEXTURE_SEMANTIC_REFLECTION_GREEN | Reflection map green component. String value: |
| TEXTURE_SEMANTIC_REFLECTION_BLUE | Reflection map blue component. String value: |
| TEXTURE_SEMANTIC_REFLECTION_ALPHA | Reflection map blue component. String value: |
| TEXTURE_SEMANTIC_REFLECTION_LUMINANCE | Reflection map luminance. String value: |
| TEXTURE_SEMANTIC_LIGHTMAP_RED | Light map/ambient occlusion map red component. String value: |
| TEXTURE_SEMANTIC_LIGHTMAP_GREEN | Light map/ambient occlusion map green component. String value: |
| TEXTURE_SEMANTIC_LIGHTMAP_BLUE | Light map/ambient occlusion map blue component. String value: |
| TEXTURE_SEMANTIC_LIGHTMAP_ALPHA | Light map/ambient occlusion map alpha component. String value: |
| TEXTURE_SEMANTIC_LIGHTMAP_LUMINANCE | Light map/ambient occlusion map luminance. String value: |
| TEXTURE_SEMANTIC_LIGHT_RED | Projected light texture #0 red component. String value: |
| TEXTURE_SEMANTIC_LIGHT_GREEN | Projected light texture #0 green component. String value: |
| TEXTURE_SEMANTIC_LIGHT_BLUE | Projected light texture #0 blue component. String value: |
| TEXTURE_SEMANTIC_LIGHT_ALPHA | Projected light texture #0 alpha component. String value: |
| TEXTURE_SEMANTIC_LIGHT_LUMINANCE | Projected light texture #0 luminance. String value: |
| TEXTURE_SEMANTIC_ENVIRONMENT_RED | Environment (cube) map red component. String value: |
| TEXTURE_SEMANTIC_ENVIRONMENT_GREEN | Environment (cube) map green component. String value: |
| TEXTURE_SEMANTIC_ENVIRONMENT_BLUE | Environment (cube) map blue component. String value: |
| TEXTURE_SEMANTIC_ENVIRONMENT_ALPHA | Environment (cube) map alpha component. String value: |
| TEXTURE_SEMANTIC_ENVIRONMENT_LUMINANCE | Environment (cube) map luminance. String value: |
| TEXTURE_SEMANTIC_IRRADIANCE_RED | Irradiance (cube) map red component. String value: |
| TEXTURE_SEMANTIC_IRRADIANCE_GREEN | Irradiance (cube) map green component. String value: |
| TEXTURE_SEMANTIC_IRRADIANCE_BLUE | Irradiance (cube) map blue component. String value: |
| TEXTURE_SEMANTIC_IRRADIANCE_ALPHA | Irradiance (cube) map alpha component. String value: |
| TEXTURE_SEMANTIC_IRRADIANCE_LUMINANCE | Irradiance (cube) map luminance. String value: |
| TEXTURE_SEMANTIC_NORMAL_X | Normal map X direction. String value: |
| TEXTURE_SEMANTIC_NORMAL_Y | Normal map Y direction. String value: |
| TEXTURE_SEMANTIC_NORMAL_Z | Normal map Z direction. String value: |
| TEXTURE_SEMANTIC_DISPLACEMENT_X | Displacement map X direction. String value: |
| TEXTURE_SEMANTIC_DISPLACEMENT_Y | Displacement map Y direction. String value: |
| TEXTURE_SEMANTIC_DISPLACEMENT_Z | Displacement map Z direction. String value: |
| TEXTURE_SEMANTIC_NORMALIZATION_X | Normalization cube map X component. String value: |
| TEXTURE_SEMANTIC_NORMALIZATION_Y | Normalization cube map Y component. String value: |
| TEXTURE_SEMANTIC_NORMALIZATION_Z | Normalization cube map Z component. String value: |
| TEXTURE_SEMANTIC_OPACITY_VALUE | Opacity value. String value: |
| TEXTURE_SEMANTIC_SHININESS_VALUE | Shininess value. String value: |
| TEXTURE_SEMANTIC_GLOSSINESS_VALUE | Glossiness value. String value: |
| TEXTURE_SEMANTIC_HEIGHT_VALUE | Height map value. String value: |
| TEXTURE_SEMANTIC_DISSOLVE_VALUE | Dissolve value. String value: |
◆ TextureTarget
Available texture upload targets.
| Enumerator | |
|---|---|
| TEXTURE_TARGET_DEFAULT | The default texture upload target. String value: |
| TEXTURE_TARGET_FLAT | Single target for 2D (flat) textures. String value: |
| TEXTURE_TARGET_CUBE_POS_X | The +X face of a cube map texture. String value: |
| TEXTURE_TARGET_CUBE_NEG_X | The -X face of a cube map texture. String value: |
| TEXTURE_TARGET_CUBE_POS_Y | The +Y face of a cube map texture. String value: |
| TEXTURE_TARGET_CUBE_NEG_Y | The -Y face of a cube map texture. String value: |
| TEXTURE_TARGET_CUBE_POS_Z | The +Z face of a cube map texture. String value: |
| TEXTURE_TARGET_CUBE_NEG_Z | The -Z face of a cube map texture. String value: |
◆ TextureAttachment
Available attachment points to attach a texture to a frame buffer.
| Enumerator | |
|---|---|
| TEXTURE_ATTACHMENT_DEFAULT | Default attachment point. String value: |
| TEXTURE_ATTACHMENT_COLOR_BUFFER_0 | Attachment point for 1st color texture. String value: |
| TEXTURE_ATTACHMENT_COLOR_BUFFER_1 | Attachment point for 2nd color texture. String value: |
| TEXTURE_ATTACHMENT_COLOR_BUFFER_2 | Attachment point for 3rd color texture. String value: |
| TEXTURE_ATTACHMENT_COLOR_BUFFER_3 | Attachment point for 4th color texture. String value: |
| TEXTURE_ATTACHMENT_DEPTH_BUFFER_0 | Attachment point for a depth texture. String value: |
| TEXTURE_ATTACHMENT_STENCIL_BUFFER_0 | Attachment point for a stencil texture. String value: |
◆ IndexBufferItem
Available index buffer items.
| Enumerator | |
|---|---|
| INDEX_BUFFER_ITEM_DEFAULT | String value: |
◆ IndexType
◆ VertexBufferItem
Available vertex buffer items to be used in vertex shaders.
| Enumerator | |
|---|---|
| VERTEX_BUFFER_ITEM_DEFAULT | String value: |
◆ AttributeType
| enum Murl::IEnums::AttributeType : UInt8 |
Available data types for vertex buffer attribute items.
| Enumerator | |
|---|---|
| ATTRIBUTE_TYPE_UNDEFINED | Undefined type. String value: |
| ATTRIBUTE_TYPE_FLOAT | Scalar 32 bit float value. String value: |
| ATTRIBUTE_TYPE_FLOAT_VECTOR_2 | A 2-component vector of 32 bit float values. String value: |
| ATTRIBUTE_TYPE_FLOAT_VECTOR_3 | A 3-component vector of 32 bit float values. String value: |
| ATTRIBUTE_TYPE_FLOAT_VECTOR_4 | A 4-component vector of 32 bit float values. String value: |
| ATTRIBUTE_TYPE_UINT8 | Scalar 8 bit unsigned integer value. String value: |
| ATTRIBUTE_TYPE_UINT8_VECTOR_2 | A 2-component vector of 8 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT8_VECTOR_3 | A 3-component vector of 8 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT8_VECTOR_4 | A 4-component vector of 8 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_SINT8 | Scalar 8 bit signed integer value. String value: |
| ATTRIBUTE_TYPE_SINT8_VECTOR_2 | A 2-component vector of 8 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT8_VECTOR_3 | A 3-component vector of 8 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT8_VECTOR_4 | A 4-component vector of 8 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_UINT16 | Scalar 16 bit unsigned integer value. String value: |
| ATTRIBUTE_TYPE_UINT16_VECTOR_2 | A 2-component vector of 16 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT16_VECTOR_3 | A 3-component vector of 16 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT16_VECTOR_4 | A 4-component vector of 16 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_SINT16 | Scalar 16 bit signed integer value. String value: |
| ATTRIBUTE_TYPE_SINT16_VECTOR_2 | A 2-component vector of 16 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT16_VECTOR_3 | A 3-component vector of 16 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT16_VECTOR_4 | A 4-component vector of 16 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT8 | Scalar 8 bit unsigned integer value, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT8_VECTOR_2 | A 2-component vector of 8 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT8_VECTOR_3 | A 3-component vector of 8 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT8_VECTOR_4 | A 4-component vector of 8 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT8 | Scalar 8 bit signed integer value, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT8_VECTOR_2 | A 2-component vector of 8 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT8_VECTOR_3 | A 3-component vector of 8 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT8_VECTOR_4 | A 4-component vector of 8 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT16 | Scalar 16 bit unsigned integer value, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT16_VECTOR_2 | A 2-component vector of 16 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT16_VECTOR_3 | A 3-component vector of 16 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_UINT16_VECTOR_4 | A 4-component vector of 16 bit unsigned integer values, normalized to [0..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT16 | Scalar 16 bit signed integer value, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT16_VECTOR_2 | A 2-component vector of 16 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT16_VECTOR_3 | A 3-component vector of 16 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_NORMALIZED_SINT16_VECTOR_4 | A 4-component vector of 16 bit signed integer values, normalized to [-1..1]. String value: |
| ATTRIBUTE_TYPE_UINT32 | Scalar 32 bit unsigned integer value. String value: |
| ATTRIBUTE_TYPE_UINT32_VECTOR_2 | A 2-component vector of 32 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT32_VECTOR_3 | A 3-component vector of 32 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_UINT32_VECTOR_4 | A 4-component vector of 32 bit unsigned integer values. String value: |
| ATTRIBUTE_TYPE_SINT32 | Scalar 32 bit signed integer value. String value: |
| ATTRIBUTE_TYPE_SINT32_VECTOR_2 | A 2-component vector of 32 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT32_VECTOR_3 | A 3-component vector of 32 bit signed integer values. String value: |
| ATTRIBUTE_TYPE_SINT32_VECTOR_4 | A 4-component vector of 32 bit signed integer values. String value: |
◆ AttributeItem
Available vertex buffer attribute items.
| Enumerator | |
|---|---|
| ATTRIBUTE_ITEM_COORD | Vertex coordinates. String value: |
| ATTRIBUTE_ITEM_NORMAL | Normal vector. String value: |
| ATTRIBUTE_ITEM_BINORMAL | Binormal vector. String value: |
| ATTRIBUTE_ITEM_TANGENT | Tangent vector. String value: |
| ATTRIBUTE_ITEM_COLOR | Vertex color. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_0 | Texture coordinate set #0. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_1 | Texture coordinate set #1. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_2 | Texture coordinate set #2. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_3 | Texture coordinate set #3. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_4 | Texture coordinate set #4. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_5 | Texture coordinate set #5. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_6 | Texture coordinate set #6. String value: |
| ATTRIBUTE_ITEM_TEXCOORD_7 | Texture coordinate set #7. String value: |
| ATTRIBUTE_ITEM_BONE_INDICES | Bone indices, to index into a given bone matrix array. String value: |
| ATTRIBUTE_ITEM_BONE_WEIGHTS | Bone weights, to blend bones together. String value: |
| ATTRIBUTE_ITEM_CUSTOM | Custom item. String value: |
| ATTRIBUTE_ITEM_BONE_OFFSET_0 | Bone offset for index #0. String value: |
| ATTRIBUTE_ITEM_BONE_OFFSET_1 | Bone offset for index #1. String value: |
| ATTRIBUTE_ITEM_BONE_OFFSET_2 | Bone offset for index #2. String value: |
| ATTRIBUTE_ITEM_BONE_OFFSET_3 | Bone offset for index #3. String value: |
◆ ConstantType
Available data types for constant shader variable items.
| Enumerator | |
|---|---|
| CONSTANT_TYPE_UNDEFINED | Undefined type. String value: |
| CONSTANT_TYPE_SINT32 | Scalar signed integer type. String value: |
| CONSTANT_TYPE_SINT32_VECTOR_2 | 2-component integer vector type. String value: |
| CONSTANT_TYPE_SINT32_VECTOR_3 | 3-component integer vector type. String value: |
| CONSTANT_TYPE_SINT32_VECTOR_4 | 4-component integer vector type. String value: |
| CONSTANT_TYPE_FLOAT | Scalar floating point type. String value: |
| CONSTANT_TYPE_FLOAT_VECTOR_2 | 2-component floating point vector type. String value: |
| CONSTANT_TYPE_FLOAT_VECTOR_3 | 3-component floating point vector type. String value: |
| CONSTANT_TYPE_FLOAT_VECTOR_4 | 4-component floating point vector type. String value: |
| CONSTANT_TYPE_FLOAT_MATRIX_2 | 2x2 floating point matrix type. String value: |
| CONSTANT_TYPE_FLOAT_MATRIX_3 | 3x3 floating point matrix type. String value: |
| CONSTANT_TYPE_FLOAT_MATRIX_4 | 4x4 floating point matrix type. String value: |
| CONSTANT_TYPE_BOOL | Scalar signed integer type. String value: |
| CONSTANT_TYPE_BOOL_VECTOR_2 | 2-component integer vector type. String value: |
| CONSTANT_TYPE_BOOL_VECTOR_3 | 3-component integer vector type. String value: |
| CONSTANT_TYPE_BOOL_VECTOR_4 | 4-component integer vector type. String value: |
◆ ConstantBufferItem
Available constant buffer items to be used in vertex and fragment shaders.
| Enumerator | |
|---|---|
| CONSTANT_BUFFER_ITEM_DEFAULT | String value: |
| CONSTANT_BUFFER_ITEM_VIEWPORT | String value: |
| CONSTANT_BUFFER_ITEM_MODEL | String value: |
| CONSTANT_BUFFER_ITEM_CAMERA | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_0 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_1 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_2 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_3 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_4 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_5 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_6 | String value: |
| CONSTANT_BUFFER_ITEM_LIGHT_7 | String value: |
| CONSTANT_BUFFER_ITEM_MATERIAL | String value: |
| CONSTANT_BUFFER_ITEM_SAMPLERS | String value: |
| CONSTANT_BUFFER_ITEM_BONES | String value: |
| CONSTANT_BUFFER_ITEM_CUSTOM | String value: |
| CONSTANT_BUFFER_ITEM_TIME | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_0 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_1 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_2 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_3 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_4 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_5 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_6 | String value: |
| CONSTANT_BUFFER_ITEM_SHADOW_7 | String value: |
◆ UniformType
Available data types for uniform variable items.
| Enumerator | |
|---|---|
| UNIFORM_TYPE_UNDEFINED | Undefined type. String value: |
| UNIFORM_TYPE_SINT32 | Scalar signed integer type. String value: |
| UNIFORM_TYPE_SINT32_VECTOR_2 | 2-component integer vector type. String value: |
| UNIFORM_TYPE_SINT32_VECTOR_3 | 3-component integer vector type. String value: |
| UNIFORM_TYPE_SINT32_VECTOR_4 | 4-component integer vector type. String value: |
| UNIFORM_TYPE_FLOAT | Scalar floating point type. String value: |
| UNIFORM_TYPE_FLOAT_VECTOR_2 | 2-component floating point vector type. String value: |
| UNIFORM_TYPE_FLOAT_VECTOR_3 | 3-component floating point vector type. String value: |
| UNIFORM_TYPE_FLOAT_VECTOR_4 | 4-component floating point vector type. String value: |
| UNIFORM_TYPE_FLOAT_MATRIX_2 | 2x2 floating point matrix type. String value: |
| UNIFORM_TYPE_FLOAT_MATRIX_3 | 3x3 floating point matrix type. String value: |
| UNIFORM_TYPE_FLOAT_MATRIX_4 | 4x4 floating point matrix type. String value: |
| UNIFORM_TYPE_SAMPLER_FLAT | Flat texture sampler. String value: |
| UNIFORM_TYPE_SAMPLER_CUBE | Cubemap sampler. String value: |
| UNIFORM_TYPE_SAMPLER_FLAT_ARRAY | Flat texture array sampler. String value: |
| UNIFORM_TYPE_SAMPLER_CUBE_ARRAY | Cubemap array sampler. String value: |
◆ UniformItem
Available uniform variable items to be used in vertex and fragment shaders.
| Enumerator | |
|---|---|
| UNIFORM_ITEM_VIEWPORT_SIZE | The current viewport size in pixels. String value: |
| UNIFORM_ITEM_VIEWPORT_SIZE_INVERTED | The inverted (i.e. reciprocal) viewport size. String value: |
| UNIFORM_ITEM_MODEL_MATRIX | The model matrix, to transform from model space to world space. String value: |
| UNIFORM_ITEM_CAMERA_WORLD_MATRIX | The camera world matrix. String value: |
| UNIFORM_ITEM_CAMERA_VIEW_MATRIX | The camera view matrix, to transform from world space to camera space. String value: |
| UNIFORM_ITEM_CAMERA_PROJECTION_MATRIX | The camera projection matrix, to project from camera space to screen space. String value: |
| UNIFORM_ITEM_CAMERA_VIEW_PROJECTION_MATRIX | The combined camera view & projection matrix (world space to screen space). String value: |
| UNIFORM_ITEM_CAMERA_POSITION | The camera position vector in world space. String value: |
| UNIFORM_ITEM_CAMERA_DIRECTION | The camera view direction vector in world space. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_0 | The world matrix of light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_1 | The world matrix of light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_2 | The world matrix of light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_3 | The world matrix of light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_4 | The world matrix of light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_5 | The world matrix of light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_6 | The world matrix of light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_WORLD_MATRIX_7 | The world matrix of light unit #7. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_0 | The view matrix of light unit #0, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_1 | The view matrix of light unit #1, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_2 | The view matrix of light unit #2, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_3 | The view matrix of light unit #3, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_4 | The view matrix of light unit #4, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_5 | The view matrix of light unit #5, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_6 | The view matrix of light unit #6, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_MATRIX_7 | The view matrix of light unit #7, useful for e.g. shadow map generation. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_0 | The projection matrix of light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_1 | The projection matrix of light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_2 | The projection matrix of light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_3 | The projection matrix of light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_4 | The projection matrix of light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_5 | The projection matrix of light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_6 | The projection matrix of light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_PROJECTION_MATRIX_7 | The projection matrix of light unit #7. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_0 | The combined view & projection matrix of light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_1 | The combined view & projection matrix of light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_2 | The combined view & projection matrix of light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_3 | The combined view & projection matrix of light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_4 | The combined view & projection matrix of light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_5 | The combined view & projection matrix of light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_6 | The combined view & projection matrix of light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_VIEW_PROJECTION_MATRIX_7 | The combined view & projection matrix of light unit #7. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_0 | The position vector of light unit #0 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_1 | The position vector of light unit #1 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_2 | The position vector of light unit #2 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_3 | The position vector of light unit #3 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_4 | The position vector of light unit #4 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_5 | The position vector of light unit #5 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_6 | The position vector of light unit #6 in world space. String value: |
| UNIFORM_ITEM_LIGHT_POSITION_7 | The position vector of light unit #7 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_0 | The direction vector of light unit #0 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_1 | The direction vector of light unit #1 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_2 | The direction vector of light unit #2 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_3 | The direction vector of light unit #3 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_4 | The direction vector of light unit #4 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_5 | The direction vector of light unit #5 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_6 | The direction vector of light unit #6 in world space. String value: |
| UNIFORM_ITEM_LIGHT_DIRECTION_7 | The direction vector of light unit #7 in world space. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_0 | Light attenuation values for light unit #0, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_1 | Light attenuation values for light unit #1, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_2 | Light attenuation values for light unit #2, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_3 | Light attenuation values for light unit #3, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_4 | Light attenuation values for light unit #4, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_5 | Light attenuation values for light unit #5, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_6 | Light attenuation values for light unit #6, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_ATTENUATION_7 | Light attenuation values for light unit #7, packed into the X, Y and Z components of a vector. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_0 | Packed light spot values for light unit #0: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_1 | Packed light spot values for light unit #1: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_2 | Packed light spot values for light unit #2: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_3 | Packed light spot values for light unit #3: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_4 | Packed light spot values for light unit #4: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_5 | Packed light spot values for light unit #5: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_6 | Packed light spot values for light unit #6: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_SPOT_7 | Packed light spot values for light unit #7: X = spot exponent, Y = spot cutoff angle, Z = light intensity. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_0 | The ambient color component for light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_1 | The ambient color component for light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_2 | The ambient color component for light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_3 | The ambient color component for light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_4 | The ambient color component for light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_5 | The ambient color component for light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_6 | The ambient color component for light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_AMBIENT_7 | The ambient color component for light unit #7. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_0 | The diffuse color component for light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_1 | The diffuse color component for light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_2 | The diffuse color component for light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_3 | The diffuse color component for light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_4 | The diffuse color component for light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_5 | The diffuse color component for light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_6 | The diffuse color component for light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_DIFFUSE_7 | The diffuse color component for light unit #7. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_0 | The specular color component for light unit #0. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_1 | The specular color component for light unit #1. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_2 | The specular color component for light unit #2. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_3 | The specular color component for light unit #3. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_4 | The specular color component for light unit #4. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_5 | The specular color component for light unit #5. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_6 | The specular color component for light unit #6. String value: |
| UNIFORM_ITEM_LIGHT_COLOR_SPECULAR_7 | The specular color component for light unit #7. String value: |
| UNIFORM_ITEM_MATERIAL_COLOR_AMBIENT | The current material's ambient color component. String value: |
| UNIFORM_ITEM_MATERIAL_COLOR_DIFFUSE | The current material's diffuse color component. String value: |
| UNIFORM_ITEM_MATERIAL_COLOR_SPECULAR | The current material's specular color component. String value: |
| UNIFORM_ITEM_MATERIAL_COLOR_EMISSIVE | The current material's emissive color component (self illumination). String value: |
| UNIFORM_ITEM_MATERIAL_SHININESS | The current material's shininess parameter (specular exponent). String value: |
| UNIFORM_ITEM_SAMPLER_0 | Sampler for texture unit #0. String value: |
| UNIFORM_ITEM_SAMPLER_1 | Sampler for texture unit #1. String value: |
| UNIFORM_ITEM_SAMPLER_2 | Sampler for texture unit #2. String value: |
| UNIFORM_ITEM_SAMPLER_3 | Sampler for texture unit #3. String value: |
| UNIFORM_ITEM_SAMPLER_4 | Sampler for texture unit #4. String value: |
| UNIFORM_ITEM_SAMPLER_5 | Sampler for texture unit #5. String value: |
| UNIFORM_ITEM_SAMPLER_6 | Sampler for texture unit #6. String value: |
| UNIFORM_ITEM_SAMPLER_7 | Sampler for texture unit #7. String value: |
| UNIFORM_ITEM_BONE_MATRIX_0 | Bone matrix #0. String value: |
| UNIFORM_ITEM_BONE_MATRIX_1 | Bone matrix #1. String value: |
| UNIFORM_ITEM_BONE_MATRIX_2 | Bone matrix #2. String value: |
| UNIFORM_ITEM_BONE_MATRIX_3 | Bone matrix #3. String value: |
| UNIFORM_ITEM_BONE_MATRIX_4 | Bone matrix #4. String value: |
| UNIFORM_ITEM_BONE_MATRIX_5 | Bone matrix #5. String value: |
| UNIFORM_ITEM_BONE_MATRIX_6 | Bone matrix #6. String value: |
| UNIFORM_ITEM_BONE_MATRIX_7 | Bone matrix #7. String value: |
| UNIFORM_ITEM_BONE_MATRIX_8 | Bone matrix #8. String value: |
| UNIFORM_ITEM_BONE_MATRIX_9 | Bone matrix #9. String value: |
| UNIFORM_ITEM_BONE_MATRIX_10 | Bone matrix #10. String value: |
| UNIFORM_ITEM_BONE_MATRIX_11 | Bone matrix #11. String value: |
| UNIFORM_ITEM_BONE_MATRIX_12 | Bone matrix #12. String value: |
| UNIFORM_ITEM_BONE_MATRIX_13 | Bone matrix #13. String value: |
| UNIFORM_ITEM_BONE_MATRIX_14 | Bone matrix #14. String value: |
| UNIFORM_ITEM_BONE_MATRIX_15 | Bone matrix #15. String value: |
| UNIFORM_ITEM_BONE_MATRIX_16 | Bone matrix #16. String value: |
| UNIFORM_ITEM_BONE_MATRIX_17 | Bone matrix #17. String value: |
| UNIFORM_ITEM_BONE_MATRIX_18 | Bone matrix #18. String value: |
| UNIFORM_ITEM_BONE_MATRIX_19 | Bone matrix #19. String value: |
| UNIFORM_ITEM_BONE_MATRIX_20 | Bone matrix #20. String value: |
| UNIFORM_ITEM_BONE_MATRIX_21 | Bone matrix #21. String value: |
| UNIFORM_ITEM_BONE_MATRIX_22 | Bone matrix #22. String value: |
| UNIFORM_ITEM_BONE_MATRIX_23 | Bone matrix #23. String value: |
| UNIFORM_ITEM_BONE_MATRIX_24 | Bone matrix #24. String value: |
| UNIFORM_ITEM_BONE_MATRIX_25 | Bone matrix #25. String value: |
| UNIFORM_ITEM_BONE_MATRIX_26 | Bone matrix #26. String value: |
| UNIFORM_ITEM_BONE_MATRIX_27 | Bone matrix #27. String value: |
| UNIFORM_ITEM_BONE_MATRIX_28 | Bone matrix #28. String value: |
| UNIFORM_ITEM_BONE_MATRIX_29 | Bone matrix #29. String value: |
| UNIFORM_ITEM_BONE_MATRIX_30 | Bone matrix #30. String value: |
| UNIFORM_ITEM_BONE_MATRIX_31 | Bone matrix #31. String value: |
| UNIFORM_ITEM_BONE_MATRIX_32 | Bone matrix #32. String value: |
| UNIFORM_ITEM_BONE_MATRIX_33 | Bone matrix #33. String value: |
| UNIFORM_ITEM_BONE_MATRIX_34 | Bone matrix #34. String value: |
| UNIFORM_ITEM_BONE_MATRIX_35 | Bone matrix #35. String value: |
| UNIFORM_ITEM_BONE_MATRIX_36 | Bone matrix #36. String value: |
| UNIFORM_ITEM_BONE_MATRIX_37 | Bone matrix #37. String value: |
| UNIFORM_ITEM_BONE_MATRIX_38 | Bone matrix #38. String value: |
| UNIFORM_ITEM_BONE_MATRIX_39 | Bone matrix #39. String value: |
| UNIFORM_ITEM_BONE_MATRIX_40 | Bone matrix #40. String value: |
| UNIFORM_ITEM_BONE_MATRIX_41 | Bone matrix #41. String value: |
| UNIFORM_ITEM_BONE_MATRIX_42 | Bone matrix #42. String value: |
| UNIFORM_ITEM_BONE_MATRIX_43 | Bone matrix #43. String value: |
| UNIFORM_ITEM_BONE_MATRIX_44 | Bone matrix #44. String value: |
| UNIFORM_ITEM_BONE_MATRIX_45 | Bone matrix #45. String value: |
| UNIFORM_ITEM_BONE_MATRIX_46 | Bone matrix #46. String value: |
| UNIFORM_ITEM_BONE_MATRIX_47 | Bone matrix #47. String value: |
| UNIFORM_ITEM_BONE_MATRIX_48 | Bone matrix #48. String value: |
| UNIFORM_ITEM_BONE_MATRIX_49 | Bone matrix #49. String value: |
| UNIFORM_ITEM_BONE_MATRIX_50 | Bone matrix #50. String value: |
| UNIFORM_ITEM_BONE_MATRIX_51 | Bone matrix #51. String value: |
| UNIFORM_ITEM_BONE_MATRIX_52 | Bone matrix #52. String value: |
| UNIFORM_ITEM_BONE_MATRIX_53 | Bone matrix #53. String value: |
| UNIFORM_ITEM_BONE_MATRIX_54 | Bone matrix #54. String value: |
| UNIFORM_ITEM_BONE_MATRIX_55 | Bone matrix #55. String value: |
| UNIFORM_ITEM_BONE_MATRIX_56 | Bone matrix #56. String value: |
| UNIFORM_ITEM_BONE_MATRIX_57 | Bone matrix #57. String value: |
| UNIFORM_ITEM_BONE_MATRIX_58 | Bone matrix #58. String value: |
| UNIFORM_ITEM_BONE_MATRIX_59 | Bone matrix #59. String value: |
| UNIFORM_ITEM_BONE_MATRIX_60 | Bone matrix #60. String value: |
| UNIFORM_ITEM_BONE_MATRIX_61 | Bone matrix #61. String value: |
| UNIFORM_ITEM_BONE_MATRIX_62 | Bone matrix #62. String value: |
| UNIFORM_ITEM_BONE_MATRIX_63 | Bone matrix #63. String value: |
| UNIFORM_ITEM_CUSTOM | Custom item. String value: |
| UNIFORM_ITEM_TIME_SECONDS | Running time (seconds part) String value: |
| UNIFORM_ITEM_TIME_FRACTION | Running time (fractional part) String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_0_0 | The combined shadow view & projection matrix for cascade #0 of light unit #0. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_1_0 | The combined shadow view & projection matrix for cascade #0 of light unit #1. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_2_0 | The combined shadow view & projection matrix for cascade #0 of light unit #2. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_3_0 | The combined shadow view & projection matrix for cascade #0 of light unit #3. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_4_0 | The combined shadow view & projection matrix for cascade #0 of light unit #4. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_5_0 | The combined shadow view & projection matrix for cascade #0 of light unit #5. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_6_0 | The combined shadow view & projection matrix for cascade #0 of light unit #6. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_7_0 | The combined shadow view & projection matrix for cascade #0 of light unit #7. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_0_1 | The combined shadow view & projection matrix for cascade #1 of light unit #0. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_1_1 | The combined shadow view & projection matrix for cascade #1 of light unit #1. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_2_1 | The combined shadow view & projection matrix for cascade #1 of light unit #2. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_3_1 | The combined shadow view & projection matrix for cascade #1 of light unit #3. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_4_1 | The combined shadow view & projection matrix for cascade #1 of light unit #4. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_5_1 | The combined shadow view & projection matrix for cascade #1 of light unit #5. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_6_1 | The combined shadow view & projection matrix for cascade #1 of light unit #6. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_7_1 | The combined shadow view & projection matrix for cascade #1 of light unit #7. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_0_2 | The combined shadow view & projection matrix for cascade #2 of light unit #0. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_1_2 | The combined shadow view & projection matrix for cascade #2 of light unit #1. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_2_2 | The combined shadow view & projection matrix for cascade #2 of light unit #2. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_3_2 | The combined shadow view & projection matrix for cascade #2 of light unit #3. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_4_2 | The combined shadow view & projection matrix for cascade #2 of light unit #4. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_5_2 | The combined shadow view & projection matrix for cascade #2 of light unit #5. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_6_2 | The combined shadow view & projection matrix for cascade #2 of light unit #6. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_7_2 | The combined shadow view & projection matrix for cascade #2 of light unit #7. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_0_3 | The combined shadow view & projection matrix for cascade #3 of light unit #0. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_1_3 | The combined shadow view & projection matrix for cascade #3 of light unit #1. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_2_3 | The combined shadow view & projection matrix for cascade #3 of light unit #2. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_3_3 | The combined shadow view & projection matrix for cascade #3 of light unit #3. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_4_3 | The combined shadow view & projection matrix for cascade #3 of light unit #4. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_5_3 | The combined shadow view & projection matrix for cascade #3 of light unit #5. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_6_3 | The combined shadow view & projection matrix for cascade #3 of light unit #6. String value: |
| UNIFORM_ITEM_SHADOW_VIEW_PROJECTION_MATRIX_7_3 | The combined shadow view & projection matrix for cascade #3 of light unit #7. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_0 | The shadow split distances (far distances) of light unit #0, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_1 | The shadow split distances (far distances) of light unit #1, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_2 | The shadow split distances (far distances) of light unit #2, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_3 | The shadow split distances (far distances) of light unit #3, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_4 | The shadow split distances (far distances) of light unit #4, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_5 | The shadow split distances (far distances) of light unit #5, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_6 | The shadow split distances (far distances) of light unit #6, packed into XYZW. String value: |
| UNIFORM_ITEM_SHADOW_SPLIT_DISTANCE_7 | The shadow split distances (far distances) of light unit #7, packed into XYZW. String value: |
◆ VaryingType
Available data types for varying variable items.
| Enumerator | |
|---|---|
| VARYING_TYPE_UNDEFINED | Undefined type. String value: |
| VARYING_TYPE_FLOAT | Scalar floating point type. String value: |
| VARYING_TYPE_FLOAT_VECTOR_2 | 2-component floating point vector type. String value: |
| VARYING_TYPE_FLOAT_VECTOR_3 | 3-component floating point vector type. String value: |
| VARYING_TYPE_FLOAT_VECTOR_4 | 4-component floating point vector type. String value: |
◆ PrimitiveType
Available primitive types for rendering vertex/index buffers.
| Enumerator | |
|---|---|
| PRIMITIVE_TYPE_UNDEFINED | Undefined primitive type. String value: |
| PRIMITIVE_TYPE_POINTS | Individual points. String value: |
| PRIMITIVE_TYPE_LINE_STRIP | A sequence of lines, with each line using the previous line's end point as the new starting point. String value: |
| PRIMITIVE_TYPE_LINE_LOOP | A sequence of lines, with each line using the previous line's end point as the new starting point; an additional line is inserted from the very last to the very first point, to form a loop. String value: |
| PRIMITIVE_TYPE_LINES | A sequence of lines; every subsequent pair of vertices forms an individual line. String value: |
| PRIMITIVE_TYPE_TRIANGLE_STRIP | A sequence of triangles, with each triangle using the previous triangle's last two vertices as its first two vertices. String value: |
| PRIMITIVE_TYPE_TRIANGLE_FAN | A triangle fan, where all triangles share the first vertex of the buffer, and each triangle shares the last vertex of the previous triangle. String value: |
| PRIMITIVE_TYPE_TRIANGLES | A sequence of triangles; every subsequent triple of vertices forms an individual triangle. String value: |
◆ BufferAccessMode
◆ BufferType
◆ VariableType
Available variable types for e.g.
Graph::IVariable nodes.
| Enumerator | |
|---|---|
| VARIABLE_TYPE_UNDEFINED | Undefined type. String value: |
| VARIABLE_TYPE_BOOL | String value: |
| VARIABLE_TYPE_REAL | String value: |
| VARIABLE_TYPE_SINT32 | String value: |
◆ TimelineUnit
Available timeline units.
| Enumerator | |
|---|---|
| TIMELINE_UNIT_0 | Timeline unit #0. String value: |
| TIMELINE_UNIT_1 | Timeline unit #1. String value: |
| TIMELINE_UNIT_2 | Timeline unit #2. String value: |
| TIMELINE_UNIT_3 | Timeline unit #3. String value: |
| TIMELINE_UNIT_4 | Timeline unit #4. String value: |
| TIMELINE_UNIT_5 | Timeline unit #5. String value: |
| TIMELINE_UNIT_6 | Timeline unit #6. String value: |
| TIMELINE_UNIT_7 | Timeline unit #7. String value: |
| TIMELINE_UNIT_8 | Timeline unit #8. String value: |
| TIMELINE_UNIT_9 | Timeline unit #9. String value: |
| TIMELINE_UNIT_10 | Timeline unit #10. String value: |
| TIMELINE_UNIT_11 | Timeline unit #11. String value: |
| TIMELINE_UNIT_12 | Timeline unit #12. String value: |
| TIMELINE_UNIT_13 | Timeline unit #13. String value: |
| TIMELINE_UNIT_14 | Timeline unit #14. String value: |
| TIMELINE_UNIT_15 | Timeline unit #15. String value: |
◆ BoneUnit
Available bone units.
| Enumerator | |
|---|---|
| BONE_UNIT_0 | Bone unit #0. String value: |
| BONE_UNIT_1 | Bone unit #1. String value: |
| BONE_UNIT_2 | Bone unit #2. String value: |
| BONE_UNIT_3 | Bone unit #3. String value: |
| BONE_UNIT_4 | Bone unit #4. String value: |
| BONE_UNIT_5 | Bone unit #5. String value: |
| BONE_UNIT_6 | Bone unit #6. String value: |
| BONE_UNIT_7 | Bone unit #7. String value: |
| BONE_UNIT_8 | Bone unit #8. String value: |
| BONE_UNIT_9 | Bone unit #9. String value: |
| BONE_UNIT_10 | Bone unit #10. String value: |
| BONE_UNIT_11 | Bone unit #11. String value: |
| BONE_UNIT_12 | Bone unit #12. String value: |
| BONE_UNIT_13 | Bone unit #13. String value: |
| BONE_UNIT_14 | Bone unit #14. String value: |
| BONE_UNIT_15 | Bone unit #15. String value: |
| BONE_UNIT_16 | Bone unit #16. String value: |
| BONE_UNIT_17 | Bone unit #17. String value: |
| BONE_UNIT_18 | Bone unit #18. String value: |
| BONE_UNIT_19 | Bone unit #19. String value: |
| BONE_UNIT_20 | Bone unit #20. String value: |
| BONE_UNIT_21 | Bone unit #21. String value: |
| BONE_UNIT_22 | Bone unit #22. String value: |
| BONE_UNIT_23 | Bone unit #23. String value: |
| BONE_UNIT_24 | Bone unit #24. String value: |
| BONE_UNIT_25 | Bone unit #25. String value: |
| BONE_UNIT_26 | Bone unit #26. String value: |
| BONE_UNIT_27 | Bone unit #27. String value: |
| BONE_UNIT_28 | Bone unit #28. String value: |
| BONE_UNIT_29 | Bone unit #29. String value: |
| BONE_UNIT_30 | Bone unit #30. String value: |
| BONE_UNIT_31 | Bone unit #31. String value: |
| BONE_UNIT_32 | Bone unit #32. String value: |
| BONE_UNIT_33 | Bone unit #33. String value: |
| BONE_UNIT_34 | Bone unit #34. String value: |
| BONE_UNIT_35 | Bone unit #35. String value: |
| BONE_UNIT_36 | Bone unit #36. String value: |
| BONE_UNIT_37 | Bone unit #37. String value: |
| BONE_UNIT_38 | Bone unit #38. String value: |
| BONE_UNIT_39 | Bone unit #39. String value: |
| BONE_UNIT_40 | Bone unit #40. String value: |
| BONE_UNIT_41 | Bone unit #41. String value: |
| BONE_UNIT_42 | Bone unit #42. String value: |
| BONE_UNIT_43 | Bone unit #43. String value: |
| BONE_UNIT_44 | Bone unit #44. String value: |
| BONE_UNIT_45 | Bone unit #45. String value: |
| BONE_UNIT_46 | Bone unit #46. String value: |
| BONE_UNIT_47 | Bone unit #47. String value: |
| BONE_UNIT_48 | Bone unit #48. String value: |
| BONE_UNIT_49 | Bone unit #49. String value: |
| BONE_UNIT_50 | Bone unit #50. String value: |
| BONE_UNIT_51 | Bone unit #51. String value: |
| BONE_UNIT_52 | Bone unit #52. String value: |
| BONE_UNIT_53 | Bone unit #53. String value: |
| BONE_UNIT_54 | Bone unit #54. String value: |
| BONE_UNIT_55 | Bone unit #55. String value: |
| BONE_UNIT_56 | Bone unit #56. String value: |
| BONE_UNIT_57 | Bone unit #57. String value: |
| BONE_UNIT_58 | Bone unit #58. String value: |
| BONE_UNIT_59 | Bone unit #59. String value: |
| BONE_UNIT_60 | Bone unit #60. String value: |
| BONE_UNIT_61 | Bone unit #61. String value: |
| BONE_UNIT_62 | Bone unit #62. String value: |
| BONE_UNIT_63 | Bone unit #63. String value: |
◆ LightUnit
◆ TextureUnit
Available texture units.
| Enumerator | |
|---|---|
| TEXTURE_UNIT_0 | Texture unit #0. String value: |
| TEXTURE_UNIT_1 | Texture unit #1. String value: |
| TEXTURE_UNIT_2 | Texture unit #2. String value: |
| TEXTURE_UNIT_3 | Texture unit #3. String value: |
| TEXTURE_UNIT_4 | Texture unit #4. String value: |
| TEXTURE_UNIT_5 | Texture unit #5. String value: |
| TEXTURE_UNIT_6 | Texture unit #6. String value: |
| TEXTURE_UNIT_7 | Texture unit #7. String value: |
◆ VertexOrder
◆ PolygonFaces
Polygon faces.
| Enumerator | |
|---|---|
| POLYGON_FACES_UNDEFINED | Undefined. String value: |
| POLYGON_FACES_NONE | No faces visible. String value: |
| POLYGON_FACES_FRONT_ONLY | Only front faces visible (i.e. back face culling enabled). String value: |
| POLYGON_FACES_BACK_ONLY | Only back faces visible (i.e. front face culling enabled). String value: |
| POLYGON_FACES_FRONT_AND_BACK | Both front and back faces visible (i.e. culling disabled). String value: |
◆ ColorBufferMode
◆ ColorBufferMaskBit
Mask bits to control which color components are written.
The values in this enumeration are specified as a bit field so they can be ORed together. If the renderer's color buffer mode is set to IEnums::COLOR_BUFFER_MODE_WRITE_ONLY, a set mask bit enables writing to the respective color channel. In case of IEnums::COLOR_BUFFER_MODE_NONE this has no effect.
◆ StencilBufferMode
Stencil buffer access mode during rendering.
| Enumerator | |
|---|---|
| STENCIL_BUFFER_MODE_UNDEFINED | Undefined mode. String value: |
| STENCIL_BUFFER_MODE_NONE | No access (no stencil values are read or written) String value: |
| STENCIL_BUFFER_MODE_READ_ONLY | Read-only access. String value: |
| STENCIL_BUFFER_MODE_WRITE_ONLY | Write-only access. String value: |
| STENCIL_BUFFER_MODE_READ_AND_WRITE | Read-and-write access. String value: |
◆ StencilBufferMaskBit
Mask bits to control which stencil buffer bits are written.
The values in this enumeration are specified as a bit field so they can be ORed together. If the renderer's stencil buffer mode is set to IEnums::STENCIL_BUFFER_MODE_WRITE_ONLY or IEnums::STENCIL_BUFFER_MODE_READ_AND_WRITE, , a set mask bit enables writing to the respective bit. In case of all other stencil buffer modes, this has no effect.
◆ StencilTestFunction
Stencil test functions.
There is a number of different functions that can be used for stencil value comparison when the stencil buffer is enabled. In this case, during rendering of each individual fragment, the fragment's associated stencil value present in the stencil buffer is compared to a reference value, using one of the given functions. Depending on the result of this comparison, a specific IEnums::StencilBufferAction can be carried out to modify this stencil value. By setting an IEnums::StencilBufferMask value of other than IEnums::STENCIL_BUFFER_MASK_ALL, it is possible to control which bits of the stencil buffer and reference value are actually used for comparison and modification.
| Enumerator | |
|---|---|
| STENCIL_TEST_FUNCTION_UNDEFINED | Undefined function. String value: |
| STENCIL_TEST_FUNCTION_NEVER | Stencil test always fails. String value: |
| STENCIL_TEST_FUNCTION_LESS | Stencil test passes, if (ref & mask) < (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_LESS_OR_EQUAL | Stencil test passes, if (ref & mask) <= (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_GREATER | Stencil test passes, if (ref & mask) > (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_GREATER_OR_EQUAL | Stencil test passes, if (ref & mask) >= (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_EQUAL | Stencil test passes, if (ref & mask) == (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_NOT_EQUAL | Stencil test passes, if (ref & mask) != (stencil & mask) String value: |
| STENCIL_TEST_FUNCTION_ALWAYS | Stencil test always passes. String value: |
◆ StencilBufferAction
Stencil buffer action.
These values specify an action carried out on a fragment's stencil buffer value. Different actions can be carried out, depending if the stencil test fails, if the stencil test passes but the depth buffer test does not, and if both stencil and depth buffer tests pass.
| Enumerator | |
|---|---|
| STENCIL_BUFFER_ACTION_UNDEFINED | Undefined action. String value: |
| STENCIL_BUFFER_ACTION_KEEP | Keep the value in the stencil buffer. String value: |
| STENCIL_BUFFER_ACTION_ZERO | Set the stencil buffer value to zero. String value: |
| STENCIL_BUFFER_ACTION_REPLACE | Set the stencil buffer value to the current reference value. String value: |
| STENCIL_BUFFER_ACTION_CLAMPED_INCREMENT | Increment the stencil buffer value by 1, clamping at the maximum value (255). String value: |
| STENCIL_BUFFER_ACTION_WRAPPED_INCREMENT | Decrement the stencil buffer value by 1, clamping at the minimum value (0). String value: |
| STENCIL_BUFFER_ACTION_CLAMPED_DECREMENT | Increment the stencil buffer value by 1 and wrap around if the result is greater than the maximum value (255 => 0). String value: |
| STENCIL_BUFFER_ACTION_WRAPPED_DECREMENT | Decrement the stencil buffer value by 1 and wrap around if the result is smaller than the maximum value (0 => 255). String value: |
| STENCIL_BUFFER_ACTION_INVERT | Invert the value in the stencil buffer bit-wise. String value: |
◆ DepthBufferMode
Depth buffer access mode during rendering.
| Enumerator | |
|---|---|
| DEPTH_BUFFER_MODE_UNDEFINED | Undefined mode. String value: |
| DEPTH_BUFFER_MODE_NONE | Do not use the depth buffer at all. String value: |
| DEPTH_BUFFER_MODE_READ_ONLY | Perform only depth comparisons, but do not update the depth buffer. String value: |
| DEPTH_BUFFER_MODE_WRITE_ONLY | Always draw all pixels and update the depth buffer accordingly. String value: |
| DEPTH_BUFFER_MODE_READ_AND_WRITE | Reject fragments based on a failed depth test, and update the depth buffer for all fragments that are not rejected. String value: |
◆ DepthTestFunction
Depth test functions.
Depending on the selected depth test function, the GPU decides whether to render or discard individual fragments. The fragment's calculated depth value is compared to the according depth value already present in the depth buffer.
| Enumerator | |
|---|---|
| DEPTH_TEST_FUNCTION_UNDEFINED | Undefined function. String value: |
| DEPTH_TEST_FUNCTION_NEVER | Depth test always fails. String value: |
| DEPTH_TEST_FUNCTION_LESS | Depth test passes if fragment depth < stored depth. String value: |
| DEPTH_TEST_FUNCTION_LESS_OR_EQUAL | Depth test passes if fragment depth <= stored depth. String value: |
| DEPTH_TEST_FUNCTION_GREATER | Depth test passes if fragment depth > stored depth. String value: |
| DEPTH_TEST_FUNCTION_GREATER_OR_EQUAL | Depth test passes if fragment depth >= stored depth. String value: |
| DEPTH_TEST_FUNCTION_EQUAL | Depth test passes if fragment depth == stored depth. String value: |
| DEPTH_TEST_FUNCTION_NOT_EQUAL | Depth test passes if fragment depth != stored depth. String value: |
| DEPTH_TEST_FUNCTION_ALWAYS | Depth test always passes. String value: |
◆ DepthTestMode
Depth test modes.
When using depth textures, the depth test mode defines how the actual result of a texture sample operation in the shader gets calculated. A value of NONE directly returns the actually stored value in the texture. A value of REFERENCE returns the result of the comparison to a given reference value, using a given DepthTestFunction.
| Enumerator | |
|---|---|
| DEPTH_TEST_MODE_UNDEFINED | Undefined function. String value: |
| DEPTH_TEST_MODE_NONE | Depth test always fails. String value: |
| DEPTH_TEST_MODE_REFERENCE | Depth test passes if fragment depth < stored depth. String value: |
◆ ObjectSortMode
Available object sorting modes.
Renderable objects can be pre-sorted in different ways. In general, for any opaque objects the "BY_MATERIAL" mode is the preferred one, as it groups together any drawables that share common material properties, including texture sets and GPU programs used. For (semi-)transparent objects, the "BY_DEPTH" mode is usually needed, so that the correct back-to-front drawing order is maintained for blending. If the "DEFAULT" mode is selected, the engine sets one of the two explicit modes, with "BY_DEPTH" being used whenever the material does not write to the Z buffer.
| Enumerator | |
|---|---|
| OBJECT_SORT_MODE_UNDEFINED | Undefined mode. String value: |
| OBJECT_SORT_MODE_BY_MATERIAL | Sort objects according to their material properties. String value: |
| OBJECT_SORT_MODE_BY_DEPTH | Sort objects according to their distance from the viewer. String value: |
◆ DepthSortMode
Available depth sorting modes.
If depth comparisons are performed in software on an object-level (i.e. depth buffer writes are disabled), there is a number of different depth sorting measures that can be applied.
| Enumerator | |
|---|---|
| DEPTH_SORT_MODE_UNDEFINED | Undefined mode. String value: |
| DEPTH_SORT_MODE_NONE | Do not sort according to a depth value. String value: |
| DEPTH_SORT_MODE_WORLD_Z | Simple world-Z sorting (absolute Z position in world space) String value: |
| DEPTH_SORT_MODE_DISTANCE | Sort according to squared distance from camera. String value: |
| DEPTH_SORT_MODE_VIEW_Z | Simple view-Z sorting (Z distance in camera space) String value: |
◆ BlendMode
Available blending modes.
Fragment blending in the GPU is done as a fixed-function stage in the pipeline. By enabling alpha blending, the output color value written in the fragment shader (or in the fixed function fragment stage) may contain an alpha value other than the maximum, which can be used to blend that fragment with the color value already present in the color buffer at the respective location, using one of the available IEnums::BlendFunction to calculate source and destination values, and an IEnums::BlendEquation to specify how these two are actually combined.
| Enumerator | |
|---|---|
| BLEND_MODE_UNDEFINED | Undefined mode. String value: |
| BLEND_MODE_NONE | Blending is disabled. String value: |
| BLEND_MODE_ALPHA | The fragment's output color alpha value is used for blending. String value: |
◆ BlendEquation
Available blend equations.
See IEnums::BlendMode.
| Enumerator | |
|---|---|
| BLEND_EQUATION_UNDEFINED | Undefined equation. String value: |
| BLEND_EQUATION_ADD | Resulting color = source color + destination color. String value: |
| BLEND_EQUATION_SUBTRACT | Resulting color = source color - destination color. String value: |
| BLEND_EQUATION_REVERSE_SUBTRACT | Resulting color = destination color - source color. String value: |
◆ BlendFunction
Available blend functions.
To determine the actual values for source and destination color to be combined by a specific IEnums::BlendEquation, it is possible to set a different blend function for both source and destination. In addition, it is also possible to specify separate functions for color and alpha values, resulting in 4 distinct values. See IEnums::BlendMode.
| Enumerator | |
|---|---|
| BLEND_FUNCTION_UNDEFINED | Undefined function. String value: |
| BLEND_FUNCTION_ZERO | Zero color (i.e. all black, with 0% alpha) String value: |
| BLEND_FUNCTION_ONE | Full color (i.e. all white, with 100% alpha) String value: |
| BLEND_FUNCTION_SRC_COLOR | The source input color. String value: |
| BLEND_FUNCTION_ONE_MINUS_SRC_COLOR | The inverted source input color. String value: |
| BLEND_FUNCTION_DST_COLOR | The destination input color. String value: |
| BLEND_FUNCTION_ONE_MINUS_DST_COLOR | The inverted destination input color. String value: |
| BLEND_FUNCTION_SRC_ALPHA | The source input color's alpha value, used for all 4 color components (RGBA). String value: |
| BLEND_FUNCTION_ONE_MINUS_SRC_ALPHA | The inverted source input color's alpha value, used for all 4 color components (RGBA). String value: |
| BLEND_FUNCTION_DST_ALPHA | The destination input color's alpha value, used for all 4 color components (RGBA). String value: |
| BLEND_FUNCTION_ONE_MINUS_DST_ALPHA | The inverted destination input color's alpha value, used for all 4 color components (RGBA). String value: |
| BLEND_FUNCTION_CONSTANT_COLOR | Constant blend color. String value: |
| BLEND_FUNCTION_ONE_MINUS_CONSTANT_COLOR | Inverted constant blend color. String value: |
| BLEND_FUNCTION_CONSTANT_ALPHA | Constant alpha. String value: |
| BLEND_FUNCTION_ONE_MINUS_CONSTANT_ALPHA | Inverted constant alpha. String value: |
| BLEND_FUNCTION_SRC_ALPHA_SATURATE | The source input color's saturated alpha value, used for all 4 color components (RGBA). String value: |
◆ ColorComponent
◆ LightModel
◆ LightingComponent
Available lighting equation components.
These components are used for both material and light source parameters, except the EMISSIVE component, which does not make any sense for light sources.
| Enumerator | |
|---|---|
| LIGHTING_COMPONENT_AMBIENT | Ambient component. String value: |
| LIGHTING_COMPONENT_DIFFUSE | Diffuse component. String value: |
| LIGHTING_COMPONENT_SPECULAR | Specular component. String value: |
| LIGHTING_COMPONENT_EMISSIVE | Emissive component. String value: |
◆ LightType
Available light types.
See Graph::ILight for a detailed description.
| Enumerator | |
|---|---|
| LIGHT_TYPE_DIRECTIONAL | Directional light. String value: |
| LIGHT_TYPE_POINT | Point light. String value: |
| LIGHT_TYPE_SPOT | Spot light. String value: |
◆ LightShape
◆ ShadowVolumeGenerationMode
Available modes for shadow volume generation.
| Enumerator | |
|---|---|
| SHADOW_VOLUME_GENERATION_MODE_DEFAULT | Default mode. String value: |
| SHADOW_VOLUME_GENERATION_MODE_NONE | Do not generate, i.e. directly use present information as a shadow volume. String value: |
| SHADOW_VOLUME_GENERATION_MODE_FROM_GEOMETRY | Generate from geometry data. Adjacency information must be present. String value: |
| SHADOW_VOLUME_GENERATION_MODE_FROM_COLLIDER | Generate from collider data. Bounding leaves must be present. String value: |
◆ ShadowMapPlacementMode
Available modes for shadow map placement.
| Enumerator | |
|---|---|
| SHADOW_MAP_PLACEMENT_MODE_DEFAULT | Default mode. String value: |
| SHADOW_MAP_PLACEMENT_MODE_CAMERA_VIEW_VOLUME | Place the shadow map at the center of the actual camera view volume. String value: |
| SHADOW_MAP_PLACEMENT_MODE_CAMERA_BOUNDING_SPHERE | Place the shadow map at the center of the camera's bounding sphere. String value: |
◆ ShadowMapAlignmentMode
Available modes for shadow map alignment.
| Enumerator | |
|---|---|
| SHADOW_MAP_ALIGNMENT_MODE_DEFAULT | Default mode. String value: |
| SHADOW_MAP_ALIGNMENT_MODE_LIGHT_DIRECTION | Align the shadow map to the direction of the light casting the shadow. String value: |
| SHADOW_MAP_ALIGNMENT_MODE_FIXED_PLANE | Align the shadow map to a fixed plane. String value: |
◆ StreamMode
Available access mode hints for audio/video streams.
See IVideoStream or IAudioStream for a detailed description.
| Enumerator | |
|---|---|
| STREAM_MODE_INACTIVE | Inactive mode. String value: |
| STREAM_MODE_RANDOM_ACCESS | Random access to individual frames or samples. String value: |
| STREAM_MODE_RUNNING_FORWARD | Provide a forward sequence of frames or samples. String value: |
◆ AlignmentX
Generic enumeration for horizontal alignment of objects.
| Enumerator | |
|---|---|
| ALIGNMENT_X_UNDEFINED | Undefined alignment. String value: |
| ALIGNMENT_X_LEFT | Align at left border. String value: |
| ALIGNMENT_X_CENTER | Horizontal center alignment. String value: |
| ALIGNMENT_X_RIGHT | Align at right border. String value: |
◆ AlignmentY
◆ AlignmentZ
◆ TextAlignmentX
◆ TextAlignmentY
Enumeration for text-specific vertical alignment.
| Enumerator | |
|---|---|
| TEXT_ALIGNMENT_Y_TOP | Top alignment. String value: |
| TEXT_ALIGNMENT_Y_CENTER | Vertical center alignment. String value: |
| TEXT_ALIGNMENT_Y_BOTTOM | Bottom alignment. String value: |
| TEXT_ALIGNMENT_Y_BASE_LINE | Alignment along a text's base line. String value: |
◆ ObjectBoundingMode
◆ GeometryType
Generic geometry types used for e.g.
collision detection in the physics simulator
| Enumerator | |
|---|---|
| GEOMETRY_TYPE_POINT | A single point without dimension. String value: |
| GEOMETRY_TYPE_RAY | A ray. String value: |
| GEOMETRY_TYPE_SPHERE | A sphere. String value: |
| GEOMETRY_TYPE_PLANE | An infinite plane. String value: |
| GEOMETRY_TYPE_BOX | A box. String value: |
| GEOMETRY_TYPE_MESH | A generic triangle mesh. String value: |
◆ FieldType
◆ FieldShape
◆ TraversalPhase
Individual phases of a single node's traversal.
| Enumerator | |
|---|---|
| TRAVERSAL_PHASE_BEFORE_PRE_PROCESS_CONTROLLERS | Phase 1: Before calling PreProcess*() on all attached controllers. String value: |
| TRAVERSAL_PHASE_AFTER_PRE_PROCESS_CONTROLLERS | Phase 2: After calling PreProcess*() on all attached controllers. String value: |
| TRAVERSAL_PHASE_BEFORE_PROCESS_SELF | Phase 3: Before calling Process*Self() on the node itself. String value: |
| TRAVERSAL_PHASE_AFTER_PROCESS_SELF | Phase 4: After calling Process*Self() on the node itself. String value: |
| TRAVERSAL_PHASE_BEFORE_PROCESS_CHILDREN | Phase 5: Before calling Process*Children() on the node itself. String value: |
| TRAVERSAL_PHASE_AFTER_PROCESS_CHILDREN | Phase 6: After calling Process*Children() on the node itself. String value: |
| TRAVERSAL_PHASE_BEFORE_POST_PROCESS_CONTROLLERS | Phase 7: Before calling PostProcess*() on all attached controllers. String value: |
| TRAVERSAL_PHASE_AFTER_POST_PROCESS_CONTROLLERS | Phase 8: After calling PostProcess*() on all attached controllers. String value: |
◆ TraversalState
Individual states modified during scene graph traversal.
| Enumerator | |
|---|---|
| MURL_DECLARE_ENUM_VALUE_PREDEFINED | No state. State of texture unit #0. State of texture unit #1. State of texture unit #2. State of texture unit #3. State of texture unit #4. State of texture unit #5. State of texture unit #6. State of texture unit #7. State of light unit #0. State of light unit #1. State of light unit #2. State of light unit #3. Material state. Parameters state. Bone state. Timeline state. Audio culler state. Video culler state. Camera state. Listener state. Layer state. Physics surface state. Physics island state. Anchor state Skeleton state Dirty flag Flag for automatic state change determination. |
◆ Axis
| enum Murl::IEnums::Axis |
◆ SortOrder
◆ RotationOrder
Rotation order enumeration.
| Enumerator | |
|---|---|
| ROTATION_ORDER_ZYX | ZYX order. String value: |
| ROTATION_ORDER_ZXY | ZXY order. String value: |
| ROTATION_ORDER_YZX | YZX order. String value: |
| ROTATION_ORDER_YXZ | YXZ order. String value: |
| ROTATION_ORDER_XZY | XZY order. String value: |
| ROTATION_ORDER_XYZ | XYZ order. String value: |
◆ AngleMeasure
◆ LengthMeasure
Enumeration of different length measures.
| Enumerator | |
|---|---|
| LENGTH_MEASURE_VIRTUAL | Virtual length unit. String value: |
| LENGTH_MEASURE_PIXELS | Pixels. String value: |
| LENGTH_MEASURE_MILLIMETERS | Millimeters. String value: |
| LENGTH_MEASURE_CENTIMETERS | Centimeters. String value: |
| LENGTH_MEASURE_INCHES | Inches. String value: |
◆ CompressionType
Compression types used for resource conversion.
| Enumerator | |
|---|---|
| COMPRESSION_TYPE_DEFAULT | Default compression. String value: |
| COMPRESSION_TYPE_LOSSLESS | Lossless compression, e.g. for WEBP images. String value: |
| COMPRESSION_TYPE_LOSSY | Lossy compression, e.g. for WEBP images. String value: |
| COMPRESSION_TYPE_BEST | Best compression, e.g. for PNG images. String value: |
◆ ComplexTransformType
Types of complex transform nodes.
| Enumerator | |
|---|---|
| COMPLEX_TRANSFORM_TYPE_REGULAR | Regular type, same calculation as used in Graph::ScaleTransform. String value: |
| COMPLEX_TRANSFORM_TYPE_SEPARATE_SCALE | String value: |
| COMPLEX_TRANSFORM_TYPE_COMBINE_SCALE | String value: |
Function Documentation
◆ IsPixelFormatCompressed()
| Bool Murl::IEnums::IsPixelFormatCompressed | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format uses hardware compression.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if compression is used.
◆ IsPixelFormatStoringLuminanceValues()
| Bool Murl::IEnums::IsPixelFormatStoringLuminanceValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores luminance values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if luminance values are stored.
◆ IsPixelFormatStoringChrominanceUValues()
| Bool Murl::IEnums::IsPixelFormatStoringChrominanceUValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores chrominance U values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if chrominance U values are stored.
◆ IsPixelFormatStoringChrominanceVValues()
| Bool Murl::IEnums::IsPixelFormatStoringChrominanceVValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores chrominance V values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if chrominance V values are stored.
◆ IsPixelFormatStoringRedValues()
| Bool Murl::IEnums::IsPixelFormatStoringRedValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores red values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if red values are stored.
◆ IsPixelFormatStoringGreenValues()
| Bool Murl::IEnums::IsPixelFormatStoringGreenValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores green values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if green values are stored.
◆ IsPixelFormatStoringBlueValues()
| Bool Murl::IEnums::IsPixelFormatStoringBlueValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores blue values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if blue values are stored.
◆ IsPixelFormatStoringAlphaValues()
| Bool Murl::IEnums::IsPixelFormatStoringAlphaValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores alpha values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if alpha values are stored.
◆ IsPixelFormatStoringDepthValues()
| Bool Murl::IEnums::IsPixelFormatStoringDepthValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores depth values.
In case of the combined IEnums::PIXEL_FORMAT_D24_S8 and IEnums::PIXEL_FORMAT_DF32_S8 formats, both this function and IsPixelFormatStoringStencilValues() will return true.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if depth values are stored.
◆ IsPixelFormatStoringStencilValues()
| Bool Murl::IEnums::IsPixelFormatStoringStencilValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores stencil values.
In case of the combined IEnums::PIXEL_FORMAT_D24_S8 and IEnums::PIXEL_FORMAT_DF32_S8 formats, both this function and IsPixelFormatStoringDepthValues() will return true.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if stencil values are stored.
◆ IsPixelFormatStoringFloatLuminanceValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatLuminanceValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores luminance values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if luminance values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatChrominanceUValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatChrominanceUValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores chrominance U values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if chrominance U values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatChrominanceVValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatChrominanceVValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores chrominance V values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if chrominance V values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatRedValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatRedValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores red values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if red values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatGreenValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatGreenValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores green values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if green values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatBlueValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatBlueValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores blue values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if blue values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatAlphaValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatAlphaValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores alpha values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if alpha values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatDepthValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatDepthValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores depth values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if depth values are stored as floating-point numbers.
◆ IsPixelFormatStoringFloatStencilValues()
| Bool Murl::IEnums::IsPixelFormatStoringFloatStencilValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores stencil values as floating-point numbers.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if stencil values are stored as floating-point numbers.
◆ IsPixelFormatStoringColorValues()
| Bool Murl::IEnums::IsPixelFormatStoringColorValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores color and/or alpha values.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if color values are stored.
◆ IsPixelFormatStoringLinearColorValues()
| Bool Murl::IEnums::IsPixelFormatStoringLinearColorValues | ( | PixelFormat | pixelFormat | ) |
Query if a given pixel format stores linear color values.
This method returns true for all pixel formats that store linear color values. This is the case for all the sRGB integer formats (e.g. SR8_SG8_SB8_A8) and all floating point formats (e.g. RF32_GF32_BF32).
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- true if color values are present and they are linear.
◆ GetPixelFormatNumberOfLuminanceBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfLuminanceBits | ( | PixelFormat | pixelFormat | ) |
Query the luminance bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of luminance bits, or 0 if not present.
◆ GetPixelFormatNumberOfChrominanceUBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfChrominanceUBits | ( | PixelFormat | pixelFormat | ) |
Query the chrominance U bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of chrominance U bits, or 0 if not present.
◆ GetPixelFormatNumberOfChrominanceVBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfChrominanceVBits | ( | PixelFormat | pixelFormat | ) |
Query the chrominance V bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of chrominance V bits, or 0 if not present.
◆ GetPixelFormatNumberOfRedBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfRedBits | ( | PixelFormat | pixelFormat | ) |
Query the red bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of red bits, or 0 if not present.
◆ GetPixelFormatNumberOfGreenBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfGreenBits | ( | PixelFormat | pixelFormat | ) |
Query the green bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of green bits, or 0 if not present.
◆ GetPixelFormatNumberOfBlueBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfBlueBits | ( | PixelFormat | pixelFormat | ) |
Query the blue bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of blue bits, or 0 if not present.
◆ GetPixelFormatNumberOfAlphaBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfAlphaBits | ( | PixelFormat | pixelFormat | ) |
Query the alpha bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of alpha bits, or 0 if not present.
◆ GetPixelFormatNumberOfDepthBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfDepthBits | ( | PixelFormat | pixelFormat | ) |
Query the depth bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of depth bits, or 0 if not present.
◆ GetPixelFormatNumberOfStencilBits()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfStencilBits | ( | PixelFormat | pixelFormat | ) |
Query the stencil bit depth of a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The number of stencil bits, or 0 if not present.
◆ GetPixelFormatLuminanceBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatLuminanceBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the luminance component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the luminance component, or -1 if not present.
◆ GetPixelFormatChrominanceUBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatChrominanceUBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the chrominance U component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the chrominance U component, or -1 if not present.
◆ GetPixelFormatChrominanceVBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatChrominanceVBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the chrominance V component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the chrominance V component, or -1 if not present.
◆ GetPixelFormatRedBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatRedBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the red component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the red component, or -1 if not present.
◆ GetPixelFormatGreenBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatGreenBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the green component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the green component, or -1 if not present.
◆ GetPixelFormatBlueBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatBlueBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the blue component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the blue component, or -1 if not present.
◆ GetPixelFormatAlphaBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatAlphaBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the alpha component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the alpha component, or -1 if not present.
◆ GetPixelFormatDepthBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatDepthBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the depth component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the depth component, or -1 if not present.
◆ GetPixelFormatStencilBitOffset()
| SInt32 Murl::IEnums::GetPixelFormatStencilBitOffset | ( | PixelFormat | pixelFormat | ) |
Query the bit offset of the stencil component for a given pixel format.
- Parameters
-
pixelFormat The pixel format to check.
- Returns
- The bit offset of the stencil component, or -1 if not present.
◆ GetPixelFormatByteSize()
| UInt32 Murl::IEnums::GetPixelFormatByteSize | ( | PixelFormat | pixelFormat | ) |
Query the number of bytes per pixel for a given pixel format.
In case of a compressed format, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The number of bytes per pixel.
◆ GetPixelFormatComponentByteSize()
| UInt32 Murl::IEnums::GetPixelFormatComponentByteSize | ( | PixelFormat | pixelFormat | ) |
Query the size in bytes of a single color component for a given pixel format.
In case of a compressed format, or a format that does not store components that are multiples of a single byte (such as PIXEL_FORMAT_R5_G6_B5), this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The number of bytes per component.
◆ GetPixelFormatNumberOfComponents()
| UInt32 Murl::IEnums::GetPixelFormatNumberOfComponents | ( | PixelFormat | pixelFormat | ) |
Query the number of color components per pixel for a given pixel format.
In case of a compressed format, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The number of components per pixel.
◆ GetPixelFormatBytesPerLine()
| UInt32 Murl::IEnums::GetPixelFormatBytesPerLine | ( | PixelFormat | pixelFormat, |
| UInt32 | sizeX | ||
| ) |
Query the required number of bytes in a single line for a given width and pixel format.
This function returns the minimum required line pitch, without any extra padding. In case of a compressed format, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query. sizeX The width in pixels.
- Returns
- The number of bytes per line.
◆ GetPixelFormatBytesPerSurface()
| UInt32 Murl::IEnums::GetPixelFormatBytesPerSurface | ( | PixelFormat | pixelFormat, |
| UInt32 | sizeX, | ||
| UInt32 | sizeY | ||
| ) |
Query the required number of surface data bytes for a given width, height and pixel format.
This function returns the minimum required surface data size, without any extra padding.
- Parameters
-
pixelFormat The pixel format to query. sizeX The width in pixels. sizeY The height in pixels.
- Returns
- The number of data bytes needed for a surface.
◆ GetPixelFormatMinNumberOfBlocksX()
| UInt32 Murl::IEnums::GetPixelFormatMinNumberOfBlocksX | ( | PixelFormat | pixelFormat | ) |
Query the minimum number of required horizontal blocks for a compressed pixel format.
For uncompressed formats, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The minimum number of horizontal blocks required, or 0 for an uncompressed format.
◆ GetPixelFormatMinNumberOfBlocksY()
| UInt32 Murl::IEnums::GetPixelFormatMinNumberOfBlocksY | ( | PixelFormat | pixelFormat | ) |
Query the minimum number of required vertical blocks for a compressed pixel format.
For uncompressed formats, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The minimum number of vertical blocks required, or 0 for an uncompressed format.
◆ GetPixelFormatCompressedBlockSizeX()
| UInt32 Murl::IEnums::GetPixelFormatCompressedBlockSizeX | ( | PixelFormat | pixelFormat | ) |
Query the horizontal block size in pixels for a compressed pixel format.
For uncompressed formats, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The horizontal block size in pixels, or 0 for an uncompressed format.
◆ GetPixelFormatCompressedBlockSizeY()
| UInt32 Murl::IEnums::GetPixelFormatCompressedBlockSizeY | ( | PixelFormat | pixelFormat | ) |
Query the vertical block size in pixels for a compressed pixel format.
For uncompressed formats, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The vertical block size in pixels, or 0 for an uncompressed format.
◆ GetPixelFormatCompressedBytesPerBlock()
| UInt32 Murl::IEnums::GetPixelFormatCompressedBytesPerBlock | ( | PixelFormat | pixelFormat | ) |
Query the block size in bytes for a compressed pixel format.
For uncompressed formats, this function returns 0.
- Parameters
-
pixelFormat The pixel format to query.
- Returns
- The block size in bytes, or 0 for an uncompressed format.
◆ GetColorBufferFormatFromPixelFormat()
| ColorBufferFormat Murl::IEnums::GetColorBufferFormatFromPixelFormat | ( | PixelFormat | pixelFormat | ) |
Select a color buffer format compatible to a given image pixel format.
- Parameters
-
pixelFormat The image pixel format.
- Returns
- A compatible color buffer format or IEnums::COLOR_BUFFER_FORMAT_UNDEFINED if there is no matching color buffer format.
◆ GetPixelFormatFromColorBufferFormat()
| PixelFormat Murl::IEnums::GetPixelFormatFromColorBufferFormat | ( | ColorBufferFormat | colorBufferFormat | ) |
Select an image pixel format compatible to a given color buffer format.
- Parameters
-
colorBufferFormat The color buffer format.
- Returns
- A compatible image pixel format or IEnums::PIXEL_FORMAT_UNDEFINED if there is no matching image pixel format.
◆ GetDepthBufferFormatFromPixelFormat()
| DepthBufferFormat Murl::IEnums::GetDepthBufferFormatFromPixelFormat | ( | PixelFormat | pixelFormat | ) |
Select a depth buffer format compatible to a given image pixel format.
- Parameters
-
pixelFormat The image pixel format.
- Returns
- A compatible depth buffer format or IEnums::DEPTH_BUFFER_FORMAT_UNDEFINED if there is no matching depth buffer format.
◆ GetPixelFormatFromDepthBufferFormat()
| PixelFormat Murl::IEnums::GetPixelFormatFromDepthBufferFormat | ( | DepthBufferFormat | depthBufferFormat | ) |
Select an image pixel format compatible to a given depth buffer format.
- Parameters
-
depthBufferFormat The depth buffer format.
- Returns
- A compatible image pixel format or IEnums::PIXEL_FORMAT_UNDEFINED if there is no matching image pixel format.
◆ GetStencilBufferFormatFromPixelFormat()
| StencilBufferFormat Murl::IEnums::GetStencilBufferFormatFromPixelFormat | ( | PixelFormat | pixelFormat | ) |
Select a stencil buffer format compatible to a given image pixel format.
- Parameters
-
pixelFormat The image pixel format.
- Returns
- A compatible stencil buffer format or IEnums::STENCIL_BUFFER_FORMAT_UNDEFINED if there is no matching stencil buffer format.
◆ GetPixelFormatFromStencilBufferFormat()
| PixelFormat Murl::IEnums::GetPixelFormatFromStencilBufferFormat | ( | StencilBufferFormat | stencilBufferFormat | ) |
Select an image pixel format compatible to a given stencil buffer format.
- Parameters
-
stencilBufferFormat The stencil buffer format.
- Returns
- A compatible image pixel format or IEnums::PIXEL_FORMAT_UNDEFINED if there is no matching image pixel format.
◆ GetIndexBufferItemName()
| const Char* Murl::IEnums::GetIndexBufferItemName | ( | IndexBufferItem | indexBufferItem | ) |
Query the name of a index buffer item.
- Parameters
-
indexBufferItem The index buffer item to query.
- Returns
- The human-readable index buffer item name.
◆ GetIndexBufferItemAlternativeName()
| const Char* Murl::IEnums::GetIndexBufferItemAlternativeName | ( | IndexBufferItem | indexBufferItem | ) |
Query the alternative name of a index buffer item.
- Parameters
-
indexBufferItem The index buffer item to query.
- Returns
- The human-readable alternative index buffer item name.
◆ GetIndexTypeByteSize()
Query the number of bytes per element for a given index type.
- Parameters
-
indexType The index data type to query.
- Returns
- The number of bytes per element.
◆ GetVertexBufferItemName()
| const Char* Murl::IEnums::GetVertexBufferItemName | ( | VertexBufferItem | vertexBufferItem | ) |
Query the name of a vertex buffer item.
- Parameters
-
vertexBufferItem The vertex buffer item to query.
- Returns
- The human-readable vertex buffer item name.
◆ GetVertexBufferItemAlternativeName()
| const Char* Murl::IEnums::GetVertexBufferItemAlternativeName | ( | VertexBufferItem | vertexBufferItem | ) |
Query the alternative name of a vertex buffer item.
- Parameters
-
vertexBufferItem The vertex buffer item to query.
- Returns
- The human-readable alternative vertex buffer item name.
◆ GetAttributeTypeByteSize()
| UInt32 Murl::IEnums::GetAttributeTypeByteSize | ( | AttributeType | attributeType | ) |
Query the total number of bytes per item for a given attribute type.
This returns the total number of bytes per item, e.g. for a 3-component vector of unsigned 16 bit integer values (IEnums::ATTRIBUTE_TYPE_UINT16_VECTOR_3) the returned number of bytes will be 3 * 2 = 6.
- Parameters
-
attributeType The attribute data type to query.
- Returns
- The number of bytes per item.
◆ GetAttributeTypeComponentByteSize()
| UInt32 Murl::IEnums::GetAttributeTypeComponentByteSize | ( | AttributeType | attributeType | ) |
Query the number of bytes per item component for a given attribute type.
This returns the number of bytes of a single component, e.g. 4 for all float-based types (scalars and vectors of any size), 2 for UINT16-based types etc.
- Parameters
-
attributeType The attribute data type to query.
- Returns
- The number of bytes per item component.
◆ GetAttributeTypeNumberOfComponents()
| UInt32 Murl::IEnums::GetAttributeTypeNumberOfComponents | ( | AttributeType | attributeType | ) |
Query the number of item components for a given attribute type.
This always returns 1 for scalar types, 2 for 2-component vectors etc.
- Parameters
-
attributeType The attribute data type to query.
- Returns
- The number of components.
◆ GetAttributeTypeSign()
| Bool Murl::IEnums::GetAttributeTypeSign | ( | AttributeType | attributeType | ) |
Query the number of item for being signed or unsigned.
- Parameters
-
attributeType The attribute data type to query.
- Returns
- true if attribute type is signed false if unsigned
◆ GetAttributeItem()
| AttributeItem Murl::IEnums::GetAttributeItem | ( | const Char * | name | ) |
Query the predefined attribute item from a shader variable name.
- Parameters
-
name The human-readable variable name to query.
- Returns
- The attribute item, or ATTRIBUTE_ITEM_CUSTOM if not found.
◆ GetAttributeItemDataType()
| AttributeType Murl::IEnums::GetAttributeItemDataType | ( | AttributeItem | attributeItem | ) |
Query the shader variable data type for an attribute item.
- Parameters
-
attributeItem The attribute item to query.
- Returns
- The attribute variable data type.
◆ GetAttributeItemDefaultPrecision()
| ShaderVariablePrecision Murl::IEnums::GetAttributeItemDefaultPrecision | ( | AttributeItem | attributeItem | ) |
Query the default variable precision for an attribute item.
- Parameters
-
attributeItem The attribute item to query.
- Returns
- The variable precision.
◆ GetAttributeItemVertexBufferItem()
| VertexBufferItem Murl::IEnums::GetAttributeItemVertexBufferItem | ( | AttributeItem | attributeItem | ) |
Query an attribute item's predefined vertex buffer item.
- Parameters
-
attributeItem The attribute item to query.
- Returns
- The attribute variable vertex buffer item.
◆ GetAttributeItemName()
| const Char* Murl::IEnums::GetAttributeItemName | ( | AttributeItem | attributeItem | ) |
Query the shader variable name for an attribute item.
- Parameters
-
attributeItem The attribute item to query.
- Returns
- The human-readable attribute variable name.
◆ GetAttributeItemAlternativeName()
| const Char* Murl::IEnums::GetAttributeItemAlternativeName | ( | AttributeItem | attributeItem | ) |
Query the alternative shader variable name for an attribute item.
- Parameters
-
attributeItem The attribute item to query.
- Returns
- The human-readable alternative attribute variable name.
◆ GetConstantTypeNumberOfComponents()
| UInt32 Murl::IEnums::GetConstantTypeNumberOfComponents | ( | ConstantType | constantType | ) |
Query the number of item components for a given constant type.
This always returns 1 for scalar types, 2 for 2-component vectors etc.
- Parameters
-
constantType The constant data type to query.
- Returns
- The number of components.
◆ GetConstantBufferItem()
| ConstantBufferItem Murl::IEnums::GetConstantBufferItem | ( | const Char * | name | ) |
Query the predefined constant buffer item from a shader variable name.
- Parameters
-
name The human-readable variable name to query.
- Returns
- The constant buffer item, or CONSTANT_BUFFER_ITEM_CUSTOM if not found.
◆ GetConstantBufferItemName()
| const Char* Murl::IEnums::GetConstantBufferItemName | ( | ConstantBufferItem | constantBufferItem | ) |
Query the name of a constant buffer item.
- Parameters
-
constantBufferItem The constant buffer item to query.
- Returns
- The human-readable constant buffer item name.
◆ GetConstantBufferItemAlternativeName()
| const Char* Murl::IEnums::GetConstantBufferItemAlternativeName | ( | ConstantBufferItem | constantBufferItem | ) |
Query the alternative name of a constant buffer item.
- Parameters
-
constantBufferItem The constant buffer item to query.
- Returns
- The human-readable alternative constant buffer item name.
◆ GetUniformTypeByteSize()
| UInt32 Murl::IEnums::GetUniformTypeByteSize | ( | UniformType | uniformType | ) |
Query the total number of bytes per item for a given uniform type.
This returns the total number of bytes per item, e.g. for a 3-component vector of signed 32 bit integer values (IEnums::UNIFORM_TYPE_SINT32_VECTOR_3) the returned number of bytes will be 3 * 4 = 12.
- Parameters
-
uniformType The uniform data type to query.
- Returns
- The number of bytes per item.
◆ GetUniformTypeComponentByteSize()
| UInt32 Murl::IEnums::GetUniformTypeComponentByteSize | ( | UniformType | uniformType | ) |
Query the number of bytes per item component for a given uniform type.
This returns the number of bytes of a single component, e.g. 4 for all float-based types (scalars and vectors of any size) etc.
- Parameters
-
uniformType The uniform data type to query.
- Returns
- The number of bytes per item component.
◆ GetUniformTypeNumberOfComponents()
| UInt32 Murl::IEnums::GetUniformTypeNumberOfComponents | ( | UniformType | uniformType | ) |
Query the number of item components for a given uniform type.
This always returns 1 for scalar types, 2 for 2-component vectors etc.
- Parameters
-
uniformType The uniform data type to query.
- Returns
- The number of components.
◆ GetUniformItem()
| UniformItem Murl::IEnums::GetUniformItem | ( | const Char * | name | ) |
Query the predefined uniform item from a shader variable name.
- Parameters
-
name The human-readable variable name to query.
- Returns
- The constant buffer item, or UNIFORM_ITEM_CUSTOM if not found.
◆ GetUniformItemDataType()
| UniformType Murl::IEnums::GetUniformItemDataType | ( | UniformItem | uniformItem | ) |
Query the shader variable data type for a uniform item.
- Parameters
-
uniformItem The uniform item to query.
- Returns
- The uniform variable data type.
◆ GetUniformItemDefaultPrecision()
| ShaderVariablePrecision Murl::IEnums::GetUniformItemDefaultPrecision | ( | UniformItem | uniformItem | ) |
Query the default variable precision for a uniform item.
- Parameters
-
uniformItem The uniform item to query.
- Returns
- The variable precision.
◆ GetUniformItemConstantBufferItem()
| ConstantBufferItem Murl::IEnums::GetUniformItemConstantBufferItem | ( | UniformItem | uniformItem | ) |
Query a uniform item's predefined constant buffer item.
- Parameters
-
uniformItem The uniform item to query.
- Returns
- The uniform variable constant buffer item.
◆ GetUniformItemName()
| const Char* Murl::IEnums::GetUniformItemName | ( | UniformItem | uniformItem | ) |
Query the shader variable name for a uniform item.
- Parameters
-
uniformItem The uniform item to query.
- Returns
- The human-readable uniform variable name.
◆ GetUniformItemAlternativeName()
| const Char* Murl::IEnums::GetUniformItemAlternativeName | ( | UniformItem | uniformItem | ) |
Query the alternative shader variable name for a uniform item.
- Parameters
-
uniformItem The uniform item to query.
- Returns
- The human-readable alternative uniform variable name.
◆ GetConstantBufferItemNumberOfUniformItems()
| UInt32 Murl::IEnums::GetConstantBufferItemNumberOfUniformItems | ( | ConstantBufferItem | constantBufferItem | ) |
Query the number of uniform items for a predefined constant buffer.
- Parameters
-
constantBufferItem The predefined constant buffer item to query.
- Returns
- The number of uniforms.
◆ GetConstantBufferItemUniformItem()
| IEnums::UniformItem Murl::IEnums::GetConstantBufferItemUniformItem | ( | ConstantBufferItem | constantBufferItem, |
| UInt32 | index | ||
| ) |
Query the predefined uniform item for a predefined constant buffer at a given index.
- Parameters
-
constantBufferItem The predefined constant buffer item to query. index The uniform index, from 0 to GetConstantBufferItemNumberOfUniformItems()-1.
- Returns
- The predefined uniform item.
◆ GetConstantBufferItemUniformItemArraySize()
| UInt32 Murl::IEnums::GetConstantBufferItemUniformItemArraySize | ( | ConstantBufferItem | constantBufferItem, |
| UInt32 | index | ||
| ) |
Query the array size of a predefined uniform item for a predefined constant buffer at a given index.
- Parameters
-
constantBufferItem The predefined constant buffer item to query. index The uniform index, from 0 to GetConstantBufferItemNumberOfUniformItems()-1.
- Returns
- The array size, or 0 if scalar.
◆ GetVaryingTypeByteSize()
| UInt32 Murl::IEnums::GetVaryingTypeByteSize | ( | VaryingType | varyingType | ) |
Query the total number of bytes per item for a given varying type.
This returns the total number of bytes per item, e.g. for a 3-component vector of 32 bit float values (IEnums::VARYING_TYPE_FLOAT_VECTOR_3) the returned number of bytes will be 3 * 4 = 12.
- Parameters
-
varyingType The varying data type to query.
- Returns
- The number of bytes per item.
◆ GetVaryingTypeComponentByteSize()
| UInt32 Murl::IEnums::GetVaryingTypeComponentByteSize | ( | VaryingType | varyingType | ) |
Query the number of bytes per item component for a given varying type.
This returns the number of bytes of a single component, e.g. 4 for all float-based types (scalars and vectors of any size) etc.
- Parameters
-
varyingType The varying data type to query.
- Returns
- The number of bytes per item component.
◆ GetVaryingTypeNumberOfComponents()
| UInt32 Murl::IEnums::GetVaryingTypeNumberOfComponents | ( | VaryingType | varyingType | ) |
Query the number of item components for a given varying type.
This always returns 1 for scalar types, 2 for 2-component vectors etc.
- Parameters
-
varyingType The varying data type to query.
- Returns
- The number of components.