A Dynamic Texture is a special texture that allows you to draw textures, frames and most kind of Game Objects directly to it.

You can take many complex objects and draw them to this one texture, which can then be used as the base texture for other Game Objects, such as Sprites. Should you then update this texture, all Game Objects using it will instantly be updated as well, reflecting the changes immediately.

It's a powerful way to generate dynamic textures at run-time that are WebGL friendly and don't invoke expensive GPU uploads on each change.

Copyconst t = this.textures.addDynamicTexture('player', 64, 128);
// draw objects to t
this.add.sprite(x, y, 'player');

Because this is a standard Texture within Phaser, you can add frames to it, meaning you can use it to generate sprite sheets, texture atlases or tile sets.

Under WebGL1, a FrameBuffer, which is what this Dynamic Texture uses internally, cannot be anti-aliased. This means that when drawing objects such as Shapes or Graphics instances to this texture, they may appear to be drawn with no aliasing around the edges. This is a technical limitation of WebGL1. To get around it, create your shape as a texture in an art package, then draw that to this texture.

Based on the assumption that you will be using this Dynamic Texture as a source for Sprites, it will automatically invert any drawing done to it on the y axis. If you do not require this, please call the setIsSpriteTexture() method and pass it false as its parameter. Do this before you start drawing to this texture, otherwise you will get vertically inverted frames under WebGL. This isn't required for Canvas.

Constructor

new DynamicTexture(manager, key, [width], [height])

Parameters

---

Scope: static

Extends

Phaser.Textures.Texture

Source: src/textures/DynamicTexture.js#L19
Since: 3.60.0

Public Members

camera

camera: Phaser.Cameras.Scene2D.Camera

Description:

An internal Camera that can be used to move around this Dynamic Texture.

Control it just like you would any Scene Camera. The difference is that it only impacts the placement of Game Objects (not textures) that you then draw to this texture.

You can scroll, zoom and rotate this Camera.

Source: src/textures/DynamicTexture.js#L191
Since: 3.12.0

---

canvas

canvas: HTMLCanvasElement

Description:

A reference to the Rendering Context belonging to the Canvas Element this Dynamic Texture is drawing to.

Source: src/textures/DynamicTexture.js#L135
Since: 3.2.0

---

context

context: CanvasRenderingContext2D

Description:

The 2D Canvas Rendering Context.

Source: src/textures/DynamicTexture.js#L144
Since: 3.7.0

---

customData

customData: object

Description:

Any additional data that was set in the source JSON (if any), or any extra data you'd like to store relating to this texture

Inherits: Phaser.Textures.Texture#customData

Source: src/textures/Texture.js#L97
Since: 3.0.0

---

dataSource

dataSource: array

Description:

An array of TextureSource data instances. Used to store additional data images, such as normal maps or specular maps.

Inherits: Phaser.Textures.Texture#dataSource

Source: src/textures/Texture.js#L78
Since: 3.0.0

---

dirty

dirty: boolean

Description:

Is this Dynamic Texture dirty or not? If not it won't spend time clearing or filling itself.

Source: src/textures/DynamicTexture.js#L154
Since: 3.12.0

---

firstFrame

firstFrame: string

Description:

The name of the first frame of the Texture.

Inherits: Phaser.Textures.Texture#firstFrame

Source: src/textures/Texture.js#L107
Since: 3.0.0

---

frames

frames: object

Description:

A key-value object pair associating the unique Frame keys with the Frames objects.

Inherits: Phaser.Textures.Texture#frames

Source: src/textures/Texture.js#L88
Since: 3.0.0

---

frameTotal

frameTotal: number

Description:

The total number of Frames in this Texture, including the __BASE frame.

A Texture will always contain at least 1 frame because every Texture contains a __BASE frame by default, in addition to any extra frames that have been added to it, such as when parsing a Sprite Sheet or Texture Atlas.

Inherits: Phaser.Textures.Texture#frameTotal

Source: src/textures/Texture.js#L116
Since: 3.0.0

---

height

height: number

Description:

The height of this Dynamic Texture.

Treat this property as read-only. Use the setSize method to change the size.

Source: src/textures/DynamicTexture.js#L113
Since: 3.60.0

---

isDrawing

isDrawing: boolean

Description:

This flag is set to 'true' during beginDraw and reset to 'falseinendDraw`, allowing you to determine if this Dynamic Texture is batch drawing, or not.

Source: src/textures/DynamicTexture.js#L124
Since: 3.60.0

---

isSpriteTexture

isSpriteTexture: boolean

Description:

Is this Dynamic Texture being used as the base texture for a Sprite Game Object?

This is enabled by default, as we expect that will be the core use for Dynamic Textures.

However, to disable it, call RenderTexture.setIsSpriteTexture(false).

You should do this before drawing to this texture, so that it correctly inverses the frames for WebGL rendering. Not doing so will result in vertically flipped frames.

This property is used in the endDraw method.

Source: src/textures/DynamicTexture.js#L163
Since: 3.60.0

---

key

key: string

Description:

The unique string-based key of this Texture.

Inherits: Phaser.Textures.Texture#key

Source: src/textures/Texture.js#L59
Since: 3.0.0

---

manager

manager: Phaser.Textures.TextureManager

Description:

A reference to the Texture Manager this Texture belongs to.

Inherits: Phaser.Textures.Texture#manager

Source: src/textures/Texture.js#L50
Since: 3.0.0

---

pipeline

pipeline: Phaser.Renderer.WebGL.Pipelines.SinglePipeline

Description:

A reference to the WebGL Single Pipeline.

This property remains null under Canvas.

Source: src/textures/DynamicTexture.js#L218
Since: 3.60.0

---

renderer

renderer: Phaser.Renderer.Canvas.CanvasRenderer, Phaser.Renderer.WebGL.WebGLRenderer

Description:

A reference to either the Canvas or WebGL Renderer that the Game instance is using.

Source: src/textures/DynamicTexture.js#L93
Since: 3.2.0

---

renderTarget

renderTarget: Phaser.Renderer.WebGL.RenderTarget

Description:

The Render Target that belongs to this Dynamic Texture.

A Render Target encapsulates a framebuffer and texture for the WebGL Renderer.

This property remains null under Canvas.

Source: src/textures/DynamicTexture.js#L205
Since: 3.60.0

---

source

source: Array.<Phaser.Textures.TextureSource>

Description:

An array of TextureSource instances. These are unique to this Texture and contain the actual Image (or Canvas) data.

Inherits: Phaser.Textures.Texture#source

Source: src/textures/Texture.js#L68
Since: 3.0.0

---

type

type: string

Description:

The internal data type of this object.

Source: src/textures/DynamicTexture.js#L73
Since: 3.60.0

---

width

width: number

Description:

The width of this Dynamic Texture.

Treat this property as read-only. Use the setSize method to change the size.

Source: src/textures/DynamicTexture.js#L102
Since: 3.60.0

---

Private Members

_eraseMode

_eraseMode: boolean

Description:

Internal erase mode flag.

Access: private

Source: src/textures/DynamicTexture.js#L181
Since: 3.16.0

---

Public Methods

add

<instance> add(name, sourceIndex, x, y, width, height)

Description:

Adds a new Frame to this Texture.

A Frame is a rectangular region of a TextureSource with a unique index or string-based key.

The name given must be unique within this Texture. If it already exists, this method will return null.

Parameters:

Returns: Phaser.Textures.Frame - The Frame that was added to this Texture, or null if the given name already exists.

Inherits: Phaser.Textures.Texture#add

Source: src/textures/Texture.js#L136
Since: 3.0.0

---

batchDraw

<instance> batchDraw(entries, [x], [y], [alpha], [tint])

Description:

Use this method if you have already called beginDraw and need to batch draw a large number of objects to this Dynamic Texture.

This method batches the drawing of the given objects to this texture, without causing a WebGL bind or batch flush for each one.

It is faster than calling draw, but you must be careful to manage the flow of code and remember to call endDraw(). If you don't need to draw large numbers of objects it's much safer and easier to use the draw method instead.

The flow should be:

Copy// Call once:
DynamicTexture.beginDraw();

// repeat n times:
DynamicTexture.batchDraw();
// or
DynamicTexture.batchDrawFrame();

// Call once:
DynamicTexture.endDraw();

Do not call any methods other than batchDraw, batchDrawFrame, or endDraw once you have started a batch. Also, be very careful not to destroy this Dynamic Texture while the batch is still open. Doing so will cause a run-time error in the WebGL Renderer.

You can use the DynamicTexture.isDrawing boolean property to tell if a batch is currently open, or not.

This method can accept any of the following:

• Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.
• Tilemap Layers.
• A Group. The contents of which will be iterated and drawn in turn.
• A Container. The contents of which will be iterated fully, and drawn in turn.
• A Scene's Display List. Pass in Scene.children to draw the whole list.
• Another Dynamic Texture or Render Texture.
• A Texture Frame instance.
• A string. This is used to look-up a texture from the Texture Manager.

Note: You cannot draw a Dynamic Texture to itself.

If passing in a Group or Container it will only draw children that return true when their willRender() method is called. I.e. a Container with 10 children, 5 of which have visible=false will only draw the 5 visible ones.

If passing in an array of Game Objects it will draw them all, regardless if they pass a willRender check or not.

You can pass in a string in which case it will look for a texture in the Texture Manager matching that string, and draw the base frame. If you need to specify exactly which frame to draw then use the method drawFrame instead.

You can pass in the x and y coordinates to draw the objects at. The use of the coordinates differ based on what objects are being drawn. If the object is a Group, Container or Display List, the coordinates are added to the positions of the children. For all other types of object, the coordinates are exact.

The alpha and tint values are only used by Texture Frames. Game Objects use their own alpha and tint values when being drawn.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L987
Since: 3.50.0

---

batchDrawFrame

<instance> batchDrawFrame(key, [frame], [x], [y], [alpha], [tint])

Description:

Use this method if you have already called beginDraw and need to batch draw a large number of texture frames to this Dynamic Texture.

This method batches the drawing of the given frames to this Dynamic Texture, without causing a WebGL bind or batch flush for each one.

It is faster than calling drawFrame, but you must be careful to manage the flow of code and remember to call endDraw(). If you don't need to draw large numbers of frames it's much safer and easier to use the drawFrame method instead.

The flow should be:

Copy// Call once:
DynamicTexture.beginDraw();

// repeat n times:
DynamicTexture.batchDraw();
// or
DynamicTexture.batchDrawFrame();

// Call once:
DynamicTexture.endDraw();

Do not call any methods other than batchDraw, batchDrawFrame, or endDraw once you have started a batch. Also, be very careful not to destroy this Dynamic Texture while the batch is still open. Doing so will cause a run-time error in the WebGL Renderer.

You can use the DynamicTexture.isDrawing boolean property to tell if a batch is currently open, or not.

Textures are referenced by their string-based keys, as stored in the Texture Manager.

You can optionally provide a position, alpha and tint value to apply to the frame before it is drawn.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L1075
Since: 3.50.0

---

beginDraw

<instance> beginDraw()

Description:

Use this method if you need to batch draw a large number of Game Objects to this Dynamic Texture in a single pass, or on a frequent basis. This is especially useful under WebGL, however, if your game is using Canvas only, it will not make any speed difference in that situation.

This method starts the beginning of a batched draw, unless one is already open.

Batched drawing is faster than calling draw in loop, but you must be careful to manage the flow of code and remember to call endDraw() when you're finished.

If you don't need to draw large numbers of objects it's much safer and easier to use the draw method instead.

The flow should be:

Copy// Call once:
DynamicTexture.beginDraw();

// repeat n times:
DynamicTexture.batchDraw();
// or
DynamicTexture.batchDrawFrame();

// Call once:
DynamicTexture.endDraw();

Do not call any methods other than batchDraw, batchDrawFrame, or endDraw once you have started a batch. Also, be very careful not to destroy this Dynamic Texture while the batch is still open. Doing so will cause a run-time error in the WebGL Renderer.

You can use the DynamicTexture.isDrawing boolean property to tell if a batch is currently open, or not.

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L921
Since: 3.50.0

---

clear

<instance> clear([x], [y], [width], [height])

Description:

Clears a portion or everything from this Dynamic Texture by erasing it and resetting it back to a blank, transparent, texture. To clear an area, specify the x, y, width and height.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L433
Since: 3.2.0

---

destroy

<instance> destroy()

Description:

Destroys this Texture and releases references to its sources and frames.

Overrides: Phaser.Textures.Texture#destroy

Source: src/textures/DynamicTexture.js#L1610
Since: 3.60.0

---

draw

<instance> draw(entries, [x], [y], [alpha], [tint])

Description:

Draws the given object, or an array of objects, to this Dynamic Texture.

It can accept any of the following:

• Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.
• Tilemap Layers.
• A Group. The contents of which will be iterated and drawn in turn.
• A Container. The contents of which will be iterated fully, and drawn in turn.
• A Scene Display List. Pass in Scene.children to draw the whole list.
• Another Dynamic Texture, or a Render Texture.
• A Texture Frame instance.
• A string. This is used to look-up the texture from the Texture Manager.

Note 1: You cannot draw a Dynamic Texture to itself.

Note 2: For Game Objects that have Post FX Pipelines, the pipeline cannot be used when drawn to this texture.

If passing in a Group or Container it will only draw children that return true when their willRender() method is called. I.e. a Container with 10 children, 5 of which have visible=false will only draw the 5 visible ones.

If passing in an array of Game Objects it will draw them all, regardless if they pass a willRender check or not.

You can pass in a string in which case it will look for a texture in the Texture Manager matching that string, and draw the base frame. If you need to specify exactly which frame to draw then use the method drawFrame instead.

You can pass in the x and y coordinates to draw the objects at. The use of the coordinates differ based on what objects are being drawn. If the object is a Group, Container or Display List, the coordinates are added to the positions of the children. For all other types of object, the coordinates are exact.

The alpha and tint values are only used by Texture Frames. Game Objects use their own alpha and tint values when being drawn.

Calling this method causes the WebGL batch to flush, so it can write the texture data to the framebuffer being used internally. The batch is flushed at the end, after the entries have been iterated. So if you've a bunch of objects to draw, try and pass them in an array in one single call, rather than making lots of separate calls.

If you are not planning on using this Dynamic Texture as a base texture for Sprite Game Objects, then you should set DynamicTexture.isSpriteTexture = false before calling this method, otherwise you will get vertically inverted frames in WebGL.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L621
Since: 3.2.0

---

drawFrame

<instance> drawFrame(key, [frame], [x], [y], [alpha], [tint])

Description:

Draws the Texture Frame to the Render Texture at the given position.

Textures are referenced by their string-based keys, as stored in the Texture Manager.

Copyvar rt = this.add.renderTexture(0, 0, 800, 600);
rt.drawFrame(key, frame);

You can optionally provide a position, alpha and tint value to apply to the frame before it is drawn.

Calling this method will cause a batch flush, so if you've got a stack of things to draw in a tight loop, try using the draw method instead.

If you need to draw a Sprite to this Render Texture, use the draw method instead.

If you are not planning on using this Dynamic Texture as a base texture for Sprite Game Objects, then you should set DynamicTexture.isSpriteTexture = false before calling this method, otherwise you will get vertically inverted frames in WebGL.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L689
Since: 3.12.0

---

endDraw

<instance> endDraw([erase])

Description:

Use this method to finish batch drawing to this Dynamic Texture.

Doing so will stop the WebGL Renderer from capturing draws and then blit the framebuffer to the Render Target owned by this texture.

Calling this method without first calling beginDraw will have no effect.

Batch drawing is faster than calling draw, but you must be careful to manage the flow of code and remember to call endDraw() when you're finished.

If you don't need to draw large numbers of objects it's much safer and easier to use the draw method instead.

The flow should be:

Copy// Call once:
DynamicTexture.beginDraw();

// repeat n times:
DynamicTexture.batchDraw();
// or
DynamicTexture.batchDrawFrame();

// Call once:
DynamicTexture.endDraw();

Do not call any methods other than batchDraw, batchDrawFrame, or endDraw once you have started a batch. Also, be very careful not to destroy this Dynamic Texture while the batch is still open. Doing so will cause a run-time error in the WebGL Renderer.

You can use the DynamicTexture.isDrawing boolean property to tell if a batch is currently open, or not.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L1149
Since: 3.50.0

---

erase

<instance> erase(entries, [x], [y])

Description:

Draws the given object, or an array of objects, to this Dynamic Texture using a blend mode of ERASE. This has the effect of erasing any filled pixels present in the objects from this texture.

It can accept any of the following:

• Any renderable Game Object, such as a Sprite, Text, Graphics or TileSprite.
• Tilemap Layers.
• A Group. The contents of which will be iterated and drawn in turn.
• A Container. The contents of which will be iterated fully, and drawn in turn.
• A Scene Display List. Pass in Scene.children to draw the whole list.
• Another Dynamic Texture, or a Render Texture.
• A Texture Frame instance.
• A string. This is used to look-up the texture from the Texture Manager.

Note: You cannot erase a Dynamic Texture from itself.

If passing in a Group or Container it will only draw children that return true when their willRender() method is called. I.e. a Container with 10 children, 5 of which have visible=false will only draw the 5 visible ones.

If passing in an array of Game Objects it will draw them all, regardless if they pass a willRender check or not.

You can pass in a string in which case it will look for a texture in the Texture Manager matching that string, and draw the base frame.

You can pass in the x and y coordinates to draw the objects at. The use of the coordinates differ based on what objects are being drawn. If the object is a Group, Container or Display List, the coordinates are added to the positions of the children. For all other types of object, the coordinates are exact.

Calling this method causes the WebGL batch to flush, so it can write the texture data to the framebuffer being used internally. The batch is flushed at the end, after the entries have been iterated. So if you've a bunch of objects to draw, try and pass them in an array in one single call, rather than making lots of separate calls.

If you are not planning on using this Dynamic Texture as a base texture for Sprite Game Objects, then you should set DynamicTexture.isSpriteTexture = false before calling this method, otherwise you will get vertically inverted frames in WebGL.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L559
Since: 3.16.0

---

fill

<instance> fill(rgb, [alpha], [x], [y], [width], [height])

Description:

Fills this Dynamic Texture with the given color.

By default it will fill the entire texture, however you can set it to fill a specific rectangular area by using the x, y, width and height arguments.

The color should be given in hex format, i.e. 0xff0000 for red, 0x00ff00 for green, etc.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L358
Since: 3.2.0

---

get

<instance> get([name])

Description:

Gets a Frame from this Texture based on either the key or the index of the Frame.

In a Texture Atlas Frames are typically referenced by a key. In a Sprite Sheet Frames are referenced by an index. Passing no value for the name returns the base texture.

Parameters:

Returns: Phaser.Textures.Frame - The Texture Frame.

Inherits: Phaser.Textures.Texture#get

Source: src/textures/Texture.js#L224
Since: 3.0.0

---

getDataSourceImage

<instance> getDataSourceImage([name])

Description:

Given a Frame name, return the data source image it uses to render with. You can use this to get the normal map for an image for example.

This will return the actual DOM Image.

Parameters:

Returns: HTMLImageElement, HTMLCanvasElement - The DOM Image or Canvas Element.

Inherits: Phaser.Textures.Texture#getDataSourceImage

Source: src/textures/Texture.js#L439
Since: 3.7.0

---

getFrameBounds

<instance> getFrameBounds([sourceIndex])

Description:

Based on the given Texture Source Index, this method will get all of the Frames using that source and then work out the bounds that they encompass, returning them in an object.

This is useful if this Texture is, for example, a sprite sheet within an Atlas, and you need to know the total bounds of the sprite sheet.

Parameters:

Returns: Phaser.Types.Math.RectangleLike - An object containing the bounds of the Frames using the given Texture Source Index.

Inherits: Phaser.Textures.Texture#getFrameBounds

Source: src/textures/Texture.js#L319
Since: 3.80.0

---

getFrameNames

<instance> getFrameNames([includeBase])

Description:

Returns an array with all of the names of the Frames in this Texture.

Useful if you want to randomly assign a Frame to a Game Object, as you can pick a random element from the returned array.

Parameters:

Returns: Array.<string> - An array of all Frame names in this Texture.

Inherits: Phaser.Textures.Texture#getFrameNames

Source: src/textures/Texture.js#L374
Since: 3.0.0

---

getFramesFromTextureSource

<instance> getFramesFromTextureSource(sourceIndex, [includeBase])

Description:

Returns an array of all the Frames in the given TextureSource.

Parameters:

Returns: Array.<Phaser.Textures.Frame> - An array of Texture Frames.

Inherits: Phaser.Textures.Texture#getFramesFromTextureSource

Source: src/textures/Texture.js#L284
Since: 3.0.0

---

getSourceImage

<instance> getSourceImage([name])

Description:

Given a Frame name, return the source image it uses to render with.

This will return the actual DOM Image or Canvas element.

Parameters:

Returns: HTMLImageElement, HTMLCanvasElement, Phaser.GameObjects.RenderTexture - The DOM Image, Canvas Element or Render Texture.

Inherits: Phaser.Textures.Texture#getSourceImage

Source: src/textures/Texture.js#L406
Since: 3.0.0

---

getTextureSourceIndex

<instance> getTextureSourceIndex(source)

Description:

Takes the given TextureSource and returns the index of it within this Texture. If it's not in this Texture, it returns -1. Unless this Texture has multiple TextureSources, such as with a multi-atlas, this method will always return zero or -1.

Parameters:

Returns: number - The index of the TextureSource within this Texture, or -1 if not in this Texture.

Inherits: Phaser.Textures.Texture#getTextureSourceIndex

Source: src/textures/Texture.js#L258
Since: 3.0.0

---

getWebGLTexture

<instance> getWebGLTexture()

Description:

Returns the underlying WebGLTextureWrapper, if not running in Canvas mode.

Returns: Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper - The underlying WebGLTextureWrapper, if not running in Canvas mode.

Source: src/textures/DynamicTexture.js#L1558
Since: 3.60.0

---

has

<instance> has(name)

Description:

Checks to see if a Frame matching the given key exists within this Texture.

Parameters:

Returns: boolean - True if a Frame with the matching key exists in this Texture.

Inherits: Phaser.Textures.Texture#has

Source: src/textures/Texture.js#L209
Since: 3.0.0

---

remove

<instance> remove(name)

Description:

Removes the given Frame from this Texture. The Frame is destroyed immediately.

Any Game Objects using this Frame should stop using it before you remove it, as it does not happen automatically.

Parameters:

Returns: boolean - True if a Frame with the matching key was removed from this Texture.

Inherits: Phaser.Textures.Texture#remove

Source: src/textures/Texture.js#L180
Since: 3.19.0

---

renderCanvas

<instance> renderCanvas(renderer, mask, camera)

Description:

This is a NOOP method. Bitmap Masks are not supported by the Canvas Renderer.

Parameters:

Source: src/textures/DynamicTexture.js#L1595
Since: 3.60.0

---

renderWebGL

<instance> renderWebGL(renderer, src, camera, parentMatrix)

Description:

Renders this Dynamic Texture onto the Stamp Game Object as a BitmapMask.

Parameters:

Source: src/textures/DynamicTexture.js#L1574
Since: 3.60.0

---

repeat

<instance> repeat(key, [frame], [x], [y], [width], [height], [alpha], [tint], [skipBatch])

Description:

Takes the given Texture Frame and draws it to this Dynamic Texture as a fill pattern, i.e. in a grid-layout based on the frame dimensions.

Textures are referenced by their string-based keys, as stored in the Texture Manager.

You can optionally provide a position, width, height, alpha and tint value to apply to the frames before they are drawn. The position controls the top-left where the repeating fill will start from. The width and height control the size of the filled area.

The position can be negative if required, but the dimensions cannot.

Calling this method will cause a batch flush by default. Use the skipBatch argument to disable this if this call is part of a larger batch draw.

If you are not planning on using this Dynamic Texture as a base texture for Sprite Game Objects, then you should set DynamicTexture.isSpriteTexture = false before calling this method, otherwise you will get vertically inverted frames in WebGL.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L732
Since: 3.60.0

---

setDataSource

<instance> setDataSource(data)

Description:

Adds a data source image to this Texture.

An example of a data source image would be a normal map, where all of the Frames for this Texture equally apply to the normal map.

Parameters:

Inherits: Phaser.Textures.Texture#setDataSource

Source: src/textures/Texture.js#L476
Since: 3.0.0

---

setFilter

<instance> setFilter(filterMode)

Description:

Sets the Filter Mode for this Texture.

The mode can be either Linear, the default, or Nearest.

For pixel-art you should use Nearest.

The mode applies to the entire Texture, not just a specific Frame of it.

Parameters:

Inherits: Phaser.Textures.Texture#setFilter

Source: src/textures/Texture.js#L502
Since: 3.0.0

---

setFromRenderTarget

<instance> setFromRenderTarget()

Description:

Links the WebGL Textures used by this Dynamic Texture to its Render Target.

This method is called internally by the Dynamic Texture when it is first created, or if you change its size.

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L314
Since: 3.70.0

---

setIsSpriteTexture

<instance> setIsSpriteTexture(value)

Description:

If you are planning on using this Render Texture as a base texture for Sprite Game Objects, then you should call this method with a value of true before drawing anything to it, otherwise you will get inverted frames in WebGL.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L339
Since: 3.60.0

---

setSize

<instance> setSize(width, [height])

Description:

Resizes this Dynamic Texture to the new dimensions given.

In WebGL it will destroy and then re-create the frame buffer being used by this Dynamic Texture. In Canvas it will resize the underlying canvas DOM element.

Both approaches will erase everything currently drawn to this texture.

If the dimensions given are the same as those already being used, calling this method will do nothing.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture.

Source: src/textures/DynamicTexture.js#L232
Since: 3.10.0

---

snapshot

<instance> snapshot(callback, [type], [encoderOptions])

Description:

Takes a snapshot of the whole of this Dynamic Texture.

The snapshot is taken immediately, but the results are returned via the given callback.

To capture a portion of this Dynamic Texture see the snapshotArea method. To capture just a specific pixel, see the snapshotPixel method.

Snapshots work by using the WebGL readPixels feature to grab every pixel from the frame buffer into an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it, which is the image returned to the callback provided.

All in all, this is a computationally expensive and blocking process, which gets more expensive the larger the resolution this Dynamic Texture has, so please be careful how you employ this in your game.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L1503
Since: 3.19.0

---

snapshotArea

<instance> snapshotArea(x, y, width, height, callback, [type], [encoderOptions])

Description:

Takes a snapshot of the given area of this Dynamic Texture.

The snapshot is taken immediately, but the results are returned via the given callback.

To capture the whole Dynamic Texture see the snapshot method. To capture just a specific pixel, see the snapshotPixel method.

Snapshots work by using the WebGL readPixels feature to grab every pixel from the frame buffer into an ArrayBufferView. It then parses this, copying the contents to a temporary Canvas and finally creating an Image object from it, which is the image returned to the callback provided.

All in all, this is a computationally expensive and blocking process, which gets more expensive the larger the resolution this Dynamic Texture has, so please be careful how you employ this in your game.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L1461
Since: 3.19.0

---

snapshotPixel

<instance> snapshotPixel(x, y, callback)

Description:

Takes a snapshot of the given pixel from this Dynamic Texture.

The snapshot is taken immediately, but the results are returned via the given callback.

To capture the whole Dynamic Texture see the snapshot method. To capture a portion of this Dynamic Texture see the snapshotArea method.

Unlike the two other snapshot methods, this one will send your callback a Color object containing the color data for the requested pixel. It doesn't need to create an internal Canvas or Image object, so is a lot faster to execute, using less memory than the other snapshot methods.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L1532
Since: 3.19.0

---

stamp

<instance> stamp(key, [frame], [x], [y], [config])

Description:

Takes the given texture key and frame and then stamps it at the given x and y coordinates. You can use the optional 'config' argument to provide lots more options about how the stamp is applied, including the alpha, tint, angle, scale and origin.

By default, the frame will stamp on the x/y coordinates based on its center.

If you wish to stamp from the top-left, set the config originX and originY properties both to zero.

Parameters:

Returns: Phaser.Textures.DynamicTexture - This Dynamic Texture instance.

Source: src/textures/DynamicTexture.js#L479
Since: 3.60.0

---

Private Methods

batchGameObject

<instance> batchGameObject(gameObject, [x], [y])

Description:

Internal method that handles drawing a single Phaser Game Object to this Dynamic Texture.

Access: private

Parameters:

Source: src/textures/DynamicTexture.js#L1311
Since: 3.12.0

---

batchGroup

<instance> batchGroup(children, [x], [y])

Description:

Internal method that handles drawing the contents of a Phaser Group to this Dynamic Texture.

Access: private

Parameters:

Source: src/textures/DynamicTexture.js#L1284
Since: 3.12.0

---

batchList

<instance> batchList(children, [x], [y], [alpha], [tint])

Description:

Internal method that handles the drawing of an array of children.

Access: private

Parameters:

Source: src/textures/DynamicTexture.js#L1225
Since: 3.12.0

---

batchTextureFrame

<instance> batchTextureFrame(textureFrame, [x], [y], [alpha], [tint])

Description:

Internal method that handles the drawing of a Texture Frame to this Dynamic Texture.

Access: private

Parameters:

Source: src/textures/DynamicTexture.js#L1411
Since: 3.12.0

---

batchTextureFrameKey

<instance> batchTextureFrameKey(key, [frame], [x], [y], [alpha], [tint])

Description:

Internal method that handles the drawing a Texture Frame based on its key.

Access: private

Parameters:

Source: src/textures/DynamicTexture.js#L1387
Since: 3.12.0

---