Struct vulkano::sampler::Sampler

pub struct Sampler { /* private fields */ }

Describes how to retrieve data from a sampled image within a shader.

Examples

A simple sampler for most usages:

use vulkano::sampler::{Sampler, SamplerCreateInfo};

let _sampler = Sampler::new(device.clone(), SamplerCreateInfo::simple_repeat_linear_no_mipmap());

More detailed sampler creation:

use vulkano::sampler::{Filter, Sampler, SamplerAddressMode, SamplerCreateInfo};

let _sampler = Sampler::new(device.clone(), SamplerCreateInfo {
    mag_filter: Filter::Linear,
    min_filter: Filter::Linear,
    address_mode: [SamplerAddressMode::Repeat; 3],
    mip_lod_bias: 1.0,
    lod: 0.0..=100.0,
    ..Default::default()
})
.unwrap();

Implementations

impl Sampler

pub fn new(
    device: Arc<Device>,
    create_info: SamplerCreateInfo
) -> Result<Arc<Sampler>, SamplerCreationError>

Creates a new Sampler.

Panics

• Panics if create_info.anisotropy is Some and contains a value less than 1.0.
• Panics if create_info.lod is empty.

pub unsafe fn from_handle(
    device: Arc<Device>,
    handle: Sampler,
    create_info: SamplerCreateInfo
) -> Arc<Sampler>

Creates a new Sampler from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• create_info must match the info used to create the object.

pub fn check_can_sample(
    &self,
    image_view: &impl ImageViewAbstract + ?Sized
) -> Result<(), SamplerImageViewIncompatibleError>

Checks whether this sampler is compatible with image_view.

pub fn address_mode(&self) -> [SamplerAddressMode; 3]

Returns the address modes for the u, v and w coordinates.

pub fn anisotropy(&self) -> Option<f32>

Returns the anisotropy mode.

pub fn border_color(&self) -> Option<BorderColor>

Returns the border color if one is used by this sampler.

pub fn compare(&self) -> Option<CompareOp>

Returns the compare operation if the sampler is a compare-mode sampler.

pub fn lod(&self) -> RangeInclusive<f32>

Returns the LOD range.

pub fn mag_filter(&self) -> Filter

Returns the magnification filter.

pub fn min_filter(&self) -> Filter

Returns the minification filter.

pub fn mip_lod_bias(&self) -> f32

Returns the mip LOD bias.

pub fn mipmap_mode(&self) -> SamplerMipmapMode

Returns the mipmap mode.

pub fn reduction_mode(&self) -> SamplerReductionMode

Returns the reduction mode.

pub fn sampler_ycbcr_conversion(&self) -> Option<&Arc<SamplerYcbcrConversion>>

Returns a reference to the sampler YCbCr conversion of this sampler, if any.

pub fn unnormalized_coordinates(&self) -> bool

Returns true if the sampler uses unnormalized coordinates.

Trait Implementations

impl Debug for Sampler

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

Formats the value using the given formatter.

impl DeviceOwned for Sampler

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Drop for Sampler

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Sampler

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Sampler> for Sampler

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for Sampler

type Handle = Sampler

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for Sampler