[−][src]Struct glium::draw_parameters::Stencil

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,
}

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

`impl Clone for Stencil`[src]

`fn clone(&self) -> Stencil`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Stencil`[src]

`impl Debug for Stencil`[src]

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

`impl Default for Stencil`[src]

`fn default() -> Stencil`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Stencil`

`impl Send for Stencil`

`impl Sync for Stencil`

`impl Unpin for Stencil`

`impl UnwindSafe for Stencil`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Content for T where T: Copy,` [src]

`type Owned = T`

A type that holds a sized version of the content.

`fn read<F, E>(usize, F) -> Result<T, E> where F: FnOnce(&mut T) -> Result<(), E>,` [src]

`fn get_elements_size() -> usize`[src]

`fn to_void_ptr(&Self) -> *const ()`[src]

`fn ref_from_ptr(mut (), usize) -> Option<mut T>`[src]

`fn is_size_suitable(usize) -> bool`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct glium::draw_parameters::Stencil

Fields

Trait Implementations

impl Clone for Stencil[src]

fn clone(&self) -> Stencil[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Copy for Stencil[src]

impl Debug for Stencil[src]

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

impl Default for Stencil[src]

fn default() -> Stencil[src]

Auto Trait Implementations

impl RefUnwindSafe for Stencil

impl Send for Stencil

impl Sync for Stencil

impl Unpin for Stencil

impl UnwindSafe for Stencil

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Content for T where T: Copy, [src]

type Owned = T

fn read<F, E>(usize, F) -> Result<T, E> where F: FnOnce(&mut T) -> Result<(), E>, [src]

fn get_elements_size() -> usize[src]

fn to_void_ptr(&Self) -> *const ()[src]

fn ref_from_ptr(*mut (), usize) -> Option<*mut T>[src]

fn is_size_suitable(usize) -> bool[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

`impl Clone for Stencil`[src]

`fn clone(&self) -> Stencil`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Stencil`[src]

`impl Debug for Stencil`[src]

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

`impl Default for Stencil`[src]

`fn default() -> Stencil`[src]

`impl RefUnwindSafe for Stencil`

`impl Send for Stencil`

`impl Sync for Stencil`

`impl Unpin for Stencil`

`impl UnwindSafe for Stencil`

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Content for T where T: Copy,` [src]

`type Owned = T`

`fn read<F, E>(usize, F) -> Result<T, E> where F: FnOnce(&mut T) -> Result<(), E>,` [src]

`fn get_elements_size() -> usize`[src]

`fn to_void_ptr(&Self) -> *const ()`[src]

`fn ref_from_ptr(mut (), usize) -> Option<mut T>`[src]

`fn is_size_suitable(usize) -> bool`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

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

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

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