Struct SDL_GPUStencilOp 

#[repr(transparent)]
pub struct SDL_GPUStencilOp(pub c_int);

Specifies what happens to a stored stencil value if stencil tests fail or pass.

Availability

This enum is available since SDL 3.2.0.

See also

• SDL_CreateGPUGraphicsPipeline

Known values (sdl3-sys)

Associated constant	Global constant	Description
INVALID	SDL_GPU_STENCILOP_INVALID
KEEP	SDL_GPU_STENCILOP_KEEP	Keeps the current value.
ZERO	SDL_GPU_STENCILOP_ZERO	Sets the value to 0.
REPLACE	SDL_GPU_STENCILOP_REPLACE	Sets the value to reference.
INCREMENT_AND_CLAMP	SDL_GPU_STENCILOP_INCREMENT_AND_CLAMP	Increments the current value and clamps to the maximum value.
DECREMENT_AND_CLAMP	SDL_GPU_STENCILOP_DECREMENT_AND_CLAMP	Decrements the current value and clamps to 0.
INVERT	SDL_GPU_STENCILOP_INVERT	Bitwise-inverts the current value.
INCREMENT_AND_WRAP	SDL_GPU_STENCILOP_INCREMENT_AND_WRAP	Increments the current value and wraps back to 0.
DECREMENT_AND_WRAP	SDL_GPU_STENCILOP_DECREMENT_AND_WRAP	Decrements the current value and wraps to the maximum value.

Tuple Fields

0: c_int

Implementations

impl SDL_GPUStencilOp

pub const INVALID: Self

pub const KEEP: Self

Keeps the current value.

pub const ZERO: Self

Sets the value to 0.

pub const REPLACE: Self

Sets the value to reference.

pub const INCREMENT_AND_CLAMP: Self

Increments the current value and clamps to the maximum value.

pub const DECREMENT_AND_CLAMP: Self

Decrements the current value and clamps to 0.

pub const INVERT: Self

Bitwise-inverts the current value.

pub const INCREMENT_AND_WRAP: Self

Increments the current value and wraps back to 0.

pub const DECREMENT_AND_WRAP: Self

Decrements the current value and wraps to the maximum value.

Trait Implementations

impl Clone for SDL_GPUStencilOp

fn clone(&self) -> SDL_GPUStencilOp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_GPUStencilOp

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_GPUStencilOp

fn default() -> SDL_GPUStencilOp

Returns the “default value” for a type.

impl From<SDL_GPUStencilOp> for c_int

fn from(value: SDL_GPUStencilOp) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_GPUStencilOp

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_GPUStencilOp

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 Ord for SDL_GPUStencilOp

fn cmp(&self, other: &SDL_GPUStencilOp) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<SDL_GPUStencilOp> for c_int

fn eq(&self, other: &SDL_GPUStencilOp) -> 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 PartialEq<i32> for SDL_GPUStencilOp

fn eq(&self, other: &c_int) -> 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 PartialEq for SDL_GPUStencilOp

fn eq(&self, other: &SDL_GPUStencilOp) -> 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 PartialOrd for SDL_GPUStencilOp

fn partial_cmp(&self, other: &SDL_GPUStencilOp) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SDL_GPUStencilOp

impl Eq for SDL_GPUStencilOp

impl StructuralPartialEq for SDL_GPUStencilOp