Skip to content

Commit 2af31b3

Browse files
committed
XRLayer: Corrects the typo shape="equirectangular" to shape="equirect"
#421
1 parent 1afe2c2 commit 2af31b3

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/tutorials/layers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Layers
3-
description: How to use display images, videos, and custom renders at high quality on quad, cylinder, and equirectangular shapes?
3+
description: How to use display images, videos, and custom renders at high quality on quad, cylinder, and equirect shapes?
44
nav: 15
55
---
66

7-
Layers allow to render videos, images, and complete scenes with higher performance and higher quality while preserving battery life and latency for quad, cylinder, and equirectangular shapes using the WebXR Layer API. Layers are perfect for use cases that display flat, high-quality content, such as videos, images, and user interfaces. The following example illustrates how to create a layer that renders a video.
7+
Layers allow to render videos, images, and complete scenes with higher performance and higher quality while preserving battery life and latency for quad, cylinder, and equirect shapes using the WebXR Layer API. Layers are perfect for use cases that display flat, high-quality content, such as videos, images, and user interfaces. The following example illustrates how to create a layer that renders a video.
88

99
First, we create a layer at `0, 1.5, -0.5` with a scale of `0.5` that displays a video assigned to `src` and starts that video when clicked.
1010

packages/react/xr/src/layer.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,16 @@ export type XRLayerProperties = XRLayerOptions &
6767
}
6868

6969
/**
70-
* Component for rendering high quality quad, cylinder, or equirectangular layers inside supported sessions. Also includes a fallback for non-supported sessions.
70+
* Component for rendering high quality quad, cylinder, or equirect layers inside supported sessions. Also includes a fallback for non-supported sessions.
7171
*
7272
* @param props
7373
* #### `src` - Property for displaying images and videos onto the layer. For rendering dynamic content to the layer, leave the `src` empty and put the dynamic (3D) content into the children, so that the layer acts as a render target.
74-
* #### `shape` - Property to configure the shape of the layer ("quad", "cylinder", "equirectangular").
74+
* #### `shape` - Property to configure the shape of the layer ("quad", "cylinder", "equirect").
7575
* #### `layout` - Property to configure the layout of the display content for stereo content ("default", "mono", "stereo-left-right", "stereo-top-bottom").
7676
* #### `centralAngle` - Property to configure the central angle in case the layer shape is a "cylinder".
77-
* #### `centralHorizontalAngle` - Property to configure the central horizontal angle in case the layer shape is "equirectangular".
78-
* #### `upperVerticalAngle` - Property to configure the upper vertical angle in case the layer shape is "equirectangular".
79-
* #### `lowerVerticalAngle` - Property to configure the lower verical angle in case the layer shape is "equirectangular".
77+
* #### `centralHorizontalAngle` - Property to configure the central horizontal angle in case the layer shape is "equirect".
78+
* #### `upperVerticalAngle` - Property to configure the upper vertical angle in case the layer shape is "equirect".
79+
* #### `lowerVerticalAngle` - Property to configure the lower vertical angle in case the layer shape is "equirect".
8080
* #### `chromaticAberrationCorrection` - Property to configure whether chromatic abberration should be corrected by the layer.
8181
* #### `quality` - Property to configure for what type of content the layer should be optimized ("default", "text-optimized", "graphics-optimized").
8282
*/

0 commit comments

Comments
 (0)