CVRCompositor Class

    Namespace: Valve.VR
    Assembly: Stride.VirtualReality.dll
    System.Object → CVRCompositor
    Derived from CVRCompositor: 

    public class CVRCompositor
    Name Description
    Methods
    CanRenderScene()
    ClearLastSubmittedFrame()
    ClearSkyboxOverride()
    ClearStageOverride()
    CompositorBringToFront()
    CompositorDumpImages()
    CompositorGoToBack()
    CompositorQuit()
    FadeGrid(Single, Boolean)
    FadeToColor(Single, Single, Single, Single, Single, Boolean)
    ForceInterleavedReprojectionOn(Boolean)
    ForceReconnectProcess()
    GetCompositorBenchmarkResults(ref Compositor_BenchmarkResults, UInt32)
    GetCumulativeStats(ref Compositor_CumulativeStats, UInt32)
    GetCurrentFadeColor(Boolean)
    GetCurrentGridAlpha()
    GetCurrentSceneFocusProcess()
    GetFrameTimeRemaining()
    GetFrameTiming(ref Compositor_FrameTiming, UInt32)
    GetFrameTimings(Compositor_FrameTiming[])
    GetLastFrameRenderer()
    GetLastPoseForTrackedDeviceIndex(UInt32, ref TrackedDevicePose_t, ref TrackedDevicePose_t)
    GetLastPosePredictionIDs(ref UInt32, ref UInt32)
    GetLastPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])
    GetMirrorTextureD3D11(EVREye, IntPtr, ref IntPtr)
    GetMirrorTextureGL(EVREye, ref UInt32, IntPtr)
    GetPosesForFrame(UInt32, TrackedDevicePose_t[])
    GetTrackingSpace()
    GetVulkanDeviceExtensionsRequired(IntPtr, StringBuilder, UInt32)
    GetVulkanInstanceExtensionsRequired(StringBuilder, UInt32)
    HideMirrorWindow()
    IsCurrentSceneFocusAppLoading()
    IsFullscreen()
    IsMirrorWindowVisible()
    IsMotionSmoothingEnabled()
    IsMotionSmoothingSupported()
    LockGLSharedTextureForAccess(IntPtr)
    PostPresentHandoff()
    ReleaseMirrorTextureD3D11(IntPtr)
    ReleaseSharedGLTexture(UInt32, IntPtr)
    SetExplicitTimingMode(EVRCompositorTimingMode)
    SetSkyboxOverride(Texture_t[])
    SetStageOverride_Async(String, ref HmdMatrix34_t, ref Compositor_StageRenderSettings, UInt32)
    SetTrackingSpace(ETrackingUniverseOrigin)
    ShouldAppRenderWithLowResources()
    ShowMirrorWindow()
    Submit(EVREye, ref Texture_t, ref VRTextureBounds_t, EVRSubmitFlags)
    SubmitExplicitTimingData()
    SuspendRendering(Boolean)
    UnlockGLSharedTextureForAccess(IntPtr)
    WaitGetPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])
    | Improve this Doc View Source

    Methods

    CanRenderScene()

    public bool CanRenderScene()
    Returns
    Type Description
    System.Boolean

    ClearLastSubmittedFrame()

    public void ClearLastSubmittedFrame()

    ClearSkyboxOverride()

    public void ClearSkyboxOverride()

    ClearStageOverride()

    public void ClearStageOverride()

    CompositorBringToFront()

    public void CompositorBringToFront()

    CompositorDumpImages()

    public void CompositorDumpImages()

    CompositorGoToBack()

    public void CompositorGoToBack()

    CompositorQuit()

    public void CompositorQuit()

    FadeGrid(Single, Boolean)

    public void FadeGrid(float fSeconds, bool bFadeIn)
    Parameters
    Type Name Description
    System.Single fSeconds
    System.Boolean bFadeIn

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

    public void FadeToColor(float fSeconds, float fRed, float fGreen, float fBlue, float fAlpha, bool bBackground)
    Parameters
    Type Name Description
    System.Single fSeconds
    System.Single fRed
    System.Single fGreen
    System.Single fBlue
    System.Single fAlpha
    System.Boolean bBackground

    ForceInterleavedReprojectionOn(Boolean)

    public void ForceInterleavedReprojectionOn(bool bOverride)
    Parameters
    Type Name Description
    System.Boolean bOverride

    ForceReconnectProcess()

    public void ForceReconnectProcess()

    GetCompositorBenchmarkResults(ref Compositor_BenchmarkResults, UInt32)

    public bool GetCompositorBenchmarkResults(ref Compositor_BenchmarkResults pBenchmarkResults, uint nSizeOfBenchmarkResults)
    Parameters
    Type Name Description
    Compositor_BenchmarkResults pBenchmarkResults
    System.UInt32 nSizeOfBenchmarkResults
    Returns
    Type Description
    System.Boolean

    GetCumulativeStats(ref Compositor_CumulativeStats, UInt32)

    public void GetCumulativeStats(ref Compositor_CumulativeStats pStats, uint nStatsSizeInBytes)
    Parameters
    Type Name Description
    Compositor_CumulativeStats pStats
    System.UInt32 nStatsSizeInBytes

    GetCurrentFadeColor(Boolean)

    public HmdColor_t GetCurrentFadeColor(bool bBackground)
    Parameters
    Type Name Description
    System.Boolean bBackground
    Returns
    Type Description
    HmdColor_t

    GetCurrentGridAlpha()

    public float GetCurrentGridAlpha()
    Returns
    Type Description
    System.Single

    GetCurrentSceneFocusProcess()

    public uint GetCurrentSceneFocusProcess()
    Returns
    Type Description
    System.UInt32

    GetFrameTimeRemaining()

    public float GetFrameTimeRemaining()
    Returns
    Type Description
    System.Single

    GetFrameTiming(ref Compositor_FrameTiming, UInt32)

    public bool GetFrameTiming(ref Compositor_FrameTiming pTiming, uint unFramesAgo)
    Parameters
    Type Name Description
    Compositor_FrameTiming pTiming
    System.UInt32 unFramesAgo
    Returns
    Type Description
    System.Boolean

    GetFrameTimings(Compositor_FrameTiming[])

    public uint GetFrameTimings(Compositor_FrameTiming[] pTiming)
    Parameters
    Type Name Description
    Compositor_FrameTiming[] pTiming
    Returns
    Type Description
    System.UInt32

    GetLastFrameRenderer()

    public uint GetLastFrameRenderer()
    Returns
    Type Description
    System.UInt32

    GetLastPoseForTrackedDeviceIndex(UInt32, ref TrackedDevicePose_t, ref TrackedDevicePose_t)

    public EVRCompositorError GetLastPoseForTrackedDeviceIndex(uint unDeviceIndex, ref TrackedDevicePose_t pOutputPose, ref TrackedDevicePose_t pOutputGamePose)
    Parameters
    Type Name Description
    System.UInt32 unDeviceIndex
    TrackedDevicePose_t pOutputPose
    TrackedDevicePose_t pOutputGamePose
    Returns
    Type Description
    EVRCompositorError

    GetLastPosePredictionIDs(ref UInt32, ref UInt32)

    public EVRCompositorError GetLastPosePredictionIDs(ref uint pRenderPosePredictionID, ref uint pGamePosePredictionID)
    Parameters
    Type Name Description
    System.UInt32 pRenderPosePredictionID
    System.UInt32 pGamePosePredictionID
    Returns
    Type Description
    EVRCompositorError

    GetLastPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

    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)

    public EVRCompositorError GetMirrorTextureD3D11(EVREye eEye, IntPtr pD3D11DeviceOrResource, ref IntPtr ppD3D11ShaderResourceView)
    Parameters
    Type Name Description
    EVREye eEye
    System.IntPtr pD3D11DeviceOrResource
    System.IntPtr ppD3D11ShaderResourceView
    Returns
    Type Description
    EVRCompositorError

    GetMirrorTextureGL(EVREye, ref UInt32, IntPtr)

    public EVRCompositorError GetMirrorTextureGL(EVREye eEye, ref uint pglTextureId, IntPtr pglSharedTextureHandle)
    Parameters
    Type Name Description
    EVREye eEye
    System.UInt32 pglTextureId
    System.IntPtr pglSharedTextureHandle
    Returns
    Type Description
    EVRCompositorError

    GetPosesForFrame(UInt32, TrackedDevicePose_t[])

    public EVRCompositorError GetPosesForFrame(uint unPosePredictionID, TrackedDevicePose_t[] pPoseArray)
    Parameters
    Type Name Description
    System.UInt32 unPosePredictionID
    TrackedDevicePose_t[] pPoseArray
    Returns
    Type Description
    EVRCompositorError

    GetTrackingSpace()

    public ETrackingUniverseOrigin GetTrackingSpace()
    Returns
    Type Description
    ETrackingUniverseOrigin

    GetVulkanDeviceExtensionsRequired(IntPtr, StringBuilder, UInt32)

    public uint GetVulkanDeviceExtensionsRequired(IntPtr pPhysicalDevice, StringBuilder pchValue, uint unBufferSize)
    Parameters
    Type Name Description
    System.IntPtr pPhysicalDevice
    System.Text.StringBuilder pchValue
    System.UInt32 unBufferSize
    Returns
    Type Description
    System.UInt32

    GetVulkanInstanceExtensionsRequired(StringBuilder, UInt32)

    public uint GetVulkanInstanceExtensionsRequired(StringBuilder pchValue, uint unBufferSize)
    Parameters
    Type Name Description
    System.Text.StringBuilder pchValue
    System.UInt32 unBufferSize
    Returns
    Type Description
    System.UInt32

    HideMirrorWindow()

    public void HideMirrorWindow()

    IsCurrentSceneFocusAppLoading()

    public bool IsCurrentSceneFocusAppLoading()
    Returns
    Type Description
    System.Boolean

    IsFullscreen()

    public bool IsFullscreen()
    Returns
    Type Description
    System.Boolean

    IsMirrorWindowVisible()

    public bool IsMirrorWindowVisible()
    Returns
    Type Description
    System.Boolean

    IsMotionSmoothingEnabled()

    public bool IsMotionSmoothingEnabled()
    Returns
    Type Description
    System.Boolean

    IsMotionSmoothingSupported()

    public bool IsMotionSmoothingSupported()
    Returns
    Type Description
    System.Boolean

    LockGLSharedTextureForAccess(IntPtr)

    public void LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)
    Parameters
    Type Name Description
    System.IntPtr glSharedTextureHandle

    PostPresentHandoff()

    public void PostPresentHandoff()

    ReleaseMirrorTextureD3D11(IntPtr)

    public void ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView)
    Parameters
    Type Name Description
    System.IntPtr pD3D11ShaderResourceView

    ReleaseSharedGLTexture(UInt32, IntPtr)

    public bool ReleaseSharedGLTexture(uint glTextureId, IntPtr glSharedTextureHandle)
    Parameters
    Type Name Description
    System.UInt32 glTextureId
    System.IntPtr glSharedTextureHandle
    Returns
    Type Description
    System.Boolean

    SetExplicitTimingMode(EVRCompositorTimingMode)

    public void SetExplicitTimingMode(EVRCompositorTimingMode eTimingMode)
    Parameters
    Type Name Description
    EVRCompositorTimingMode eTimingMode

    SetSkyboxOverride(Texture_t[])

    public EVRCompositorError SetSkyboxOverride(Texture_t[] pTextures)
    Parameters
    Type Name Description
    Texture_t[] pTextures
    Returns
    Type Description
    EVRCompositorError

    SetStageOverride_Async(String, ref HmdMatrix34_t, ref Compositor_StageRenderSettings, UInt32)

    public EVRCompositorError SetStageOverride_Async(string pchRenderModelPath, ref HmdMatrix34_t pTransform, ref Compositor_StageRenderSettings pRenderSettings, uint nSizeOfRenderSettings)
    Parameters
    Type Name Description
    System.String pchRenderModelPath
    HmdMatrix34_t pTransform
    Compositor_StageRenderSettings pRenderSettings
    System.UInt32 nSizeOfRenderSettings
    Returns
    Type Description
    EVRCompositorError

    SetTrackingSpace(ETrackingUniverseOrigin)

    public void SetTrackingSpace(ETrackingUniverseOrigin eOrigin)
    Parameters
    Type Name Description
    ETrackingUniverseOrigin eOrigin

    ShouldAppRenderWithLowResources()

    public bool ShouldAppRenderWithLowResources()
    Returns
    Type Description
    System.Boolean

    ShowMirrorWindow()

    public void ShowMirrorWindow()

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

    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()

    public EVRCompositorError SubmitExplicitTimingData()
    Returns
    Type Description
    EVRCompositorError

    SuspendRendering(Boolean)

    public void SuspendRendering(bool bSuspend)
    Parameters
    Type Name Description
    System.Boolean bSuspend

    UnlockGLSharedTextureForAccess(IntPtr)

    public void UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)
    Parameters
    Type Name Description
    System.IntPtr glSharedTextureHandle

    WaitGetPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

    public EVRCompositorError WaitGetPoses(TrackedDevicePose_t[] pRenderPoseArray, TrackedDevicePose_t[] pGamePoseArray)
    Parameters
    Type Name Description
    TrackedDevicePose_t[] pRenderPoseArray
    TrackedDevicePose_t[] pGamePoseArray
    Returns
    Type Description
    EVRCompositorError

    Extension Methods