Enum vulkano::image::sampler::SamplerAddressMode

#[non_exhaustive]
#[repr(i32)]
pub enum SamplerAddressMode {
    Repeat = 0,
    MirroredRepeat = 1,
    ClampToEdge = 2,
    ClampToBorder = 3,
    MirrorClampToEdge = 4,
}

How the sampler should behave when it needs to access a pixel that is out of range of the texture.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Repeat = 0

Repeat the texture. In other words, the pixel at coordinate x + 1.0 is the same as the one at coordinate x.

MirroredRepeat = 1

Repeat the texture but mirror it at every repetition. In other words, the pixel at coordinate x + 1.0 is the same as the one at coordinate 1.0 - x.

ClampToEdge = 2

The coordinates are clamped to the valid range. Coordinates below 0.0 have the same value as coordinate 0.0. Coordinates over 1.0 have the same value as coordinate 1.0.

ClampToBorder = 3

Any pixel out of range is colored using the colour selected with the border_color on the SamplerBuilder.

When this mode is chosen, the numeric type of the image view’s format must match the border color. When using a floating-point border color, the sampler can only be used with floating-point or depth image views. When using an integer border color, the sampler can only be used with integer or stencil image views. In addition to this, you can’t use an opaque black border color with an image view that uses component swizzling.

MirrorClampToEdge = 4

Similar to MirroredRepeat, except that coordinates are clamped to the range [-1.0, 1.0].

The sampler_mirror_clamp_to_edge feature or the khr_sampler_mirror_clamp_to_edge extension must be enabled on the device.

Trait Implementations

impl Clone for SamplerAddressMode

fn clone(&self) -> SamplerAddressMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplerAddressMode

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

Formats the value using the given formatter.

impl From<SamplerAddressMode> for SamplerAddressMode

fn from(val: SamplerAddressMode) -> Self

Converts to this type from the input type.

impl Hash for SamplerAddressMode

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 for SamplerAddressMode

fn eq(&self, other: &SamplerAddressMode) -> 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 TryFrom<SamplerAddressMode> for SamplerAddressMode

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: SamplerAddressMode) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SamplerAddressMode

impl Eq for SamplerAddressMode

impl StructuralEq for SamplerAddressMode

impl StructuralPartialEq for SamplerAddressMode