Struct Frame 

pub struct Frame { /* private fields */ }

The part of a texture a draw samples.

The part a frame covers is its window; a draw samples through it. The whole texture by default; Sheet::cell and Frame::rect select a part of one.

Implementations

impl Frame

pub fn rect(min: Vec2, max: Vec2) -> Self

The part between min and max, in 0..1 texture coordinates.

A window past those coordinates repeats the texture: a max.x of 3.0 lays three copies of it across the draw.

Examples found in repository

examples/sprite-adventure.rs (line 924)

fn masonry(tiles: f32) -> Frame {
    let course = 1.0 / STONE_ROWS as f32;

    Frame::rect(Vec2::new(0.0, 1.0 - course), Vec2::new(tiles, 1.0))
}

/// The wall or door's alpha `fraction` of the way from [`SOLID`] to
/// [`GHOST_ALPHA`].
fn ghost_alpha(fraction: f32) -> f32 {
    SOLID + (GHOST_ALPHA - SOLID) * fraction
}

/// The wall face in column `variant`, windowed to the meters `standing` of
/// one course, measured up from that course's own base: every row of the
/// cave sheet below the floor's covers [`WALL_HEIGHT`], so a course keeps
/// the floor's texels to the meter however it is cut.
fn cave_wall_face(variant: u32, standing: Range<f32>) -> Frame {
    let cell = Vec2::new(1.0 / CAVE_COLUMNS as f32, 1.0 / CAVE_ROWS as f32);
    let left = (variant % CAVE_COLUMNS) as f32 * cell.x;
    let face = (CAVE_FLOOR_ROW + 1) as f32 * cell.y;
    let up_from_base = |height: f32| 1.0 - (1.0 - face) * (height / WALL_HEIGHT);

    Frame::rect(
        Vec2::new(left, up_from_base(standing.end)),
        Vec2::new(left + cell.x, up_from_base(standing.start)),
    )
}

pub fn mirrored(self) -> Self

The same window with its x edges the other way round, so what a draw samples through it is mirrored.

Examples found in repository

examples/isometric-board.rs (line 719)

fn sprite_frame(facing_right: bool) -> Frame {
    let cell = Sheet::new(UVec2::new(SPRITE_COLUMNS, SPRITE_ROWS))
        .cell_at(UVec2::new(SPRITE_COLUMN, SPRITE_ROW));
    if facing_right { cell } else { cell.mirrored() }
}

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

The whole texture.

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame