public Class VRCompositor

Unsafe version of: GetCompositorBenchmarkResults

Parameters

nSizeOfBenchmarkResults:int

should be set to sizeof(Compositor_BenchmarkResults)

Unsafe version of: GetCumulativeStats

Unsafe version of: GetCurrentFadeColor

Unsafe version of: GetCurrentFadeColor

Unsafe version of: GetFrameTiming

Unsafe version of: GetFrameTimings

Unsafe version of: GetLastPoseForTrackedDeviceIndex

Unsafe version of: GetLastPosePredictionIDs

Unsafe version of: GetLastPoses

Unsafe version of: GetMirrorTextureD3D11

Unsafe version of: GetMirrorTextureGL

Unsafe version of: GetPosesForFrame

Unsafe version of: GetVulkanDeviceExtensionsRequired

Unsafe version of: GetVulkanInstanceExtensionsRequired

Unsafe version of: SetSkyboxOverride

Unsafe version of: SetStageOverride_Async

Unsafe version of: Submit

Unsafe version of: WaitGetPoses

Returns true if the current process has the scene focus.

Annotations

@NativeType:bool

Clears the frame that was sent with the last call to Submit. This will cause the compositor to show the grid until Submit is called again.

Resets compositor skybox back to defaults.

Resets the stage to its default user specified setting.

Brings the compositor window to the front. This is useful for covering any other window that may be on the HMD and is obscuring the compositor window.

Writes back buffer and stereo left/right pair from the application to a 'screenshots' folder in the SteamVR runtime root.

Pushes the compositor window to the back. This is useful for allowing other applications to draw directly to the HMD.

DEPRECATED: Tells the compositor process to clean up and exit. You do not need to call this function at shutdown. Under normal circumstances the compositor will manage its own life cycle based on what applications are running.

Fading the Grid in or out in fSeconds.

Fades the view on the HMD to the specified color.

The fade will take fSeconds, and the color values are between 0.0 and 1.0. This color is faded on top of the scene based on the alpha parameter. Removing the fade color instantly would be FadeToColor( 0.0, 0.0, 0.0, 0.0, 0.0 ). Values are in un-premultiplied alpha space.

Override interleaved reprojection logic to force on.

Force reconnecting to the compositor process.

Returns true if pBenchmarkResults is filled it. Sets pBenchmarkResults with the result of the compositor benchmark.

Annotations

@NativeType:bool

Fills out stats accumulated for the last connected application.

Parameters

nStatsSizeInBytes:int

must be sizeof( Compositor_CumulativeStats )

Fills out stats accumulated for the last connected application.

Get current fade color value.

Annotations

@NativeType:HmdColor_t

Get current alpha value of grid.

Returns the process ID of the process that is currently rendering the scene.

Annotations

@NativeType:uint32_t

Returns the time in seconds left in the current (as identified by FrameTiming's frameIndex) frame.

Due to "running start", this value may roll over to the next frame before ever reaching 0.0.

Returns true if timing data is filled it. Sets oldest timing info if nFramesAgo is larger than the stored history.

Be sure to set timing.size = sizeof(Compositor_FrameTiming) on struct passed in before calling this function.

Annotations

@NativeType:bool

Interface for copying a range of timing data. Frames are returned in ascending order (oldest to newest) with the last being the most recent frame. Only the first entry's m_nSize needs to be set, as the rest will be inferred from that. Returns total number of entries filled out.

Annotations

@NativeType:uint32_t

Returns the process ID of the process that rendered the last frame (or 0 if the compositor itself rendered the frame).

Returns:int

0 when fading out from an app and the app's process Id when fading into an app

Annotations

@NativeType:uint32_t

Interface for accessing last set of poses returned by WaitGetPoses one at a time.

It is okay to pass NULL for either pose if you only want one of the values.

Returns:int

VR#EVRCompositorError_VRCompositorError_IndexOutOfRange if unDeviceIndex not less than VR#k_unMaxTrackedDeviceCount otherwise VR#EVRCompositorError_VRCompositorError_None

Annotations

@NativeType:EVRCompositorError

Returns the frame id associated with the poses last returned by WaitGetPoses.

Deltas between IDs correspond to number of headset vsync intervals.

Annotations

@NativeType:EVRCompositorError

Get the last set of poses returned by WaitGetPoses.

Annotations

@NativeType:EVRCompositorError

Opens a shared D3D11 texture with the undistorted composited image for each eye.

Use ReleaseMirrorTextureD3D11 when finished instead of calling Release on the resource itself.

Annotations

@NativeType:EVRCompositorError

Access to mirror textures from OpenGL.

Annotations

@NativeType:EVRCompositorError

Get the most up-to-date predicted (or recorded - up to 100ms old) set of poses for a given frame id.

Annotations

@NativeType:EVRCompositorError

Gets current tracking space returned by WaitGetPoses.

Annotations

@NativeType:ETrackingUniverseOrigin

Returns 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. The string will be a space separated list of required device extensions to enable in VkCreateDevice.

Annotations

@NativeType:uint32_t

Returns 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. The string will be a space separated list of required device extensions to enable in VkCreateDevice.

Annotations

@NativeType:uint32_t

Returns 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. The string will be a space separated list of-required instance extensions to enable in VkCreateInstance.

Annotations

@NativeType:uint32_t

Returns 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing null. The string will be a space separated list of-required instance extensions to enable in VkCreateInstance.

Annotations

@NativeType:uint32_t

DEPRECATED: Closes the headset view, either as a window or docked widget.

Indicates whether or not the current scene focus app is currently loading.

This is inferred from its use of FadeGrid to explicitly fade to the compositor to cover up the fact that it cannot render at a sustained full framerate during this time.

Annotations

@NativeType:bool

Return whether the compositor is fullscreen.

Annotations

@NativeType:bool

DEPRECATED: Returns true if the headset view (either as a window or docked widget) is shown.

Annotations

@NativeType:bool

Indicates whether or not motion smoothing is enabled by the user settings.

If you want to know if motion smoothing actually triggered due to a late frame, check CompositorFrameTiming m_nReprojectionFlags & VRCompositor_ReprojectionMotion instead.

Annotations

@NativeType:bool

Indicates whether or not motion smoothing is supported by the current hardware.

Annotations

@NativeType:bool

Call immediately after presenting your app's window (i.e. companion window) to unblock the compositor.

This is an optional call, which only needs to be used if you can't instead call WaitGetPoses immediately after Present(). For example, if your engine's render and game loop are not on separate threads, or blocking the render thread until 3ms before the next vsync would introduce a deadlock of some sort. This function tells the compositor that you have finished all rendering after having Submitted buffers for both eyes, and it is free to start its rendering work. This should only be called from the same thread you are rendering on.

Releases a shared D3D11 texture.

Annotations

@NativeType:bool

Vulkan/D3D12 Only

There are two purposes for SetExplicitTimingMode:

1. To get a more accurate GPU timestamp for when the frame begins in Vulkan/D3D12 applications.
2. (Optional) To avoid having WaitGetPoses access the Vulkan queue so that the queue can be accessed from another thread while WaitGetPoses is executing.

More accurate GPU timestamp for the start of the frame is achieved by the application calling SubmitExplicitTimingData immediately before its first submission to the Vulkan/D3D12 queue. This is more accurate because normally this GPU timestamp is recorded during WaitGetPoses. In D3D11, WaitGetPoses queues a GPU timestamp write, but it does not actually get submitted to the GPU until the application flushes. By using SubmitExplicitTimingData, the timestamp is recorded at the same place for Vulkan/D3D12 as it is for D3D11, resulting in a more accurate GPU time measurement for the frame.

Avoiding WaitGetPoses accessing the Vulkan queue can be achieved using SetExplicitTimingMode as well. If this is desired, the application should set the timing mode to VR#EVRCompositorTimingMode_VRCompositorTimingMode_Explicit_ApplicationPerformsPostPresentHandoff and MUST call PostPresentHandoff itself. If these conditions are met, then WaitGetPoses is guaranteed not to access the queue. Note that PostPresentHandoff and SubmitExplicitTimingData will access the queue, so only WaitGetPoses becomes safe for accessing the queue from another thread.

Override the skybox used in the compositor (e.g. for during level loads when the app can't feed scene images fast enough)

Order is Front, Back, Left, Right, Top, Bottom. If only a single texture is passed, it is assumed in lat-long format. If two are passed, it is assumed a lat-long stereo pair.

Annotations

@NativeType:EVRCompositorError

Override the stage model used in the compositor to replace the grid.

RenderModelPath is a full path the an OBJ file to load. This file will be loaded asynchronously from disk and uploaded to the gpu by the runtime. Once ready for rendering, the VREvent VR#EVREventType_VREvent_Compositor_StageOverrideReady will be sent. Use FadeToGrid to reveal. Call ClearStageOverride to free the associated resources when finished.

Annotations

@NativeType:EVRCompositorError

Override the stage model used in the compositor to replace the grid.

RenderModelPath is a full path the an OBJ file to load. This file will be loaded asynchronously from disk and uploaded to the gpu by the runtime. Once ready for rendering, the VREvent VR#EVREventType_VREvent_Compositor_StageOverrideReady will be sent. Use FadeToGrid to reveal. Call ClearStageOverride to free the associated resources when finished.

Annotations

@NativeType:EVRCompositorError

Override the stage model used in the compositor to replace the grid.

RenderModelPath is a full path the an OBJ file to load. This file will be loaded asynchronously from disk and uploaded to the gpu by the runtime. Once ready for rendering, the VREvent VR#EVREventType_VREvent_Compositor_StageOverrideReady will be sent. Use FadeToGrid to reveal. Call ClearStageOverride to free the associated resources when finished.

Annotations

@NativeType:EVRCompositorError

Sets tracking space returned by WaitGetPoses.

Parameters

eOrigin:int

one of:

VR#ETrackingUniverseOrigin_TrackingUniverseSeated

VR#ETrackingUniverseOrigin_TrackingUniverseStanding

VR#ETrackingUniverseOrigin_TrackingUniverseRawAndUncalibrated

Let an app know it should be rendering with low resources.

Annotations

@NativeType:bool

DEPRECATED: Opens the headset view (as either a window or docked widget depending on user's preferences) that displays what the user sees in the headset.

Updated scene texture to display.

If pBounds is NULL the entire texture will be used. If called from an OpenGL app, consider adding a glFlush after submitting both frames to signal the driver to start processing, otherwise it may wait until the command buffer fills up, causing the app to miss frames.

OpenGL dirty state: glBindTexture

Parameters

eEye:int

one of:

VR#EVREye_Eye_Left

VR#EVREye_Eye_Right

nSubmitFlags:int

one of:

VR#EVRSubmitFlags_Submit_Default	VR#EVRSubmitFlags_Submit_LensDistortionAlreadyApplied
VR#EVRSubmitFlags_Submit_GlRenderBuffer	VR#EVRSubmitFlags_Submit_Reserved
VR#EVRSubmitFlags_Submit_TextureWithDepth	VR#EVRSubmitFlags_Submit_FrameDiscontinuty
VR#EVRSubmitFlags_Submit_VulkanTextureWithArrayData	VR#EVRSubmitFlags_Submit_GlArrayTexture
VR#EVRSubmitFlags_Submit_Reserved2	VR#EVRSubmitFlags_Submit_Reserved3

Returns:int

return codes:

• IsNotSceneApplication (make sure to call VR_Init with VRApplication_Scene)
• DoNotHaveFocus (some other app has taken focus)
• TextureIsOnWrongDevice (application did not use proper AdapterIndex - see IVRSystem.GetDXGIOutputInfo)
• SharedTexturesNotSupported (application needs to call CreateDXGIFactory1 or later before creating DX device)
• TextureUsesUnsupportedFormat (scene textures must be compatible with DXGI sharing rules - e.g. uncompressed, no mips, etc.)
• InvalidTexture (usually means bad arguments passed in)
• AlreadySubmitted (app has submitted two left textures or two right textures in a single frame - i.e. before calling WaitGetPoses again)

Annotations

@NativeType:EVRCompositorError

Vulkan/D3D12 Only

Submit explicit timing data. When SetExplicitTimingMode is true, this must be called immediately before the application's first vkQueueSubmit (Vulkan) or ID3D12CommandQueue::ExecuteCommandLists (D3D12) of each frame. This function will insert a GPU timestamp write just before the application starts its rendering. This function will perform a vkQueueSubmit on Vulkan so must not be done simultaneously with VkQueue operations on another thread.

Returns:int

VR#EVRCompositorError_VRCompositorError_RequestFailed if SetExplicitTimingMode is not enabled

Annotations

@NativeType:EVRCompositorError

Temporarily suspends rendering (useful for finer control over scene transitions).

Scene applications should call this function to get poses to render with (and optionally poses predicted an additional frame out to use for gameplay). This function will block until "running start" milliseconds before the start of the frame, and should be called at the last moment before needing to start rendering.

Annotations

@NativeType:EVRCompositorError