Class: VideoBaseTexture

PIXI. VideoBaseTexture

A texture of a [playing] Video.

Video base textures mimic Pixi 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)

Name Type Default Description
source HTMLVideoElement

Video source

scaleMode number PIXI.settings.SCALE_MODE optional

See PIXI.SCALE_MODES for possible values

Extends

Members

autoUpdate

Sets autoUpdate property.

Methods

staticPIXI.VideoBaseTexture.fromUrl(videoSrc, scaleMode){PIXI.VideoBaseTexture}

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 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

Returns:
Type Description
PIXI.VideoBaseTexture Newly created VideoBaseTexture

staticPIXI.VideoBaseTexture.fromVideo(video, scaleMode){PIXI.VideoBaseTexture}

Mimic Pixi 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

Returns:
Type Description
PIXI.VideoBaseTexture Newly created VideoBaseTexture

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

inherited _loadSvgSourceUsingDataUri(dataUri)

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

Name Type Description
dataUri string

The data uri to load from.

inherited _loadSvgSourceUsingString(svgString)

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:
  • event:loaded

inherited _loadSvgSourceUsingXhr()

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

Updates type of the source image.

Destroys this texture

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.

inherited protectedloadSource(source)

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.

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

Fires:
  • event:update

inherited updateSourceImage(newSrc)

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

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

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