Struct StencilDescriptor 

pub struct StencilDescriptor(/* private fields */);

A configuration for stencil test operations.

C++ equivalent: MTL::StencilDescriptor

Implementations

impl StencilDescriptor

pub fn new() -> Option<Self>

Create a new stencil descriptor.

C++ equivalent: static StencilDescriptor* alloc()->init()

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a StencilDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal stencil descriptor object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

pub fn stencil_compare_function(&self) -> CompareFunction

Get the stencil compare function.

C++ equivalent: CompareFunction stencilCompareFunction() const

pub fn set_stencil_compare_function(&self, func: CompareFunction)

Set the stencil compare function.

C++ equivalent: void setStencilCompareFunction(CompareFunction)

pub fn stencil_failure_operation(&self) -> StencilOperation

Get the stencil failure operation.

C++ equivalent: StencilOperation stencilFailureOperation() const

pub fn set_stencil_failure_operation(&self, op: StencilOperation)

Set the stencil failure operation.

C++ equivalent: void setStencilFailureOperation(StencilOperation)

pub fn depth_failure_operation(&self) -> StencilOperation

Get the depth failure operation.

C++ equivalent: StencilOperation depthFailureOperation() const

pub fn set_depth_failure_operation(&self, op: StencilOperation)

Set the depth failure operation.

C++ equivalent: void setDepthFailureOperation(StencilOperation)

pub fn depth_stencil_pass_operation(&self) -> StencilOperation

Get the depth/stencil pass operation.

C++ equivalent: StencilOperation depthStencilPassOperation() const

pub fn set_depth_stencil_pass_operation(&self, op: StencilOperation)

Set the depth/stencil pass operation.

C++ equivalent: void setDepthStencilPassOperation(StencilOperation)

pub fn read_mask(&self) -> u32

Get the read mask.

C++ equivalent: uint32_t readMask() const

pub fn set_read_mask(&self, mask: u32)

Set the read mask.

C++ equivalent: void setReadMask(uint32_t)

pub fn write_mask(&self) -> u32

Get the write mask.

C++ equivalent: uint32_t writeMask() const

pub fn set_write_mask(&self, mask: u32)

Set the write mask.

C++ equivalent: void setWriteMask(uint32_t)

Trait Implementations

impl Clone for StencilDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for StencilDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for StencilDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for StencilDescriptor

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for StencilDescriptor

impl Sync for StencilDescriptor