Struct bevy::render::texture::ImageSamplerDescriptor

pub struct ImageSamplerDescriptor {
    pub label: Option<String>,
    pub address_mode_u: ImageAddressMode,
    pub address_mode_v: ImageAddressMode,
    pub address_mode_w: ImageAddressMode,
    pub mag_filter: ImageFilterMode,
    pub min_filter: ImageFilterMode,
    pub mipmap_filter: ImageFilterMode,
    pub lod_min_clamp: f32,
    pub lod_max_clamp: f32,
    pub compare: Option<ImageCompareFunction>,
    pub anisotropy_clamp: u16,
    pub border_color: Option<ImageSamplerBorderColor>,
}

Indicates to an ImageLoader how an Image should be sampled. As this type is part of the ImageLoaderSettings, it will be serialized to an image asset .meta file which might require a migration in case of a breaking change.

This types mirrors wgpu::SamplerDescriptor, but that might change in future versions.

Fields

label: Option<String>

address_mode_u: ImageAddressMode

How to deal with out of bounds accesses in the u (i.e. x) direction.

address_mode_v: ImageAddressMode

How to deal with out of bounds accesses in the v (i.e. y) direction.

address_mode_w: ImageAddressMode

How to deal with out of bounds accesses in the w (i.e. z) direction.

mag_filter: ImageFilterMode

How to filter the texture when it needs to be magnified (made larger).

min_filter: ImageFilterMode

How to filter the texture when it needs to be minified (made smaller).

mipmap_filter: ImageFilterMode

How to filter between mip map levels

lod_min_clamp: f32

Minimum level of detail (i.e. mip level) to use.

lod_max_clamp: f32

Maximum level of detail (i.e. mip level) to use.

compare: Option<ImageCompareFunction>

If this is enabled, this is a comparison sampler using the given comparison function.

anisotropy_clamp: u16

Must be at least 1. If this is not 1, all filter modes must be linear.

border_color: Option<ImageSamplerBorderColor>

Border color to use when address_mode is ImageAddressMode::ClampToBorder.

Implementations

impl ImageSamplerDescriptor

pub fn linear() -> ImageSamplerDescriptor

Returns a sampler descriptor with Linear min and mag filters

Examples found in repository

examples/3d/motion_blur.rs (line 399)

fn uv_debug_texture() -> Image {
    use bevy::render::{render_asset::RenderAssetUsages, render_resource::*, texture::*};
    const TEXTURE_SIZE: usize = 7;

    let mut palette = [
        164, 164, 164, 255, 168, 168, 168, 255, 153, 153, 153, 255, 139, 139, 139, 255, 153, 153,
        153, 255, 177, 177, 177, 255, 159, 159, 159, 255,
    ];

    let mut texture_data = [0; TEXTURE_SIZE * TEXTURE_SIZE * 4];
    for y in 0..TEXTURE_SIZE {
        let offset = TEXTURE_SIZE * y * 4;
        texture_data[offset..(offset + TEXTURE_SIZE * 4)].copy_from_slice(&palette);
        palette.rotate_right(12);
    }

    let mut img = Image::new_fill(
        Extent3d {
            width: TEXTURE_SIZE as u32,
            height: TEXTURE_SIZE as u32,
            depth_or_array_layers: 1,
        },
        TextureDimension::D2,
        &texture_data,
        TextureFormat::Rgba8UnormSrgb,
        RenderAssetUsages::RENDER_WORLD,
    );
    img.sampler = ImageSampler::Descriptor(ImageSamplerDescriptor {
        address_mode_u: ImageAddressMode::Repeat,
        address_mode_v: ImageAddressMode::MirrorRepeat,
        mag_filter: ImageFilterMode::Nearest,
        ..ImageSamplerDescriptor::linear()
    });
    img
}

pub fn nearest() -> ImageSamplerDescriptor

Returns a sampler descriptor with Nearest min and mag filters

pub fn as_wgpu(&self) -> SamplerDescriptor<'_>

Trait Implementations

impl Clone for ImageSamplerDescriptor

fn clone(&self) -> ImageSamplerDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageSamplerDescriptor

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

Formats the value using the given formatter.

impl Default for ImageSamplerDescriptor

fn default() -> ImageSamplerDescriptor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageSamplerDescriptor

fn deserialize<__D>( __deserializer: __D ) -> Result<ImageSamplerDescriptor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<SamplerDescriptor<'a>> for ImageSamplerDescriptor

fn from(value: SamplerDescriptor<'_>) -> ImageSamplerDescriptor

Converts to this type from the input type.

impl Serialize for ImageSamplerDescriptor

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.