Class CVRCompositor

Inheritance

Object

CVRCompositor

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.Toolkit.OpenVR.Headers

Assembly: cs.temp.dll.dll

Syntax

public class CVRCompositor

Methods

CanRenderScene()

Declaration

public bool CanRenderScene()

Returns

Type	Description
Boolean

CanRenderScene()

Declaration

public bool CanRenderScene()

Returns

Type	Description
Boolean

ClearLastSubmittedFrame()

Declaration

public void ClearLastSubmittedFrame()

ClearLastSubmittedFrame()

Declaration

public void ClearLastSubmittedFrame()

ClearSkyboxOverride()

Declaration

public void ClearSkyboxOverride()

ClearSkyboxOverride()

Declaration

public void ClearSkyboxOverride()

CompositorBringToFront()

Declaration

public void CompositorBringToFront()

CompositorBringToFront()

Declaration

public void CompositorBringToFront()

CompositorDumpImages()

Declaration

public void CompositorDumpImages()

CompositorDumpImages()

Declaration

public void CompositorDumpImages()

CompositorGoToBack()

Declaration

public void CompositorGoToBack()

CompositorGoToBack()

Declaration

public void CompositorGoToBack()

CompositorQuit()

Declaration

public void CompositorQuit()

CompositorQuit()

Declaration

public void CompositorQuit()

FadeGrid(Single, Boolean)

Declaration

public void FadeGrid(float fSeconds, bool bFadeIn)

Parameters

Type	Name	Description
Single	fSeconds
Boolean	bFadeIn

FadeGrid(Single, Boolean)

Declaration

public void FadeGrid(float fSeconds, bool bFadeIn)

Parameters

Type	Name	Description
Single	fSeconds
Boolean	bFadeIn

FadeToColor(Single, Single, Single, Single, Single, Boolean)

Declaration

public void FadeToColor(float fSeconds, float fRed, float fGreen, float fBlue, float fAlpha, bool bBackground)

Parameters

Type	Name	Description
Single	fSeconds
Single	fRed
Single	fGreen
Single	fBlue
Single	fAlpha
Boolean	bBackground

FadeToColor(Single, Single, Single, Single, Single, Boolean)

Declaration

public void FadeToColor(float fSeconds, float fRed, float fGreen, float fBlue, float fAlpha, bool bBackground)

Parameters

Type	Name	Description
Single	fSeconds
Single	fRed
Single	fGreen
Single	fBlue
Single	fAlpha
Boolean	bBackground

ForceInterleavedReprojectionOn(Boolean)

Declaration

public void ForceInterleavedReprojectionOn(bool bOverride)

Parameters

Type	Name	Description
Boolean	bOverride

ForceInterleavedReprojectionOn(Boolean)

Declaration

public void ForceInterleavedReprojectionOn(bool bOverride)

Parameters

Type	Name	Description
Boolean	bOverride

ForceReconnectProcess()

Declaration

public void ForceReconnectProcess()

ForceReconnectProcess()

Declaration

public void ForceReconnectProcess()

GetCumulativeStats(ref Compositor_CumulativeStats, UInt32)

Declaration

public void GetCumulativeStats(ref Compositor_CumulativeStats pStats, uint nStatsSizeInBytes)

Parameters

Type	Name	Description
Compositor_CumulativeStats	pStats
UInt32	nStatsSizeInBytes

GetCumulativeStats(ref Compositor_CumulativeStats, UInt32)

Declaration

public void GetCumulativeStats(ref Compositor_CumulativeStats pStats, uint nStatsSizeInBytes)

Parameters

Type	Name	Description
Compositor_CumulativeStats	pStats
UInt32	nStatsSizeInBytes

GetCurrentFadeColor(Boolean)

Declaration

public HmdColor_t GetCurrentFadeColor(bool bBackground)

Parameters

Type	Name	Description
Boolean	bBackground

Returns

Type	Description
HmdColor_t

GetCurrentFadeColor(Boolean)

Declaration

public HmdColor_t GetCurrentFadeColor(bool bBackground)

Parameters

Type	Name	Description
Boolean	bBackground

Returns

Type	Description
HmdColor_t

GetCurrentGridAlpha()

Declaration

public float GetCurrentGridAlpha()

Returns

Type	Description
Single

GetCurrentGridAlpha()

Declaration

public float GetCurrentGridAlpha()

Returns

Type	Description
Single

GetCurrentSceneFocusProcess()

Declaration

public uint GetCurrentSceneFocusProcess()

Returns

Type	Description
UInt32

GetCurrentSceneFocusProcess()

Declaration

public uint GetCurrentSceneFocusProcess()

Returns

Type	Description
UInt32

GetFrameTimeRemaining()

Declaration

public float GetFrameTimeRemaining()

Returns

Type	Description
Single

GetFrameTimeRemaining()

Declaration

public float GetFrameTimeRemaining()

Returns

Type	Description
Single

GetFrameTiming(ref Compositor_FrameTiming, UInt32)

Declaration

public bool GetFrameTiming(ref Compositor_FrameTiming pTiming, uint unFramesAgo)

Parameters

Type	Name	Description
Compositor_FrameTiming	pTiming
UInt32	unFramesAgo

Returns

Type	Description
Boolean

GetFrameTiming(ref Compositor_FrameTiming, UInt32)

Declaration

public bool GetFrameTiming(ref Compositor_FrameTiming pTiming, uint unFramesAgo)

Parameters

Type	Name	Description
Compositor_FrameTiming	pTiming
UInt32	unFramesAgo

Returns

Type	Description
Boolean

GetFrameTimings(ref Compositor_FrameTiming, UInt32)

Declaration

public uint GetFrameTimings(ref Compositor_FrameTiming pTiming, uint nFrames)

Parameters

Type	Name	Description
Compositor_FrameTiming	pTiming
UInt32	nFrames

Returns

Type	Description
UInt32

GetFrameTimings(ref Compositor_FrameTiming, UInt32)

Declaration

public uint GetFrameTimings(ref Compositor_FrameTiming pTiming, uint nFrames)

Parameters

Type	Name	Description
Compositor_FrameTiming	pTiming
UInt32	nFrames

Returns

Type	Description
UInt32

GetLastFrameRenderer()

Declaration

public uint GetLastFrameRenderer()

Returns

Type	Description
UInt32

GetLastFrameRenderer()

Declaration

public uint GetLastFrameRenderer()

Returns

Type	Description
UInt32

GetLastPoseForTrackedDeviceIndex(UInt32, ref TrackedDevicePose_t, ref TrackedDevicePose_t)

Declaration

public EVRCompositorError GetLastPoseForTrackedDeviceIndex(uint unDeviceIndex, ref TrackedDevicePose_t pOutputPose, ref TrackedDevicePose_t pOutputGamePose)

Parameters

Type	Name	Description
UInt32	unDeviceIndex
TrackedDevicePose_t	pOutputPose
TrackedDevicePose_t	pOutputGamePose

Returns

Type	Description
EVRCompositorError

GetLastPoseForTrackedDeviceIndex(UInt32, ref TrackedDevicePose_t, ref TrackedDevicePose_t)

Declaration

public EVRCompositorError GetLastPoseForTrackedDeviceIndex(uint unDeviceIndex, ref TrackedDevicePose_t pOutputPose, ref TrackedDevicePose_t pOutputGamePose)

Parameters

Type	Name	Description
UInt32	unDeviceIndex
TrackedDevicePose_t	pOutputPose
TrackedDevicePose_t	pOutputGamePose

Returns

Type	Description
EVRCompositorError

GetLastPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

Declaration

public EVRCompositorError GetLastPoses(TrackedDevicePose_t[] pRenderPoseArray, TrackedDevicePose_t[] pGamePoseArray)

Parameters

Type	Name	Description
TrackedDevicePose_t[]	pRenderPoseArray
TrackedDevicePose_t[]	pGamePoseArray

Returns

Type	Description
EVRCompositorError

GetLastPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

Declaration

public EVRCompositorError GetLastPoses(TrackedDevicePose_t[] pRenderPoseArray, TrackedDevicePose_t[] pGamePoseArray)

Parameters

Type	Name	Description
TrackedDevicePose_t[]	pRenderPoseArray
TrackedDevicePose_t[]	pGamePoseArray

Returns

Type	Description
EVRCompositorError

GetMirrorTextureD3D11(EVREye, IntPtr, ref IntPtr)

Declaration

public EVRCompositorError GetMirrorTextureD3D11(EVREye eEye, IntPtr pD3D11DeviceOrResource, ref IntPtr ppD3D11ShaderResourceView)

Parameters

Type	Name	Description
EVREye	eEye
IntPtr	pD3D11DeviceOrResource
IntPtr	ppD3D11ShaderResourceView

Returns

Type	Description
EVRCompositorError

GetMirrorTextureD3D11(EVREye, IntPtr, ref IntPtr)

Declaration

public EVRCompositorError GetMirrorTextureD3D11(EVREye eEye, IntPtr pD3D11DeviceOrResource, ref IntPtr ppD3D11ShaderResourceView)

Parameters

Type	Name	Description
EVREye	eEye
IntPtr	pD3D11DeviceOrResource
IntPtr	ppD3D11ShaderResourceView

Returns

Type	Description
EVRCompositorError

GetMirrorTextureGL(EVREye, ref UInt32, IntPtr)

Declaration

public EVRCompositorError GetMirrorTextureGL(EVREye eEye, ref uint pglTextureId, IntPtr pglSharedTextureHandle)

Parameters

Type	Name	Description
EVREye	eEye
UInt32	pglTextureId
IntPtr	pglSharedTextureHandle

Returns

Type	Description
EVRCompositorError

GetMirrorTextureGL(EVREye, ref UInt32, IntPtr)

Declaration

public EVRCompositorError GetMirrorTextureGL(EVREye eEye, ref uint pglTextureId, IntPtr pglSharedTextureHandle)

Parameters

Type	Name	Description
EVREye	eEye
UInt32	pglTextureId
IntPtr	pglSharedTextureHandle

Returns

Type	Description
EVRCompositorError

GetTrackingSpace()

Declaration

public ETrackingUniverseOrigin GetTrackingSpace()

Returns

Type	Description
ETrackingUniverseOrigin

GetTrackingSpace()

Declaration

public ETrackingUniverseOrigin GetTrackingSpace()

Returns

Type	Description
ETrackingUniverseOrigin

GetVulkanDeviceExtensionsRequired(IntPtr, StringBuilder, UInt32)

Declaration

public uint GetVulkanDeviceExtensionsRequired(IntPtr pPhysicalDevice, StringBuilder pchValue, uint unBufferSize)

Parameters

Type	Name	Description
IntPtr	pPhysicalDevice
StringBuilder	pchValue
UInt32	unBufferSize

Returns

Type	Description
UInt32

GetVulkanDeviceExtensionsRequired(IntPtr, StringBuilder, UInt32)

Declaration

public uint GetVulkanDeviceExtensionsRequired(IntPtr pPhysicalDevice, StringBuilder pchValue, uint unBufferSize)

Parameters

Type	Name	Description
IntPtr	pPhysicalDevice
StringBuilder	pchValue
UInt32	unBufferSize

Returns

Type	Description
UInt32

GetVulkanInstanceExtensionsRequired(StringBuilder, UInt32)

Declaration

public uint GetVulkanInstanceExtensionsRequired(StringBuilder pchValue, uint unBufferSize)

Parameters

Type	Name	Description
StringBuilder	pchValue
UInt32	unBufferSize

Returns

Type	Description
UInt32

GetVulkanInstanceExtensionsRequired(StringBuilder, UInt32)

Declaration

public uint GetVulkanInstanceExtensionsRequired(StringBuilder pchValue, uint unBufferSize)

Parameters

Type	Name	Description
StringBuilder	pchValue
UInt32	unBufferSize

Returns

Type	Description
UInt32

HideMirrorWindow()

Declaration

public void HideMirrorWindow()

HideMirrorWindow()

Declaration

public void HideMirrorWindow()

IsFullscreen()

Declaration

public bool IsFullscreen()

Returns

Type	Description
Boolean

IsFullscreen()

Declaration

public bool IsFullscreen()

Returns

Type	Description
Boolean

IsMirrorWindowVisible()

Declaration

public bool IsMirrorWindowVisible()

Returns

Type	Description
Boolean

IsMirrorWindowVisible()

Declaration

public bool IsMirrorWindowVisible()

Returns

Type	Description
Boolean

IsMotionSmoothingEnabled()

Declaration

public bool IsMotionSmoothingEnabled()

Returns

Type	Description
Boolean

IsMotionSmoothingEnabled()

Declaration

public bool IsMotionSmoothingEnabled()

Returns

Type	Description
Boolean

LockGLSharedTextureForAccess(IntPtr)

Declaration

public void LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
IntPtr	glSharedTextureHandle

LockGLSharedTextureForAccess(IntPtr)

Declaration

public void LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
IntPtr	glSharedTextureHandle

PostPresentHandoff()

Declaration

public void PostPresentHandoff()

PostPresentHandoff()

Declaration

public void PostPresentHandoff()

ReleaseMirrorTextureD3D11(IntPtr)

Declaration

public void ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView)

Parameters

Type	Name	Description
IntPtr	pD3D11ShaderResourceView

ReleaseMirrorTextureD3D11(IntPtr)

Declaration

public void ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView)

Parameters

Type	Name	Description
IntPtr	pD3D11ShaderResourceView

ReleaseSharedGLTexture(UInt32, IntPtr)

Declaration

public bool ReleaseSharedGLTexture(uint glTextureId, IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
UInt32	glTextureId
IntPtr	glSharedTextureHandle

Returns

Type	Description
Boolean

ReleaseSharedGLTexture(UInt32, IntPtr)

Declaration

public bool ReleaseSharedGLTexture(uint glTextureId, IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
UInt32	glTextureId
IntPtr	glSharedTextureHandle

Returns

Type	Description
Boolean

SetExplicitTimingMode(EVRCompositorTimingMode)

Declaration

public void SetExplicitTimingMode(EVRCompositorTimingMode eTimingMode)

Parameters

Type	Name	Description
EVRCompositorTimingMode	eTimingMode

SetExplicitTimingMode(EVRCompositorTimingMode)

Declaration

public void SetExplicitTimingMode(EVRCompositorTimingMode eTimingMode)

Parameters

Type	Name	Description
EVRCompositorTimingMode	eTimingMode

SetSkyboxOverride(Texture_t[])

Declaration

public EVRCompositorError SetSkyboxOverride(Texture_t[] pTextures)

Parameters

Type	Name	Description
Texture_t[]	pTextures

Returns

Type	Description
EVRCompositorError

SetSkyboxOverride(Texture_t[])

Declaration

public EVRCompositorError SetSkyboxOverride(Texture_t[] pTextures)

Parameters

Type	Name	Description
Texture_t[]	pTextures

Returns

Type	Description
EVRCompositorError

SetTrackingSpace(ETrackingUniverseOrigin)

Declaration

public void SetTrackingSpace(ETrackingUniverseOrigin eOrigin)

Parameters

Type	Name	Description
ETrackingUniverseOrigin	eOrigin

SetTrackingSpace(ETrackingUniverseOrigin)

Declaration

public void SetTrackingSpace(ETrackingUniverseOrigin eOrigin)

Parameters

Type	Name	Description
ETrackingUniverseOrigin	eOrigin

ShouldAppRenderWithLowResources()

Declaration

public bool ShouldAppRenderWithLowResources()

Returns

Type	Description
Boolean

ShouldAppRenderWithLowResources()

Declaration

public bool ShouldAppRenderWithLowResources()

Returns

Type	Description
Boolean

ShowMirrorWindow()

Declaration

public void ShowMirrorWindow()

ShowMirrorWindow()

Declaration

public void ShowMirrorWindow()

Submit(EVREye, ref Texture_t, ref VRTextureBounds_t, EVRSubmitFlags)

Declaration

public EVRCompositorError Submit(EVREye eEye, ref Texture_t pTexture, ref VRTextureBounds_t pBounds, EVRSubmitFlags nSubmitFlags)

Parameters

Type	Name	Description
EVREye	eEye
Texture_t	pTexture
VRTextureBounds_t	pBounds
EVRSubmitFlags	nSubmitFlags

Returns

Type	Description
EVRCompositorError

Submit(EVREye, ref Texture_t, ref VRTextureBounds_t, EVRSubmitFlags)

Declaration

public EVRCompositorError Submit(EVREye eEye, ref Texture_t pTexture, ref VRTextureBounds_t pBounds, EVRSubmitFlags nSubmitFlags)

Parameters

Type	Name	Description
EVREye	eEye
Texture_t	pTexture
VRTextureBounds_t	pBounds
EVRSubmitFlags	nSubmitFlags

Returns

Type	Description
EVRCompositorError

SubmitExplicitTimingData()

Declaration

public EVRCompositorError SubmitExplicitTimingData()

Returns

Type	Description
EVRCompositorError

SubmitExplicitTimingData()

Declaration

public EVRCompositorError SubmitExplicitTimingData()

Returns

Type	Description
EVRCompositorError

SuspendRendering(Boolean)

Declaration

public void SuspendRendering(bool bSuspend)

Parameters

Type	Name	Description
Boolean	bSuspend

SuspendRendering(Boolean)

Declaration

public void SuspendRendering(bool bSuspend)

Parameters

Type	Name	Description
Boolean	bSuspend

UnlockGLSharedTextureForAccess(IntPtr)

Declaration

public void UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
IntPtr	glSharedTextureHandle

UnlockGLSharedTextureForAccess(IntPtr)

Declaration

public void UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

Type	Name	Description
IntPtr	glSharedTextureHandle

WaitGetPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

Declaration

public EVRCompositorError WaitGetPoses(TrackedDevicePose_t[] pRenderPoseArray, TrackedDevicePose_t[] pGamePoseArray)

Parameters

Type	Name	Description
TrackedDevicePose_t[]	pRenderPoseArray
TrackedDevicePose_t[]	pGamePoseArray

Returns

Type	Description
EVRCompositorError

WaitGetPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

Declaration

public EVRCompositorError WaitGetPoses(TrackedDevicePose_t[] pRenderPoseArray, TrackedDevicePose_t[] pGamePoseArray)

Parameters

Type	Name	Description
TrackedDevicePose_t[]	pRenderPoseArray
TrackedDevicePose_t[]	pGamePoseArray

Returns

Type	Description
EVRCompositorError