Navigation
These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. VideoTexture

new VideoTexture(source, scaleMode)

A texture of a [playing] Video.

See the "deus" demo.

Parameters
Name Type Description
source HTMLVideoElement

-

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Source code: pixi/textures/VideoTexture.js, line 1

Extends

Public Properties

[readonly] hasLoaded : boolean

[read-only] Set to true once the base texture has loaded

Inherited From
Source code: pixi/textures/BaseTexture.js, line 55

[readonly] height : number

[read-only] The height of the base texture set when the image has loaded

Inherited From
Source code: pixi/textures/BaseTexture.js, line 37

imageUrl : string

Inherited From
Source code: pixi/textures/BaseTexture.js, line 141

mipmap : boolean

Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work

Inherited From
Source code: pixi/textures/BaseTexture.js, line 92

premultipliedAlpha : boolean

Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)

Inherited From
Default Value
  • true
Source code: pixi/textures/BaseTexture.js, line 74

resolution : number

The Resolution of the texture.

Inherited From
Source code: pixi/textures/BaseTexture.js, line 20

scaleMode : number

The scale mode to apply when scaling this texture

Inherited From
Default Value
  • PIXI.scaleModes.LINEAR
Source code: pixi/textures/BaseTexture.js, line 46

source :Image

The image source that is used to create the texture.

Inherited From
Source code: pixi/textures/BaseTexture.js, line 64

[readonly] width : number

[read-only] The width of the base texture set when the image has loaded

Inherited From
Source code: pixi/textures/BaseTexture.js, line 28

Public Methods

<static> baseTextureFromVideo(video, scaleMode) → {PIXI.VideoTexture}

Mimic Pixi BaseTexture.from.... method.

Parameters
Name Type Description
video HTMLVideoElement

-

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns
Source code: pixi/textures/VideoTexture.js, line 110

<static> fromUrl(videoSrc, scaleMode) → {PIXI.VideoTexture}

Mimic Pixi BaseTexture.from.... method.

Parameters
Name Type Description
videoSrc String

The URL for the video.

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns
Source code: pixi/textures/VideoTexture.js, line 152

<static> textureFromVideo(video, scaleMode) → {PIXI.Texture}

Mimic Pixi BaseTexture.from.... method.

Parameters
Name Type Description
video HTMLVideoElement

-

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns

A Texture, but not a VideoTexture.

Source code: pixi/textures/VideoTexture.js, line 137

destroy()

Destroys this base texture

Inherited From
Source code: pixi/textures/BaseTexture.js, line 160

dirty()

Sets all glTextures to be dirty.

Inherited From
Source code: pixi/textures/BaseTexture.js, line 196

unloadFromGPU()

Removes the base texture from the GPU, useful for managing resources on the GPU. Atexture is still 100% usable and will simply be reuploaded if there is a sprite on screen that is using it.

Inherited From
Source code: pixi/textures/BaseTexture.js, line 209

updateSourceImage(newSrc)

Changes the source image of the texture

Parameters
Name Type Description
newSrc String

the path of the image

Inherited From
Source code: pixi/textures/BaseTexture.js, line 183