Struct SamplerDescriptor 

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

A configuration for a sampler state.

C++ equivalent: MTL::SamplerDescriptor

Implementations

impl SamplerDescriptor

pub fn new() -> Option<Self>

Create a new sampler descriptor.

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

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

Create a SamplerDescriptor from a raw pointer.

Safety

The pointer must be a valid Metal sampler descriptor object.

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

Get the raw pointer.

pub fn min_filter(&self) -> SamplerMinMagFilter

Get the minification filter.

C++ equivalent: SamplerMinMagFilter minFilter() const

pub fn set_min_filter(&self, filter: SamplerMinMagFilter)

Set the minification filter.

C++ equivalent: void setMinFilter(SamplerMinMagFilter)

pub fn mag_filter(&self) -> SamplerMinMagFilter

Get the magnification filter.

C++ equivalent: SamplerMinMagFilter magFilter() const

pub fn set_mag_filter(&self, filter: SamplerMinMagFilter)

Set the magnification filter.

C++ equivalent: void setMagFilter(SamplerMinMagFilter)

pub fn mip_filter(&self) -> SamplerMipFilter

Get the mipmap filter.

C++ equivalent: SamplerMipFilter mipFilter() const

pub fn set_mip_filter(&self, filter: SamplerMipFilter)

Set the mipmap filter.

C++ equivalent: void setMipFilter(SamplerMipFilter)

pub fn s_address_mode(&self) -> SamplerAddressMode

Get the S (horizontal) address mode.

C++ equivalent: SamplerAddressMode sAddressMode() const

pub fn set_s_address_mode(&self, mode: SamplerAddressMode)

Set the S (horizontal) address mode.

C++ equivalent: void setSAddressMode(SamplerAddressMode)

pub fn t_address_mode(&self) -> SamplerAddressMode

Get the T (vertical) address mode.

C++ equivalent: SamplerAddressMode tAddressMode() const

pub fn set_t_address_mode(&self, mode: SamplerAddressMode)

Set the T (vertical) address mode.

C++ equivalent: void setTAddressMode(SamplerAddressMode)

pub fn r_address_mode(&self) -> SamplerAddressMode

Get the R (depth) address mode.

C++ equivalent: SamplerAddressMode rAddressMode() const

pub fn set_r_address_mode(&self, mode: SamplerAddressMode)

Set the R (depth) address mode.

C++ equivalent: void setRAddressMode(SamplerAddressMode)

pub fn border_color(&self) -> SamplerBorderColor

Get the border color.

C++ equivalent: SamplerBorderColor borderColor() const

pub fn set_border_color(&self, color: SamplerBorderColor)

Set the border color.

C++ equivalent: void setBorderColor(SamplerBorderColor)

pub fn lod_min_clamp(&self) -> f32

Get the minimum LOD clamp.

C++ equivalent: float lodMinClamp() const

pub fn set_lod_min_clamp(&self, clamp: f32)

Set the minimum LOD clamp.

C++ equivalent: void setLodMinClamp(float)

pub fn lod_max_clamp(&self) -> f32

Get the maximum LOD clamp.

C++ equivalent: float lodMaxClamp() const

pub fn set_lod_max_clamp(&self, clamp: f32)

Set the maximum LOD clamp.

C++ equivalent: void setLodMaxClamp(float)

pub fn lod_bias(&self) -> f32

Get the LOD bias.

C++ equivalent: float lodBias() const

pub fn set_lod_bias(&self, bias: f32)

Set the LOD bias.

C++ equivalent: void setLodBias(float)

pub fn lod_average(&self) -> bool

Get whether LOD averaging is enabled.

C++ equivalent: bool lodAverage() const

pub fn set_lod_average(&self, average: bool)

Set whether LOD averaging is enabled.

C++ equivalent: void setLodAverage(bool)

pub fn max_anisotropy(&self) -> UInteger

Get the maximum anisotropy.

C++ equivalent: NS::UInteger maxAnisotropy() const

pub fn set_max_anisotropy(&self, max: UInteger)

Set the maximum anisotropy.

C++ equivalent: void setMaxAnisotropy(NS::UInteger)

pub fn compare_function(&self) -> CompareFunction

Get the compare function.

C++ equivalent: CompareFunction compareFunction() const

pub fn set_compare_function(&self, func: CompareFunction)

Set the compare function.

C++ equivalent: void setCompareFunction(CompareFunction)

pub fn reduction_mode(&self) -> SamplerReductionMode

Get the reduction mode.

C++ equivalent: SamplerReductionMode reductionMode() const

pub fn set_reduction_mode(&self, mode: SamplerReductionMode)

Set the reduction mode.

C++ equivalent: void setReductionMode(SamplerReductionMode)

pub fn normalized_coordinates(&self) -> bool

Check if normalized coordinates are used.

C++ equivalent: bool normalizedCoordinates() const

pub fn set_normalized_coordinates(&self, normalized: bool)

Set whether normalized coordinates are used.

C++ equivalent: void setNormalizedCoordinates(bool)

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*)

pub fn support_argument_buffers(&self) -> bool

Check if LOD average is supported.

C++ equivalent: bool supportArgumentBuffers() const

pub fn set_support_argument_buffers(&self, support: bool)

Set whether argument buffers are supported.

C++ equivalent: void setSupportArgumentBuffers(bool)

Trait Implementations

impl Clone for SamplerDescriptor

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 SamplerDescriptor

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

Formats the value using the given formatter.

impl Default for SamplerDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for SamplerDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for SamplerDescriptor

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 SamplerDescriptor

impl Sync for SamplerDescriptor