Skip to content

Add support for equirect layer #5710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Add support for equirect layer #5710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7439dc9
Add support for equirect layer
vincentfretin Apr 25, 2025
e62d5f5
Add layer-equirect example, stereo-top-bottom 360 video by default fo…
vincentfretin May 3, 2025
55c057b
Add property to set sphere radius, 198 by default (lower value than d…
vincentfretin May 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions examples/test/layer-equirect/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Compositor Equirect Layer Example • A-Frame</title>
<meta name="description" content="Compositor Equirect Layer Example • A-Frame">
<script src="../../../dist/aframe-master.js"></script>
<script src="https://unpkg.com/[email protected]/dist/aframe-environment-component.min.js"></script>
<script src="toggle-layer.js"></script>
</head>
<body>
<a-scene>
<a-assets>
<!--
SOURCE:
https://immersive-web.github.io/webxr-samples/layers-samples/media-layer-sample.html
stereo-top-bottom 360 4300x4300 30fps
-->
<video id="video" autoplay preload="auto" loop crossorigin="anonymous" width="4300" height="4300">
<source src="https://oculus-mp4.s3.amazonaws.com/immersive+video+8K+for+Oculus+Browser/everestvr_4.3k_30s_360_h264_crf23_binaural_CREDIT_JON_GRIFFITH_injected.mp4">
</video>

<!--
SOURCE:
https://immersive-web.github.io/webxr-samples/layers-samples/eqrt-video.html
stereo-left-right 180 3840x1920 30fps
-->
<!--
<video id="video" autoplay preload="auto" loop crossorigin="anonymous" width="3840" height="1920">
<source src="https://d25a56pc18k0co.cloudfront.net/sloths_binaural_3840_180_3D-injected.mp4">
</video>
-->

<!--
SOURCE:
https://immersive-web.github.io/webxr-samples/layers-samples/eqrt-layer.html
stereo-top-bottom 4k image
-->
<!--
<img id="image" src="https://cdn.jsdelivr.net/gh/immersive-web/webxr-samples@main/media/textures/chess-pano-4k.png" />
-->
</a-assets>
<a-entity
layer="src: #video; type: stereo-top-bottom-equirect; is180: false"
position="0 0 0"></a-entity>
<a-entity id="leftHand" toggle-layer laser-controls="hand: left"></a-entity>
<a-entity id="rightHand" toggle-layer laser-controls="hand: right"></a-entity>
</a-scene>
</body>
</html>
9 changes: 9 additions & 0 deletions examples/test/layer-equirect/toggle-layer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/* global AFRAME */
AFRAME.registerComponent('toggle-layer', {
init: function () {
var layerEl = document.querySelector('[layer]');
this.el.addEventListener('thumbstickdown', function () {
layerEl.components.layer.toggleCompositorLayer();
});
}
});
55 changes: 53 additions & 2 deletions src/components/layer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ var warn = utils.debug('components:layer:warn');

export var Component = registerComponent('layer', {
schema: {
type: {default: 'quad', oneOf: ['quad', 'monocubemap', 'stereocubemap']},
type: {default: 'quad', oneOf: ['mono-equirect', 'stereo-left-right-equirect', 'stereo-top-bottom-equirect', 'quad', 'monocubemap', 'stereocubemap']},
src: {type: 'map'},
is180: {default: false, if: {type: ['mono-equirect', 'stereo-left-right-equirect', 'stereo-top-bottom-equirect']}},
radius: {default: 198, if: {type: ['mono-equirect', 'stereo-left-right-equirect', 'stereo-top-bottom-equirect']}},
rotateCubemap: {default: false},
width: {default: 0},
height: {default: 0}
Expand Down Expand Up @@ -59,6 +61,11 @@ export var Component = registerComponent('layer', {
this.destroyLayer();
this.texture = undefined;
this.textureIsVideo = this.data.src.tagName === 'VIDEO';
if (type.endsWith('equirect')) {
this.loadEquirectImage();
return;
}

if (type === 'quad') {
this.loadQuadImage();
return;
Expand Down Expand Up @@ -104,6 +111,15 @@ export var Component = registerComponent('layer', {
}
},

loadEquirectImage: function () {
var src = this.data.src;
var self = this;
this.el.sceneEl.systems.material.loadTexture(src, {src: src}, function textureLoaded (texture) {
self.el.sceneEl.renderer.initTexture(texture);
self.texture = texture;
});
},

loadQuadImage: function () {
var src = this.data.src;
var self = this;
Expand Down Expand Up @@ -226,7 +242,7 @@ export var Component = registerComponent('layer', {
if (this.data.src.complete && (this.pendingCubeMapUpdate || this.loadingScreen || this.visibilityChanged)) { this.loadCubeMapImages(); }
if (!this.needsRedraw && !this.layer.needsRedraw) { return; }
if (this.textureIsVideo) { return; }
if (this.data.type === 'quad') { this.draw(); }
if (this.data.type === 'quad' || this.data.type.endsWith('equirect')) { this.draw(); }
},

initLayer: function () {
Expand All @@ -237,6 +253,11 @@ export var Component = registerComponent('layer', {
self.visibilityChanged = evt.session.visibilityState !== 'hidden';
};

if (type.endsWith('equirect')) {
this.initEquirectLayer();
return;
}

if (type === 'quad') {
this.initQuadLayer();
return;
Expand All @@ -248,6 +269,36 @@ export var Component = registerComponent('layer', {
}
},

initEquirectLayer: function () {
if (!this.texture) { return; }
var sceneEl = this.el.sceneEl;
var eqrtIs180 = this.data.is180;
var eqrtRadius = this.data.radius;
var eqrtLayout = this.data.type.replace('-equirect', ''); // mono stereo-left-right stereo-top-bottom
if (this.textureIsVideo) {
var mediaBinding = new XRMediaBinding(sceneEl.xrSession);
this.layer = mediaBinding.createEquirectLayer(this.data.src, {
space: this.referenceSpace,
layout: eqrtLayout
});
} else {
var eqrtTextureWidth = this.texture.image.width;
var eqrtTextureHeight = this.texture.image.height;
var xrGLFactory = this.xrGLFactory = sceneEl.renderer.xr.getBinding();
this.layer = xrGLFactory.createEquirectLayer({
space: this.referenceSpace,
viewPixelWidth: eqrtTextureWidth / (eqrtLayout === 'stereo-left-right' ? 2 : 1),
viewPixelHeight: eqrtTextureHeight / (eqrtLayout === 'stereo-top-bottom' ? 2 : 1),
layout: eqrtLayout
});
}
this.layer.centralHorizontalAngle = Math.PI * (eqrtIs180 ? 1 : 2);
this.layer.upperVerticalAngle = Math.PI / 2.0;
this.layer.lowerVerticalAngle = -Math.PI / 2.0;
this.layer.radius = eqrtRadius;
sceneEl.renderer.xr.addLayer(this.layer);
},

initQuadLayer: function () {
if (!this.texture) { return; }
var sceneEl = this.el.sceneEl;
Expand Down
Loading