Skip to main content

MapLayer

Struct MapLayer 

Source
pub struct MapLayer {
    pub tilemap: Tilemap,
    pub visible: bool,
    pub opacity: f32,
    pub scroll_factor: (f32, f32),
    pub blend_mode: BlendMode,
    pub z_index: i32,
    pub no_animation: bool,
    pub level: i32,
}
Expand description

A single layer in the map rendering stack.

Each layer owns a Tilemap and carries display properties that control how it is positioned and blended relative to other layers.

Fields§

§tilemap: Tilemap

The tilemap data for this layer.

§visible: bool

Whether this layer should be drawn. Invisible layers are skipped entirely during compositing.

§opacity: f32

Global opacity: 0.0 = fully transparent, 1.0 = fully opaque.

§scroll_factor: (f32, f32)

Parallax scroll factor.

(1.0, 1.0) means the layer scrolls at the same rate as the camera. (0.5, 0.5) means the layer scrolls at half the camera speed (distant background), and (2.0, 2.0) means it scrolls faster (foreground).

§blend_mode: BlendMode

How this layer blends with layers rendered below it.

§z_index: i32

Sort order. Lower values are rendered first (behind).

§no_animation: bool

When true, the layer’s content does not animate frame-to-frame. Renderers may cache pre-rendered tiles for performance.

§level: i32

Elevation level this layer belongs to (0 = ground, the default). Multi-level maps split rendering at the player’s elevation: layers with level <= player_elevation render below sprites, layers above render over them.

Implementations§

Source§

impl MapLayer

Source

pub fn new(tilemap: Tilemap, z_index: i32) -> Self

Create a new layer with sensible defaults.

  • tilemap – the tile data for this layer.
  • z_index – render order (lower = behind).

Trait Implementations§

Source§

impl Clone for MapLayer

Source§

fn clone(&self) -> MapLayer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MapLayer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.