Struct screen_13::driver::shader::SamplerInfoBuilder
source · pub struct SamplerInfoBuilder { /* private fields */ }
Expand description
Builder for SamplerInfo
.
Implementations§
source§impl SamplerInfoBuilder
impl SamplerInfoBuilder
sourcepub fn flags(self, value: SamplerCreateFlags) -> Self
pub fn flags(self, value: SamplerCreateFlags) -> Self
Bitmask specifying additional parameters of a sampler.
sourcepub fn mag_filter(self, value: Filter) -> Self
pub fn mag_filter(self, value: Filter) -> Self
Specify the magnification filter to apply to texture lookups.
The default value is vk::Filter::NEAREST
sourcepub fn min_filter(self, value: Filter) -> Self
pub fn min_filter(self, value: Filter) -> Self
Specify the minification filter to apply to texture lookups.
The default value is vk::Filter::NEAREST
sourcepub fn mipmap_mode(self, value: SamplerMipmapMode) -> Self
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
sourcepub fn address_mode_u(self, value: SamplerAddressMode) -> Self
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
sourcepub fn address_mode_v(self, value: SamplerAddressMode) -> Self
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
sourcepub fn address_mode_w(self, value: SamplerAddressMode) -> Self
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
sourcepub fn mip_lod_bias<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
pub fn mip_lod_bias<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
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.
sourcepub fn anisotropy_enable(self, value: bool) -> Self
pub fn anisotropy_enable(self, value: bool) -> Self
Enables anisotropic filtering, as described in the Texel Anisotropic Filtering section
sourcepub fn max_anisotropy<VALUE: Into<OrderedFloat<f32>>>(
self,
value: VALUE
) -> Self
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.
sourcepub fn compare_enable(self, value: bool) -> Self
pub fn compare_enable(self, value: bool) -> Self
Enables comparison against a reference value during lookups.
sourcepub fn compare_op(self, value: CompareOp) -> Self
pub fn compare_op(self, value: CompareOp) -> Self
Specifies the comparison operator to apply to fetched data before filtering as described in the Depth Compare Operation section.
sourcepub fn min_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
pub fn min_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
Used to clamp the minimum of the computed LOD value.
sourcepub fn max_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
pub fn max_lod<VALUE: Into<OrderedFloat<f32>>>(self, value: VALUE) -> Self
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
.
sourcepub fn border_color(self, value: BorderColor) -> Self
pub fn border_color(self, value: BorderColor) -> Self
Secifies the predefined border color to use.
The default value is vk::BorderColor::FLOAT_TRANSPARENT_BLACK
sourcepub fn unnormalized_coordinates(self, value: bool) -> Self
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 requirements.
sourcepub fn reduction_mode(self, value: SamplerReductionMode) -> Self
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 requirements.
source§impl SamplerInfoBuilder
impl SamplerInfoBuilder
sourcepub fn build(self) -> SamplerInfo
pub fn build(self) -> SamplerInfo
Builds a new SamplerInfo
.
Trait Implementations§
source§impl Clone for SamplerInfoBuilder
impl Clone for SamplerInfoBuilder
source§fn clone(&self) -> SamplerInfoBuilder
fn clone(&self) -> SamplerInfoBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more