Namespace: Textures

Type Definitions

---

PixelConfig

An object containing the position and color data for a single pixel in a CanvasTexture.

Type:

• object

Properties:

Name	Type	Description
x	number	The x-coordinate of the pixel.
y	number	The y-coordinate of the pixel.
color	number	The color of the pixel, not including the alpha channel.
alpha	number	The alpha of the pixel, between 0 and 1.

Since: 3.16.0

Source: src/textures/typedefs/PixelConfig.js (Line 1)

---

SpriteSheetConfig

Type:

• object

Properties:

Name	Type	Argument	Default	Description
frameWidth	number			The fixed width of each frame.
frameHeight	number	<optional>		The fixed height of each frame. If not set it will use the frameWidth as the height.
startFrame	number	<optional>	0	Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.
endFrame	number	<optional>	-1	The total number of frames to extract from the Sprite Sheet. The default value of -1 means "extract all frames".
margin	number	<optional>	0	If the frames have been drawn with a margin, specify the amount here.
spacing	number	<optional>	0	If the frames have been drawn with spacing between them, specify the amount here.

Since: 3.0.0

Source: src/textures/typedefs/SpriteSheetConfig.js (Line 1)

---

SpriteSheetFromAtlasConfig

Type:

• object

Properties:

Name	Type	Argument	Default	Description
atlas	string			The key of the Texture Atlas in which this Sprite Sheet can be found.
frame	string			The key of the Texture Atlas Frame in which this Sprite Sheet can be found.
frameWidth	number			The fixed width of each frame.
frameHeight	number	<optional>		The fixed height of each frame. If not set it will use the frameWidth as the height.
startFrame	number	<optional>	0	Skip a number of frames. Useful when there are multiple sprite sheets in one Texture.
endFrame	number	<optional>	-1	The total number of frames to extract from the Sprite Sheet. The default value of -1 means "extract all frames".
margin	number	<optional>	0	If the frames have been drawn with a margin, specify the amount here.
spacing	number	<optional>	0	If the frames have been drawn with spacing between them, specify the amount here.

Since: 3.0.0

Source: src/textures/typedefs/SpriteSheetFromAtlasConfig.js (Line 1)