Struct nannou::vk::SamplerBuilder

pub struct SamplerBuilder {
    pub mag_filter: Option<Filter>,
    pub min_filter: Option<Filter>,
    pub mipmap_mode: Option<MipmapMode>,
    pub address_u: Option<SamplerAddressMode>,
    pub address_v: Option<SamplerAddressMode>,
    pub address_w: Option<SamplerAddressMode>,
    pub mip_lod_bias: Option<f32>,
    pub max_anisotropy: Option<f32>,
    pub min_lod: Option<f32>,
    pub max_lod: Option<f32>,
}

A builder struct that makes the process of building a Sampler more modular.

Fields

mag_filter: Option<Filter>

min_filter: Option<Filter>

mipmap_mode: Option<MipmapMode>

address_u: Option<SamplerAddressMode>

address_v: Option<SamplerAddressMode>

address_w: Option<SamplerAddressMode>

mip_lod_bias: Option<f32>

max_anisotropy: Option<f32>

min_lod: Option<f32>

max_lod: Option<f32>

Methods

impl SamplerBuilder

pub const DEFAULT_MAG_FILTER: Filter

pub const DEFAULT_MIN_FILTER: Filter

pub const DEFAULT_MIPMAP_MODE: MipmapMode

pub const DEFAULT_ADDRESS_U: SamplerAddressMode

pub const DEFAULT_ADDRESS_V: SamplerAddressMode

pub const DEFAULT_ADDRESS_W: SamplerAddressMode

pub const DEFAULT_MIP_LOD_BIAS: f32

pub const DEFAULT_MAX_ANISOTROPY: f32

pub const DEFAULT_MIN_LOD: f32

pub const DEFAULT_MAX_LOD: f32

pub fn new() -> Self

Begin building a new vulkan Sampler.

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

How the implementation should sample from the image when it is respectively larger than the original.

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

How the implementation should sample from the image when it is respectively smaller than the original.

pub fn mipmap_mode(self, mode: MipmapMode) -> Self

How the implementation should choose which mipmap to use.

pub fn address_u(self, mode: SamplerAddressMode) -> Self

How the implementation should behave when sampling outside of the texture coordinates range [0.0, 1.0].

pub fn address_v(self, mode: SamplerAddressMode) -> Self

How the implementation should behave when sampling outside of the texture coordinates range [0.0, 1.0].

pub fn address_w(self, mode: SamplerAddressMode) -> Self

How the implementation should behave when sampling outside of the texture coordinates range [0.0, 1.0].

pub fn mip_lod_bias(self, bias: f32) -> Self

Level of detail bias.

pub fn max_anisotropy(self, max: f32) -> Self

Must be greater than oro equal to 1.0.

If greater than 1.0, the implementation will use anisotropic filtering. Using a value greater than 1.0 requires the sampler_anisotropy feature to be enabled when creating the device.

pub fn min_lod(self, lod: f32) -> Self

The minimum mipmap level to use.

pub fn max_lod(self, lod: f32) -> Self

The maximum mipmap level to use.

pub fn build(
    self,
    device: Arc<Device>
) -> Result<Arc<Sampler>, SamplerCreationError>

Build the sampler with the givenn behaviour.

Trait Implementations

impl PartialEq<SamplerBuilder> for SamplerBuilder

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

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

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

This method tests for !=.

impl Clone for SamplerBuilder

fn clone(&self) -> SamplerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SamplerBuilder

fn default() -> SamplerBuilder

Returns the "default value" for a type.

impl Debug for SamplerBuilder

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

Formats the value using the given formatter.