LLGL::ClearValue Struct Reference

Clear value structure for color, depth, and stencil clear operations. More...

#include <CommandBufferFlags.h>

Public Member Functions
	ClearValue ()=default
	ClearValue (const float color[4], float depth=1.0f, std::uint32_t stencil=0)
	Constructor for color, depth, and stencil values.
	ClearValue (float r, float g, float b, float a, float depth=1.0f, std::uint32_t stencil=0)
	Constructor for color, depth, and stencil values.
	ClearValue (float depth)
	Constructor for the depth value only.
	ClearValue (std::uint32_t stencil)
	Constructor for the stencil value only.
	ClearValue (float depth, std::uint32_t stencil)
	Constructor for the depth and stencil values.

Public Attributes
float	color [4] = { 0.0f, 0.0f, 0.0f, 0.0f }
	Specifies the clear value to clear a color attachment. By default (0.0, 0.0, 0.0, 0.0).
float	depth = 1.0f
	Specifies the clear value to clear a depth attachment. By default 1.0.
std::uint32_t	stencil = 0
	Specifies the clear value to clear a stencil attachment. By default 0.

Detailed Description

Clear value structure for color, depth, and stencil clear operations.

See also

AttachmentClear::clearValue

TextureDescriptor::clearValue

Constructor & Destructor Documentation

ClearValue() [1/6]

LLGL::ClearValue::ClearValue ( )

default

ClearValue() [2/6]

LLGL::ClearValue::ClearValue ( const float color[4], float depth = 1.0f, std::uint32_t stencil = 0 )

inline

Constructor for color, depth, and stencil values.

ClearValue() [3/6]

LLGL::ClearValue::ClearValue ( float r, float g, float b, float a, float depth = 1.0f, std::uint32_t stencil = 0 )

inline

Constructor for color, depth, and stencil values.

ClearValue() [4/6]

LLGL::ClearValue::ClearValue ( float depth )

inline

Constructor for the depth value only.

ClearValue() [5/6]

LLGL::ClearValue::ClearValue ( std::uint32_t stencil )

inline

Constructor for the stencil value only.

ClearValue() [6/6]

LLGL::ClearValue::ClearValue ( float depth, std::uint32_t stencil )

inline

Constructor for the depth and stencil values.

Member Data Documentation

color

float LLGL::ClearValue::color[4] = { 0.0f, 0.0f, 0.0f, 0.0f }

Specifies the clear value to clear a color attachment. By default (0.0, 0.0, 0.0, 0.0).

depth

float LLGL::ClearValue::depth = 1.0f

Specifies the clear value to clear a depth attachment. By default 1.0.

stencil

std::uint32_t LLGL::ClearValue::stencil = 0

Specifies the clear value to clear a stencil attachment. By default 0.

---

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

• CommandBufferFlags.h