WebXR Device API
The createEquirectLayer() method of the XRWebGLBinding interface returns an XREquirectLayer object, which is a layer that maps equirectangular coded data onto the inside of a sphere.
Syntax
createEquirectLayer(options)
Parameters
options- : An object to configure the XREquirectLayer. It must have the
space,viewPixelHeight, andviewPixelWidthproperties.inithas the following properties:centralHorizontalAngle- : A number indicating the central horizontal angle in radians of the sphere. Default value:
6.28318(2π).
- : A number indicating the central horizontal angle in radians of the sphere. Default value:
colorFormat- : A WebGL_API/Types 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_ALPHA8Additionally, for contexts with the WEBGL_compressed_texture_etc extension enabled:ext.COMPRESSED_RGB8_ETC2ext.COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2ext.COMPRESSED_RGBA8_ETC2_EACext.COMPRESSED_SRGB8_ETC2ext.COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2ext.COMPRESSED_SRGB8_ALPHA8_ETC2_EACAdditionally, for contexts with the WEBGL_compressed_texture_astc extension enabled:Allof the formats the extension supports. The default value isgl.RGBA.
- : A WebGL_API/Types defining the data type of the color texture data. Possible values:
depthFormat- : A WebGL_API/Types defining the data type of the depth texture data, or else
0to indicate 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.
- : A WebGL_API/Types defining the data type of the depth texture data, or else
isStatic- : A boolean that, if true, indicates you can only draw to this layer when XRCompositionLayer.needsRedraw is
true. The default value isfalse.
- : A boolean that, if true, indicates you can only draw to this layer when XRCompositionLayer.needsRedraw is
layout- : A string indicating the layout of the layer. Possible values:
default- : The layer accommodates all views of the session.
mono- : A single XRSubImage is allocated and presented to both eyes.
stereo- : The user agent decides how it allocates the XRSubImage (one or two) and the layout (top/bottom or left/right).
stereo-left-right- : A single XRSubImage is allocated. Left eye gets the left area of the texture, right eye the right.
stereo-top-bottom- : A single XRSubImage is allocated. Left eye gets the top area of the texture, right eye the bottom.
The default value is
mono.
- : A single XRSubImage is allocated. Left eye gets the top area of the texture, right eye the bottom.
The default value is
- : A string indicating the layout of the layer. Possible values:
lowerVerticalAngle- : A number indicating the lower vertical angle in radians of the sphere. Default value:
-1.570795(-π/2).
- : A number indicating the lower vertical angle in radians of the sphere. Default value:
mipLevels- : A number specifying desired number of mip levels. The default value is
1.
- : A number specifying desired number of mip levels. The default value is
radius- : A number indicating the radius of the sphere. Default value:
0(infinite sphere).
- : A number indicating the radius of the sphere. Default value:
spaceRequired- : An XRSpace object defining the layer's spatial relationship with the user's physical environment.
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.
- : The textures of XRWebGLSubImage will be of type
texture-array- : The textures of XRWebGLSubImage will be of type
gl.TEXTURE_2D_ARRAY(WebGL 2 contexts only). The default value istexture.
- : The textures of XRWebGLSubImage will be of type
- : A string defining the type of texture the layer will have. Possible values:
transform- : An XRRigidTransform object defining the offset and orientation relative to
space.
- : An XRRigidTransform object defining the offset and orientation relative to
upperVerticalAngle- : A number indicating the upper vertical angle in radians of the sphere. Default value:
1.570795(π/2).
- : A number indicating the upper vertical angle in radians of the sphere. Default value:
viewPixelHeightRequired- : A number specifying the pixel height of the layer view.
viewPixelWidthRequired- : A number specifying the pixel width of the layer view.
- : An object to configure the XREquirectLayer. It must have the
Return value
An XREquirectLayer object.
Examples
Creating an XREquirectLayer
Configure the equirect layer using the properties listed above in a call to createEquirect(). To present layers to the XR device, add them to the layers render state using XRSession.updateRenderState().
function onXRSessionStarted(xrSession) {
const glCanvas = document.createElement("canvas");
const gl = glCanvas.getContext("webgl2", { xrCompatible: true });
const xrGlBinding = new XRWebGLBinding(xrSession, gl);
const equirectLayer = xrGlBinding.createEquirectLayer({
space: xrReferenceSpace,
viewPixelWidth: 1200,
viewPixelHeight: 600,
centralHorizontalAngle: 2 * Math.PI,
upperVerticalAngle: Math.PI / 2.0,
lowerVerticalAngle: -Math.PI / 2.0,
radius: 0,
});
xrSession.updateRenderState({
layers: [equirectLayer],
});
}
Specifications
Browser compatibility
See also
- XREquirectLayer
- WebGL constants
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
