Struct TileMapRenderContext 

pub struct TileMapRenderContext<'a, 'b> {
    pub context: &'a mut RenderContext<'b>,
    /* private fields */
}

Context for rendering tiles in a tile map. It is especially used by TileMapEffect objects.

Fields

context: &'a mut RenderContext<'b>

The underlying render context that tiles will be rendered into.

Implementations

impl TileMapRenderContext<'_, '_>

pub fn transform(&self) -> &Matrix4<f32>

The transformation to apply before rendering

pub fn tile_map_handle(&self) -> Handle<Node>

The handle of the TileMap node

pub fn position(&self) -> Vector3<f32>

The global position of the TileMap

pub fn visible_bounds(&self) -> OptionTileRect

The area of tiles that are touching the frustum

pub fn set_tile_visible(&mut self, position: Vector2<i32>, is_visible: bool)

Set a position to false in order to prevent later effects from rendering a tile at this position. All positions are true by default. Normally, once a tile has been rendered at a position, the position should be set to false to prevent a second tile from being rendered at the same position.

pub fn is_tile_visible(&self, position: Vector2<i32>) -> bool

True if tiles should be rendered at that position. Normally this should always be checked before rendering a tile to prevent the rendering from conflicting with some previous effect that has set the position to false.

pub fn get_animated_version( &self, handle: TileDefinitionHandle, ) -> TileDefinitionHandle

The handle of the tile that should be rendered at the current time in order to animate the tile at the given handle.

pub fn draw_tile( &mut self, position: Vector2<i32>, handle: TileDefinitionHandle, )

Render the tile with the given handle at the given position. Normally TileMapRenderContext::is_tile_visible should be checked before calling this method to ensure that tiles are permitted to be rendered at this position, and then TileMapRenderContext::set_tile_visible should be used to set the position to false to prevent any future effects from rendering at this position.

pub fn push_tile(&mut self, position: Vector2<i32>, data: &TileRenderData)

Render the given tile data at the given cell position. This makes it possible to render a tile that is not in the tile map’s tile set.