Struct DepthStencilDescriptor 

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

A configuration for depth and stencil test operations.

C++ equivalent: MTL::DepthStencilDescriptor

Implementations

impl DepthStencilDescriptor

pub fn new() -> Option<Self>

Create a new depth/stencil descriptor.

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

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

Create a DepthStencilDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal depth/stencil descriptor object.

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

Get the raw pointer.

pub fn depth_compare_function(&self) -> CompareFunction

Get the depth compare function.

C++ equivalent: CompareFunction depthCompareFunction() const

pub fn set_depth_compare_function(&self, func: CompareFunction)

Set the depth compare function.

C++ equivalent: void setDepthCompareFunction(CompareFunction)

pub fn is_depth_write_enabled(&self) -> bool

Check if depth write is enabled.

C++ equivalent: bool isDepthWriteEnabled() const

pub fn set_depth_write_enabled(&self, enabled: bool)

Set whether depth write is enabled.

C++ equivalent: void setDepthWriteEnabled(bool)

pub fn front_face_stencil(&self) -> Option<StencilDescriptor>

Get the front face stencil descriptor.

C++ equivalent: StencilDescriptor* frontFaceStencil() const

pub fn set_front_face_stencil(&self, stencil: Option<&StencilDescriptor>)

Set the front face stencil descriptor.

C++ equivalent: void setFrontFaceStencil(StencilDescriptor*)

pub fn back_face_stencil(&self) -> Option<StencilDescriptor>

Get the back face stencil descriptor.

C++ equivalent: StencilDescriptor* backFaceStencil() const

pub fn set_back_face_stencil(&self, stencil: Option<&StencilDescriptor>)

Set the back face stencil descriptor.

C++ equivalent: void setBackFaceStencil(StencilDescriptor*)

pub fn label(&self) -> Option<String>

Get the label.

C++ equivalent: NS::String* label() const

pub fn set_label(&self, label: &str)

Set the label.

C++ equivalent: void setLabel(const NS::String*)

Trait Implementations

impl Clone for DepthStencilDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DepthStencilDescriptor

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

Formats the value using the given formatter.

impl Default for DepthStencilDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for DepthStencilDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for DepthStencilDescriptor

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 DepthStencilDescriptor

impl Sync for DepthStencilDescriptor