Class CVRCompositor

Namespace

Valve.VR

Assembly

Stride.VirtualReality.dll

public class CVRCompositor

Inheritance

object

CVRCompositor

Methods

CanRenderScene()

public bool CanRenderScene()

Returns

bool

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(float, bool)

public void FadeGrid(float fSeconds, bool bFadeIn)

Parameters

fSeconds float

bFadeIn bool

FadeToColor(float, float, float, float, float, bool)

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

Parameters

fSeconds float

fRed float

fGreen float

fBlue float

fAlpha float

bBackground bool

ForceInterleavedReprojectionOn(bool)

public void ForceInterleavedReprojectionOn(bool bOverride)

Parameters

bOverride bool

ForceReconnectProcess()

public void ForceReconnectProcess()

GetCompositorBenchmarkResults(ref Compositor_BenchmarkResults, uint)

public bool GetCompositorBenchmarkResults(ref Compositor_BenchmarkResults pBenchmarkResults, uint nSizeOfBenchmarkResults)

Parameters

pBenchmarkResults Compositor_BenchmarkResults

nSizeOfBenchmarkResults uint

Returns

bool

GetCumulativeStats(ref Compositor_CumulativeStats, uint)

public void GetCumulativeStats(ref Compositor_CumulativeStats pStats, uint nStatsSizeInBytes)

Parameters

pStats Compositor_CumulativeStats

nStatsSizeInBytes uint

GetCurrentFadeColor(bool)

public HmdColor_t GetCurrentFadeColor(bool bBackground)

Parameters

bBackground bool

Returns

HmdColor_t

GetCurrentGridAlpha()

public float GetCurrentGridAlpha()

Returns

float

GetCurrentSceneFocusProcess()

public uint GetCurrentSceneFocusProcess()

Returns

uint

GetFrameTimeRemaining()

public float GetFrameTimeRemaining()

Returns

float

GetFrameTiming(ref Compositor_FrameTiming, uint)

public bool GetFrameTiming(ref Compositor_FrameTiming pTiming, uint unFramesAgo)

Parameters

pTiming Compositor_FrameTiming

unFramesAgo uint

Returns

bool

GetFrameTimings(Compositor_FrameTiming[])

public uint GetFrameTimings(Compositor_FrameTiming[] pTiming)

Parameters

pTiming Compositor_FrameTiming[]

Returns

uint

GetLastFrameRenderer()

public uint GetLastFrameRenderer()

Returns

uint

GetLastPoseForTrackedDeviceIndex(uint, ref TrackedDevicePose_t, ref TrackedDevicePose_t)

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

Parameters

unDeviceIndex uint

pOutputPose TrackedDevicePose_t

pOutputGamePose TrackedDevicePose_t

Returns

EVRCompositorError

GetLastPosePredictionIDs(ref uint, ref uint)

public EVRCompositorError GetLastPosePredictionIDs(ref uint pRenderPosePredictionID, ref uint pGamePosePredictionID)

Parameters

pRenderPosePredictionID uint

pGamePosePredictionID uint

Returns

EVRCompositorError

GetLastPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

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

Parameters

pRenderPoseArray TrackedDevicePose_t[]

pGamePoseArray TrackedDevicePose_t[]

Returns

EVRCompositorError

GetMirrorTextureD3D11(EVREye, IntPtr, ref IntPtr)

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

Parameters

eEye EVREye

pD3D11DeviceOrResource IntPtr

ppD3D11ShaderResourceView IntPtr

Returns

EVRCompositorError

GetMirrorTextureGL(EVREye, ref uint, IntPtr)

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

Parameters

eEye EVREye

pglTextureId uint

pglSharedTextureHandle IntPtr

Returns

EVRCompositorError

GetPosesForFrame(uint, TrackedDevicePose_t[])

public EVRCompositorError GetPosesForFrame(uint unPosePredictionID, TrackedDevicePose_t[] pPoseArray)

Parameters

unPosePredictionID uint

pPoseArray TrackedDevicePose_t[]

Returns

EVRCompositorError

GetTrackingSpace()

public ETrackingUniverseOrigin GetTrackingSpace()

Returns

ETrackingUniverseOrigin

GetVulkanDeviceExtensionsRequired(IntPtr, StringBuilder, uint)

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

Parameters

pPhysicalDevice IntPtr

pchValue StringBuilder

unBufferSize uint

Returns

uint

GetVulkanInstanceExtensionsRequired(StringBuilder, uint)

public uint GetVulkanInstanceExtensionsRequired(StringBuilder pchValue, uint unBufferSize)

Parameters

pchValue StringBuilder

unBufferSize uint

Returns

uint

HideMirrorWindow()

public void HideMirrorWindow()

IsCurrentSceneFocusAppLoading()

public bool IsCurrentSceneFocusAppLoading()

Returns

bool

IsFullscreen()

public bool IsFullscreen()

Returns

bool

IsMirrorWindowVisible()

public bool IsMirrorWindowVisible()

Returns

bool

IsMotionSmoothingEnabled()

public bool IsMotionSmoothingEnabled()

Returns

bool

IsMotionSmoothingSupported()

public bool IsMotionSmoothingSupported()

Returns

bool

LockGLSharedTextureForAccess(IntPtr)

public void LockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

glSharedTextureHandle IntPtr

PostPresentHandoff()

public void PostPresentHandoff()

ReleaseMirrorTextureD3D11(IntPtr)

public void ReleaseMirrorTextureD3D11(IntPtr pD3D11ShaderResourceView)

Parameters

pD3D11ShaderResourceView IntPtr

ReleaseSharedGLTexture(uint, IntPtr)

public bool ReleaseSharedGLTexture(uint glTextureId, IntPtr glSharedTextureHandle)

Parameters

glTextureId uint

glSharedTextureHandle IntPtr

Returns

bool

SetExplicitTimingMode(EVRCompositorTimingMode)

public void SetExplicitTimingMode(EVRCompositorTimingMode eTimingMode)

Parameters

eTimingMode EVRCompositorTimingMode

SetSkyboxOverride(Texture_t[])

public EVRCompositorError SetSkyboxOverride(Texture_t[] pTextures)

Parameters

pTextures Texture_t[]

Returns

EVRCompositorError

SetStageOverride_Async(string, ref HmdMatrix34_t, ref Compositor_StageRenderSettings, uint)

public EVRCompositorError SetStageOverride_Async(string pchRenderModelPath, ref HmdMatrix34_t pTransform, ref Compositor_StageRenderSettings pRenderSettings, uint nSizeOfRenderSettings)

Parameters

pchRenderModelPath string

pTransform HmdMatrix34_t

pRenderSettings Compositor_StageRenderSettings

nSizeOfRenderSettings uint

Returns

EVRCompositorError

SetTrackingSpace(ETrackingUniverseOrigin)

public void SetTrackingSpace(ETrackingUniverseOrigin eOrigin)

Parameters

eOrigin ETrackingUniverseOrigin

ShouldAppRenderWithLowResources()

public bool ShouldAppRenderWithLowResources()

Returns

bool

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

eEye EVREye

pTexture Texture_t

pBounds VRTextureBounds_t

nSubmitFlags EVRSubmitFlags

Returns

EVRCompositorError

SubmitExplicitTimingData()

public EVRCompositorError SubmitExplicitTimingData()

Returns

EVRCompositorError

SuspendRendering(bool)

public void SuspendRendering(bool bSuspend)

Parameters

bSuspend bool

UnlockGLSharedTextureForAccess(IntPtr)

public void UnlockGLSharedTextureForAccess(IntPtr glSharedTextureHandle)

Parameters

glSharedTextureHandle IntPtr

WaitGetPoses(TrackedDevicePose_t[], TrackedDevicePose_t[])

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

Parameters

pRenderPoseArray TrackedDevicePose_t[]

pGamePoseArray TrackedDevicePose_t[]

Returns

EVRCompositorError