OGRE  2.3
Object-Oriented Graphics Rendering Engine
Image

Classes

class  Ogre::ASTCCodec
 Codec specialized in loading ASTC (ARM Adaptive Scalable Texture Compression) images. More...
 
class  Ogre::DDSCodec
 Codec specialized in loading DDS (Direct Draw Surface) images. More...
 
class  Ogre::DDSCodec2
 Codec specialized in loading DDS (Direct Draw Surface) images. More...
 
class  Ogre::ETCCodec
 Codec specialized in loading ETC (Ericsson Texture Compression) images. More...
 
struct  Ogre::FilterKernel
 
struct  Ogre::FilterSeparableKernel
 
class  Ogre::FreeImageCodec
 Codec specialized in images loaded using FreeImage. More...
 
class  Ogre::FreeImageCodec2
 Codec specialized in images loaded using FreeImage. More...
 
class  Ogre::Image
 Class representing an image file. More...
 
class  Ogre::Image2
 Class representing an image file. More...
 
class  Ogre::ImageCodec
 Codec specialized in images. More...
 
class  Ogre::ImageCodec2
 Codec specialized in images. More...
 
struct  Ogre::LinearResampler
 
struct  Ogre::LinearResampler_Byte< channels >
 
struct  Ogre::LinearResampler_Float32
 
struct  Ogre::NearestResampler< elemsize >
 
class  Ogre::OITDCodec
 Codec specialized in loading OITD (Ogre Internal Texture Dump) format. More...
 
class  Ogre::PixelBox
 
class  Ogre::PixelFormatGpuUtils
 The pixel format used for images, textures, and render surfaces. More...
 
class  Ogre::PixelFormatToShaderType
 
class  Ogre::PixelUtil
 Some utility functions for packing and unpacking pixel data. More...
 
class  Ogre::PVRTCCodec
 Codec specialized in loading PVRTC (PowerVR) images. More...
 
class  Ogre::STBIImageCodec
 Codec specialized in images loaded using stbi (https://github.com/nothings/stb). More...
 

Typedefs

typedef vector< const Image * >::type Ogre::ConstImagePtrList
 
typedef void() Ogre::ImageBlur2D(uint8 *_tmpPtr, uint8 *_srcDstPtr, int32 width, int32 height, int32 bytesPerRow, const uint8 kernel[5], const int8 kernelStart, const int8 kernelEnd)
 Range is [kernelStart; kernelEnd]. More...
 
typedef void() Ogre::ImageDownsampler2D(uint8 *dstPtr, uint8 const *srcPtr, int32 dstWidth, int32 dstHeight, int32 dstBytesPerRow, int32 srcWidth, int32 srcBytesPerRow, const uint8 kernel[5][5], const int8 kernelStartX, const int8 kernelEndX, const int8 kernelStartY, const int8 kernelEndY)
 Range is [kernelStart; kernelEnd]. More...
 
typedef void() Ogre::ImageDownsampler3D(uint8 *dstPtr, uint8 const *srcPtr, int32 dstWidth, int32 dstHeight, int32 dstDepth, int32 dstBytesPerRow, int32 dstBytesPerImage, int32 srcWidth, int32 srcHeight, int32 srcBytesPerRow, int32 srcBytesPerImage)
 Bilinear 3D downsampler. More...
 
typedef void() Ogre::ImageDownsamplerCube(uint8 *dstPtr, uint8 const **srcPtr, int32 dstWidth, int32 dstHeight, int32 dstBytesPerRow, int32 srcWidth, int32 srcHeight, int32 srcBytesPerRow, const uint8 kernel[5][5], const int8 kernelStartX, const int8 kernelEndX, const int8 kernelStartY, const int8 kernelEndY, uint8 currentFace)
 
typedef vector< Image * >::type Ogre::ImagePtrList
 
typedef vector< PixelFormat >::type Ogre::PixelFormatList
 

Enumerations

enum  Ogre::ImageFlags { Ogre::IF_COMPRESSED = 0x00000001 , Ogre::IF_CUBEMAP = 0x00000002 , Ogre::IF_3D_TEXTURE = 0x00000004 }
 
enum  Ogre::PixelComponentType {
  Ogre::PCT_BYTE = 0 , Ogre::PCT_SHORT = 1 , Ogre::PCT_FLOAT16 = 2 , Ogre::PCT_FLOAT32 = 3 ,
  Ogre::PCT_SINT = 4 , Ogre::PCT_UINT = 5 , Ogre::PCT_COUNT = 6
}
 Pixel component format. More...
 
enum  Ogre::PixelFormat {
  Ogre::PF_UNKNOWN = 0 , Ogre::PF_L8 = 1 , Ogre::PF_BYTE_L = PF_L8 , Ogre::PF_L16 = 2 ,
  Ogre::PF_SHORT_L = PF_L16 , Ogre::PF_A8 = 3 , Ogre::PF_BYTE_A = PF_A8 , Ogre::PF_A4L4 = 4 ,
  Ogre::PF_BYTE_LA = 5 , Ogre::PF_R5G6B5 = 6 , Ogre::PF_B5G6R5 = 7 , Ogre::PF_R3G3B2 = 31 ,
  Ogre::PF_A4R4G4B4 = 8 , Ogre::PF_A1R5G5B5 = 9 , Ogre::PF_R8G8B8 = 10 , Ogre::PF_B8G8R8 = 11 ,
  Ogre::PF_A8R8G8B8 = 12 , Ogre::PF_A8B8G8R8 = 13 , Ogre::PF_B8G8R8A8 = 14 , Ogre::PF_R8G8B8A8 = 28 ,
  Ogre::PF_X8R8G8B8 = 26 , Ogre::PF_X8B8G8R8 = 27 , Ogre::PF_BYTE_RGB = PF_R8G8B8 , Ogre::PF_BYTE_BGR = PF_B8G8R8 ,
  Ogre::PF_BYTE_BGRA = PF_B8G8R8A8 , Ogre::PF_BYTE_RGBA = PF_R8G8B8A8 , Ogre::PF_A2R10G10B10 = 15 , Ogre::PF_A2B10G10R10 = 16 ,
  Ogre::PF_DXT1 = 17 , Ogre::PF_DXT2 = 18 , Ogre::PF_DXT3 = 19 , Ogre::PF_DXT4 = 20 ,
  Ogre::PF_DXT5 = 21 , Ogre::PF_FLOAT16_R = 32 , Ogre::PF_FLOAT16_RGB = 22 , Ogre::PF_FLOAT16_RGBA = 23 ,
  Ogre::PF_FLOAT32_R = 33 , Ogre::PF_FLOAT32_RGB = 24 , Ogre::PF_FLOAT32_RGBA = 25 , Ogre::PF_FLOAT16_GR = 35 ,
  Ogre::PF_FLOAT32_GR = 36 , Ogre::PF_DEPTH_DEPRECATED = 29 , Ogre::PF_SHORT_RGBA = 30 , Ogre::PF_SHORT_GR = 34 ,
  Ogre::PF_SHORT_RGB = 37 , Ogre::PF_PVRTC_RGB2 = 38 , Ogre::PF_PVRTC_RGBA2 = 39 , Ogre::PF_PVRTC_RGB4 = 40 ,
  Ogre::PF_PVRTC_RGBA4 = 41 , Ogre::PF_PVRTC2_2BPP = 42 , Ogre::PF_PVRTC2_4BPP = 43 , Ogre::PF_R11G11B10_FLOAT = 44 ,
  Ogre::PF_R8_UINT = 45 , Ogre::PF_R8G8_UINT = 46 , Ogre::PF_R8G8B8_UINT = 47 , Ogre::PF_R8G8B8A8_UINT = 48 ,
  Ogre::PF_R16_UINT = 49 , Ogre::PF_R16G16_UINT = 50 , Ogre::PF_R16G16B16_UINT = 51 , Ogre::PF_R16G16B16A16_UINT = 52 ,
  Ogre::PF_R32_UINT = 53 , Ogre::PF_R32G32_UINT = 54 , Ogre::PF_R32G32B32_UINT = 55 , Ogre::PF_R32G32B32A32_UINT = 56 ,
  Ogre::PF_R8_SINT = 57 , Ogre::PF_R8G8_SINT = 58 , Ogre::PF_R8G8B8_SINT = 59 , Ogre::PF_R8G8B8A8_SINT = 60 ,
  Ogre::PF_R16_SINT = 61 , Ogre::PF_R16G16_SINT = 62 , Ogre::PF_R16G16B16_SINT = 63 , Ogre::PF_R16G16B16A16_SINT = 64 ,
  Ogre::PF_R32_SINT = 65 , Ogre::PF_R32G32_SINT = 66 , Ogre::PF_R32G32B32_SINT = 67 , Ogre::PF_R32G32B32A32_SINT = 68 ,
  Ogre::PF_R9G9B9E5_SHAREDEXP = 69 , Ogre::PF_BC4_UNORM = 70 , Ogre::PF_BC4_SNORM = 71 , Ogre::PF_BC5_UNORM = 72 ,
  Ogre::PF_BC5_SNORM = 73 , Ogre::PF_BC6H_UF16 = 74 , Ogre::PF_BC6H_SF16 = 75 , Ogre::PF_BC7_UNORM = 76 ,
  Ogre::PF_BC7_UNORM_SRGB = 77 , Ogre::PF_R8 = 78 , Ogre::PF_RG8 = 79 , Ogre::PF_R8_SNORM = 80 ,
  Ogre::PF_R8G8_SNORM = 81 , Ogre::PF_R8G8B8_SNORM = 82 , Ogre::PF_R8G8B8A8_SNORM = 83 , Ogre::PF_R16_SNORM = 84 ,
  Ogre::PF_R16G16_SNORM = 85 , Ogre::PF_R16G16B16_SNORM = 86 , Ogre::PF_R16G16B16A16_SNORM = 87 , Ogre::PF_ETC1_RGB8 = 88 ,
  Ogre::PF_ETC2_RGB8 = 89 , Ogre::PF_ETC2_RGBA8 = 90 , Ogre::PF_ETC2_RGB8A1 = 91 , Ogre::PF_ATC_RGB = 92 ,
  Ogre::PF_ATC_RGBA_EXPLICIT_ALPHA = 93 , Ogre::PF_ATC_RGBA_INTERPOLATED_ALPHA = 94 , Ogre::PF_ASTC_RGBA_4X4_LDR = 95 , Ogre::PF_ASTC_RGBA_5X4_LDR = 96 ,
  Ogre::PF_ASTC_RGBA_5X5_LDR = 97 , Ogre::PF_ASTC_RGBA_6X5_LDR = 98 , Ogre::PF_ASTC_RGBA_6X6_LDR = 99 , Ogre::PF_ASTC_RGBA_8X5_LDR = 100 ,
  Ogre::PF_ASTC_RGBA_8X6_LDR = 101 , Ogre::PF_ASTC_RGBA_8X8_LDR = 102 , Ogre::PF_ASTC_RGBA_10X5_LDR = 103 , Ogre::PF_ASTC_RGBA_10X6_LDR = 104 ,
  Ogre::PF_ASTC_RGBA_10X8_LDR = 105 , Ogre::PF_ASTC_RGBA_10X10_LDR = 106 , Ogre::PF_ASTC_RGBA_12X10_LDR = 107 , Ogre::PF_ASTC_RGBA_12X12_LDR = 108 ,
  Ogre::PF_ASTC_SRGB8A8_4X4_LDR = 109 , Ogre::PF_ASTC_SRGB8A8_5X4_LDR = 110 , Ogre::PF_ASTC_SRGB8A8_5X5_LDR = 111 , Ogre::PF_ASTC_SRGB8A8_6X5_LDR = 112 ,
  Ogre::PF_ASTC_SRGB8A8_6X6_LDR = 113 , Ogre::PF_ASTC_SRGB8A8_8X5_LDR = 114 , Ogre::PF_ASTC_SRGB8A8_8X6_LDR = 115 , Ogre::PF_ASTC_SRGB8A8_8X8_LDR = 116 ,
  Ogre::PF_ASTC_SRGB8A8_10X5_LDR = 117 , Ogre::PF_ASTC_SRGB8A8_10X6_LDR = 118 , Ogre::PF_ASTC_SRGB8A8_10X8_LDR = 119 , Ogre::PF_ASTC_SRGB8A8_10X10_LDR = 120 ,
  Ogre::PF_ASTC_SRGB8A8_12X10_LDR = 121 , Ogre::PF_ASTC_SRGB8A8_12X12_LDR = 122 , Ogre::PF_D24_UNORM_S8_UINT = 123 , Ogre::PF_D24_UNORM_X8 = 124 ,
  Ogre::PF_X24_S8_UINT = 125 , Ogre::PF_D24_UNORM = 126 , Ogre::PF_D16_UNORM = 127 , Ogre::PF_D32_FLOAT = 128 ,
  Ogre::PF_D32_FLOAT_X24_S8_UINT = 129 , Ogre::PF_D32_FLOAT_X24_X8 = 130 , Ogre::PF_X32_X24_S8_UINT = 131 , Ogre::PF_NULL = 132 ,
  Ogre::PF_COUNT = 133
}
 The pixel format used for images, textures, and render surfaces. More...
 
enum  Ogre::PixelFormatFlags {
  Ogre::PFF_HASALPHA = 0x00000001 , Ogre::PFF_COMPRESSED = 0x00000002 , Ogre::PFF_FLOAT = 0x00000004 , Ogre::PFF_DEPTH = 0x00000008 ,
  Ogre::PFF_NATIVEENDIAN = 0x00000010 , Ogre::PFF_LUMINANCE = 0x00000020 , Ogre::PFF_INTEGER = 0x00000040 , Ogre::PFF_SIGNED = 0x00000080
}
 Flags defining some on/off properties of pixel formats. More...
 
enum  Ogre::PixelFormatGpu {
  Ogre::PFG_UNKNOWN , Ogre::PFG_NULL , Ogre::PFG_RGBA32_FLOAT , Ogre::PFG_RGBA32_UINT ,
  Ogre::PFG_RGBA32_SINT , Ogre::PFG_RGB32_FLOAT , Ogre::PFG_RGB32_UINT , Ogre::PFG_RGB32_SINT ,
  Ogre::PFG_RGBA16_FLOAT , Ogre::PFG_RGBA16_UNORM , Ogre::PFG_RGBA16_UINT , Ogre::PFG_RGBA16_SNORM ,
  Ogre::PFG_RGBA16_SINT , Ogre::PFG_RG32_FLOAT , Ogre::PFG_RG32_UINT , Ogre::PFG_RG32_SINT ,
  Ogre::PFG_D32_FLOAT_S8X24_UINT , Ogre::PFG_R10G10B10A2_UNORM , Ogre::PFG_R10G10B10A2_UINT , Ogre::PFG_R11G11B10_FLOAT ,
  Ogre::PFG_RGBA8_UNORM , Ogre::PFG_RGBA8_UNORM_SRGB , Ogre::PFG_RGBA8_UINT , Ogre::PFG_RGBA8_SNORM ,
  Ogre::PFG_RGBA8_SINT , Ogre::PFG_RG16_FLOAT , Ogre::PFG_RG16_UNORM , Ogre::PFG_RG16_UINT ,
  Ogre::PFG_RG16_SNORM , Ogre::PFG_RG16_SINT , Ogre::PFG_D32_FLOAT , Ogre::PFG_R32_FLOAT ,
  Ogre::PFG_R32_UINT , Ogre::PFG_R32_SINT , Ogre::PFG_D24_UNORM , Ogre::PFG_D24_UNORM_S8_UINT ,
  Ogre::PFG_RG8_UNORM , Ogre::PFG_RG8_UINT , Ogre::PFG_RG8_SNORM , Ogre::PFG_RG8_SINT ,
  Ogre::PFG_R16_FLOAT , Ogre::PFG_D16_UNORM , Ogre::PFG_R16_UNORM , Ogre::PFG_R16_UINT ,
  Ogre::PFG_R16_SNORM , Ogre::PFG_R16_SINT , Ogre::PFG_R8_UNORM , Ogre::PFG_R8_UINT ,
  Ogre::PFG_R8_SNORM , Ogre::PFG_R8_SINT , Ogre::PFG_A8_UNORM , Ogre::PFG_R1_UNORM ,
  Ogre::PFG_R9G9B9E5_SHAREDEXP , Ogre::PFG_R8G8_B8G8_UNORM , Ogre::PFG_G8R8_G8B8_UNORM , Ogre::PFG_BC1_UNORM ,
  Ogre::PFG_BC1_UNORM_SRGB , Ogre::PFG_BC2_UNORM , Ogre::PFG_BC2_UNORM_SRGB , Ogre::PFG_BC3_UNORM ,
  Ogre::PFG_BC3_UNORM_SRGB , Ogre::PFG_BC4_UNORM , Ogre::PFG_BC4_SNORM , Ogre::PFG_BC5_UNORM ,
  Ogre::PFG_BC5_SNORM , Ogre::PFG_B5G6R5_UNORM , Ogre::PFG_B5G5R5A1_UNORM , Ogre::PFG_BGRA8_UNORM ,
  Ogre::PFG_BGRX8_UNORM , Ogre::PFG_R10G10B10_XR_BIAS_A2_UNORM , Ogre::PFG_BGRA8_UNORM_SRGB , Ogre::PFG_BGRX8_UNORM_SRGB ,
  Ogre::PFG_BC6H_UF16 , Ogre::PFG_BC6H_SF16 , Ogre::PFG_BC7_UNORM , Ogre::PFG_BC7_UNORM_SRGB ,
  Ogre::PFG_AYUV , Ogre::PFG_Y410 , Ogre::PFG_Y416 , Ogre::PFG_NV12 ,
  Ogre::PFG_P010 , Ogre::PFG_P016 , Ogre::PFG_420_OPAQUE , Ogre::PFG_YUY2 ,
  Ogre::PFG_Y210 , Ogre::PFG_Y216 , Ogre::PFG_NV11 , Ogre::PFG_AI44 ,
  Ogre::PFG_IA44 , Ogre::PFG_P8 , Ogre::PFG_A8P8 , Ogre::PFG_B4G4R4A4_UNORM ,
  Ogre::PFG_P208 , Ogre::PFG_V208 , Ogre::PFG_V408 , Ogre::PFG_RGB8_UNORM ,
  Ogre::PFG_RGB8_UNORM_SRGB , Ogre::PFG_BGR8_UNORM , Ogre::PFG_BGR8_UNORM_SRGB , Ogre::PFG_RGB16_UNORM ,
  Ogre::PFG_PVRTC_RGB2 , Ogre::PFG_PVRTC_RGB2_SRGB , Ogre::PFG_PVRTC_RGBA2 , Ogre::PFG_PVRTC_RGBA2_SRGB ,
  Ogre::PFG_PVRTC_RGB4 , Ogre::PFG_PVRTC_RGB4_SRGB , Ogre::PFG_PVRTC_RGBA4 , Ogre::PFG_PVRTC_RGBA4_SRGB ,
  Ogre::PFG_PVRTC2_2BPP , Ogre::PFG_PVRTC2_2BPP_SRGB , Ogre::PFG_PVRTC2_4BPP , Ogre::PFG_PVRTC2_4BPP_SRGB ,
  Ogre::PFG_ETC1_RGB8_UNORM , Ogre::PFG_ETC2_RGB8_UNORM , Ogre::PFG_ETC2_RGB8_UNORM_SRGB , Ogre::PFG_ETC2_RGBA8_UNORM ,
  Ogre::PFG_ETC2_RGBA8_UNORM_SRGB , Ogre::PFG_ETC2_RGB8A1_UNORM , Ogre::PFG_ETC2_RGB8A1_UNORM_SRGB , Ogre::PFG_EAC_R11_UNORM ,
  Ogre::PFG_EAC_R11_SNORM , Ogre::PFG_EAC_R11G11_UNORM , Ogre::PFG_EAC_R11G11_SNORM , Ogre::PFG_ATC_RGB ,
  Ogre::PFG_ATC_RGBA_EXPLICIT_ALPHA , Ogre::PFG_ATC_RGBA_INTERPOLATED_ALPHA , Ogre::PFG_ASTC_RGBA_UNORM_4X4_LDR , Ogre::PFG_ASTC_RGBA_UNORM_5X4_LDR ,
  Ogre::PFG_ASTC_RGBA_UNORM_5X5_LDR , Ogre::PFG_ASTC_RGBA_UNORM_6X5_LDR , Ogre::PFG_ASTC_RGBA_UNORM_6X6_LDR , Ogre::PFG_ASTC_RGBA_UNORM_8X5_LDR ,
  Ogre::PFG_ASTC_RGBA_UNORM_8X6_LDR , Ogre::PFG_ASTC_RGBA_UNORM_8X8_LDR , Ogre::PFG_ASTC_RGBA_UNORM_10X5_LDR , Ogre::PFG_ASTC_RGBA_UNORM_10X6_LDR ,
  Ogre::PFG_ASTC_RGBA_UNORM_10X8_LDR , Ogre::PFG_ASTC_RGBA_UNORM_10X10_LDR , Ogre::PFG_ASTC_RGBA_UNORM_12X10_LDR , Ogre::PFG_ASTC_RGBA_UNORM_12X12_LDR ,
  Ogre::PFG_ASTC_RGBA_UNORM_4X4_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_5X4_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_5X5_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_6X5_sRGB ,
  Ogre::PFG_ASTC_RGBA_UNORM_6X6_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_8X5_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_8X6_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_8X8_sRGB ,
  Ogre::PFG_ASTC_RGBA_UNORM_10X5_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_10X6_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_10X8_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_10X10_sRGB ,
  Ogre::PFG_ASTC_RGBA_UNORM_12X10_sRGB , Ogre::PFG_ASTC_RGBA_UNORM_12X12_sRGB , Ogre::PFG_COUNT
}
 The pixel format used for images, textures, and render surfaces. More...
 

Variables

const FilterKernel Ogre::c_filterKernels [3]
 
const FilterSeparableKernel Ogre::c_filterSeparableKernels [1]
 
ImageDownsampler2D Ogre::downscale2x_A8
 
ImageDownsamplerCube Ogre::downscale2x_A8_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_A
 
ImageDownsamplerCube Ogre::downscale2x_Float32_A_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_X
 
ImageDownsamplerCube Ogre::downscale2x_Float32_X_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_XA
 
ImageDownsamplerCube Ogre::downscale2x_Float32_XA_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_XX
 
ImageDownsamplerCube Ogre::downscale2x_Float32_XX_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_XXX
 
ImageDownsamplerCube Ogre::downscale2x_Float32_XXX_cube
 
ImageDownsampler2D Ogre::downscale2x_Float32_XXXA
 
ImageDownsamplerCube Ogre::downscale2x_Float32_XXXA_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_A8
 
ImageDownsamplerCube Ogre::downscale2x_Signed_A8_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_X8
 
ImageDownsamplerCube Ogre::downscale2x_Signed_X8_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_XA88
 
ImageDownsamplerCube Ogre::downscale2x_Signed_XA88_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_XX88
 
ImageDownsamplerCube Ogre::downscale2x_Signed_XX88_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_XXX888
 
ImageDownsamplerCube Ogre::downscale2x_Signed_XXX888_cube
 
ImageDownsampler2D Ogre::downscale2x_Signed_XXXA8888
 
ImageDownsamplerCube Ogre::downscale2x_Signed_XXXA8888_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_A8
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_A8_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_AX88
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_AX88_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_AXXX8888
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_AXXX8888_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_X8
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_X8_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_XA88
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_XA88_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_XX88
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_XX88_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_XXX888
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_XXX888_cube
 
ImageDownsampler2D Ogre::downscale2x_sRGB_XXXA8888
 
ImageDownsamplerCube Ogre::downscale2x_sRGB_XXXA8888_cube
 
ImageDownsampler2D Ogre::downscale2x_X8
 
ImageDownsamplerCube Ogre::downscale2x_X8_cube
 
ImageDownsampler2D Ogre::downscale2x_XA88
 
ImageDownsamplerCube Ogre::downscale2x_XA88_cube
 
ImageDownsampler2D Ogre::downscale2x_XX88
 
ImageDownsamplerCube Ogre::downscale2x_XX88_cube
 
ImageDownsampler2D Ogre::downscale2x_XXX888
 
ImageDownsamplerCube Ogre::downscale2x_XXX888_cube
 
ImageDownsampler2D Ogre::downscale2x_XXXA8888
 
ImageDownsamplerCube Ogre::downscale2x_XXXA8888_cube
 
ImageDownsampler3D Ogre::downscale3D2x_A8
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_A
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_X
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_XA
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_XX
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_XXX
 
ImageDownsampler3D Ogre::downscale3D2x_Float32_XXXA
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_A8
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_X8
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_XA88
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_XX88
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_XXX888
 
ImageDownsampler3D Ogre::downscale3D2x_Signed_XXXA8888
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_A8
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_AX88
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_AXXX8888
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_X8
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_XA88
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_XX88
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_XXX888
 
ImageDownsampler3D Ogre::downscale3D2x_sRGB_XXXA8888
 
ImageDownsampler3D Ogre::downscale3D2x_X8
 
ImageDownsampler3D Ogre::downscale3D2x_XA88
 
ImageDownsampler3D Ogre::downscale3D2x_XX88
 
ImageDownsampler3D Ogre::downscale3D2x_XXX888
 
ImageDownsampler3D Ogre::downscale3D2x_XXXA8888
 
ImageBlur2D Ogre::separableBlur_A8
 
ImageBlur2D Ogre::separableBlur_Float32_A
 
ImageBlur2D Ogre::separableBlur_Float32_X
 
ImageBlur2D Ogre::separableBlur_Float32_XA
 
ImageBlur2D Ogre::separableBlur_Float32_XX
 
ImageBlur2D Ogre::separableBlur_Float32_XXX
 
ImageBlur2D Ogre::separableBlur_Float32_XXXA
 
ImageBlur2D Ogre::separableBlur_Signed_A8
 
ImageBlur2D Ogre::separableBlur_Signed_X8
 
ImageBlur2D Ogre::separableBlur_Signed_XA88
 
ImageBlur2D Ogre::separableBlur_Signed_XX88
 
ImageBlur2D Ogre::separableBlur_Signed_XXX888
 
ImageBlur2D Ogre::separableBlur_Signed_XXXA8888
 
ImageBlur2D Ogre::separableBlur_sRGB_A8
 
ImageBlur2D Ogre::separableBlur_sRGB_AX88
 
ImageBlur2D Ogre::separableBlur_sRGB_AXXX8888
 
ImageBlur2D Ogre::separableBlur_sRGB_X8
 
ImageBlur2D Ogre::separableBlur_sRGB_XA88
 
ImageBlur2D Ogre::separableBlur_sRGB_XX88
 
ImageBlur2D Ogre::separableBlur_sRGB_XXX888
 
ImageBlur2D Ogre::separableBlur_sRGB_XXXA8888
 
ImageBlur2D Ogre::separableBlur_X8
 
ImageBlur2D Ogre::separableBlur_XA88
 
ImageBlur2D Ogre::separableBlur_XX88
 
ImageBlur2D Ogre::separableBlur_XXX888
 
ImageBlur2D Ogre::separableBlur_XXXA8888
 

Detailed Description

Typedef Documentation

◆ ConstImagePtrList

typedef vector<const Image*>::type Ogre::ConstImagePtrList

◆ ImageBlur2D

typedef void() Ogre::ImageBlur2D(uint8 *_tmpPtr, uint8 *_srcDstPtr, int32 width, int32 height, int32 bytesPerRow, const uint8 kernel[5], const int8 kernelStart, const int8 kernelEnd)

Range is [kernelStart; kernelEnd].

Parameters
_tmpPtrTemporary buffer. Must be able to hold a copy of _srcDstPtr
_srcDstPtrInput image to blur, output image blurred
width
height
kernel
kernelStart
kernelEnd

◆ ImageDownsampler2D

typedef void() Ogre::ImageDownsampler2D(uint8 *dstPtr, uint8 const *srcPtr, int32 dstWidth, int32 dstHeight, int32 dstBytesPerRow, int32 srcWidth, int32 srcBytesPerRow, const uint8 kernel[5][5], const int8 kernelStartX, const int8 kernelEndX, const int8 kernelStartY, const int8 kernelEndY)

Range is [kernelStart; kernelEnd].

Parameters
dstPtr
srcPtr
width
height
kernel
kernelStartX
kernelEndX
kernelStartY
kernelEndY

◆ ImageDownsampler3D

typedef void() Ogre::ImageDownsampler3D(uint8 *dstPtr, uint8 const *srcPtr, int32 dstWidth, int32 dstHeight, int32 dstDepth, int32 dstBytesPerRow, int32 dstBytesPerImage, int32 srcWidth, int32 srcHeight, int32 srcBytesPerRow, int32 srcBytesPerImage)

Bilinear 3D downsampler.

◆ ImageDownsamplerCube

typedef void() Ogre::ImageDownsamplerCube(uint8 *dstPtr, uint8 const **srcPtr, int32 dstWidth, int32 dstHeight, int32 dstBytesPerRow, int32 srcWidth, int32 srcHeight, int32 srcBytesPerRow, const uint8 kernel[5][5], const int8 kernelStartX, const int8 kernelEndX, const int8 kernelStartY, const int8 kernelEndY, uint8 currentFace)

◆ ImagePtrList

typedef vector<Image*>::type Ogre::ImagePtrList

◆ PixelFormatList

typedef vector<PixelFormat>::type Ogre::PixelFormatList

Enumeration Type Documentation

◆ ImageFlags

Enumerator
IF_COMPRESSED 
IF_CUBEMAP 
IF_3D_TEXTURE 

◆ PixelComponentType

Pixel component format.

Enumerator
PCT_BYTE 
PCT_SHORT 

Byte per component (8 bit fixed 0.0..1.0)

PCT_FLOAT16 

Short per component (16 bit fixed 0.0..1.0))

PCT_FLOAT32 

16 bit float per component

PCT_SINT 

32 bit float per component

PCT_UINT 

Signed integer per component.

PCT_COUNT 

Unsigned integer per component.

◆ PixelFormat

The pixel format used for images, textures, and render surfaces.

Enumerator
PF_UNKNOWN 

Unknown pixel format.

PF_L8 

8-bit pixel format, all bits luminance.

PF_BYTE_L 
PF_L16 

16-bit pixel format, all bits luminance.

PF_SHORT_L 
PF_A8 

8-bit pixel format, all bits alpha.

PF_BYTE_A 
PF_A4L4 

8-bit pixel format, 4 bits alpha, 4 bits luminance.

PF_BYTE_LA 

2 byte pixel format, 1 byte luminance, 1 byte alpha

PF_R5G6B5 

16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.

PF_B5G6R5 

16-bit pixel format, 5 bits red, 6 bits green, 5 bits blue.

PF_R3G3B2 

8-bit pixel format, 2 bits blue, 3 bits green, 3 bits red.

PF_A4R4G4B4 

16-bit pixel format, 4 bits for alpha, red, green and blue.

PF_A1R5G5B5 

16-bit pixel format, 5 bits for blue, green, red and 1 for alpha.

PF_R8G8B8 

24-bit pixel format, 8 bits for red, green and blue.

PF_B8G8R8 

24-bit pixel format, 8 bits for blue, green and red.

PF_A8R8G8B8 

32-bit pixel format, 8 bits for alpha, red, green and blue.

PF_A8B8G8R8 

32-bit pixel format, 8 bits for blue, green, red and alpha.

PF_B8G8R8A8 

32-bit pixel format, 8 bits for blue, green, red and alpha.

PF_R8G8B8A8 

32-bit pixel format, 8 bits for red, green, blue and alpha.

PF_X8R8G8B8 

32-bit pixel format, 8 bits for red, 8 bits for green, 8 bits for blue like PF_A8R8G8B8, but alpha will get discarded

PF_X8B8G8R8 

32-bit pixel format, 8 bits for blue, 8 bits for green, 8 bits for red like PF_A8B8G8R8, but alpha will get discarded

PF_BYTE_RGB 

3 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue

PF_BYTE_BGR 

3 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red

PF_BYTE_BGRA 

4 byte pixel format, 1 byte for blue, 1 byte for green, 1 byte for red and one byte for alpha

PF_BYTE_RGBA 

4 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue, and one byte for alpha

PF_A2R10G10B10 

32-bit pixel format, 2 bits for alpha, 10 bits for red, green and blue.

PF_A2B10G10R10 

32-bit pixel format, 10 bits for blue, green and red, 2 bits for alpha.

PF_DXT1 

DDS (DirectDraw Surface) DXT1 format.

PF_DXT2 

DDS (DirectDraw Surface) DXT2 format.

PF_DXT3 

DDS (DirectDraw Surface) DXT3 format.

PF_DXT4 

DDS (DirectDraw Surface) DXT4 format.

PF_DXT5 

DDS (DirectDraw Surface) DXT5 format.

PF_FLOAT16_R 

16-bit pixel format, 16 bits (float) for red

PF_FLOAT16_RGB 

48-bit pixel format, 16 bits (float) for red, 16 bits (float) for green, 16 bits (float) for blue

PF_FLOAT16_RGBA 

64-bit pixel format, 16 bits (float) for red, 16 bits (float) for green, 16 bits (float) for blue, 16 bits (float) for alpha

PF_FLOAT32_R 
PF_FLOAT32_RGB 

96-bit pixel format, 32 bits (float) for red, 32 bits (float) for green, 32 bits (float) for blue

PF_FLOAT32_RGBA 

128-bit pixel format, 32 bits (float) for red, 32 bits (float) for green, 32 bits (float) for blue, 32 bits (float) for alpha

PF_FLOAT16_GR 

32-bit, 2-channel s10e5 floating point pixel format, 16-bit green, 16-bit red

PF_FLOAT32_GR 

64-bit, 2-channel floating point pixel format, 32-bit green, 32-bit red

PF_DEPTH_DEPRECATED 

Depth texture format.

PF_SHORT_RGBA 

64-bit pixel format, 16 bits for red, green, blue and alpha

PF_SHORT_GR 

32-bit pixel format, 16-bit green, 16-bit red

PF_SHORT_RGB 

48-bit pixel format, 16 bits for red, green and blue

PF_PVRTC_RGB2 

PVRTC (PowerVR) RGB 2 bpp.

PF_PVRTC_RGBA2 

PVRTC (PowerVR) RGBA 2 bpp.

PF_PVRTC_RGB4 

PVRTC (PowerVR) RGB 4 bpp.

PF_PVRTC_RGBA4 

PVRTC (PowerVR) RGBA 4 bpp.

PF_PVRTC2_2BPP 

PVRTC (PowerVR) Version 2, 2 bpp.

PF_PVRTC2_4BPP 

PVRTC (PowerVR) Version 2, 4 bpp.

PF_R11G11B10_FLOAT 

32-bit pixel format, 11 bits (float) for red, 11 bits (float) for green, 10 bits (float) for blue

PF_R8_UINT 

8-bit pixel format, 8 bits red (unsigned int).

PF_R8G8_UINT 

16-bit pixel format, 8 bits red (unsigned int), 8 bits blue (unsigned int).

PF_R8G8B8_UINT 

24-bit pixel format, 8 bits red (unsigned int), 8 bits blue (unsigned int), 8 bits green (unsigned int).

PF_R8G8B8A8_UINT 

32-bit pixel format, 8 bits red (unsigned int), 8 bits blue (unsigned int), 8 bits green (unsigned int), 8 bits alpha (unsigned int).

PF_R16_UINT 

16-bit pixel format, 16 bits red (unsigned int).

PF_R16G16_UINT 

32-bit pixel format, 16 bits red (unsigned int), 16 bits blue (unsigned int).

PF_R16G16B16_UINT 

48-bit pixel format, 16 bits red (unsigned int), 16 bits blue (unsigned int), 16 bits green (unsigned int).

PF_R16G16B16A16_UINT 

64-bit pixel format, 16 bits red (unsigned int), 16 bits blue (unsigned int), 16 bits green (unsigned int), 16 bits alpha (unsigned int).

PF_R32_UINT 

32-bit pixel format, 32 bits red (unsigned int).

PF_R32G32_UINT 

64-bit pixel format, 32 bits red (unsigned int), 32 bits blue (unsigned int).

PF_R32G32B32_UINT 

96-bit pixel format, 32 bits red (unsigned int), 32 bits blue (unsigned int), 32 bits green (unsigned int).

PF_R32G32B32A32_UINT 

128-bit pixel format, 32 bits red (unsigned int), 32 bits blue (unsigned int), 32 bits green (unsigned int), 32 bits alpha (unsigned int).

PF_R8_SINT 

8-bit pixel format, 8 bits red (signed int).

PF_R8G8_SINT 

16-bit pixel format, 8 bits red (signed int), 8 bits blue (signed int).

PF_R8G8B8_SINT 

24-bit pixel format, 8 bits red (signed int), 8 bits blue (signed int), 8 bits green (signed int).

PF_R8G8B8A8_SINT 

32-bit pixel format, 8 bits red (signed int), 8 bits blue (signed int), 8 bits green (signed int), 8 bits alpha (signed int).

PF_R16_SINT 

16-bit pixel format, 16 bits red (signed int).

PF_R16G16_SINT 

32-bit pixel format, 16 bits red (signed int), 16 bits blue (signed int).

PF_R16G16B16_SINT 

48-bit pixel format, 16 bits red (signed int), 16 bits blue (signed int), 16 bits green (signed int).

PF_R16G16B16A16_SINT 

64-bit pixel format, 16 bits red (signed int), 16 bits blue (signed int), 16 bits green (signed int), 16 bits alpha (signed int).

PF_R32_SINT 

32-bit pixel format, 32 bits red (signed int).

PF_R32G32_SINT 

64-bit pixel format, 32 bits red (signed int), 32 bits blue (signed int).

PF_R32G32B32_SINT 

96-bit pixel format, 32 bits red (signed int), 32 bits blue (signed int), 32 bits green (signed int).

PF_R32G32B32A32_SINT 

128-bit pixel format, 32 bits red (signed int), 32 bits blue (signed int), 32 bits green (signed int), 32 bits alpha (signed int).

PF_R9G9B9E5_SHAREDEXP 

32-bit pixel format, 9 bits for blue, green, red plus a 5 bit exponent.

PF_BC4_UNORM 

DDS (DirectDraw Surface) BC4 format (unsigned normalised)

PF_BC4_SNORM 

DDS (DirectDraw Surface) BC4 format (signed normalised)

PF_BC5_UNORM 

DDS (DirectDraw Surface) BC5 format (unsigned normalised)

PF_BC5_SNORM 

DDS (DirectDraw Surface) BC5 format (signed normalised)

PF_BC6H_UF16 

DDS (DirectDraw Surface) BC6H format (unsigned 16 bit float)

PF_BC6H_SF16 

DDS (DirectDraw Surface) BC6H format (signed 16 bit float)

PF_BC7_UNORM 

DDS (DirectDraw Surface) BC7 format (unsigned normalised)

PF_BC7_UNORM_SRGB 

DDS (DirectDraw Surface) BC7 format (unsigned normalised sRGB)

PF_R8 

8-bit pixel format, all bits red.

PF_RG8 

16-bit pixel format, 8 bits red, 8 bits green.

PF_R8_SNORM 

8-bit pixel format, 8 bits red (signed normalised int).

PF_R8G8_SNORM 

16-bit pixel format, 8 bits red (signed normalised int), 8 bits blue (signed normalised int).

PF_R8G8B8_SNORM 

24-bit pixel format, 8 bits red (signed normalised int), 8 bits blue (signed normalised int), 8 bits green (signed normalised int).

PF_R8G8B8A8_SNORM 

32-bit pixel format, 8 bits red (signed normalised int), 8 bits blue (signed normalised int), 8 bits green (signed normalised int), 8 bits alpha (signed normalised int).

PF_R16_SNORM 

16-bit pixel format, 16 bits red (signed normalised int).

PF_R16G16_SNORM 

32-bit pixel format, 16 bits red (signed normalised int), 16 bits blue (signed normalised int).

PF_R16G16B16_SNORM 

48-bit pixel format, 16 bits red (signed normalised int), 16 bits blue (signed normalised int), 16 bits green (signed normalised int).

PF_R16G16B16A16_SNORM 

64-bit pixel format, 16 bits red (signed normalised int), 16 bits blue (signed normalised int), 16 bits green (signed normalised int), 16 bits alpha (signed normalised int).

PF_ETC1_RGB8 

ETC1 (Ericsson Texture Compression)

PF_ETC2_RGB8 

ETC2 (Ericsson Texture Compression)

PF_ETC2_RGBA8 

ETC2 (Ericsson Texture Compression)

PF_ETC2_RGB8A1 

ETC2 (Ericsson Texture Compression)

PF_ATC_RGB 

ATC (AMD_compressed_ATC_texture)

PF_ATC_RGBA_EXPLICIT_ALPHA 

ATC (AMD_compressed_ATC_texture)

PF_ATC_RGBA_INTERPOLATED_ALPHA 

ATC (AMD_compressed_ATC_texture)

PF_ASTC_RGBA_4X4_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 4x4)

PF_ASTC_RGBA_5X4_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 5x4)

PF_ASTC_RGBA_5X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 5x5)

PF_ASTC_RGBA_6X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 6x5)

PF_ASTC_RGBA_6X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 6x6)

PF_ASTC_RGBA_8X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 8x5)

PF_ASTC_RGBA_8X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 8x6)

PF_ASTC_RGBA_8X8_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 8x8)

PF_ASTC_RGBA_10X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 10x5)

PF_ASTC_RGBA_10X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 10x6)

PF_ASTC_RGBA_10X8_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 10x8)

PF_ASTC_RGBA_10X10_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 10x10)

PF_ASTC_RGBA_12X10_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 12x10)

PF_ASTC_RGBA_12X12_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 12x12)

PF_ASTC_SRGB8A8_4X4_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 4x4)

PF_ASTC_SRGB8A8_5X4_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 5x4)

PF_ASTC_SRGB8A8_5X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 5x5)

PF_ASTC_SRGB8A8_6X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 6x5)

PF_ASTC_SRGB8A8_6X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 6x6)

PF_ASTC_SRGB8A8_8X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 8x5)

PF_ASTC_SRGB8A8_8X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 8x6)

PF_ASTC_SRGB8A8_8X8_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 8x8)

PF_ASTC_SRGB8A8_10X5_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 10x5)

PF_ASTC_SRGB8A8_10X6_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 10x6)

PF_ASTC_SRGB8A8_10X8_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 10x8)

PF_ASTC_SRGB8A8_10X10_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 10x10)

PF_ASTC_SRGB8A8_12X10_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 12x10)

PF_ASTC_SRGB8A8_12X12_LDR 

ASTC (ARM Adaptive Scalable Texture Compression 8 bits each sRGB 8 bits alpha, block size 12x12)

PF_D24_UNORM_S8_UINT 

Depth texture format.

24 bits for depth, 8 bits for stencil. The following formats are just reinterpretations of the same depth buffer: 24-bit normalized uint depth and 8-bit stencil

  • PF_D24_UNORM_S8_UINT
  • PF_D24_UNORM_X8
  • PF_X24_S8_UINT 24-bit normalized uint depth
  • PF_D24_UNORM 16-bit normalized uint depth
  • PF_D16_UNORM 32-bit floating point depth
  • PF_D32_FLOAT 32-bit floating point depth & 8-bit stencil (+24 unused bits)
  • PF_D32_FLOAT_X24_S8_UINT
  • PF_D32_FLOAT_X24_X8
  • PF_X32_X24_S8_UINT

This means that e.g. a PF_D24_UNORM_X8 and a PF_D24_UNORM_S8_UINT may or may not internally point to the same depth buffer. Use depth buffer pools if you want a guarantee that they use different buffers. Last but not least, not all GPUs support all these formats.

PF_D24_UNORM_X8 

Depth texture format. 24 bits for depth.

PF_X24_S8_UINT 

Depth texture format. 8 bits for stencil.

PF_D24_UNORM 

Depth texture format 24 bits for depth.

PF_D16_UNORM 

Depth texture format. 16 bits for depth.

PF_D32_FLOAT 

Depth texture format. 32 bits for depth.

PF_D32_FLOAT_X24_S8_UINT 

Depth texture format. 32 bits for depth. 8 bits for stencil.

PF_D32_FLOAT_X24_X8 

Depth texture format. 32 bits for depth.

PF_X32_X24_S8_UINT 

Depth texture format. 8 bits for stencil.

PF_NULL 

Dummy, used for UAV-only rendering.

D3D11 calls it Target-independent rasterization / UAVOnlyRenderingForcedSampleCount OpenGL is under GL_ARB_framebuffer_no_attachments

PF_COUNT 

◆ PixelFormatFlags

Flags defining some on/off properties of pixel formats.

Enumerator
PFF_HASALPHA 

This format has an alpha channel.

PFF_COMPRESSED 

This format is compressed.

This invalidates the values in elemBytes, elemBits and the bit counts as these might not be fixed in a compressed format.

PFF_FLOAT 

This is a floating point format.

PFF_DEPTH 

This is a depth format (for depth textures)

PFF_NATIVEENDIAN 

Format is in native endian.

Generally true for the 16, 24 and 32 bits formats which can be represented as machine integers.

PFF_LUMINANCE 

This is an intensity format instead of a RGB one.

The luminance replaces R,G and B. (but not A)

PFF_INTEGER 

This is an integer format.

PFF_SIGNED 

This integer format is signed.

◆ PixelFormatGpu

The pixel format used for images, textures, and render surfaces.

Enumerator
PFG_UNKNOWN 
PFG_NULL 
PFG_RGBA32_FLOAT 
PFG_RGBA32_UINT 
PFG_RGBA32_SINT 
PFG_RGB32_FLOAT 
PFG_RGB32_UINT 
PFG_RGB32_SINT 
PFG_RGBA16_FLOAT 
PFG_RGBA16_UNORM 
PFG_RGBA16_UINT 
PFG_RGBA16_SNORM 
PFG_RGBA16_SINT 
PFG_RG32_FLOAT 
PFG_RG32_UINT 
PFG_RG32_SINT 
PFG_D32_FLOAT_S8X24_UINT 
PFG_R10G10B10A2_UNORM 
PFG_R10G10B10A2_UINT 
PFG_R11G11B10_FLOAT 
PFG_RGBA8_UNORM 
PFG_RGBA8_UNORM_SRGB 
PFG_RGBA8_UINT 
PFG_RGBA8_SNORM 
PFG_RGBA8_SINT 
PFG_RG16_FLOAT 
PFG_RG16_UNORM 
PFG_RG16_UINT 
PFG_RG16_SNORM 
PFG_RG16_SINT 
PFG_D32_FLOAT 
PFG_R32_FLOAT 
PFG_R32_UINT 
PFG_R32_SINT 
PFG_D24_UNORM 
PFG_D24_UNORM_S8_UINT 
PFG_RG8_UNORM 
PFG_RG8_UINT 
PFG_RG8_SNORM 
PFG_RG8_SINT 
PFG_R16_FLOAT 
PFG_D16_UNORM 
PFG_R16_UNORM 
PFG_R16_UINT 
PFG_R16_SNORM 
PFG_R16_SINT 
PFG_R8_UNORM 
PFG_R8_UINT 
PFG_R8_SNORM 
PFG_R8_SINT 
PFG_A8_UNORM 
PFG_R1_UNORM 
PFG_R9G9B9E5_SHAREDEXP 
PFG_R8G8_B8G8_UNORM 

D3D11 only.

A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the UYVY format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel.

PFG_G8R8_G8B8_UNORM 

D3D11 only. See PFG_R8G8_B8G8_UNORM.

PFG_BC1_UNORM 

BC1, aka DXT1 & DXT2.

PFG_BC1_UNORM_SRGB 
PFG_BC2_UNORM 

BC2, aka DXT3 & DXT4.

PFG_BC2_UNORM_SRGB 
PFG_BC3_UNORM 

BC3, aka DXT5.

PFG_BC3_UNORM_SRGB 
PFG_BC4_UNORM 

One channel compressed 4bpp. Ideal for greyscale.

PFG_BC4_SNORM 

Two channels compressed 8bpp. Ideal for normal maps or greyscale + alpha.

PFG_BC5_UNORM 
PFG_BC5_SNORM 
PFG_B5G6R5_UNORM 
PFG_B5G5R5A1_UNORM 
PFG_BGRA8_UNORM 

Avoid this one (prefer RGBA8).

PFG_BGRX8_UNORM 

Avoid this one (prefer RGBA8).

PFG_R10G10B10_XR_BIAS_A2_UNORM 
PFG_BGRA8_UNORM_SRGB 

Avoid this one (prefer RGBA8).

PFG_BGRX8_UNORM_SRGB 

Avoid this one (prefer RGBA8).

PFG_BC6H_UF16 

BC6H format (unsigned 16 bit float)

PFG_BC6H_SF16 

BC6H format (signed 16 bit float)

PFG_BC7_UNORM 
PFG_BC7_UNORM_SRGB 
PFG_AYUV 
PFG_Y410 
PFG_Y416 
PFG_NV12 
PFG_P010 
PFG_P016 
PFG_420_OPAQUE 
PFG_YUY2 
PFG_Y210 
PFG_Y216 
PFG_NV11 
PFG_AI44 
PFG_IA44 
PFG_P8 
PFG_A8P8 
PFG_B4G4R4A4_UNORM 
PFG_P208 
PFG_V208 
PFG_V408 
PFG_RGB8_UNORM 

24bpp storage formats, CPU only.

PFG_RGB8_UNORM_SRGB 
PFG_BGR8_UNORM 
PFG_BGR8_UNORM_SRGB 
PFG_RGB16_UNORM 

48bpp storage formats, CPU only.

PFG_PVRTC_RGB2 

PVRTC (PowerVR) RGB 2 bpp.

PFG_PVRTC_RGB2_SRGB 
PFG_PVRTC_RGBA2 

PVRTC (PowerVR) RGBA 2 bpp.

PFG_PVRTC_RGBA2_SRGB 
PFG_PVRTC_RGB4 

PVRTC (PowerVR) RGB 4 bpp.

PFG_PVRTC_RGB4_SRGB 
PFG_PVRTC_RGBA4 

PVRTC (PowerVR) RGBA 4 bpp.

PFG_PVRTC_RGBA4_SRGB 
PFG_PVRTC2_2BPP 

PVRTC (PowerVR) Version 2, 2 bpp.

PFG_PVRTC2_2BPP_SRGB 
PFG_PVRTC2_4BPP 

PVRTC (PowerVR) Version 2, 4 bpp.

PFG_PVRTC2_4BPP_SRGB 
PFG_ETC1_RGB8_UNORM 

ETC1 (Ericsson Texture Compression)

PFG_ETC2_RGB8_UNORM 

ETC2 (Ericsson Texture Compression). Mandatory in GLES 3.0.

PFG_ETC2_RGB8_UNORM_SRGB 
PFG_ETC2_RGBA8_UNORM 
PFG_ETC2_RGBA8_UNORM_SRGB 
PFG_ETC2_RGB8A1_UNORM 
PFG_ETC2_RGB8A1_UNORM_SRGB 
PFG_EAC_R11_UNORM 

EAC compression (built on top of ETC2) Mandatory in GLES 3.0 for 1 channel & 2 channels.

PFG_EAC_R11_SNORM 
PFG_EAC_R11G11_UNORM 
PFG_EAC_R11G11_SNORM 
PFG_ATC_RGB 

ATC (AMD_compressed_ATC_texture)

PFG_ATC_RGBA_EXPLICIT_ALPHA 

ATC (AMD_compressed_ATC_texture)

PFG_ATC_RGBA_INTERPOLATED_ALPHA 

ATC (AMD_compressed_ATC_texture)

PFG_ASTC_RGBA_UNORM_4X4_LDR 

ASTC (ARM Adaptive Scalable Texture Compression RGBA, block size 4x4)

PFG_ASTC_RGBA_UNORM_5X4_LDR 
PFG_ASTC_RGBA_UNORM_5X5_LDR 
PFG_ASTC_RGBA_UNORM_6X5_LDR 
PFG_ASTC_RGBA_UNORM_6X6_LDR 
PFG_ASTC_RGBA_UNORM_8X5_LDR 
PFG_ASTC_RGBA_UNORM_8X6_LDR 
PFG_ASTC_RGBA_UNORM_8X8_LDR 
PFG_ASTC_RGBA_UNORM_10X5_LDR 
PFG_ASTC_RGBA_UNORM_10X6_LDR 
PFG_ASTC_RGBA_UNORM_10X8_LDR 
PFG_ASTC_RGBA_UNORM_10X10_LDR 
PFG_ASTC_RGBA_UNORM_12X10_LDR 
PFG_ASTC_RGBA_UNORM_12X12_LDR 
PFG_ASTC_RGBA_UNORM_4X4_sRGB 

ASTC (ARM Adaptive Scalable Texture Compression RGBA_UNORM sRGB, block size 4x4)

PFG_ASTC_RGBA_UNORM_5X4_sRGB 
PFG_ASTC_RGBA_UNORM_5X5_sRGB 
PFG_ASTC_RGBA_UNORM_6X5_sRGB 
PFG_ASTC_RGBA_UNORM_6X6_sRGB 
PFG_ASTC_RGBA_UNORM_8X5_sRGB 
PFG_ASTC_RGBA_UNORM_8X6_sRGB 
PFG_ASTC_RGBA_UNORM_8X8_sRGB 
PFG_ASTC_RGBA_UNORM_10X5_sRGB 
PFG_ASTC_RGBA_UNORM_10X6_sRGB 
PFG_ASTC_RGBA_UNORM_10X8_sRGB 
PFG_ASTC_RGBA_UNORM_10X10_sRGB 
PFG_ASTC_RGBA_UNORM_12X10_sRGB 
PFG_ASTC_RGBA_UNORM_12X12_sRGB 
PFG_COUNT 

Variable Documentation

◆ c_filterKernels

const FilterKernel Ogre::c_filterKernels[3]
extern

◆ c_filterSeparableKernels

const FilterSeparableKernel Ogre::c_filterSeparableKernels[1]
extern

◆ downscale2x_A8

ImageDownsampler2D Ogre::downscale2x_A8

◆ downscale2x_A8_cube

ImageDownsamplerCube Ogre::downscale2x_A8_cube

◆ downscale2x_Float32_A

ImageDownsampler2D Ogre::downscale2x_Float32_A

◆ downscale2x_Float32_A_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_A_cube

◆ downscale2x_Float32_X

ImageDownsampler2D Ogre::downscale2x_Float32_X

◆ downscale2x_Float32_X_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_X_cube

◆ downscale2x_Float32_XA

ImageDownsampler2D Ogre::downscale2x_Float32_XA

◆ downscale2x_Float32_XA_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_XA_cube

◆ downscale2x_Float32_XX

ImageDownsampler2D Ogre::downscale2x_Float32_XX

◆ downscale2x_Float32_XX_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_XX_cube

◆ downscale2x_Float32_XXX

ImageDownsampler2D Ogre::downscale2x_Float32_XXX

◆ downscale2x_Float32_XXX_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_XXX_cube

◆ downscale2x_Float32_XXXA

ImageDownsampler2D Ogre::downscale2x_Float32_XXXA

◆ downscale2x_Float32_XXXA_cube

ImageDownsamplerCube Ogre::downscale2x_Float32_XXXA_cube

◆ downscale2x_Signed_A8

ImageDownsampler2D Ogre::downscale2x_Signed_A8

◆ downscale2x_Signed_A8_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_A8_cube

◆ downscale2x_Signed_X8

ImageDownsampler2D Ogre::downscale2x_Signed_X8

◆ downscale2x_Signed_X8_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_X8_cube

◆ downscale2x_Signed_XA88

ImageDownsampler2D Ogre::downscale2x_Signed_XA88

◆ downscale2x_Signed_XA88_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_XA88_cube

◆ downscale2x_Signed_XX88

ImageDownsampler2D Ogre::downscale2x_Signed_XX88

◆ downscale2x_Signed_XX88_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_XX88_cube

◆ downscale2x_Signed_XXX888

ImageDownsampler2D Ogre::downscale2x_Signed_XXX888

◆ downscale2x_Signed_XXX888_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_XXX888_cube

◆ downscale2x_Signed_XXXA8888

ImageDownsampler2D Ogre::downscale2x_Signed_XXXA8888

◆ downscale2x_Signed_XXXA8888_cube

ImageDownsamplerCube Ogre::downscale2x_Signed_XXXA8888_cube

◆ downscale2x_sRGB_A8

ImageDownsampler2D Ogre::downscale2x_sRGB_A8

◆ downscale2x_sRGB_A8_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_A8_cube

◆ downscale2x_sRGB_AX88

ImageDownsampler2D Ogre::downscale2x_sRGB_AX88

◆ downscale2x_sRGB_AX88_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_AX88_cube

◆ downscale2x_sRGB_AXXX8888

ImageDownsampler2D Ogre::downscale2x_sRGB_AXXX8888

◆ downscale2x_sRGB_AXXX8888_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_AXXX8888_cube

◆ downscale2x_sRGB_X8

ImageDownsampler2D Ogre::downscale2x_sRGB_X8

◆ downscale2x_sRGB_X8_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_X8_cube

◆ downscale2x_sRGB_XA88

ImageDownsampler2D Ogre::downscale2x_sRGB_XA88

◆ downscale2x_sRGB_XA88_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_XA88_cube

◆ downscale2x_sRGB_XX88

ImageDownsampler2D Ogre::downscale2x_sRGB_XX88

◆ downscale2x_sRGB_XX88_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_XX88_cube

◆ downscale2x_sRGB_XXX888

ImageDownsampler2D Ogre::downscale2x_sRGB_XXX888

◆ downscale2x_sRGB_XXX888_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_XXX888_cube

◆ downscale2x_sRGB_XXXA8888

ImageDownsampler2D Ogre::downscale2x_sRGB_XXXA8888

◆ downscale2x_sRGB_XXXA8888_cube

ImageDownsamplerCube Ogre::downscale2x_sRGB_XXXA8888_cube

◆ downscale2x_X8

ImageDownsampler2D Ogre::downscale2x_X8

◆ downscale2x_X8_cube

ImageDownsamplerCube Ogre::downscale2x_X8_cube

◆ downscale2x_XA88

ImageDownsampler2D Ogre::downscale2x_XA88

◆ downscale2x_XA88_cube

ImageDownsamplerCube Ogre::downscale2x_XA88_cube

◆ downscale2x_XX88

ImageDownsampler2D Ogre::downscale2x_XX88

◆ downscale2x_XX88_cube

ImageDownsamplerCube Ogre::downscale2x_XX88_cube

◆ downscale2x_XXX888

ImageDownsampler2D Ogre::downscale2x_XXX888

◆ downscale2x_XXX888_cube

ImageDownsamplerCube Ogre::downscale2x_XXX888_cube

◆ downscale2x_XXXA8888

ImageDownsampler2D Ogre::downscale2x_XXXA8888

◆ downscale2x_XXXA8888_cube

ImageDownsamplerCube Ogre::downscale2x_XXXA8888_cube

◆ downscale3D2x_A8

ImageDownsampler3D Ogre::downscale3D2x_A8

◆ downscale3D2x_Float32_A

ImageDownsampler3D Ogre::downscale3D2x_Float32_A

◆ downscale3D2x_Float32_X

ImageDownsampler3D Ogre::downscale3D2x_Float32_X

◆ downscale3D2x_Float32_XA

ImageDownsampler3D Ogre::downscale3D2x_Float32_XA

◆ downscale3D2x_Float32_XX

ImageDownsampler3D Ogre::downscale3D2x_Float32_XX

◆ downscale3D2x_Float32_XXX

ImageDownsampler3D Ogre::downscale3D2x_Float32_XXX

◆ downscale3D2x_Float32_XXXA

ImageDownsampler3D Ogre::downscale3D2x_Float32_XXXA

◆ downscale3D2x_Signed_A8

ImageDownsampler3D Ogre::downscale3D2x_Signed_A8

◆ downscale3D2x_Signed_X8

ImageDownsampler3D Ogre::downscale3D2x_Signed_X8

◆ downscale3D2x_Signed_XA88

ImageDownsampler3D Ogre::downscale3D2x_Signed_XA88

◆ downscale3D2x_Signed_XX88

ImageDownsampler3D Ogre::downscale3D2x_Signed_XX88

◆ downscale3D2x_Signed_XXX888

ImageDownsampler3D Ogre::downscale3D2x_Signed_XXX888

◆ downscale3D2x_Signed_XXXA8888

ImageDownsampler3D Ogre::downscale3D2x_Signed_XXXA8888

◆ downscale3D2x_sRGB_A8

ImageDownsampler3D Ogre::downscale3D2x_sRGB_A8

◆ downscale3D2x_sRGB_AX88

ImageDownsampler3D Ogre::downscale3D2x_sRGB_AX88

◆ downscale3D2x_sRGB_AXXX8888

ImageDownsampler3D Ogre::downscale3D2x_sRGB_AXXX8888

◆ downscale3D2x_sRGB_X8

ImageDownsampler3D Ogre::downscale3D2x_sRGB_X8

◆ downscale3D2x_sRGB_XA88

ImageDownsampler3D Ogre::downscale3D2x_sRGB_XA88

◆ downscale3D2x_sRGB_XX88

ImageDownsampler3D Ogre::downscale3D2x_sRGB_XX88

◆ downscale3D2x_sRGB_XXX888

ImageDownsampler3D Ogre::downscale3D2x_sRGB_XXX888

◆ downscale3D2x_sRGB_XXXA8888

ImageDownsampler3D Ogre::downscale3D2x_sRGB_XXXA8888

◆ downscale3D2x_X8

ImageDownsampler3D Ogre::downscale3D2x_X8

◆ downscale3D2x_XA88

ImageDownsampler3D Ogre::downscale3D2x_XA88

◆ downscale3D2x_XX88

ImageDownsampler3D Ogre::downscale3D2x_XX88

◆ downscale3D2x_XXX888

ImageDownsampler3D Ogre::downscale3D2x_XXX888

◆ downscale3D2x_XXXA8888

ImageDownsampler3D Ogre::downscale3D2x_XXXA8888

◆ separableBlur_A8

ImageBlur2D Ogre::separableBlur_A8

◆ separableBlur_Float32_A

ImageBlur2D Ogre::separableBlur_Float32_A

◆ separableBlur_Float32_X

ImageBlur2D Ogre::separableBlur_Float32_X

◆ separableBlur_Float32_XA

ImageBlur2D Ogre::separableBlur_Float32_XA

◆ separableBlur_Float32_XX

ImageBlur2D Ogre::separableBlur_Float32_XX

◆ separableBlur_Float32_XXX

ImageBlur2D Ogre::separableBlur_Float32_XXX

◆ separableBlur_Float32_XXXA

ImageBlur2D Ogre::separableBlur_Float32_XXXA

◆ separableBlur_Signed_A8

ImageBlur2D Ogre::separableBlur_Signed_A8

◆ separableBlur_Signed_X8

ImageBlur2D Ogre::separableBlur_Signed_X8

◆ separableBlur_Signed_XA88

ImageBlur2D Ogre::separableBlur_Signed_XA88

◆ separableBlur_Signed_XX88

ImageBlur2D Ogre::separableBlur_Signed_XX88

◆ separableBlur_Signed_XXX888

ImageBlur2D Ogre::separableBlur_Signed_XXX888

◆ separableBlur_Signed_XXXA8888

ImageBlur2D Ogre::separableBlur_Signed_XXXA8888

◆ separableBlur_sRGB_A8

ImageBlur2D Ogre::separableBlur_sRGB_A8

◆ separableBlur_sRGB_AX88

ImageBlur2D Ogre::separableBlur_sRGB_AX88

◆ separableBlur_sRGB_AXXX8888

ImageBlur2D Ogre::separableBlur_sRGB_AXXX8888

◆ separableBlur_sRGB_X8

ImageBlur2D Ogre::separableBlur_sRGB_X8

◆ separableBlur_sRGB_XA88

ImageBlur2D Ogre::separableBlur_sRGB_XA88

◆ separableBlur_sRGB_XX88

ImageBlur2D Ogre::separableBlur_sRGB_XX88

◆ separableBlur_sRGB_XXX888

ImageBlur2D Ogre::separableBlur_sRGB_XXX888

◆ separableBlur_sRGB_XXXA8888

ImageBlur2D Ogre::separableBlur_sRGB_XXXA8888

◆ separableBlur_X8

ImageBlur2D Ogre::separableBlur_X8

◆ separableBlur_XA88

ImageBlur2D Ogre::separableBlur_XA88

◆ separableBlur_XX88

ImageBlur2D Ogre::separableBlur_XX88

◆ separableBlur_XXX888

ImageBlur2D Ogre::separableBlur_XXX888

◆ separableBlur_XXXA8888

ImageBlur2D Ogre::separableBlur_XXXA8888