API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classImageLayer

@codexo/exojs-tilemap / tilemap / stable

A data-only image layer: a single image (texture + resolved URL) placed as a background or foreground layer. The layer itself holds no scene-graph state - it is rendered by an import('./ImageLayerNode').ImageLayerNode, which import('./TileMapNode').TileMapNode and import('./TileMapView').TileMapView generate and interleave with tile layers by the map's combined document order (import('./TileMap').TileMap.renderableLayers). Parallax, opacity, tint, offset, and repeat flags are carried from the source Tiled map.

17
props
0
methods
0
events
Import
import { ImageLayer } from '@codexo/exojs-tilemap'

A data-only image layer: a single image (texture + resolved URL) placed as a background or foreground layer. The layer itself holds no scene-graph state - it is rendered by an import('./ImageLayerNode').ImageLayerNode, which import('./TileMapNode').TileMapNode and import('./TileMapView').TileMapView generate and interleave with tile layers by the map's combined document order (import('./TileMap').TileMap.renderableLayers).

Parallax, opacity, tint, offset, and repeat flags are carried from the source Tiled map.

Constructors1
new(options: ImageLayerOptionsConstruction options for an ImageLayer.): ImageLayer
Properties17
class: string
Layer class string.
id: number
Layer id (unique within the map).
image: string
Resolved URL of the layer image.
kind: "image"
Layer-kind discriminant.
name: string
Layer name.
offsetX: number
Layer pixel offset X.
offsetY: number
Layer pixel offset Y.
opacity: number
Layer opacity in [0, 1].
parallaxScale: number
Uniform scale applied around the layer origin during parallax rendering.
parallaxX: number
Horizontal parallax factor.
parallaxY: number
Vertical parallax factor.
properties: TilePropertiesAn immutable, flat key-value bag of generic tile properties. Adapters copy and freeze source properties; the runtime never retains a caller-owned mutable objec…
Immutable layer properties.
repeatX: boolean
Whether the image repeats horizontally.
repeatY: boolean
Whether the image repeats vertically.
texture: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (… | null
Loaded texture for the image, or null if unavailable.
tintColor: null | number
Tint colour as 0xRRGGBB, or null.
visible: boolean
Whether the layer is visible.
Source
packages/exojs-tilemap/src/ImageLayer.ts