Class: XRRenderer
Renderer for VR and AR content
After construction, the domElement property, which contains a div dom element, should be added to the dom.
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new XRRenderer(__namedParameters)
Constructor for an XRRenderer
Parameters
| Name | Type |
|---|---|
__namedParameters | XRRendererParams |
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:128
Properties
animationLoop
• Private Optional animationLoop: (delta: number, time: number) => void
Type declaration
▸ (delta, time): void
A user defined animation loop
Parameters
| Name | Type |
|---|---|
delta | number |
time | number |
Returns
void
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:96
buttonDomElement
• Private Optional buttonDomElement: HTMLElement
The HTML element for the XR interaction button
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:106
camera
• camera: PerspectiveCamera | OrthographicCamera
The camera to render with
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:86
domElement
• domElement: HTMLElement
The DOM element for the renderer
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:76
events
• Private events: EventSystem
Events system for frame events
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:116
frame
• Optional frame: XRFrame
The latest xr frame
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:91
lastCallTime
• Private lastCallTime: number = 0
The renderers last call time
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:121
mode
• Private mode: XRRendererMode
The mode the renderer is in
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:101
resizeObserver
• Private resizeObserver: ResizeObserver
The resize observer for the renderer dom element
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:111
scene
• scene: Scene
The scene that should be rendered
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:81
three
• three: WebGLRenderer
The renderer for the xr renderer
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:71
Methods
destroy
▸ Private destroy(): void
Destroys the XR renderer
Returns
void
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:232
onFrame
▸ onFrame(handler): EventSubscription
Registers an event handler for new XRFrame frames
Parameters
| Name | Type | Description |
|---|---|---|
handler | (e: FrameEvent) => void | the handler for a new frame |
Returns
EventSubscription
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:224
onResize
▸ Private onResize(): void
Handles resizing of the XR renderer
Returns
void
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:243
setAnimationLoop
▸ setAnimationLoop(fn): void
Sets a function to be called on every render
Parameters
| Name | Type | Description |
|---|---|---|
fn | (delta: number, time: number) => void | the function to be called on render |
Returns
void
Defined in
packages/three/src/renderer/xr/xr-renderer.ts:207
setCamera
▸ setCamera(c): void
Sets the camera for the renderer
Parameters
| Name | Type | Description |
|---|---|---|
c | PerspectiveCamera | OrthographicCamera | the new camera for the renderer |
Returns
void