Skip to main content

CubemapProjection

Since version 4.0.0

source

Projection based on cubemap images, accepts both multiple or single images.

class CubemapProjection extends Projection

Extends

Properties

src

Source URL to panorama image/video.

video

Properties for the video element.
Setting false will treat panorama source as an image, true will use default properties.

Methods

createMesh

Generate triangle mesh from current projection.

updateCamera

Update camera to match projection's settings.

updateControl

Update control to match projection's settings.

Constructor​

Create new instance.
new CubemapProjection(options: CubemapProjectionOptions): CubemapProjection

Parameters

options

CubemapProjectionOptions

Options

Properties​

src​

>=4.0.0
readonly inherited
src

string | HTMLElement | (string | HTMLElement)[]

Source URL to panorama image/video.

source

video​

>=4.0.0
readonly inherited
video

undefined | boolean | Partial<VideoConfig>

Properties for the video element.
Setting false will treat panorama source as an image, true will use default properties.

Example

Default properties

autoplay: true
muted: true
loop: false
volume: 1

source

Methods​

createMesh​

>=4.0.0
createMesh

TriangleMesh<{ uTexture: UniformCanvasCube | UniformTextureCube }>

createMesh(ctx: WebGLContext, texture: Texture2D): TriangleMesh<{ uTexture: UniformCanvasCube | UniformTextureCube }>

Generate triangle mesh from current projection.

Parameters

ctx

WebGLContext

Instance of the WebGLContext helper

texture

Texture2D

New texture to apply

source

updateCamera​

>=4.0.0
inherited
updateCamera

void

updateCamera(camera: Camera): void

Update camera to match projection's settings.

Parameters

camera

Camera

Instance of the camera to update

source

updateControl​

>=4.0.0
inherited
updateControl

void

updateControl(control: PanoControl): void

Update control to match projection's settings.

Parameters

control

PanoControl

Instance of the control to update

source