VRHMD device object

A vrhmd object is optional. You only need to make one if you want to use a virtual reality head-mounted display.

An object of type vrhmd runs a virtual reality head-mounted display supported by Psychtoolbox. To use a VRHMD, make a vrhmd object in the experiment script outside trials using function vrhmdObject and add it using addToExperiment. A vrhmd object is also a screen object, i.e. it has all the properties of a screen object (and some additional ones). If you make a vrhmd object, it takes the place of a screen object.

See Psychtoolbox documentation for extra requirements for VRHMDs, e.g.  http://psychtoolbox.org/docs/OculusVR for the Oculus Rift.

‍Currently VRHMDs only work in monoscopic or 2D stereo modes (property stereo below), not 3D head tracking mode.

Input properties

options
quality

Default: options = Psychtoolbox default
Default: quality = lowest quality, highest speed

options is a string that goes to Psychtoolbox PsychVRHMD('AutoSetupHMD') input basicRequirements. See PsychVRHMD help text for more information. <cd>[]<cd> = Psychtoolbox default.

quality is a number between 0–1 setting quality/performance tradeoff: 0 = lowest quality, highest speed, 1 = highest quality, lowest speed.

Input properties all screen objects have

n_screen
The default value (highest attached screen number) is usually the HMD.

height_cm
distance_cm
These properties retain their literal meanings: height of the display panel in the headset, and distance from eye to display panel.

openRect
Ignored by vrhmd objects.

doSyncTests
syncTestParams
useCompositor

multisample

gamma

bufferChannelResolution
clampChannels

showMouseCursor

flipHorz
flipVert

stereo
stereoOptions
For vrhmd objects, stereo is just the number 0 or 1: 0 = monoscopic, 1 = 2D stereo. For stereo display, as usual you can use element property nn_eyes to set whether an element shows on left/right/both eyes.

beforeOpenCode
openCode
afterOpenCode
For vrhmd objects, beforeOpenCode code runs after the HMD is opened (with the imaging pipeline). For all of these properties, code can also use variable ptbVrhmd containing the Psychtoolbox HMD “handle” returned by PsychVRHMD('AutoSetupHMD').

Input properties all objects have

report
info

Record properties

PsychBench uses record properties to record information during experiments. You can't set record properties but you can see them in experiment results by listing them input property report.

Record properties all screen objects have

refreshRate
refreshInterval

< All documentation