Class: Frame

Members

bottom : number

The bottom of the frame (y + height).

Type:

• number

Source:

src/animation/Frame.js line 126

centerX : number

Center X position within the image to cut from.

Type:

• number

Source:

src/animation/Frame.js line 60

centerY : number

Center Y position within the image to cut from.

Type:

• number

Source:

src/animation/Frame.js line 65

distance : number

The distance from the top left to the bottom-right of this Frame.

Type:

• number

Source:

src/animation/Frame.js line 70

height : number

Height of the frame.

Type:

• number

Source:

src/animation/Frame.js line 45

index : number

The index of this Frame within the FrameData set it is being added to.

Type:

• number

Source:

src/animation/Frame.js line 25

name : string

Useful for Texture Atlas files (is set to the filename value).

Type:

• string

Source:

src/animation/Frame.js line 55

right : number

The right of the Frame (x + width).

Type:

• number

Source:

src/animation/Frame.js line 121

rotated : boolean

Is the frame rotated in the source texture?

Type:

• boolean

Source:

src/animation/Frame.js line 76

sourceSizeH : number

Height of the original sprite before it was trimmed.

Type:

• number

Source:

src/animation/Frame.js line 92

sourceSizeW : number

Width of the original sprite before it was trimmed.

Type:

• number

Source:

src/animation/Frame.js line 87

spriteSourceSizeH : number

Height of the trimmed sprite.

Type:

• number

Source:

src/animation/Frame.js line 116

spriteSourceSizeW : number

Width of the trimmed sprite.

Type:

• number

Source:

src/animation/Frame.js line 110

spriteSourceSizeX : number

X position of the trimmed sprite inside original sprite.

Type:

• number

Source:

src/animation/Frame.js line 98

spriteSourceSizeY : number

Y position of the trimmed sprite inside original sprite.

Type:

• number

Source:

src/animation/Frame.js line 104

trimmed : boolean

Was it trimmed when packed?

Type:

• boolean

Source:

src/animation/Frame.js line 82

width : number

Width of the frame.

Type:

• number

Source:

src/animation/Frame.js line 40

x : number

X position within the image to cut from.

Type:

• number

Source:

src/animation/Frame.js line 30

y : number

Y position within the image to cut from.

Type:

• number

Source:

src/animation/Frame.js line 35

Methods

clone()

Clones this Frame into a new Phaser.Frame object and returns it. Note that all properties are cloned, including the name and index.

Source:

src/animation/Frame.js line 185

Returns:

An exact copy of this Frame object.

Type

Phaser.Frame

getRect( [out])

Returns a Rectangle set to the dimensions of this Frame.

Parameters:

Name	Type	Argument	Description
out	Phaser.Rectangle	<optional>	A rectangle to copy the frame dimensions to.

Source:

src/animation/Frame.js line 209

Returns:

A rectangle.

Type

Phaser.Rectangle

resize(width, height)

Adjusts of all the Frame properties based on the given width and height values.

Parameters:

Name	Type	Description
width	integer	The new width of the Frame.
height	integer	The new height of the Frame.

Source:

src/animation/Frame.js line 132

setTrim(trimmed, actualWidth, actualHeight, destX, destY, destWidth, destHeight)

If the frame was trimmed when added to the Texture Atlas this records the trim and source data.

Parameters:

Name	Type	Description
trimmed	boolean	If this frame was trimmed or not.
actualWidth	number	The width of the frame before being trimmed.
actualHeight	number	The height of the frame before being trimmed.
destX	number	The destination X position of the trimmed frame for display.
destY	number	The destination Y position of the trimmed frame for display.
destWidth	number	The destination width of the trimmed frame for display.
destHeight	number	The destination height of the trimmed frame for display.

Source:

src/animation/Frame.js line 154