Struct wgpu::SamplerDescriptor

source ·
pub struct SamplerDescriptor<'a> {
    pub label: Label<'a>,
    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>,
}
Expand description

Describes a Sampler.

For use with Device::create_sampler.

Corresponds to WebGPU GPUSamplerDescriptor.

Fields§

§label: Label<'a>

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§

source§

impl<'a> Clone for SamplerDescriptor<'a>

source§

fn clone(&self) -> SamplerDescriptor<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for SamplerDescriptor<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SamplerDescriptor<'_>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'a> PartialEq for SamplerDescriptor<'a>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> StructuralPartialEq for SamplerDescriptor<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for SamplerDescriptor<'a>

§

impl<'a> Send for SamplerDescriptor<'a>

§

impl<'a> Sync for SamplerDescriptor<'a>

§

impl<'a> Unpin for SamplerDescriptor<'a>

§

impl<'a> UnwindSafe for SamplerDescriptor<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,