LLGL::FormatAttributes Struct Reference

Vertex and texture format attributes structure. More...

#include <Format.h>

Public Attributes
std::uint16_t	bitSize
	Size (in bits) of the a pixel block or vertex attribute. This is 0 for invalid formats.
std::uint8_t	blockWidth
	Width of a pixel block. This is 1 for all non-compressed formats. This is 0 for invalid formats.
std::uint8_t	blockHeight
	Height of a pixel block. This is 1 for all non-compressed formats. This is 0 for invalid formats.
std::uint8_t	components
	Number of components. This is either 1, 2, 3, or 4. This is 0 for invalid formats.
ImageFormat	format
	Image pixel format. This is ignored for depth-stencil and compressed formats.
DataType	dataType
	Color component data type. This is ignored for depth-stencil and compressed formats.
long	flags
	Specifies the boolean attributes of this format descriptor. This can be bitwise OR combination of the FormatFlags entries.

Detailed Description

Vertex and texture format attributes structure.

Remarks

Describes all attributes of a hardware format, e.g. bit size, color components, compression etc.

Note

This descriptor structure has no default initializers to fulfill the requirements of a plain-old-data (POD) structure.

See also

GetFormatAttribs

Member Data Documentation

bitSize

std::uint16_t LLGL::FormatAttributes::bitSize

Size (in bits) of the a pixel block or vertex attribute. This is 0 for invalid formats.

blockHeight

std::uint8_t LLGL::FormatAttributes::blockHeight

Height of a pixel block. This is 1 for all non-compressed formats. This is 0 for invalid formats.

blockWidth

std::uint8_t LLGL::FormatAttributes::blockWidth

Width of a pixel block. This is 1 for all non-compressed formats. This is 0 for invalid formats.

components

std::uint8_t LLGL::FormatAttributes::components

Number of components. This is either 1, 2, 3, or 4. This is 0 for invalid formats.

dataType

DataType LLGL::FormatAttributes::dataType

Color component data type. This is ignored for depth-stencil and compressed formats.

Remarks

For depth-stencil formats, this data type always refers to the depth component, because stencil components are always in 8-bit unsigned integer format.

flags

long LLGL::FormatAttributes::flags

Specifies the boolean attributes of this format descriptor. This can be bitwise OR combination of the FormatFlags entries.

See also

FormatFlags

format

ImageFormat LLGL::FormatAttributes::format

Image pixel format. This is ignored for depth-stencil and compressed formats.

---

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

• Format.h