new RenderTexture(game, key, width, height)
A RenderTexture is a special texture that allows any displayObject to be rendered to it.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | Current game instance. |
key |
string | Asset key for the render texture. |
width |
number | the width of the render texture. |
height |
number | the height of the render texture. |
- Source:
Members
-
frame
-
- Source:
Properties:
Name Type Description framePIXI.Rectangle The frame for this texture.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
height
-
- Source:
Properties:
Name Type Description heightnumber the height.
-
indetityMatrix
-
- Source:
Properties:
Name Type Description indetityMatrixPIXI.mat3 Matrix object.
-
key
-
- Source:
Properties:
Name Type Description keystring The key of the RenderTexture in the Cache, if stored there.
-
name
-
- Source:
Properties:
Name Type Description namestring the name of the object.
-
type
-
- Source:
Properties:
Name Type Description typenumber Base Phaser object type.
-
type
-
- Source:
Properties:
Name Type Description typenumber Base Phaser object type.
-
width
-
- Source:
Properties:
Name Type Description widthnumber the width.
Methods
-
render(displayObject, position, clear, renderHidden)
-
This function will draw the display object to the texture. If the display object is a Group or has children it will draw all children as well.
Parameters:
Name Type Argument Default Description displayObjectDisplayObject The display object to render this texture on.
positionPhaser.Point <optional>
Where to draw the display object.
clearboolean <optional>
false If true the texture will be cleared before the displayObject is drawn.
renderHiddenboolean <optional>
false If true displayObjects that have their visible property set to false will still be rendered.
- Source:
-
renderXY(displayObject, x, y, clear, renderHidden)
-
This function will draw the display object to the texture at the given x/y coordinates. If the display object is a Group or has children it will draw all children as well.
Parameters:
Name Type Argument Default Description displayObjectDisplayObject The display object to render this texture on.
xnumber The x coordinate to draw the display object at.
ynumber The y coordinate to draw the display object at.
clearboolean <optional>
false If true the texture will be cleared before the displayObject is drawn.
renderHiddenboolean <optional>
false If true displayObjects that have their visible property set to false will still be rendered.
- Source:
-
resize()
-
Resizes the RenderTexture.
- Source: