Enum vulkano::image::sampler::BorderColor

#[non_exhaustive]
#[repr(i32)]
pub enum BorderColor {
    FloatTransparentBlack = 0,
    IntTransparentBlack = 1,
    FloatOpaqueBlack = 2,
    IntOpaqueBlack = 3,
    FloatOpaqueWhite = 4,
    IntOpaqueWhite = 5,
}

The color to use for the border of an image.

Only relevant if you use ClampToBorder.

Using a border color restricts the sampler to either floating-point images or integer images.

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.

FloatTransparentBlack = 0

The value (0.0, 0.0, 0.0, 0.0). Can only be used with floating-point images.

IntTransparentBlack = 1

The value (0, 0, 0, 0). Can only be used with integer images.

FloatOpaqueBlack = 2

The value (0.0, 0.0, 0.0, 1.0). Can only be used with floating-point identity-swizzled images.

IntOpaqueBlack = 3

The value (0, 0, 0, 1). Can only be used with integer identity-swizzled images.

FloatOpaqueWhite = 4

The value (1.0, 1.0, 1.0, 1.0). Can only be used with floating-point images.

IntOpaqueWhite = 5

The value (1, 1, 1, 1). Can only be used with integer images.

Trait Implementations

impl Clone for BorderColor

fn clone(&self) -> BorderColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorderColor

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

Formats the value using the given formatter.

impl From<BorderColor> for BorderColor

fn from(val: BorderColor) -> Self

Converts to this type from the input type.

impl Hash for BorderColor

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 BorderColor

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

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for BorderColor

impl Eq for BorderColor

impl StructuralEq for BorderColor

impl StructuralPartialEq for BorderColor