Faro::GraphicsFormat Struct Reference

Describes a graphics format. More...

#include <GraphicsFormat.hpp>

Public Member Functions
	GraphicsFormat ()
	GraphicsFormat (GraphicsFormatElements elements, GraphicsFormatElementType elementType, GraphicsFormatElementLayout elementLayout)
uint8	GetElementCount ()
	Get the amount of elements/channels in this format.
uint8	GetStride ()
	Get the size of 1 format instance.

Public Attributes
GraphicsFormatElements	elements = FE_Unknown
GraphicsFormatElementType	elementType = FET_Unknown
GraphicsFormatElementLayout	elementLayout = FEL_Unknown
bool	linear = true

Static Public Attributes
static GraphicsFormat	Byte = { FE_R, FET_UNorm, FEL_8 }
static GraphicsFormat	Byte2 = { FE_RG, FET_UNorm, FEL_8_8 }
static GraphicsFormat	Byte4 = { FE_RGBA, FET_UNorm, FEL_8_8_8_8 }
static GraphicsFormat	Float = { FE_R, FET_Float, FEL_32 }
static GraphicsFormat	Float2 = { FE_RG, FET_Float, FEL_32_32 }
static GraphicsFormat	Float3 = { FE_RGB, FET_Float, FEL_32_32_32 }
static GraphicsFormat	Float4 = { FE_RGBA, FET_Float, FEL_32_32_32_32 }

Detailed Description

Describes a graphics format.

Constructor & Destructor Documentation

GraphicsFormat() [1/2]

Faro::GraphicsFormat::GraphicsFormat ( )

inline

GraphicsFormat() [2/2]

Faro::GraphicsFormat::GraphicsFormat ( GraphicsFormatElements  elements, GraphicsFormatElementType  elementType, GraphicsFormatElementLayout  elementLayout  )

inline

Member Function Documentation

GetElementCount()

uint8 Faro::GraphicsFormat::GetElementCount

(

)

Get the amount of elements/channels in this format.

Returns

uint8 Amount of elements

GetStride()

uint8 Faro::GraphicsFormat::GetStride

(

)

Get the size of 1 format instance.

Returns

uint8 Size of this format

Member Data Documentation

Byte

GraphicsFormat Faro::GraphicsFormat::Byte = { FE_R, FET_UNorm, FEL_8 }

static

Byte2

GraphicsFormat Faro::GraphicsFormat::Byte2 = { FE_RG, FET_UNorm, FEL_8_8 }

static

Byte4

GraphicsFormat Faro::GraphicsFormat::Byte4 = { FE_RGBA, FET_UNorm, FEL_8_8_8_8 }

static

elementLayout

GraphicsFormatElementLayout Faro::GraphicsFormat::elementLayout = FEL_Unknown

elements

GraphicsFormatElements Faro::GraphicsFormat::elements = FE_Unknown

elementType

GraphicsFormatElementType Faro::GraphicsFormat::elementType = FET_Unknown

Float

GraphicsFormat Faro::GraphicsFormat::Float = { FE_R, FET_Float, FEL_32 }

static

Float2

GraphicsFormat Faro::GraphicsFormat::Float2 = { FE_RG, FET_Float, FEL_32_32 }

static

Float3

GraphicsFormat Faro::GraphicsFormat::Float3 = { FE_RGB, FET_Float, FEL_32_32_32 }

static

Float4

GraphicsFormat Faro::GraphicsFormat::Float4 = { FE_RGBA, FET_Float, FEL_32_32_32_32 }

static

linear

bool Faro::GraphicsFormat::linear = true

---

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

• /github/workspace/Source/Engine/Graphics/GraphicsBase/Source/GraphicsFormat.hpp
• /github/workspace/Source/Engine/Graphics/GraphicsBase/Source/GraphicsFormat.cpp