Skip to main content

Class: Sprite

Defined in: rendering/sprite.ts:39

The Sprite class represents a sprite in the rendering system.

Constructors

Constructor

new Sprite(options): Sprite

Defined in: rendering/sprite.ts:62

Constructs a new instance of the Sprite class.

Parameters

options

SpriteOptions

The options for creating the sprite.

Returns

Sprite

Properties

bleed

bleed: number

Defined in: rendering/sprite.ts:44

The bleed value applied to the sprite.


height

height: number

Defined in: rendering/sprite.ts:50

The height of the sprite, including the bleed value.


pivot

pivot: Vector2

Defined in: rendering/sprite.ts:53

The pivot point of the sprite.


renderable

readonly renderable: Renderable

Defined in: rendering/sprite.ts:56

The sprite material used for rendering.


renderLayer

renderLayer: ForgeRenderLayer

Defined in: rendering/sprite.ts:41

The render layer to which the sprite belongs.


width

width: number

Defined in: rendering/sprite.ts:47

The width of the sprite, including the bleed value.