pub struct Stencil {
    pub test_clockwise: StencilTest,
    pub reference_value_clockwise: i32,
    pub write_mask_clockwise: u32,
    pub fail_operation_clockwise: StencilOperation,
    pub pass_depth_fail_operation_clockwise: StencilOperation,
    pub depth_pass_operation_clockwise: StencilOperation,
    pub test_counter_clockwise: StencilTest,
    pub reference_value_counter_clockwise: i32,
    pub write_mask_counter_clockwise: u32,
    pub fail_operation_counter_clockwise: StencilOperation,
    pub pass_depth_fail_operation_counter_clockwise: StencilOperation,
    pub depth_pass_operation_counter_clockwise: StencilOperation,
}
Expand description

Describes the parameters that must be used for the stencil operations when drawing.

Fields§

§test_clockwise: StencilTest

A comparison against the existing value in the stencil buffer.

Only relevant for faces that are clockwise on the target surface. Other faces, points and lines use stencil_test_counter_clockwise instead.

The default value is AlwaysPass.

§reference_value_clockwise: i32

Reference value that is used by stencil_test_clockwise, stencil_fail_operation_clockwise, stencil_pass_depth_fail_operation_clockwise and stencil_depth_pass_operation_clockwise.

§write_mask_clockwise: u32

Allows specifying a mask when writing data on the stencil buffer.

Only relevant for faces that are clockwise on the target surface. Other faces, points and lines use stencil_write_mask_counter_clockwise instead.

The default value is 0xffffffff.

§fail_operation_clockwise: StencilOperation

Specifies the operation to do when a fragment fails the stencil test.

The stencil test is the test specified by stencil_test_clockwise.

Only relevant for faces that are clockwise on the target surface. Other faces, points and lines use stencil_fail_operation_counter_clockwise instead.

The default value is Keep.

§pass_depth_fail_operation_clockwise: StencilOperation

Specifies the operation to do when a fragment passes the stencil test but fails the depth test.

The stencil test is the test specified by stencil_test_clockwise.

Only relevant for faces that are clockwise on the target surface. Other faces, points and lines use stencil_pass_depth_fail_operation_counter_clockwise instead.

The default value is Keep.

§depth_pass_operation_clockwise: StencilOperation

Specifies the operation to do when a fragment passes both the stencil and depth tests.

The stencil test is the test specified by stencil_test_clockwise.

Only relevant for faces that are clockwise on the target surface. Other faces, points and lines use stencil_depth_pass_operation_counter_clockwise instead.

The default value is Keep.

§test_counter_clockwise: StencilTest

A comparaison against the existing value in the stencil buffer.

Only relevant for points, lines and faces that are counter-clockwise on the target surface. Other faces use stencil_test_counter_clockwise instead.

The default value is AlwaysPass.

§reference_value_counter_clockwise: i32

Reference value that is used by stencil_test_counter_clockwise, stencil_fail_operation_counter_clockwise, stencil_pass_depth_fail_operation_counter_clockwise and stencil_depth_pass_operation_counter_clockwise.

§write_mask_counter_clockwise: u32

Allows specifying a mask when writing data on the stencil buffer.

Only relevant for points, lines and faces that are counter-clockwise on the target surface. Other faces use stencil_write_mask_clockwise instead.

The default value is 0xffffffff.

§fail_operation_counter_clockwise: StencilOperation

Specifies the operation to do when a fragment fails the stencil test.

The stencil test is the test specified by stencil_test_counter_clockwise.

Only relevant for faces that are counter-clockwise on the target surface. Other faces use stencil_fail_operation_clockwise instead.

The default value is Keep.

§pass_depth_fail_operation_counter_clockwise: StencilOperation

Specifies the operation to do when a fragment passes the stencil test but fails the depth test.

The stencil test is the test specified by stencil_test_counter_clockwise.

Only relevant for faces that are counter-clockwise on the target surface. Other faces use stencil_pass_depth_fail_operation_clockwise instead.

The default value is Keep.

§depth_pass_operation_counter_clockwise: StencilOperation

Specifies the operation to do when a fragment passes both the stencil and depth tests.

The stencil test is the test specified by stencil_test_counter_clockwise.

Only relevant for faces that are counter-clockwise on the target surface. Other faces use stencil_depth_pass_operation_clockwise instead.

The default value is Keep.

Trait Implementations§

source§

impl Clone for Stencil

source§

fn clone(&self) -> Stencil

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Stencil

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Stencil

source§

fn default() -> Stencil

Returns the “default value” for a type. Read more
source§

impl Copy for Stencil

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Content for Twhere T: Copy,

§

type Owned = T

A type that holds a sized version of the content.
source§

unsafe fn read<F, E>(size: usize, f: F) -> Result<T, E>where F: FnOnce(&mut T) -> Result<(), E>,

Prepares an output buffer, then turns this buffer into an Owned. User-provided closure F must only write to and not read from &mut Self.
source§

fn get_elements_size() -> usize

Returns the size of each element.
source§

fn to_void_ptr(&self) -> *const ()

Produces a pointer to the data.
source§

fn ref_from_ptr<'a>(ptr: *mut (), size: usize) -> Option<*mut T>

Builds a pointer to this type from a raw pointer.
source§

fn is_size_suitable(size: usize) -> bool

Returns true if the size is suitable to store a type like this.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.