VRPose.linearVelocity

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The linearVelocity read-only property of the VRPose interface returns an array representing the linear velocity vector of the VRDisplay at the current VRPose.timestamp, in meters per second.

In other words, the current velocity at which the sensor is moving along the x, y, and z axes.

Syntax

var myLinearVelocity = VRPose.linearVelocity;

Value

A Float32Array, or null if the VR sensor is not able to provide linear velocity data.

Examples

// rendering loop for a VR scene
function drawVRScene() {
  // WebVR: Request the next frame of the animation
  vrSceneFrame = vrDisplay.requestAnimationFrame(drawVRScene);

  // Populate frameData with the data of the next frame to display
  vrDisplay.getFrameData(frameData);

  // Retrieve the linear velocity values for use in rendering
  // curFramePose is a VRPose object
  var curFramePose = frameData.pose;
  var linVel = curFramePose.linearVelocity;
  var lvx = linVel[0];
  var lvy = linVel[1];
  var lvz = linVel[2];

  // render the scene
  ...

  // WebVR: submit the rendered frame to the VR display
  vrDisplay.submitFrame();
}

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'linearVelocity' in that specification.
Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also