API Docs for: 0.0.2
Show:

Atlantis.RenderTarget Class

Defined in: Framework\Graphics\RenderTarget.js:10
Module: Framework
Parent Module: Atlantis

A render target is a graphics surface where we can draw

Constructor

Atlantis.RenderTarget

(
  • width
  • height
  • (optional)
  • (optional)
)

Defined in Framework\Graphics\RenderTarget.js:10

Parameters:

  • width Number

    Desired width.

  • height Number

    Desired height.

  • (optional) Boolean

    is3D Define if the surface is a 3D surface (WebGL)

  • (optional) HTMLCanvas

    A canvas to use with this renderTarget

Methods

getData

() Object

Defined in Framework\Graphics\RenderTarget.js:52

Gets the image data of the canvas.

Returns:

Object:

Return the ImageData of the context.

setData

(
  • imageData
)

Defined in Framework\Graphics\RenderTarget.js:43

Set the image data of the canvas.

Parameters:

  • imageData Object

    Data to put in the canvas.

() CanvasContext

Defined in Framework\Graphics\RenderTarget.js:62

Get the context of the canvas used to draw.

Returns:

CanvasContext:

Return the canvas context.

clear

()

Defined in Framework\Graphics\RenderTarget.js:109

Clear the entire surface

getCanvas

() HTMLCanvas

Defined in Framework\Graphics\RenderTarget.js:71

Gets the canvas used to draw.

Returns:

HTMLCanvas:

Return the canvas used to draw.

getHeight

() Number

Defined in Framework\Graphics\RenderTarget.js:89

Gets the height of the drawing surface.

Returns:

Number:

Return the height of the drawing surface.

getWidth

() Number

Defined in Framework\Graphics\RenderTarget.js:80

Gets the width of the drawing surface.

Returns:

Number:

Return the width of the drawing surface.

saveAsJpg

() String

Defined in Framework\Graphics\RenderTarget.js:134

Save the content of the renderTarget to an image

Returns:

String:

Return a base64 of the image with mime type "image/jpg"

saveAsPng

() String

Defined in Framework\Graphics\RenderTarget.js:125

Save the content of the renderTarget to an image

Returns:

String:

Return a base64 of the image with mime type "image/png"

setSize

(
  • width
  • height
)

Defined in Framework\Graphics\RenderTarget.js:98

Change the size of the drawing surface.

Parameters: