Enum gemini_engine::elements::view::Wrapping

pub enum Wrapping {
    Wrap,
    Ignore,
    Panic,
}

Wrapping is used to determine how you want to handle out-of-bounds pixels during plotting pixels to the screen. Here’s how each possible value functions:

Variants

Wrap

Wrapping::Wrap wraps any out of bounds pixels around to the other side. This is useful if you have an object that travels the entirety of the screen and appears on the other side when it reaches the end.

Ignore

Wrapping::Ignore simply skips all out-of-bounds pixels. This is useful if you might have an object clipping through the edge of the screen but don’t want it to wrap to the other side like Wrapping::Wrap or panic and end the process like Wrapping::Panic

Panic

Wrapping::Panic will panic! if any pixels are out of bounds. You should use this if you have your own wrapping system implemented

Implementations

impl Wrapping

pub fn handle_bounds(&self, pos: Vec2D, bounds: Vec2D) -> Option<Vec2D>

Handle the position based on the given bounds and the Wrapping variation (See the Wrapping documentation for more info)

Panics

Wrapping::Panic will panic if the position is out of bounds

Trait Implementations

impl Clone for Wrapping

fn clone(&self) -> Wrapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wrapping

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

Formats the value using the given formatter.

impl Copy for Wrapping