Type Alias SamplerDescriptor

pub type SamplerDescriptor<'a> = SamplerDescriptor<Label<'a>>;

Describes a Sampler.

For use with Device::create_sampler.

Corresponds to WebGPU GPUSamplerDescriptor.

Aliased Type

struct SamplerDescriptor<'a> {
    pub label: Option<&'a str>,
    pub address_mode_u: AddressMode,
    pub address_mode_v: AddressMode,
    pub address_mode_w: AddressMode,
    pub mag_filter: FilterMode,
    pub min_filter: FilterMode,
    pub mipmap_filter: FilterMode,
    pub lod_min_clamp: f32,
    pub lod_max_clamp: f32,
    pub compare: Option<CompareFunction>,
    pub anisotropy_clamp: u16,
    pub border_color: Option<SamplerBorderColor>,
}

Fields

label: Option<&'a str>

Debug label of the sampler. This will show up in graphics debuggers for easy identification.

address_mode_u: AddressMode

How to deal with out of bounds accesses in the u (i.e. x) direction

address_mode_v: AddressMode

How to deal with out of bounds accesses in the v (i.e. y) direction

address_mode_w: AddressMode

How to deal with out of bounds accesses in the w (i.e. z) direction

mag_filter: FilterMode

How to filter the texture when it needs to be magnified (made larger)

min_filter: FilterMode

How to filter the texture when it needs to be minified (made smaller)

mipmap_filter: FilterMode

How to filter between mip map levels

lod_min_clamp: f32

Minimum level of detail (i.e. mip level) to use

lod_max_clamp: f32

Maximum level of detail (i.e. mip level) to use

compare: Option<CompareFunction>

If this is enabled, this is a comparison sampler using the given comparison function.

anisotropy_clamp: u16

Must be at least 1. If this is not 1, all filter modes must be linear.

border_color: Option<SamplerBorderColor>

Border color to use when address_mode is [AddressMode::ClampToBorder]

Trait Implementations

impl<L> Clone for SamplerDescriptor<L>

where L: Clone,

fn clone(&self) -> SamplerDescriptor<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L> Debug for SamplerDescriptor<L>

where L: Debug,

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

Formats the value using the given formatter.

impl<L> Default for SamplerDescriptor<L>

where L: Default,

fn default() -> SamplerDescriptor<L>

Returns the “default value” for a type.

impl<'de, L> Deserialize<'de> for SamplerDescriptor<L>

where L: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SamplerDescriptor<L>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<L> PartialEq for SamplerDescriptor<L>

where L: PartialEq,

fn eq(&self, other: &SamplerDescriptor<L>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<L> Serialize for SamplerDescriptor<L>

where L: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<L> StructuralPartialEq for SamplerDescriptor<L>