Struct SamplerInfoBuilder 

pub struct SamplerInfoBuilder { /* private fields */ }

Builder for SamplerInfo.

Implementations

impl SamplerInfoBuilder

pub fn flags(self, value: SamplerCreateFlags) -> Self

Bitmask specifying additional parameters of a sampler.

pub fn mag_filter(self, value: Filter) -> Self

Specifies the magnification filter to apply to texture lookups.

The default value is vk::Filter::NEAREST.

pub fn min_filter(self, value: Filter) -> Self

Specifies the minification filter to apply to texture lookups.

The default value is vk::Filter::NEAREST.

pub fn mipmap_mode(self, value: SamplerMipmapMode) -> Self

A value specifying the mipmap filter to apply to lookups.

The default value is vk::SamplerMipmapMode::NEAREST.

pub fn address_mode_u(self, value: SamplerAddressMode) -> Self

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

The default value is vk::SamplerAddressMode::REPEAT.

pub fn address_mode_v(self, value: SamplerAddressMode) -> Self

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

The default value is vk::SamplerAddressMode::REPEAT.

pub fn address_mode_w(self, value: SamplerAddressMode) -> Self

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

The default value is vk::SamplerAddressMode::REPEAT.

pub fn mip_lod_bias<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self

Bias added to the mipmap LOD calculation and to bias provided by SPIR-V image sampling instructions.

pub fn anisotropy_enable(self, value: bool) -> Self

Enables anisotropic filtering.

pub fn max_anisotropy<VALUE: Into<OrderedFloat<f32>>>( self, value: VALUE, ) -> Self

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

If anisotropy_enable is false, max_anisotropy is ignored.

pub fn compare_enable(self, value: bool) -> Self

Enables comparison against a reference value during lookups.

pub fn compare_op(self, value: CompareOp) -> Self

Specifies the comparison operator to apply to fetched data before filtering.

pub fn min_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self

Minimum LOD value used to clamp the computed level of detail.

pub fn max_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self

Maximum LOD value used to clamp the computed level of detail.

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

pub fn border_color(self, value: BorderColor) -> Self

Specifies the predefined border color to use.

The default value is vk::BorderColor::FLOAT_TRANSPARENT_BLACK.

pub fn unnormalized_coordinates(self, value: bool) -> Self

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 VkSamplerCreateInfo.

pub fn reduction_mode(self, value: SamplerReductionMode) -> Self

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 VkSamplerReductionModeCreateInfo.

impl SamplerInfoBuilder

pub fn build(self) -> SamplerInfo

Builds a new SamplerInfo.

Trait Implementations

impl Clone for SamplerInfoBuilder

fn clone(&self) -> SamplerInfoBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SamplerInfoBuilder

impl Debug for SamplerInfoBuilder

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

Formats the value using the given formatter.

impl Default for SamplerInfoBuilder

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.