Struct SamplerInfo

#[non_exhaustive]
pub struct SamplerInfo {

    pub flags: SamplerCreateFlags,
    pub mag_filter: Filter,
    pub min_filter: Filter,
    pub mipmap_mode: SamplerMipmapMode,
    pub address_mode_u: SamplerAddressMode,
    pub address_mode_v: SamplerAddressMode,
    pub address_mode_w: SamplerAddressMode,
    pub mip_lod_bias: OrderedFloat<f32>,
    pub anisotropy_enable: bool,
    pub max_anisotropy: OrderedFloat<f32>,
    pub compare_enable: bool,
    pub compare_op: CompareOp,
    pub min_lod: OrderedFloat<f32>,
    pub max_lod: OrderedFloat<f32>,
    pub border_color: BorderColor,
    pub unnormalized_coordinates: bool,
    pub reduction_mode: SamplerReductionMode,
}

Information used to create a vk::Sampler instance.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flags: SamplerCreateFlags

Bitmask specifying additional parameters of a sampler.

mag_filter: Filter

Specify the magnification filter to apply to texture lookups.

The default value is vk::Filter::NEAREST

min_filter: Filter

Specify the minification filter to apply to texture lookups.

The default value is vk::Filter::NEAREST

mipmap_mode: SamplerMipmapMode

A value specifying the mipmap filter to apply to lookups.

The default value is vk::SamplerMipmapMode::NEAREST

address_mode_u: SamplerAddressMode

A value specifying the addressing mode for U coordinates outside [0, 1).

The default value is vk::SamplerAddressMode::REPEAT

address_mode_v: SamplerAddressMode

A value specifying the addressing mode for V coordinates outside [0, 1).

The default value is vk::SamplerAddressMode::REPEAT

address_mode_w: SamplerAddressMode

A value specifying the addressing mode for W coordinates outside [0, 1).

The default value is vk::SamplerAddressMode::REPEAT

mip_lod_bias: OrderedFloat<f32>

The bias to be added to mipmap LOD calculation and bias provided by image sampling functions in SPIR-V, as described in the LOD Operation section.

anisotropy_enable: bool

Enables anisotropic filtering, as described in the Texel Anisotropic Filtering section

max_anisotropy: OrderedFloat<f32>

The anisotropy value clamp used by the sampler when anisotropy_enable is true.

If anisotropy_enable is false, max_anisotropy is ignored.

compare_enable: bool

Enables comparison against a reference value during lookups.

compare_op: CompareOp

Specifies the comparison operator to apply to fetched data before filtering as described in the Depth Compare Operation section.

min_lod: OrderedFloat<f32>

Used to clamp the minimum of the computed LOD value.

max_lod: OrderedFloat<f32>

Used to clamp the maximum of the computed LOD value.

To avoid clamping the maximum value, set maxLod to the constant vk::LOD_CLAMP_NONE.

border_color: BorderColor

Secifies the predefined border color to use.

The default value is vk::BorderColor::FLOAT_TRANSPARENT_BLACK

unnormalized_coordinates: bool

Controls whether to use unnormalized or normalized texel coordinates to address texels of the image.

When set to true, the range of the image coordinates used to lookup the texel is in the range of zero to the image size in each dimension.

When set to false the range of image coordinates is zero to one.

See requirements.

reduction_mode: SamplerReductionMode

Specifies sampler reduction mode.

Setting magnification filter (mag_filter) to vk::Filter::NEAREST disables sampler reduction mode.

The default value is vk::SamplerReductionMode::WEIGHTED_AVERAGE

See requirements.

Implementations

impl SamplerInfo

pub const LINEAR: SamplerInfoBuilder

Default sampler information with mag_filter, min_filter and mipmap_mode set to linear.

pub const NEAREST: SamplerInfoBuilder

Default sampler information with mag_filter, min_filter and mipmap_mode set to nearest.

pub fn to_builder(self) -> SamplerInfoBuilder

Converts a SamplerInfo into a SamplerInfoBuilder.

Trait Implementations

impl Clone for SamplerInfo

fn clone(&self) -> SamplerInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamplerInfo

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

Formats the value using the given formatter.

impl Default for SamplerInfo

fn default() -> Self

Returns the “default value” for a type.

impl From<SamplerInfoBuilder> for SamplerInfo

fn from(info: SamplerInfoBuilder) -> Self

Converts to this type from the input type.

impl Hash for SamplerInfo

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SamplerInfo

fn eq(&self, other: &SamplerInfo) -> 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 Copy for SamplerInfo

impl Eq for SamplerInfo

impl StructuralPartialEq for SamplerInfo