Enum gfx_hal::image::WrapMode

pub enum WrapMode {
    Tile,
    Mirror,
    Clamp,
    Border,
    MirrorClamp,
}

Specifies how image coordinates outside the range [0, 1] are handled.

Variants

Tile

Tile the image, that is, sample the coordinate modulo 1.0, so addressing the image beyond an edge will "wrap" back from the other edge.

Mirror

Mirror the image. Like tile, but uses abs(coord) before the modulo.

Clamp

Clamp the image to the value at 0.0 or 1.0 respectively.

Border

Use border color.

MirrorClamp

Mirror once and clamp to edge otherwise.

Only valid if Features::SAMPLER_MIRROR_CLAMP_EDGE is enabled.

Trait Implementations

impl Clone for WrapMode

fn clone(&self) -> WrapMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for WrapMode

impl Debug for WrapMode

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

Formats the value using the given formatter.

impl Eq for WrapMode

impl Hash for WrapMode

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for WrapMode

fn cmp(&self, other: &WrapMode) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<WrapMode> for WrapMode

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<WrapMode> for WrapMode

fn partial_cmp(&self, other: &WrapMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for WrapMode

impl StructuralPartialEq for WrapMode