Struct nannou_wgpu::SamplerBuilder

pub struct SamplerBuilder {
    pub descriptor: SamplerDescriptor<'static>,
}

Simplifies the construction of a Sampler with a set of reasonable defaults.

Fields

descriptor: SamplerDescriptor<'static>

Implementations

impl<'b> SamplerBuilder

pub const DEFAULT_ADDRESS_MODE_U: AddressMode = wgpu::AddressMode::ClampToEdge

pub const DEFAULT_ADDRESS_MODE_V: AddressMode = wgpu::AddressMode::ClampToEdge

pub const DEFAULT_ADDRESS_MODE_W: AddressMode = wgpu::AddressMode::ClampToEdge

pub const DEFAULT_MAG_FILTER: FilterMode = wgpu::FilterMode::Linear

pub const DEFAULT_MIN_FILTER: FilterMode = wgpu::FilterMode::Linear

pub const DEFAULT_MIPMAP_FILTER: FilterMode = wgpu::FilterMode::Nearest

pub const DEFAULT_LOD_MIN_CLAMP: f32 = 0f32

pub const DEFAULT_LOD_MAX_CLAMP: f32 = 100f32

pub const DEFAULT_COMPARE: Option<CompareFunction> = None

pub const DEFAULT_ANISOTROPY_CLAMP: u16 = 1u16

pub const DEFAULT_LABEL: &'static str = "nannou-sampler"

pub const DEFAULT_BORDER_COLOR: Option<SamplerBorderColor> = None

pub const DEFAULT_DESCRIPTOR: SamplerDescriptor<'static> = _

pub fn new() -> Self

Begin building a Sampler, starting with the Default parameters.

pub fn address_mode_u(self, mode: AddressMode) -> Self

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

pub fn address_mode_v(self, mode: AddressMode) -> Self

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

pub fn address_mode_w(self, mode: AddressMode) -> Self

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

pub fn address_mode(self, mode: AddressMode) -> Self

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

Applies the same address mode to all axes.

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

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

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

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

pub fn mipmap_filter(self, filter: FilterMode) -> Self

How the implementation should choose which mipmap to use.

pub fn lod_min_clamp(self, min: f32) -> Self

The minimum mipmap level to use.

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

The maximum mipmap level to use.

pub fn compare(self, f: Option<CompareFunction>) -> Self

The comparison function to use, if any.

pub fn anisotropy_clamp(self, clamp: u16) -> Self

The anisotropy level to clamp to, if any.

pub fn label(self, label: Option<&'static str>) -> Self

The label to use, if any.

pub fn build(&self, device: &Device) -> Sampler

Calls device.create_sampler(&self.descriptor) internally.

pub fn into_descriptor(self) -> SamplerDescriptor<'static>

Consume the builder and produce the inner SamplerDescriptor.

Trait Implementations

impl Debug for SamplerBuilder

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

Formats the value using the given formatter.

impl Default for SamplerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<SamplerDescriptor<'static>> for SamplerBuilder

fn from(descriptor: SamplerDescriptor<'static>) -> Self

Converts to this type from the input type.

impl Into<SamplerDescriptor<'static>> for SamplerBuilder

fn into(self) -> SamplerDescriptor<'static>

Converts this type into the (usually inferred) input type.