Show: Inherited Protected Private Deprecated

Atlantis.SpriteBatch Class

Defined in: Framework\Graphics\SpriteBatch.js:40

Module: Framework
Parent Module: Atlantis

Define a SpriteBatch that is responsible to draw multiple elements on screen on one pass.

Constructor

`Atlantis.SpriteBatch`

(

The

)

Defined in Framework\Graphics\SpriteBatch.js:40

Parameters:

The Atlantis.Graphics.GraphicsDevice

graphics device.

Index
Methods

Item Index

Methods

begin
draw
drawString
drawTexture static
end

Methods

`begin`

(

The
A

)

Defined in Framework\Graphics\SpriteBatch.js:70

Begin the batch operation.

Parameters:

The Atlantis.SpriteSortMode

type of sorting to use (option, default is Immediate).
A Array
transform matrix to apply for all items (optional). The matrix is a 3x3 matrix in a single array.
```
   - [ScaleX, SkewX, SkewY, ScaleY, TranslationX, TranslationY]
```

`draw`

(

The
The
A
A
Rotation
Origin
Scale
An
The

)

Defined in Framework\Graphics\SpriteBatch.js:227

Draw a texture on the screen

Parameters:

The Image

image or canvas to draw.
The Atlantis.Rectangle | Atlantis.Vector2

position or the rectangle of the image.
A Atlantis.Rectangle

source rectangle.
A String

color to apply on the image in hex format.
Rotation Number

of the image.
Origin Atlantis.Vector2

of the image (defaut is 0, 0 on top/left).
Scale Atlantis.Vector2

of the image (default is 1/1);
An Atlantis.SpriteEffect

effect to apply (default is none).
The Number

layer depth (Important when SpriteSortMode is set to BackToFront or FrontToBack).

`drawString`

(

The
The
The
The
Rotation
Origin
Scale
An
The

)

Defined in Framework\Graphics\SpriteBatch.js:262

Draw a string on the screen

Parameters:

The Atlantis.SpriteFont

SpriteFont to use.
The String

string to draw.
The Atlantis.Vector2

position of the string.
The String

color of the string in hex format.
Rotation Number

of the image.
Origin Atlantis.Vector2

of the image (defaut is 0, 0 on top/left).
Scale Atlantis.Vector2

of the image (default is 1/1);
An Atlantis.SpriteEffect

effect to apply (default is none).
The Number

layer depth (Important when SpriteSortMode is set to BackToFront or FrontToBack).

`drawTexture`

(

The
The
x
y
width
height
A

)

static

Defined in Framework\Graphics\SpriteBatch.js:206

Draw a texture on the screen

Parameters:

The CanvasContext

canvas context.
The Image

image or canvas to draw.
x Number

coordinate.
y Number

coordinate.
width Number

of the image.
height Number

of the image.
A Atlantis.Rectangle

source rectangle.

`end`

()

Defined in Framework\Graphics\SpriteBatch.js:111

Execute the batch process and draw the result in the screen.