Struct gfx_hal::image::SamplerDesc

pub struct SamplerDesc {
    pub min_filter: Filter,
    pub mag_filter: Filter,
    pub mip_filter: Filter,
    pub wrap_mode: (WrapMode, WrapMode, WrapMode),
    pub lod_bias: Lod,
    pub lod_range: Range<Lod>,
    pub comparison: Option<Comparison>,
    pub border: PackedColor,
    pub normalized: bool,
    pub anisotropy_clamp: Option<u8>,
}

Specifies how to sample from an image. These are all the parameters available that alter how the GPU goes from a coordinate in an image to producing an actual value from the texture, including filtering/ scaling, wrap mode, etc.

Fields

min_filter: Filter

Minification filter method to use.

mag_filter: Filter

Magnification filter method to use.

mip_filter: Filter

Mip filter method to use.

wrap_mode: (WrapMode, WrapMode, WrapMode)

Wrapping mode for each of the U, V, and W axis (S, T, and R in OpenGL speak).

lod_bias: Lod

This bias is added to every computed mipmap level (N + lod_bias). For example, if it would select mipmap level 2 and lod_bias is 1, it will use mipmap level 3.

lod_range: Range<Lod>

This range is used to clamp LOD level used for sampling.

comparison: Option<Comparison>

Comparison mode, used primary for a shadow map.

border: PackedColor

Border color is used when one of the wrap modes is set to border.

normalized: bool

Specifies whether the texture coordinates are normalized.

anisotropy_clamp: Option<u8>

Anisotropic filtering.

Can be Some(_) only if Features::SAMPLER_ANISOTROPY is enabled.

Methods

impl SamplerDesc

pub fn new(filter: Filter, wrap: WrapMode) -> Self

Create a new sampler description with a given filter method for all filtering operations and a wrapping mode, using no LOD modifications.

Trait Implementations

impl Clone for SamplerDesc

fn clone(&self) -> SamplerDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplerDesc

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

Formats the value using the given formatter.

impl Eq for SamplerDesc

impl Hash for SamplerDesc

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<SamplerDesc> for SamplerDesc

fn eq(&self, other: &SamplerDesc) -> bool

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

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

This method tests for !=.

impl StructuralEq for SamplerDesc

impl StructuralPartialEq for SamplerDesc