Documentation generator: JsDoc Toolkit 2.4.0
Template: Codeview 1.2
Generated on: 2013-9-6 21:36

Class jaws.SpriteSheet

Cut out invidual frames (images) from a larger spritesheet-image. "Field Summary" contains options for the SpriteSheet()-constructor.

Class Summary
Constructor Attributes Constructor Name and Description
 
jaws.SpriteSheet(options)
Field Summary
Field Attributes Field Name and Description
 
width and height of invidual frames in spritesheet
 
all single frames cut out from image
 
Image/canvas/canvas
or asset-string to cut up smaller images from
 
vertical or horizontal offset to start cutting from
 
How to cut out invidual images from spritesheet, either "right" or "down"
 
Scale the sprite sheet by this factor before cutting out the frames.

Class Detail

jaws.SpriteSheet(options)
Parameters:
options

Field Detail

{array} frame_size
width and height of invidual frames in spritesheet
{array} frames
all single frames cut out from image
{image|image} Image/canvas
or asset-string to cut up smaller images from
{integer} offset
vertical or horizontal offset to start cutting from
{string} orientation
How to cut out invidual images from spritesheet, either "right" or "down"
{int} scale_image
Scale the sprite sheet by this factor before cutting out the frames. frame_size is automatically re-sized too