Skip to main content

Video Textures

Try it from the Editor in the tutorial project.

This project creates a texture and runtime, downloads and plays a video file and renders the video into the texture. This texture is then applied to a model and used in the scene.

This script performs the following functions:

  • Create new Texture
  • Create an HTML Video element and play the video
  • Apply the new texture to the material on the TV model
  • Update the texture with video data every frame
import {
Script,
Texture,
PIXELFORMAT_RGB8,
FILTER_LINEAR_MIPMAP_LINEAR,
FILTER_LINEAR,
ADDRESS_CLAMP_TO_EDGE
} from 'playcanvas';

export class VideoTexture extends Script {
static scriptName = "videoTexture";

/**
* MP4 video asset to play back on this video texture.
*
* @attribute
* @title Video Asset
* @type {Asset}
*/
videoAsset = null;

/**
* URL to use if there is video asset selected.
*
* @attribute
* @title Video Url
* @type {string}
*/
videoUrl = null;

/**
* Event that is fired as soon as the video texture is ready to play.
*
* @attribute
* @title Play Event
* @type {string}
*/
playEvent = '';

// initialize code called once per entity
initialize() {
const app = this.app;

// Create HTML Video Element to play the video
const video = document.createElement('video');
video.loop = true;

// muted attribute is required for videos to autoplay
video.muted = true;

// critical for iOS or the video won't initially play, and will go fullscreen when playing
video.playsInline = true;

// needed because the video is being hosted on a different server url
video.crossOrigin = "anonymous";

// autoplay the video
video.autoplay = true;

// iOS video texture playback requires that you add the video to the DOMParser
// with at least 1x1 as the video's dimensions
const style = video.style;
style.width = '1px';
style.height = '1px';
style.position = 'absolute';
style.opacity = '0';
style.zIndex = '-1000';
style.pointerEvents = 'none';

document.body.appendChild(video);

// Create a texture to hold the video frame data
this.videoTexture = new Texture(app.graphicsDevice, {
format: PIXELFORMAT_RGB8,
minFilter: FILTER_LINEAR_MIPMAP_LINEAR,
magFilter: FILTER_LINEAR,
addressU: ADDRESS_CLAMP_TO_EDGE,
addressV: ADDRESS_CLAMP_TO_EDGE,
mipmaps: true
});
this.videoTexture.setSource(video);

video.addEventListener('canplaythrough', (e) => {
app.fire(this.playEvent, this.videoTexture);
video.play();
});

// set video source
video.src = this.videoAsset ? this.videoAsset.getFileUrl() : this.videoUrl;

document.body.appendChild(video);
video.load();

this.on('destroy', () => {
this.videoTexture.destroy();
video.remove();
});
}

// update code called every frame
update(dt) {
// Transfer the latest video frame to the video texture
this.videoTexture.upload();
}
}