Class SpriteRenderer

The SpriteRenderer component renders 2D images (sprites) to the screen.
It supports features like image slicing, scaling, rotation, flipping, opacity, color masking and tinting.
Images can be rendered with custom dimensions, positioned with offsets, and even tiled across an area.
The component allows control over pixel smoothing and can be assigned to specific render layers.

Example

const spriteRenderer = new SpriteRenderer({
  image: this.assetManager.getImage("image.png"),
  width: 1920,
  height: 1080,
  offset: new Vector2(0, 0),
  flipHorizontally: false,
  flipVertically: false,
  rotation: 0,
  opacity: 1,
  maskColor: "#FF0000",
  maskColorMix: 0,
  tintColor: "#00FF00",
  layer: "Default",
  slice: {x: 0, y: 0, width: 1920, height: 1080},
  scale: new Vector2(1, 1),
  tiled: new Vector2(1, 1),
  smooth: false
});
Copy