Liking cljdoc? Tell your friends :D

web.media.VRDisplay

The VRDisplay interface of the WebVR API represents any VR device by this API. It includes generic information such as device IDs descriptions, as well as methods for starting to present a VR retrieving eye parameters and display capabilities, and other functionality.

The VRDisplay interface of the WebVR API represents any VR device
by this API. It includes generic information such as device IDs
descriptions, as well as methods for starting to present a VR
retrieving eye parameters and display capabilities, and other
functionality.
raw docstring

cancel-animation-framecljs

(cancel-animation-frame this handle)

Method.

[Experimental]

The cancelAnimationFrame() method of the web.media.VRDisplay is a special implementation of Window.cancelAnimationFrame unregisters callbacks registered with VRDisplay.requestAnimationFrame().

vrDisplayInstance.cancelAnimationFrame(handle);

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/cancelAnimationFrame

Method.

[Experimental]

The cancelAnimationFrame() method of the `web.media.VRDisplay`
is a special implementation of `Window.cancelAnimationFrame`
unregisters callbacks registered with `VRDisplay.requestAnimationFrame()`.

`vrDisplayInstance.cancelAnimationFrame(handle);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/cancelAnimationFrame`
sourceraw docstring

capabilitiescljs

(capabilities this)

Property.

[Read Only] [Experimental]

The capabilities read-only property of the web.media.VRDisplay returns a web.vr.VRDisplayCapabilities object that indicates various capabilities of the VRDisplay.

var myCapabilities = vrDisplayInstance.capabilities;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/capabilities

Property.

[Read Only]
[Experimental]

The capabilities read-only property of the `web.media.VRDisplay`
returns a `web.vr.VRDisplayCapabilities` object that indicates
various capabilities of the VRDisplay.

`var myCapabilities = vrDisplayInstance.capabilities;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/capabilities`
sourceraw docstring

depth-farcljs

(depth-far this)

Property.

[Experimental]

The depthFar property of the web.media.VRDisplay interface and sets the z-depth defining the far plane of the eye view frustum, the furthest viewable boundary of the scene.

`var mydepthFar = vrDisplayInstance.depthFar;

vrDisplayInstance.depthFar = 7500.0;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthFar

Property.

[Experimental]

The depthFar property of the `web.media.VRDisplay` interface
and sets the z-depth defining the far plane of the eye view frustum,
the furthest viewable boundary of the scene.

`var mydepthFar = vrDisplayInstance.depthFar;

vrDisplayInstance.depthFar = 7500.0;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthFar`
sourceraw docstring

depth-nearcljs

(depth-near this)

Property.

[Experimental]

The depthNear property of the web.media.VRDisplay interface and sets the z-depth defining the near plane of the eye view i.e. the nearest viewable boundary of the scene.

`var mydepthNear = vrDisplayInstance.depthNear;

vrDisplayInstance.depthNear = 1.0;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthNear

Property.

[Experimental]

The depthNear property of the `web.media.VRDisplay` interface
and sets the z-depth defining the near plane of the eye view
i.e. the nearest viewable boundary of the scene.

`var mydepthNear = vrDisplayInstance.depthNear;

vrDisplayInstance.depthNear = 1.0;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthNear`
sourceraw docstring

display-idcljs

(display-id this)

Property.

[Read Only] [Experimental]

The displayId read-only property of the web.media.VRDisplay returns an identifier for this particular VRDisplay, which is used as an association point in the Gamepad API (see Gamepad.displayId).

var myDisplayID = vrDisplayInstance.displayId;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/displayId

Property.

[Read Only]
[Experimental]

The displayId read-only property of the `web.media.VRDisplay`
returns an identifier for this particular VRDisplay, which is
used as an association point in the Gamepad API (see `Gamepad.displayId`).

`var myDisplayID = vrDisplayInstance.displayId;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/displayId`
sourceraw docstring

display-namecljs

(display-name this)

Property.

[Read Only] [Experimental]

The displayName read-only property of the web.media.VRDisplay returns a human-readable name to identify the VRDisplay.

var myDisplayName = vrDisplayInstance.displayName;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/displayName

Property.

[Read Only]
[Experimental]

The displayName read-only property of the `web.media.VRDisplay`
returns a human-readable name to identify the VRDisplay.

`var myDisplayName = vrDisplayInstance.displayName;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/displayName`
sourceraw docstring

exit-presentcljs

(exit-present this & args)

Method.

[Experimental]

The exitPresent() method of the web.media.VRDisplay interface the VRDisplay presenting a scene.

vrDisplayInstance.exitPresent().then(function() { // Do something after the presentation has ended });

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/exitPresent

Method.

[Experimental]

The exitPresent() method of the `web.media.VRDisplay` interface
the VRDisplay presenting a scene.

`vrDisplayInstance.exitPresent().then(function() {
// Do something after the presentation has ended
});`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/exitPresent`
sourceraw docstring

get-eye-parameterscljs

(get-eye-parameters this which-eye)

Method.

[Experimental]

The getEyeParameters() method of the web.media.VRDisplay interface the web.vr.VREyeParameters object containing the eye parameters the specified eye.

var myEyeParameters = vrDisplayInstance.getEyeParameters(whichEye);

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getEyeParameters

Method.

[Experimental]

The getEyeParameters() method of the `web.media.VRDisplay` interface
the `web.vr.VREyeParameters` object containing the eye parameters
the specified eye.

`var myEyeParameters = vrDisplayInstance.getEyeParameters(whichEye);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getEyeParameters`
sourceraw docstring

get-frame-datacljs

(get-frame-data this frame-data)

Method.

[Experimental]

The getFrameData() method of the web.media.VRDisplay interface a web.vr.VRFrameData object and populates it with the information to render the current frame.

vrDisplayInstance.getFrameData(frameData);

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getFrameData

Method.

[Experimental]

The getFrameData() method of the `web.media.VRDisplay` interface
a `web.vr.VRFrameData` object and populates it with the information
to render the current frame.

`vrDisplayInstance.getFrameData(frameData);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getFrameData`
sourceraw docstring

get-immediate-posecljs

(get-immediate-pose this)

Method.

[Experimental] [Obsolute]

The getImmediatePose() method of the web.media.VRDisplay interface a web.vr.VRPose object defining the current pose of the VRDisplay, no prediction applied.

var myImmediatePose = vrDisplayInstance.getImmediatePose();

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getImmediatePose

Method.

[Experimental]
[Obsolute]

The getImmediatePose() method of the `web.media.VRDisplay` interface
a `web.vr.VRPose` object defining the current pose of the VRDisplay,
no prediction applied.

`var myImmediatePose = vrDisplayInstance.getImmediatePose();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getImmediatePose`
sourceraw docstring

get-layerscljs

(get-layers this)

Method.

[Experimental]

The getLayers() method of the web.media.VRDisplay interface the layers currently being presented by the VRDisplay.

var myLayers = vrDisplayInstance.getLayers();

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getLayers

Method.

[Experimental]

The getLayers() method of the `web.media.VRDisplay` interface
the layers currently being presented by the VRDisplay.

`var myLayers = vrDisplayInstance.getLayers();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getLayers`
sourceraw docstring

get-posecljs

(get-pose this)

Method.

[Deprecated]

The getPose() method of the web.media.VRDisplay interface returns web.vr.VRPose object defining the future predicted pose of VRDisplay as it will be when the current frame is actually presented.

var myPose = vrDisplayInstance.getPose();

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getPose

Method.

[Deprecated]

The getPose() method of the `web.media.VRDisplay` interface returns
`web.vr.VRPose` object defining the future predicted pose of
VRDisplay as it will be when the current frame is actually presented.

`var myPose = vrDisplayInstance.getPose();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/getPose`
sourceraw docstring

hardware-unit-idcljs

(hardware-unit-id this)

Method.

[Experimental] [Obsolute]

The hardwareUnitId read-only property of the VRDevice interface the distinct hardware ID for the overall hardware unit that this is a part of. All devices that are part of the same physical of hardware will have the same hardwareUnitId.

var hardwareID = VRDevice.hardwareUnitId;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/hardwareUnitId

Method.

[Experimental]
[Obsolute]

The hardwareUnitId read-only property of the `VRDevice` interface
the distinct hardware ID for the overall hardware unit that this
is a part of. All devices that are part of the same physical
of hardware will have the same hardwareUnitId.

`var hardwareID = VRDevice.hardwareUnitId;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/hardwareUnitId`
sourceraw docstring

is-connectedcljs

(is-connected this)

Property.

[Read Only] [Experimental]

The isConnected read-only property of the web.media.VRDisplay returns a js.Boolean indicating whether the VRDisplay is connected the computer.

var isItConnected = vrDisplayInstance.isConnected;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/isConnected

Property.

[Read Only]
[Experimental]

The isConnected read-only property of the `web.media.VRDisplay`
returns a `js.Boolean` indicating whether the VRDisplay is connected
the computer.

`var isItConnected = vrDisplayInstance.isConnected;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/isConnected`
sourceraw docstring

is-presentingcljs

(is-presenting this)

Property.

[Read Only] [Experimental]

The isPresenting read-only property of the web.media.VRDisplay returns a js.Boolean indicating whether the VRDisplay is currently content presented through it.

var isItPresenting = vrDisplayInstance.isPresenting;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/isPresenting

Property.

[Read Only]
[Experimental]

The isPresenting read-only property of the `web.media.VRDisplay`
returns a `js.Boolean` indicating whether the VRDisplay is currently
content presented through it.

`var isItPresenting = vrDisplayInstance.isPresenting;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/isPresenting`
sourceraw docstring

request-animation-framecljs

(request-animation-frame this callback)

Method.

[Experimental]

The requestAnimationFrame() method of the web.media.VRDisplay is a special implementation of Window.requestAnimationFrame a callback function that will be called every time a new frame the VRDisplay presentation is rendered:

var handle = vrDisplayInstance.requestAnimationFrame(callback);

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/requestAnimationFrame

Method.

[Experimental]

The requestAnimationFrame() method of the `web.media.VRDisplay`
is a special implementation of `Window.requestAnimationFrame`
a callback function that will be called every time a new frame
the VRDisplay presentation is rendered:

`var handle = vrDisplayInstance.requestAnimationFrame(callback);`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/requestAnimationFrame`
sourceraw docstring

request-presentcljs

(request-present this & args)

Method.

[Experimental]

The requestPresent() method of the web.media.VRDisplay interface the VRDisplay presenting a scene.

vrDisplayInstance.requestPresent(layers).then(function() { // Do something after the presentation has begun });

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/requestPresent

Method.

[Experimental]

The requestPresent() method of the `web.media.VRDisplay` interface
the VRDisplay presenting a scene.

`vrDisplayInstance.requestPresent(layers).then(function() {
// Do something after the presentation has begun
});`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/requestPresent`
sourceraw docstring

reset-posecljs

(reset-pose this)

Method.

[Deprecated]

The resetPose() method of the web.media.VRDisplay interface the pose for the VRDisplay, treating its current VRPose.position VRPose.orientation as the "origin/zero" values.

vrDisplayInstance.resetPose();

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose

Method.

[Deprecated]

The resetPose() method of the `web.media.VRDisplay` interface
the pose for the VRDisplay, treating its current `VRPose.position`
`VRPose.orientation` as the \"origin/zero\" values.

`vrDisplayInstance.resetPose();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose`
sourceraw docstring

set-depth-far!cljs

(set-depth-far! this val)

Property.

[Experimental]

The depthFar property of the web.media.VRDisplay interface and sets the z-depth defining the far plane of the eye view frustum, the furthest viewable boundary of the scene.

`var mydepthFar = vrDisplayInstance.depthFar;

vrDisplayInstance.depthFar = 7500.0;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthFar

Property.

[Experimental]

The depthFar property of the `web.media.VRDisplay` interface
and sets the z-depth defining the far plane of the eye view frustum,
the furthest viewable boundary of the scene.

`var mydepthFar = vrDisplayInstance.depthFar;

vrDisplayInstance.depthFar = 7500.0;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthFar`
sourceraw docstring

set-depth-near!cljs

(set-depth-near! this val)

Property.

[Experimental]

The depthNear property of the web.media.VRDisplay interface and sets the z-depth defining the near plane of the eye view i.e. the nearest viewable boundary of the scene.

`var mydepthNear = vrDisplayInstance.depthNear;

vrDisplayInstance.depthNear = 1.0;`

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthNear

Property.

[Experimental]

The depthNear property of the `web.media.VRDisplay` interface
and sets the z-depth defining the near plane of the eye view
i.e. the nearest viewable boundary of the scene.

`var mydepthNear = vrDisplayInstance.depthNear;

vrDisplayInstance.depthNear = 1.0;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/depthNear`
sourceraw docstring

stage-parameterscljs

(stage-parameters this)

Property.

[Read Only] [Experimental]

The stageParameters read-only property of the web.media.VRDisplay returns a web.vr.VRStageParameters object containing room-scale if the VRDisplay is capable of supporting room-scale experiences.

var myStageParameters = vrDisplayInstance.stageParameters;

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/stageParameters

Property.

[Read Only]
[Experimental]

The stageParameters read-only property of the `web.media.VRDisplay`
returns a `web.vr.VRStageParameters` object containing room-scale
if the VRDisplay is capable of supporting room-scale experiences.

`var myStageParameters = vrDisplayInstance.stageParameters;`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/stageParameters`
sourceraw docstring

submit-framecljs

(submit-frame this)

Method.

[Experimental]

The submitFrame() method of the web.media.VRDisplay interface the current state of the web.vr.VRLayerInit currently being and displays it on the VRDisplay.

vrDisplayInstance.submitFrame();

See also: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/submitFrame

Method.

[Experimental]

The submitFrame() method of the `web.media.VRDisplay` interface
the current state of the `web.vr.VRLayerInit` currently being
and displays it on the VRDisplay.

`vrDisplayInstance.submitFrame();`

See also: `https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/submitFrame`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close