API Docs for: 1.0.1

Grape.SpriteVisualizer Class

Extends
Defined in: js\grape\etc\sprite-visualizer.js:2

Visualizes a sprite. If no sprite is set, draws a question mark to indicate the error.

Constructor

Grape.SpriteVisualizer

(
  • [opts]
)

Defined in js\grape\etc\sprite-visualizer.js:2

Parameters:

  • [opts] Object optional

    Initial values of properties

Item Index

Methods

Properties

Methods

visualize

(
  • ctx
)

Inherited from Grape.Visualizer: js\grape\etc\visualizer.js:48

This abstract method is called each render frame if visible is set to true.

Parameters:

  • ctx CanvasRenderingContext2D

    The rendering context

Properties

alpha

Number

Inherited from Grape.Visualizer: js\grape\etc\visualizer.js:17

The alpha value set before calling the visualize method

Default: 1

sprite

Grape.Sprite

Defined in js\grape\etc\sprite-visualizer.js:22

The sprite

subimage

Number

Defined in js\grape\etc\sprite-visualizer.js:13

The image index of the sprite to show

Default: 0

visible

Number

Inherited from Grape.Visualizer: js\grape\etc\visualizer.js:29

If set false, the visualize method is not called.

Default: true