akasha.xr

Class XRWebGLLayer

java.lang.Object

akasha.EventTarget

akasha.xr.XRLayer

akasha.xr.XRWebGLLayer

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XRWebGLLayer")
public class XRWebGLLayer
extends XRLayer

The XRWebGLLayer interface of the WebXR Device API provides a linkage between the WebXR device (or simulated XR device, in the case of an inline session) and a WebGL context used to render the scene for display on the device. In particular, it provides access to the WebGL framebuffer and viewport to ease access to the context.The XRWebGLLayer interface of the WebXR Device API provides a linkage between the WebXR device (or simulated XR device, in the case of an inline session) and a WebGL context used to render the scene for display on the device.Although XRWebGLLayer is currently the only type of framebuffer layer supported by WebGL, it's entirely possible that future updates to the WebXR specification may allow for other layer types and corresponding image sources.

See Also:

XRWebGLLayer - MDN, XRWebGLLayer - WebXR Device API

Constructor Summary

Constructors

Constructor and Description
XRWebGLLayer(XRSession session, WebGL2RenderingContext context) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.
XRWebGLLayer(XRSession session, WebGL2RenderingContext context, XRWebGLLayerInit layerInit) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.
XRWebGLLayer(XRSession session, WebGLRenderingContext context) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.
XRWebGLLayer(XRSession session, WebGLRenderingContext context, XRWebGLLayerInit layerInit) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.
XRWebGLLayer(XRSession session, XRWebGLRenderingContext context) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.
XRWebGLLayer(XRSession session, XRWebGLRenderingContext context, XRWebGLLayerInit layerInit) The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

Method Summary

Modifier and Type	Method and Description
boolean	antialias() The read-only XRWebGLLayer property antialias is a Boolean value which is true if the rendering layer's frame buffer supports antialiasing.
WebGLFramebuffer	framebuffer() The read-only XRWebGLLayer property framebuffer is an opaque WebGLFramebuffer which is used to buffer the rendered image if the XR compositor is being used.
int	framebufferHeight() The read-only XRWebGLLayer property framebufferHeight indicates the height of the framebuffer, in pixels.
int	framebufferWidth() The read-only XRWebGLLayer property framebufferWidth specifies the width of the framebuffer, in pixels.
static double	getNativeFramebufferScaleFactor(XRSession session) The static method XRWebGLLayer.getNativeFramebufferScaleFactor() returns a floating-point scaling factor by which one can multiply the specified XRSession's resolution to get the native resolution of the WebXR device's frame buffer.
XRViewport	getViewport(XRView view) The XRWebGLLayer interface's getViewport() method returns the XRViewport that should be used to render the specified XRView into the WebGL layer.
boolean	ignoreDepthValues() The read-only XRWebGLLayer property ignoreDepthValues is a Boolean value which is true if the session has been configured to ignore the values in the depth buffer while rendering the scene.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    XRWebGLRenderingContext context,
                    @Nonnull
                    XRWebGLLayerInit layerInit)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    WebGLRenderingContext context,
                    @Nonnull
                    XRWebGLLayerInit layerInit)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    WebGL2RenderingContext context,
                    @Nonnull
                    XRWebGLLayerInit layerInit)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    XRWebGLRenderingContext context)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    WebGLRenderingContext context)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

XRWebGLLayer

public XRWebGLLayer(@Nonnull
                    XRSession session,
                    @Nonnull
                    WebGL2RenderingContext context)

The WebXR Device API XRWebGLLayer() constructor creates and returns a new XRWebGLLayer object, providing the linkage between the WebXR device and the WebGL graphics layer used to render the 3D scene.

See Also:

XRWebGLLayer.XRWebGLLayer - MDN, XRWebGLLayer() - WebXR Device API

Method Detail

antialias

@JsProperty(name="antialias")
public boolean antialias()

The read-only XRWebGLLayer property antialias is a Boolean value which is true if the rendering layer's frame buffer supports antialiasing.

See Also:

XRWebGLLayer.antialias - MDN, XRWebGLLayer.antialias - WebXR Device API

framebuffer

@JsProperty(name="framebuffer")
 @Nullable
public WebGLFramebuffer framebuffer()

The read-only XRWebGLLayer property framebuffer is an opaque WebGLFramebuffer which is used to buffer the rendered image if the XR compositor is being used. Otherwise, this property's value is null.

See Also:

XRWebGLLayer.framebuffer - MDN, XRWebGLLayer.framebuffer - WebXR Device API

framebufferHeight

@JsProperty(name="framebufferHeight")
public int framebufferHeight()

The read-only XRWebGLLayer property framebufferHeight indicates the height of the framebuffer, in pixels.

See Also:

XRWebGLLayer.framebufferHeight - MDN, XRWebGLLayer.framebufferHeight - WebXR Device API

framebufferWidth

@JsProperty(name="framebufferWidth")
public int framebufferWidth()

The read-only XRWebGLLayer property framebufferWidth specifies the width of the framebuffer, in pixels.

See Also:

XRWebGLLayer.framebufferWidth - MDN, XRWebGLLayer.framebufferWidth - WebXR Device API

ignoreDepthValues

@JsProperty(name="ignoreDepthValues")
public boolean ignoreDepthValues()

The read-only XRWebGLLayer property ignoreDepthValues is a Boolean value which is true if the session has been configured to ignore the values in the depth buffer while rendering the scene. If the depth buffer is being used to determine the position of vertices, this property is false.

See Also:

XRWebGLLayer.ignoreDepthValues - MDN, XRWebGLLayer.ignoreDepthValues - WebXR Device API

getNativeFramebufferScaleFactor

public static double getNativeFramebufferScaleFactor(@Nonnull
                                                     XRSession session)

The static method XRWebGLLayer.getNativeFramebufferScaleFactor() returns a floating-point scaling factor by which one can multiply the specified XRSession's resolution to get the native resolution of the WebXR device's frame buffer.

See Also:

XRWebGLLayer.getNativeFramebufferScaleFactor - MDN, static XRWebGLLayer.getNativeFramebufferScaleFactor() - WebXR Device API

getViewport

@Nullable
public XRViewport getViewport(@Nonnull
                                        XRView view)

The XRWebGLLayer interface's getViewport() method returns the XRViewport that should be used to render the specified XRView into the WebGL layer.

See Also:

XRWebGLLayer.getViewport - MDN, XRWebGLLayer.getViewport() - WebXR Device API