Struct wgpu::SamplerDescriptor[−][src]

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: Option<NonZeroU8>,
    pub border_color: Option<SamplerBorderColor>,
}

Describes a Sampler

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: Option<NonZeroU8>

Valid values: 1, 2, 4, 8, and 16.

border_color: Option<SamplerBorderColor>

Border color to use when address_mode is AddressMode::ClampToBorder

Trait Implementations

impl<'a> Clone for SamplerDescriptor<'a>[src]

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

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<'a> Debug for SamplerDescriptor<'a>[src]

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

Formats the value using the given formatter. Read more

impl Default for SamplerDescriptor<'_>[src]

fn default() -> Self[src]

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

impl<'a> PartialEq<SamplerDescriptor<'a>> for SamplerDescriptor<'a>[src]

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

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, other: &SamplerDescriptor<'a>) -> bool[src]

This method tests for !=.

impl<'a> StructuralPartialEq for SamplerDescriptor<'a>[src]

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

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> Upcast<T> for T

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