ezEngine  Milestone 7
ezImageFormat Struct Reference

Enum describing the encoding format of the pixels of an image. More...

#include <ImageFormat.h>

Public Types

enum  Enum {
  UNKNOWN, R32G32B32A32_TYPELESS, R32G32B32A32_FLOAT, R32G32B32A32_UINT,
  R32G32B32A32_SINT, R32G32B32_TYPELESS, R32G32B32_FLOAT, R32G32B32_UINT,
  R32G32B32_SINT, R16G16B16A16_TYPELESS, R16G16B16A16_FLOAT, R16G16B16A16_UNORM,
  R16G16B16A16_UINT, R16G16B16A16_SNORM, R16G16B16A16_SINT, R32G32_TYPELESS,
  R32G32_FLOAT, R32G32_UINT, R32G32_SINT, R32G8X24_TYPELESS,
  D32_FLOAT_S8X24_UINT, R32_FLOAT_X8X24_TYPELESS, X32_TYPELESS_G8X24_UINT, R10G10B10A2_TYPELESS,
  R10G10B10A2_UNORM, R10G10B10A2_UINT, R10G10B10_XR_BIAS_A2_UNORM, R11G11B10_FLOAT,
  R8G8B8A8_UNORM, R8G8B8A8_TYPELESS, R8G8B8A8_UNORM_SRGB, R8G8B8A8_UINT,
  R8G8B8A8_SNORM, R8G8B8A8_SINT, B8G8R8A8_UNORM, B8G8R8X8_UNORM,
  B8G8R8A8_TYPELESS, B8G8R8A8_UNORM_SRGB, B8G8R8X8_TYPELESS, B8G8R8X8_UNORM_SRGB,
  R16G16_TYPELESS, R16G16_FLOAT, R16G16_UNORM, R16G16_UINT,
  R16G16_SNORM, R16G16_SINT, R32_TYPELESS, D32_FLOAT,
  R32_FLOAT, R32_UINT, R32_SINT, R24G8_TYPELESS,
  D24_UNORM_S8_UINT, R24_UNORM_X8_TYPELESS, X24_TYPELESS_G8_UINT, B8G8R8_UNORM,
  R8G8_TYPELESS, R8G8_UNORM, R8G8_UINT, R8G8_SNORM,
  R8G8_SINT, B5G6R5_UNORM, B5G5R5A1_UNORM, B5G5R5X1_UNORM,
  R16_TYPELESS, R16_FLOAT, D16_UNORM, R16_UNORM,
  R16_UINT, R16_SNORM, R16_SINT, R8_TYPELESS,
  R8_UNORM, R8_UINT, R8_SNORM, R8_SINT,
  A8_UNORM, R1_UNORM, R9G9B9E5_SHAREDEXP, BC1_TYPELESS,
  BC1_UNORM, BC1_UNORM_SRGB, BC2_TYPELESS, BC2_UNORM,
  BC2_UNORM_SRGB, BC3_TYPELESS, BC3_UNORM, BC3_UNORM_SRGB,
  BC4_TYPELESS, BC4_UNORM, BC4_SNORM, BC5_TYPELESS,
  BC5_UNORM, BC5_SNORM, BC6H_TYPELESS, BC6H_UF16,
  BC6H_SF16, BC7_TYPELESS, BC7_UNORM, BC7_UNORM_SRGB,
  B4G4R4A4_UNORM, NUM_FORMATS
}
 Enum describing the encoding format of the pixels of an image.
 

Static Public Member Functions

static const char * GetName (Enum format)
 Returns the name of the given format. More...
 
static ezUInt32 GetBitsPerPixel (Enum format)
 Returns the number of bits per pixel of the given format.
 
static ezUInt32 GetRedMask (Enum format)
 If applicable, returns a bitmask for the red component of the format.
 
static ezUInt32 GetGreenMask (Enum format)
 If applicable, returns a bitmask for the green component of the format.
 
static ezUInt32 GetBlueMask (Enum format)
 If applicable, returns a bitmask for the blue component of the format.
 
static ezUInt32 GetAlphaMask (Enum format)
 If applicable, returns a bitmask for alpha red component of the format.
 
static ezImageFormatType::Enum GetType (Enum format)
 Returns the type of the image format.
 
static ezImageFormat::Enum FromPixelMask (ezUInt32 uiRedMask, ezUInt32 uiGreenMask, ezUInt32 uiBlueMask, ezUInt32 uiAlphaMask)
 Finds a format matching the given component masks.
 

Private Member Functions

 EZ_MAKE_SUBSYSTEM_STARTUP_FRIEND (CoreUtils, Image)
 

Static Private Member Functions

static void Startup ()
 
static void Shutdown ()
 

Detailed Description

Enum describing the encoding format of the pixels of an image.

Member Function Documentation

const char * ezImageFormat::GetName ( Enum  format)
static

Returns the name of the given format.

The returned string is guaranteed to be stable across engine versions and thus suitable for serialization.


The documentation for this struct was generated from the following files: