XRWebGLLayer: XRWebGLLayer() Konstruktor

Syntax

new XRWebGLLayer(session, context)
new XRWebGLLayer(session, context, options)

Parameter

session

Ein XRSession-Objekt, das die WebXR-Sitzung angibt, die mit dem WebGL-Kontext gerendert wird.

context

Ein WebGLRenderingContext oder WebGL2RenderingContext, der den WebGL-Zeichnungskontext identifiziert, der zum Rendern der Szene für die angegebene WebXR-Sitzung verwendet wird.

options Optional

Ein Objekt, das Konfigurationsoptionen für das neue XRWebGLLayer bereitstellt. Die verfügbaren Optionen sind:

alpha

Der Farb-Puffer des Framebuffers wird mit einem Alphakanal eingerichtet, wenn die alpha-Boolean-Eigenschaft true ist. Andernfalls hat der Farbpuffer keinen Alphakanal. Der Standardwert ist true.

antialias

Ein Boolean-Wert, der true ist, wenn Anti-Aliasing beim Rendern im Kontext verwendet werden soll; andernfalls false. Der Browser wählt die zu verwendende Anti-Aliasing-Methode; es gibt derzeit keine Unterstützung, um einen bestimmten Modus anzufordern. Der Standardwert ist true.

depth

Ein Boolean-Wert, der, wenn true, verlangt, dass die neue Ebene einen Tiefenpuffer hat; andernfalls wird keine Tiefenschicht zugewiesen. Der Standardwert ist true.

framebufferScaleFactor

Ein Gleitkommawert, der verwendet wird, um das Bild während des Komponierens zu skalieren. Ein Wert von 1,0 repräsentiert die Standard-Pixelgröße für den Framebuffer. Die statische XRWebGLLayer-Funktion XRWebGLLayer.getNativeFramebufferScaleFactor() gibt die Skala zurück, die zu einem 1:1-Pixelverhältnis führen würde und dadurch sicherstellt, dass das Rendering in der nativen Auflösung des Geräts erfolgt. Der Standardwert ist 1,0.

ignoreDepthValues

Ein Boolean-Wert, der angibt, ob der Inhalt des Tiefenpuffers beim Komponieren der Szene ignoriert werden soll oder nicht. Der Standardwert ist false.

stencil

Ein Boolean-Wert, der, wenn true, verlangt, dass die neue Ebene einen Schablonenpuffer beinhaltet. Andernfalls wird kein Schablonenpuffer zugewiesen. Der Standardwert ist false.

Rückgabewert

Ein neu erstelltes XRWebGLLayer, das die angegebene XRSession mit dem durch context angegebenen WebGL-Kontext verknüpft, der als Renderer für die Sitzung verwendet wird. Alle in layerInit angegebenen Optionen werden verwendet, um die Konfiguration des Renderingsystems anzupassen.

Ausnahmen

InvalidStateError DOMException

Wird ausgelöst, wenn das neue XRWebGLLayer aufgrund eines von mehreren möglichen Zustandsfehlern nicht erstellt werden konnte:

• Die durch session angegebene XRSession wurde bereits gestoppt.
• Der angegebene WebGL-Kontext, context, ist verloren gegangen aus irgendeinem Grund, wie z.B. einem GPU-Wechsel oder -Reset.
• Die angegebene session ist immersiv, aber der context ist nicht WebXR-kompatibel.

OperationError DOMException

Wird ausgelöst, wenn die Ressourcen (einschließlich Speicherpuffer), die für den Betrieb der Ebene erforderlich sind, nicht zugewiesen werden konnten.

Beispiele

In diesem Beispiel wird ein neues XRWebGLLayer für eine WebXR-Sitzung, xrSession, erstellt.

xrSession.updateRenderState({
  baseLayer: new XRWebGLLayer(xrSession, gl, {
    alpha: false,
    antialias: false,
    depth: false,
    framebufferScaleFactor: 0.5,
    ignoreDepthValues: true,
    stencil: false,
  }),
});

Spezifikationen

Browser-Kompatibilität

Siehe auch

• WebXR Device API
• Einführung in WebGL
• Umgang mit verlorenem Kontext in WebGL: Khronos WebGL Wiki