Struct SDL_GPUDepthStencilState 

#[repr(C)]
pub struct SDL_GPUDepthStencilState {
    pub compare_op: SDL_GPUCompareOp,
    pub back_stencil_state: SDL_GPUStencilOpState,
    pub front_stencil_state: SDL_GPUStencilOpState,
    pub compare_mask: Uint8,
    pub write_mask: Uint8,
    pub enable_depth_test: bool,
    pub enable_depth_write: bool,
    pub enable_stencil_test: bool,
    pub padding1: Uint8,
    pub padding2: Uint8,
    pub padding3: Uint8,
}

A structure specifying the parameters of the graphics pipeline depth stencil state.

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_GPUGraphicsPipelineCreateInfo

Notes for sdl3-sys

This struct has padding fields which shouldn’t be accessed directly; use struct update syntax with e.g. ..Default::default() for manual construction.

Fields

compare_op: SDL_GPUCompareOp

The comparison operator used for depth testing.

back_stencil_state: SDL_GPUStencilOpState

The stencil op state for back-facing triangles.

front_stencil_state: SDL_GPUStencilOpState

The stencil op state for front-facing triangles.

compare_mask: Uint8

Selects the bits of the stencil values participating in the stencil test.

write_mask: Uint8

Selects the bits of the stencil values updated by the stencil test.

enable_depth_test: bool

true enables the depth test.

enable_depth_write: bool

true enables depth writes. Depth writes are always disabled when enable_depth_test is false.

enable_stencil_test: bool

true enables the stencil test.

padding1: Uint8

👎Deprecated:

padding fields are exempt from semver; init with ..Default::default()

padding2: Uint8

👎Deprecated:

padding fields are exempt from semver; init with ..Default::default()

padding3: Uint8

👎Deprecated:

padding fields are exempt from semver; init with ..Default::default()

Trait Implementations

impl Clone for SDL_GPUDepthStencilState

fn clone(&self) -> SDL_GPUDepthStencilState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDL_GPUDepthStencilState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SDL_GPUDepthStencilState

fn default() -> SDL_GPUDepthStencilState

Returns the “default value” for a type.

impl Hash for SDL_GPUDepthStencilState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SDL_GPUDepthStencilState

fn eq(&self, other: &SDL_GPUDepthStencilState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SDL_GPUDepthStencilState

impl Eq for SDL_GPUDepthStencilState

impl StructuralPartialEq for SDL_GPUDepthStencilState