Enum cogl::PipelineWrapMode

#[non_exhaustive]
pub enum PipelineWrapMode {
    Repeat,
    MirroredRepeat,
    ClampToEdge,
    Automatic,
    // some variants omitted
}

The wrap mode specifies what happens when texture coordinates outside the range 0→1 are used. Note that if the filter mode is anything but PipelineFilter::Nearest then texels outside the range 0→1 might be used even when the coordinate is exactly 0 or 1 because OpenGL will try to sample neighbouring pixels. For example if you are trying to render the full texture then you may get artifacts around the edges when the pixels from the other side are merged in if the wrap mode is set to repeat.

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

The texture will be repeated. This is useful for example to draw a tiled background.

MirroredRepeat

ClampToEdge

The coordinates outside the range 0→1 will sample copies of the edge pixels of the texture. This is useful to avoid artifacts if only one copy of the texture is being rendered.

Automatic

Cogl will try to automatically decide which of the above two to use. For cogl_rectangle, it will use repeat mode if any of the texture coordinates are outside the range 0→1, otherwise it will use clamp to edge. For cogl_polygon it will always use repeat mode. For cogl_vertex_buffer_draw it will use repeat mode except for layers that have point sprite coordinate generation enabled. This is the default value.

Trait Implementations

impl Clone for PipelineWrapMode

fn clone(&self) -> PipelineWrapMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PipelineWrapMode

impl Debug for PipelineWrapMode

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

Formats the value using the given formatter.

impl Display for PipelineWrapMode

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

Formats the value using the given formatter.

impl Eq for PipelineWrapMode

impl Hash for PipelineWrapMode

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

Feeds this value into the given Hasher.

pub 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 PipelineWrapMode

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

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PipelineWrapMode> for PipelineWrapMode

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

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

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

This method tests for !=.

impl PartialOrd<PipelineWrapMode> for PipelineWrapMode

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

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

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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 PipelineWrapMode

impl StructuralPartialEq for PipelineWrapMode