PixiJS API Documentation

Class: VideoBaseTexture

PIXI.VideoBaseTexture

A texture of a [playing] Video.

Video base textures mimic PixiJS BaseTexture.from.... method in their creation process.

This can be used in several ways, such as:

let texture = PIXI.VideoBaseTexture.fromUrl('http://mydomain.com/video.mp4');

let texture = PIXI.VideoBaseTexture.fromUrl({ src: 'http://mydomain.com/video.mp4', mime: 'video/mp4' });

let texture = PIXI.VideoBaseTexture.fromUrls(['/video.webm', '/video.mp4']);

let texture = PIXI.VideoBaseTexture.fromUrls([
    { src: '/video.webm', mime: 'video/webm' },
    { src: '/video.mp4', mime: 'video/mp4' }
]);

See the "deus" demo.

new PIXI.VideoBaseTexture (source, scaleMode, autoPlay)

VideoBaseTexture.js:36

Name	Type	Default	Description
`source`	HTMLVideoElement		Video source
`scaleMode`	number	PIXI.settings.SCALE_MODE	optional See PIXI.SCALE_MODES for possible values
`autoPlay`	boolean	true	optional Start playing video as soon as it is loaded

Extends

PIXI.BaseTexture

Members

autoPlay boolean

When set to true will automatically play videos used by this texture once they are loaded. If false, it will not modify the playing state.

Default Value:

true

autoUpdate boolean

Should the base texture automatically update itself, set to true by default

hasLoaded boolean readonly inherited overrides

Set to true once the base texture has successfully loaded.

This is never true if the underlying source fails to load or has no texture data.

height number readonly inherited overrides

The height of the base texture set when the image has loaded

imageType string readonly inherited

Type of image defined in source, eg. png or svg

imageUrl string inherited

The image url of the texture

isLoading boolean readonly inherited

Set to true if the source is currently loading.

If an Image source is loading the 'loaded' or 'error' event will be dispatched when the operation ends. An underyling source that is immediately-available bypasses loading entirely.

mipmap boolean inherited

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

See:

PIXI.MIPMAP_TEXTURES

origSource Image readonly inherited

The image source that is used to create the texture. This is used to store the original Svg source when it is replaced with a canvas element.

TODO: Currently not in use but could be used when re-scaling svg.

premultipliedAlpha boolean inherited

Controls if RGB channels should be pre-multiplied by Alpha (WebGL only) All blend modes, and shaders written for default value. Change it on your own risk.

Default Value:

true

realHeight number readonly inherited

Used to store the actual height of the source of this texture

realWidth number readonly inherited

Used to store the actual width of the source of this texture

resolution number inherited

The resolution / device pixel ratio of the texture

Default Value:

scaleMode number inherited

The scale mode to apply when scaling this texture

Default Value:

PIXI.settings.SCALE_MODE

See:

PIXI.SCALE_MODES

source HTMLImageElement | HTMLCanvasElement readonly inherited

The image source that is used to create the texture.

TODO: Make this a setter that calls loadSource();

sourceScale number readonly inherited

Scale for source image. Used with Svg images to scale them before rasterization.

textureCacheIds inherited

The ids under which this BaseTexture has been added to the base texture cache. This is automatically set as long as BaseTexture.addToCache is used, but may not be set if a BaseTexture is added directly to the BaseTextureCache array.

width number readonly inherited overrides

The width of the base texture set when the image has loaded

wrapMode number inherited

WebGL Texture wrap mode

See:

PIXI.WRAP_MODES

Methods

PIXI.VideoBaseTexture.fromUrl (videoSrc, scaleMode, crossorigin, autoPlay)PIXI.VideoBaseTexture static VideoBaseTexture.js:253

Helper function that creates a new BaseTexture based on the given video element. This BaseTexture can then be used to create a texture

Name Type Default Description

videoSrc

string | object | Array.<string> | Array.<object>

The URL(s) for the video.

Name	Type	Description
`src`	string	optional One of the source urls for the video
`mime`	string	optional The mimetype of the video (e.g. 'video/mp4'). If not specified the url's extension will be used as the second part of the mime type.

scaleMode

number

See PIXI.SCALE_MODES for possible values

crossorigin

boolean

(auto)

optional

Should use anonymous CORS? Defaults to true if the URL is not a data-URI.

autoPlay

boolean

true

optional

Start playing video as soon as it is loaded

Returns:

Type	Description
PIXI.VideoBaseTexture	Newly created VideoBaseTexture

PIXI.VideoBaseTexture.fromVideo (video, scaleMode, autoPlay)PIXI.VideoBaseTexture static VideoBaseTexture.js:221

Mimic PixiJS BaseTexture.from.... method.

Name	Type	Default	Description
`video`	HTMLVideoElement		Video to create texture from
`scaleMode`	number	PIXI.settings.SCALE_MODE	optional See PIXI.SCALE_MODES for possible values
`autoPlay`	boolean	true	optional Start playing video as soon as it is loaded

Returns:

Type	Description
PIXI.VideoBaseTexture	Newly created VideoBaseTexture

_loadSvgSource () inherited BaseTexture.js:475

Checks if source is an SVG image and whether it's loaded via a URL or a data URI. Then calls _loadSvgSourceUsingDataUri or _loadSvgSourceUsingXhr.

_loadSvgSourceUsingDataUri (dataUri) inherited BaseTexture.js:501

Reads an SVG string from data URI and then calls _loadSvgSourceUsingString.

Name	Type	Description
`dataUri`	string	The data uri to load from.

_loadSvgSourceUsingString (svgString) inherited BaseTexture.js:560

Loads texture using an SVG string. The original SVG Image is stored as origSource and the created canvas is the new source. The SVG is scaled using sourceScale. Called by _loadSvgSourceUsingXhr or _loadSvgSourceUsingDataUri.

Name	Type	Description
`svgString`	string	SVG source as string

Fires:

PIXI.BaseTexture#event:loaded

_loadSvgSourceUsingXhr () inherited BaseTexture.js:524

Loads an SVG string from imageUrl using XHR and then calls _loadSvgSourceUsingString.

_updateDimensions () inherited BaseTexture.js:282

Update dimensions from real values

_updateImageType () inherited BaseTexture.js:436

Updates type of the source image.

destroy () overrides VideoBaseTexture.js:192

Destroys this texture

dispose () inherited BaseTexture.js:649

Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.

Fires:

PIXI.BaseTexture#event:dispose

loadSource (source) protected inherited BaseTexture.js:311

Load a source.

If the source is not-immediately-available, such as an image that needs to be downloaded, then the 'loaded' or 'error' event will be dispatched in the future and hasLoaded will remain false after this call.

The logic state after calling loadSource directly or indirectly (eg. fromImage, new BaseTexture) is:

if (texture.hasLoaded) {
   // texture ready for use
} else if (texture.isLoading) {
   // listen to 'loaded' and/or 'error' events on texture
} else {
   // not loading, not going to load UNLESS the source is reloaded
   // (it may still make sense to listen to the events)
}

Name	Type	Description
`source`	HTMLImageElement \| HTMLCanvasElement	the source object of the texture.

update () inherited BaseTexture.js:265

Updates the texture on all the webgl renderers, this also assumes the src has changed.

Fires:

PIXI.BaseTexture#event:update

updateSourceImage (newSrc) inherited BaseTexture.js:660

Changes the source image of the texture. The original source must be an Image element.

Name	Type	Description
`newSrc`	string	the path of the image

Events

dispose inherited BaseTexture.js:251

Fired when BaseTexture is destroyed.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Instance of texture being destroyed.

error inherited BaseTexture.js:235

Fired when a not-immediately-available source fails to load.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Resource errored.

loaded inherited BaseTexture.js:227

Fired when a not-immediately-available source finishes loading.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Resource loaded.

update inherited BaseTexture.js:243

Fired when BaseTexture is updated.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Instance of texture being updated.