XRWebGLBinding: createProjectionLayer() method
WebXR Device API
WebXR Device API
The createProjectionLayer() method of the XRWebGLBinding interface returns an XRProjectionLayer object which is a layer that fills the entire view of the observer and is refreshed close to the device's native frame rate.
Syntax
createProjectionLayer(options)
Parameters
options- : An object to configure the XRProjectionLayer.
textureType- : A string defining the type of texture the layer will have. Possible values:
texture- : The textures of XRWebGLSubImage will be of type
gl.TEXTURE_2D. texture-array- : The textures of XRWebGLSubImage will be of type
gl.TEXTURE_2D_ARRAY(WebGL 2 contexts only). The default value istexture.
colorFormat- : A GLenum defining the data type of the color texture data. Possible values:
gl.RGBgl.RGBAAdditionally, for contexts with the EXT_sRGB extension enabled:ext.SRGB_EXText.SRGB_ALPHA_EXTAdditionally, for WebGL2RenderingContext contexts:gl.RGBA8gl.RGB8gl.SRGB8gl.RGB8_ALPHA8The default value isgl.RGBA.
depthFormat- : A GLenum defining the data type of the depth texture data or
0indicating that the layer should not provide a depth texture. (In that case XRProjectionLayer.ignoreDepthValues will betrue.) Possible values within WebGLRenderingContext contexts with the WEBGL_depth_texture extension enabled, or within WebGL2RenderingContext contexts (no extension required):gl.DEPTH_COMPONENTgl.DEPTH_STENCILAdditionally, for WebGL2RenderingContext contexts:gl.DEPTH_COMPONENT24gl.DEPTH24_STENCIL24The default value isgl.DEPTH_COMPONENT.
scaleFactor- : A floating-point value which is used to scale the layer during compositing. A value of
1.0represents the default pixel size for the frame buffer. (See also XRWebGLLayer.getNativeFramebufferScaleFactor().) Unlike other layers, theXRProjectionLayercan't be created with an explicit pixel width and height, because the size is inferred by the hardware. (Projection layers fill the observer's entire view.)
Return value
An XRProjectionLayer object.
Examples
Creating an XRProjectionLayer in a WebGL 2 context
The textureType option allows allocating a texture array instead, in which every XRView will be rendered into a separate level of the array. This allows for some rendering optimizations, such as the use of the OVR_multiview2 extension available in WebGL 2 contexts.
function onXRSessionStarted(xrSession) {
const glCanvas = document.createElement("canvas");
const gl = glCanvas.getContext("webgl2", { xrCompatible: true });
const xrGlBinding = new XRWebGLBinding(xrSession, gl);
const projectionLayer = xrGlBinding.createProjectionLayer({
textureType: "texture-array",
});
xrSession.updateRenderState({
layers: [projectionLayer],
});
}
Specifications
Browser compatibility
See also
- XRProjectionLayer
- WebGL constants