Skip to content

LiteFX

LiteFX::Rendering::RenderTarget::clearValues

`LiteFX::Rendering::RenderTarget::clearValues`¶

Returns the value, the render target is cleared with, if clearBuffer either or clearStencil is specified.

Synopsis¶

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] virtual Vector4f const& clearValues() const noexcept override;

Description¶

If the format is a color format and clearBuffer is specified, this contains the clear color. However, if the format is a depth/stencil format, the R and G channels contain the depth and stencil value to clear the buffer with. Note that the stencil buffer is only cleared, if clearStencil is specified and vice versa.

Return Value¶

The value, the render target is cleared with, if clearBuffer either or clearStencil is specified.