nicegraf
ngf_clear_info Struct Reference

Data Fields

float clear_color [4]
 
struct { 
 
   float   clear_depth 
 
   uint32_t   clear_stencil 
 
clear_depth_stencil 
 

Detailed Description

Specifies a render target clear operation.

Field Documentation

◆ clear_color

float ngf_clear_info::clear_color[4]

The color to clear to. Each element corresponds to the red, green, blue and alpha channel respectively, and is a floating point value within the [0; 1] range, with 0.0 corresponding to none an 1.0 corresponding to full intensity. If the format of the render target image does not have a corresponding channel, the value is ignored. This field is used for color attachments only.

◆ clear_depth

float ngf_clear_info::clear_depth

The depth value to clear to.

◆ [struct]

struct { ... } ngf_clear_info::clear_depth_stencil

The depth and stencil values to clear to. This field is used for depth or combined depth/stencil attachments only.

◆ clear_stencil

uint32_t ngf_clear_info::clear_stencil

The stencil value to clear to.