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;

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

More detailed sampler creation:

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

let _sampler = Sampler::start(device.clone())
    .filter(Filter::Linear)
    .address_mode(SamplerAddressMode::Repeat)
    .mip_lod_bias(1.0)
    .lod(0.0..=100.0)
    .build()
    .unwrap();

Implementations

impl Sampler

pub fn start(device: Arc<Device>) -> SamplerBuilder

Starts constructing a new Sampler.

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

Shortcut for creating a sampler with linear sampling, linear mipmaps, and with the repeat mode for borders.

Useful for prototyping, but can also be used in real projects.

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

Shortcut for creating a sampler with linear sampling, that only uses the main level of images, and with the repeat mode for borders.

Useful for prototyping, but can also be used in real projects.

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

Checks whether this sampler is compatible with image_view.

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 mag_filter(&self) -> Filter

Returns the magnification filter.

pub fn min_filter(&self) -> Filter

Returns the minification filter.

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, fmt: &mut Formatter<'_>) -> Result<(), Error>

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 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 !=.

impl VulkanObject for Sampler

type Object = Sampler

The type of the object.

fn internal_object(&self) -> Sampler

Returns a reference to the object.

impl Eq for Sampler