• Articles
  • Tutorials
  • Api Documentation
  • Api Documentation
  • Valve.VR
  • CVRScreenshots

    Show / Hide Table of Contents
    • Valve.VR
      • AppOverrideKeys_t
      • CameraVideoStreamFrameHeader_t
      • ChaperoneCalibrationState
      • Compositor_CumulativeStats
      • Compositor_FrameTiming
      • Compositor_OverlaySettings
      • COpenVRContext
      • CVRApplications
      • CVRChaperone
      • CVRChaperoneSetup
      • CVRCompositor
      • CVRDriverManager
      • CVRExtendedDisplay
      • CVRInput
      • CVRIOBuffer
      • CVRNotifications
      • CVROverlay
      • CVRRenderModels
      • CVRResources
      • CVRScreenshots
      • CVRSettingHelper
      • CVRSettings
      • CVRSpatialAnchors
      • CVRSystem
      • CVRTrackedCamera
      • D3D12TextureData_t
      • DistortionCoordinates_t
      • DriverDirectMode_FrameTiming
      • EAdditionalRadioFeatures
      • EChaperoneConfigFile
      • EChaperoneImportFlags
      • ECollisionBoundsStyle
      • EColorSpace
      • EDeviceActivityLevel
      • EDualAnalogWhich
      • EGamepadTextInputLineMode
      • EGamepadTextInputMode
      • EHDCPError
      • EHiddenAreaMeshType
      • EIOBufferError
      • EIOBufferMode
      • EOverlayDirection
      • EShowUIType
      • ETextureType
      • ETrackedControllerRole
      • ETrackedDeviceClass
      • ETrackedDeviceProperty
      • ETrackedPropertyError
      • ETrackingResult
      • ETrackingUniverseOrigin
      • EVRApplicationError
      • EVRApplicationProperty
      • EVRApplicationTransitionState
      • EVRApplicationType
      • EVRButtonId
      • EVRComponentProperty
      • EVRCompositorError
      • EVRCompositorTimingMode
      • EVRControllerAxisType
      • EVRControllerEventOutputType
      • EVRDistortionFunctionType
      • EVREventType
      • EVREye
      • EVRFinger
      • EVRFingerSplay
      • EVRFirmwareError
      • EVRInitError
      • EVRInputError
      • EVRInputFilterCancelType
      • EVRInputStringBits
      • EVRMouseButton
      • EVRMuraCorrectionMode
      • EVRNotificationError
      • EVRNotificationStyle
      • EVRNotificationType
      • EVROverlayError
      • EVROverlayIntersectionMaskPrimitiveType
      • EVRRenderModelError
      • EVRScreenshotError
      • EVRScreenshotPropertyFilenames
      • EVRScreenshotType
      • EVRSettingsError
      • EVRSkeletalMotionRange
      • EVRSkeletalReferencePose
      • EVRSkeletalTrackingLevel
      • EVRSkeletalTransformSpace
      • EVRSpatialAnchorError
      • EVRState
      • EVRSubmitFlags
      • EVRTrackedCameraError
      • EVRTrackedCameraFrameLayout
      • EVRTrackedCameraFrameType
      • EVSync
      • HiddenAreaMesh_t
      • HmdColor_t
      • HmdMatrix33_t
      • HmdMatrix34_t
      • HmdMatrix44_t
      • HmdQuad_t
      • HmdQuaternion_t
      • HmdQuaternionf_t
      • HmdRect2_t
      • HmdVector2_t
      • HmdVector3_t
      • HmdVector3d_t
      • HmdVector4_t
      • Imu_OffScaleFlags
      • ImuSample_t
      • InputAnalogActionData_t
      • InputDigitalActionData_t
      • InputOriginInfo_t
      • InputPoseActionData_t
      • InputSkeletalActionData_t
      • IntersectionMaskCircle_t
      • IntersectionMaskRectangle_t
      • ISteamVR_Action
      • ISteamVR_Action_Boolean
      • ISteamVR_Action_In
      • ISteamVR_Action_In_Source
      • ISteamVR_Action_Out
      • ISteamVR_Action_Out_Source
      • ISteamVR_Action_Pose
      • ISteamVR_Action_Single
      • ISteamVR_Action_Skeleton_Source
      • ISteamVR_Action_Source
      • ISteamVR_Action_Vector2
      • ISteamVR_Action_Vector3
      • ISteamVR_Action_Vibration
      • ISteamVR_ActionSet
      • IVRApplications
      • IVRChaperone
      • IVRChaperoneSetup
      • IVRCompositor
      • IVRDriverManager
      • IVRExtendedDisplay
      • IVRInput
      • IVRIOBuffer
      • IVRNotifications
      • IVROverlay
      • IVRRenderModels
      • IVRResources
      • IVRScreenshots
      • IVRSettings
      • IVRSpatialAnchors
      • IVRSystem
      • IVRTrackedCamera
      • NotificationBitmap_t
      • OpenVR
      • OpenVRInterop
      • RenderModel_ComponentState_t
      • RenderModel_ControllerMode_State_t
      • RenderModel_t
      • RenderModel_t_Packed
      • RenderModel_TextureMap_t
      • RenderModel_TextureMap_t_Packed
      • RenderModel_Vertex_t
      • SkeletalMotionRangeChange
      • SpatialAnchorPose_t
      • SteamVR
      • SteamVR.InitializedStates
      • SteamVR_Action
      • SteamVR_Action_Boolean
      • SteamVR_Action_Boolean.ActiveChangeHandler
      • SteamVR_Action_Boolean.ChangeHandler
      • SteamVR_Action_Boolean.StateDownHandler
      • SteamVR_Action_Boolean.StateHandler
      • SteamVR_Action_Boolean.StateUpHandler
      • SteamVR_Action_Boolean.UpdateHandler
      • SteamVR_Action_Boolean_Source
      • SteamVR_Action_Boolean_Source_Map
      • SteamVR_Action_In_Source
      • SteamVR_Action_In_Source_Map<SourceElement>
      • SteamVR_Action_In<SourceMap, SourceElement>
      • SteamVR_Action_Out_Source
      • SteamVR_Action_Out<SourceMap, SourceElement>
      • SteamVR_Action_Pose
      • SteamVR_Action_Pose.ActiveChangeHandler
      • SteamVR_Action_Pose.ChangeHandler
      • SteamVR_Action_Pose.DeviceConnectedChangeHandler
      • SteamVR_Action_Pose.TrackingChangeHandler
      • SteamVR_Action_Pose.UpdateHandler
      • SteamVR_Action_Pose.ValidPoseChangeHandler
      • SteamVR_Action_Pose_Base<SourceMap, SourceElement>
      • SteamVR_Action_Pose_Source
      • SteamVR_Action_Pose_Source_Map<Source>
      • SteamVR_Action_Single
      • SteamVR_Action_Single.ActiveChangeHandler
      • SteamVR_Action_Single.AxisHandler
      • SteamVR_Action_Single.ChangeHandler
      • SteamVR_Action_Single.UpdateHandler
      • SteamVR_Action_Single_Source
      • SteamVR_Action_Single_Source_Map
      • SteamVR_Action_Skeleton
      • SteamVR_Action_Skeleton.ActiveChangeHandler
      • SteamVR_Action_Skeleton.ChangeHandler
      • SteamVR_Action_Skeleton.DeviceConnectedChangeHandler
      • SteamVR_Action_Skeleton.TrackingChangeHandler
      • SteamVR_Action_Skeleton.UpdateHandler
      • SteamVR_Action_Skeleton.ValidPoseChangeHandler
      • SteamVR_Action_Skeleton_Source
      • SteamVR_Action_Skeleton_Source_Map
      • SteamVR_Action_Source
      • SteamVR_Action_Source_Map
      • SteamVR_Action_Source_Map<SourceElement>
      • SteamVR_Action_Vector2
      • SteamVR_Action_Vector2.ActiveChangeHandler
      • SteamVR_Action_Vector2.AxisHandler
      • SteamVR_Action_Vector2.ChangeHandler
      • SteamVR_Action_Vector2.UpdateHandler
      • SteamVR_Action_Vector2_Source
      • SteamVR_Action_Vector2_Source_Map
      • SteamVR_Action_Vector3
      • SteamVR_Action_Vector3.ActiveChangeHandler
      • SteamVR_Action_Vector3.AxisHandler
      • SteamVR_Action_Vector3.ChangeHandler
      • SteamVR_Action_Vector3.UpdateHandler
      • SteamVR_Action_Vector3_Source
      • SteamVR_Action_Vector3_Source_Map
      • SteamVR_Action_Vibration
      • SteamVR_Action_Vibration.ActiveChangeHandler
      • SteamVR_Action_Vibration.ExecuteHandler
      • SteamVR_Action_Vibration_Source
      • SteamVR_Action_Vibration_Source_Map
      • SteamVR_Action<SourceMap, SourceElement>
      • SteamVR_ActionDirections
      • SteamVR_Actions
      • SteamVR_ActionSet
      • SteamVR_ActionSet_Data
      • SteamVR_ActionSet_Manager
      • SteamVR_ActivateActionSetOnLoad
      • SteamVR_Behaviour
      • SteamVR_Behaviour_Boolean
      • SteamVR_Behaviour_Boolean.ActiveChangeHandler
      • SteamVR_Behaviour_Boolean.ChangeHandler
      • SteamVR_Behaviour_Boolean.StateDownHandler
      • SteamVR_Behaviour_Boolean.StateHandler
      • SteamVR_Behaviour_Boolean.StateUpHandler
      • SteamVR_Behaviour_Boolean.UpdateHandler
      • SteamVR_Behaviour_BooleanEvent
      • SteamVR_Behaviour_Pose
      • SteamVR_Behaviour_Pose.ActiveChangeHandler
      • SteamVR_Behaviour_Pose.ChangeHandler
      • SteamVR_Behaviour_Pose.DeviceConnectedChangeHandler
      • SteamVR_Behaviour_Pose.DeviceIndexChangedHandler
      • SteamVR_Behaviour_Pose.TrackingChangeHandler
      • SteamVR_Behaviour_Pose.UpdateHandler
      • SteamVR_Behaviour_Pose.ValidPoseChangeHandler
      • SteamVR_Behaviour_Pose_ConnectedChangedEvent
      • SteamVR_Behaviour_Pose_DeviceIndexChangedEvent
      • SteamVR_Behaviour_Pose_TrackingChangedEvent
      • SteamVR_Behaviour_PoseEvent
      • SteamVR_Behaviour_Single
      • SteamVR_Behaviour_Single.AxisHandler
      • SteamVR_Behaviour_Single.ChangeHandler
      • SteamVR_Behaviour_Single.UpdateHandler
      • SteamVR_Behaviour_SingleEvent
      • SteamVR_Behaviour_Skeleton
      • SteamVR_Behaviour_Skeleton.ActiveChangeHandler
      • SteamVR_Behaviour_Skeleton.ChangeHandler
      • SteamVR_Behaviour_Skeleton.DeviceConnectedChangeHandler
      • SteamVR_Behaviour_Skeleton.MirrorType
      • SteamVR_Behaviour_Skeleton.TrackingChangeHandler
      • SteamVR_Behaviour_Skeleton.UpdateHandler
      • SteamVR_Behaviour_Skeleton.ValidPoseChangeHandler
      • SteamVR_Behaviour_Skeleton_ConnectedChangedEvent
      • SteamVR_Behaviour_Skeleton_TrackingChangedEvent
      • SteamVR_Behaviour_SkeletonCustom
      • SteamVR_Behaviour_SkeletonEvent
      • SteamVR_Behaviour_Vector2
      • SteamVR_Behaviour_Vector2.AxisHandler
      • SteamVR_Behaviour_Vector2.ChangeHandler
      • SteamVR_Behaviour_Vector2.UpdateHandler
      • SteamVR_Behaviour_Vector2Event
      • SteamVR_Behaviour_Vector3
      • SteamVR_Behaviour_Vector3.AxisHandler
      • SteamVR_Behaviour_Vector3.ChangeHandler
      • SteamVR_Behaviour_Vector3.UpdateHandler
      • SteamVR_Behaviour_Vector3Event
      • SteamVR_Camera
      • SteamVR_CameraFlip
      • SteamVR_CameraMask
      • SteamVR_Ears
      • SteamVR_Events
      • SteamVR_Events.Action
      • SteamVR_Events.Action<T>
      • SteamVR_Events.Action<T0, T1, T2>
      • SteamVR_Events.Action<T0, T1>
      • SteamVR_Events.ActionNoArgs
      • SteamVR_Events.Event
      • SteamVR_Events.Event<T>
      • SteamVR_Events.Event<T0, T1, T2>
      • SteamVR_Events.Event<T0, T1>
      • SteamVR_ExternalCamera
      • SteamVR_ExternalCamera.Config
      • SteamVR_Fade
      • SteamVR_Frustum
      • SteamVR_HistoryBuffer
      • SteamVR_HistoryStep
      • SteamVR_IK
      • SteamVR_Input
      • SteamVR_Input.PosesUpdatedHandler
      • SteamVR_Input.SkeletonsUpdatedHandler
      • SteamVR_Input_ActionSet_buggy
      • SteamVR_Input_ActionSet_default
      • SteamVR_Input_ActionSet_mixedreality
      • SteamVR_Input_ActionSet_platformer
      • SteamVR_Input_Source
      • SteamVR_Input_Sources
      • SteamVR_Input_Sources_Comparer
      • SteamVR_LoadLevel
      • SteamVR_Menu
      • SteamVR_Overlay
      • SteamVR_Overlay.IntersectionResults
      • SteamVR_PlayArea
      • SteamVR_PlayArea.Size
      • SteamVR_Render
      • SteamVR_RenderModel
      • SteamVR_RenderModel.RenderModel
      • SteamVR_RenderModel.RenderModelInterfaceHolder
      • SteamVR_RingBuffer<T>
      • SteamVR_Settings
      • SteamVR_Skeleton_FingerExtensionTypeLists
      • SteamVR_Skeleton_FingerExtensionTypes
      • SteamVR_Skeleton_FingerIndexEnum
      • SteamVR_Skeleton_FingerIndexes
      • SteamVR_Skeleton_FingerSplayIndexEnum
      • SteamVR_Skeleton_FingerSplayIndexes
      • SteamVR_Skeleton_HandMask
      • SteamVR_Skeleton_JointIndexEnum
      • SteamVR_Skeleton_JointIndexes
      • SteamVR_Skeleton_Pose
      • SteamVR_Skeleton_Pose_Hand
      • SteamVR_Skeleton_Poser
      • SteamVR_Skeleton_Poser.PoseBlendingBehaviour
      • SteamVR_Skeleton_Poser.PoseBlendingBehaviour.BlenderTypes
      • SteamVR_Skeleton_Poser.SkeletonBlendablePose
      • SteamVR_Skeleton_PoseSnapshot
      • SteamVR_Skybox
      • SteamVR_Skybox.CellSize
      • SteamVR_SphericalProjection
      • SteamVR_TrackedCamera
      • SteamVR_TrackedCamera.VideoStreamTexture
      • SteamVR_TrackedObject
      • SteamVR_TrackedObject.EIndex
      • SteamVR_UpdateModes
      • SteamVR_Utils
      • SteamVR_Utils.RigidTransform
      • SteamVR_Utils.SystemFn
      • Texture_t
      • TrackedDevicePose_t
      • VRActiveActionSet_t
      • VRBoneTransform_t
      • VRControllerAxis_t
      • VRControllerState_t
      • VRControllerState_t_Packed
      • VREvent_ApplicationLaunch_t
      • VREvent_Chaperone_t
      • VREvent_Controller_t
      • VREvent_Data_t
      • VREvent_DualAnalog_t
      • VREvent_EditingCameraSurface_t
      • VREvent_HapticVibration_t
      • VREvent_HDCPError_t
      • VREvent_InputActionManifestLoad_t
      • VREvent_InputBindingLoad_t
      • VREvent_Ipd_t
      • VREvent_Keyboard_t
      • VREvent_MessageOverlay_t
      • VREvent_Mouse_t
      • VREvent_Notification_t
      • VREvent_Overlay_t
      • VREvent_PerformanceTest_t
      • VREvent_Process_t
      • VREvent_ProgressUpdate_t
      • VREvent_Property_t
      • VREvent_Reserved_t
      • VREvent_Screenshot_t
      • VREvent_ScreenshotProgress_t
      • VREvent_Scroll_t
      • VREvent_SeatedZeroPoseReset_t
      • VREvent_ShowDevTools_t
      • VREvent_ShowUI_t
      • VREvent_SpatialAnchor_t
      • VREvent_Status_t
      • VREvent_t
      • VREvent_t_Packed
      • VREvent_TouchPadMove_t
      • VREvent_WebConsole_t
      • VRMessageOverlayResponse
      • VROverlayFlags
      • VROverlayInputMethod
      • VROverlayIntersectionMaskPrimitive_Data_t
      • VROverlayIntersectionMaskPrimitive_t
      • VROverlayIntersectionParams_t
      • VROverlayIntersectionResults_t
      • VROverlayTransformType
      • VRSkeletalSummaryData_t
      • VRTextureBounds_t
      • VRTextureDepthInfo_t
      • VRTextureWithDepth_t
      • VRTextureWithPose_t
      • VRTextureWithPoseAndDepth_t
      • VRVulkanTextureData_t
    • Valve.VR.InteractionSystem
      • AfterTimer_Component
      • AllowTeleportWhileAttachedToHand
      • ArcheryTarget
      • Arrow
      • ArrowHand
      • ArrowheadRotation
      • Balloon
      • Balloon.BalloonColor
      • BalloonColliders
      • BalloonHapticBump
      • BalloonSpawner
      • BodyCollider
      • ChaperoneInfo
      • CircularDrive
      • CircularDrive.Axis_t
      • ComplexThrowable
      • ComplexThrowable.AttachMode
      • ControllerButtonHints
      • ControllerHoverHighlight
      • CustomEvents
      • CustomEvents.UnityEventHand
      • CustomEvents.UnityEventSingleFloat
      • DebugUI
      • DestroyOnDetachedFromHand
      • DestroyOnParticleSystemDeath
      • DestroyOnTriggerEnter
      • DistanceHaptics
      • DontDestroyOnLoad
      • EnumFlags
      • EnumFlagsPropertyDrawer
      • Equippable
      • ExplosionWobble
      • FallbackCameraController
      • FireSource
      • GrabTypes
      • Hand
      • Hand.AttachedObject
      • Hand.AttachmentFlags
      • HandEditor
      • HandEvent
      • HapticRack
      • HideOnHandFocusLost
      • HoverButton
      • IgnoreHovering
      • IgnoreTeleportTrace
      • InputModule
      • Interactable
      • Interactable.OnAttachedToHandDelegate
      • Interactable.OnDetachedFromHandDelegate
      • InteractableDebug
      • InteractableHoverEvents
      • ItemPackage
      • ItemPackage.ItemPackageType
      • ItemPackageReference
      • ItemPackageSpawner
      • LinearAnimation
      • LinearAnimator
      • LinearAudioPitch
      • LinearBlendshape
      • LinearDisplacement
      • LinearDrive
      • LinearMapping
      • Longbow
      • Longbow.Handedness
      • ModalThrowable
      • Player
      • PlaySound
      • ReleaseStyle
      • RenderModel
      • SeeThru
      • SleepOnAwake
      • SoundBowClick
      • SoundDeparent
      • SoundPlayOneshot
      • SpawnAndAttachAfterControllerIsTracking
      • SpawnAndAttachToHand
      • Teleport
      • TeleportArc
      • TeleportArea
      • TeleportAreaEditor
      • TeleportMarkerBase
      • TeleportPoint
      • TeleportPoint.TeleportPointType
      • TeleportPointEditor
      • Throwable
      • UIElement
      • UIElementEditor
      • Unparent
      • Util
      • VelocityEstimator
      • WhichHand

    Class CVRScreenshots

    Inheritance
    System.Object
    CVRScreenshots
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Valve.VR
    Assembly: Assembly-CSharp.dll
    Syntax
    public class CVRScreenshots

    Methods

    GetScreenshotPropertyFilename(UInt32, EVRScreenshotPropertyFilenames, StringBuilder, UInt32, ref EVRScreenshotError)

    Declaration
    public uint GetScreenshotPropertyFilename(uint screenshotHandle, EVRScreenshotPropertyFilenames filenameType, StringBuilder pchFilename, uint cchFilename, ref EVRScreenshotError pError)
    Parameters
    Type Name Description
    System.UInt32 screenshotHandle
    EVRScreenshotPropertyFilenames filenameType
    System.Text.StringBuilder pchFilename
    System.UInt32 cchFilename
    EVRScreenshotError pError
    Returns
    Type Description
    System.UInt32

    GetScreenshotPropertyType(UInt32, ref EVRScreenshotError)

    Declaration
    public EVRScreenshotType GetScreenshotPropertyType(uint screenshotHandle, ref EVRScreenshotError pError)
    Parameters
    Type Name Description
    System.UInt32 screenshotHandle
    EVRScreenshotError pError
    Returns
    Type Description
    EVRScreenshotType

    HookScreenshot(EVRScreenshotType[])

    Declaration
    public EVRScreenshotError HookScreenshot(EVRScreenshotType[] pSupportedTypes)
    Parameters
    Type Name Description
    EVRScreenshotType[] pSupportedTypes
    Returns
    Type Description
    EVRScreenshotError

    RequestScreenshot(ref UInt32, EVRScreenshotType, String, String)

    Declaration
    public EVRScreenshotError RequestScreenshot(ref uint pOutScreenshotHandle, EVRScreenshotType type, string pchPreviewFilename, string pchVRFilename)
    Parameters
    Type Name Description
    System.UInt32 pOutScreenshotHandle
    EVRScreenshotType type
    System.String pchPreviewFilename
    System.String pchVRFilename
    Returns
    Type Description
    EVRScreenshotError

    SubmitScreenshot(UInt32, EVRScreenshotType, String, String)

    Declaration
    public EVRScreenshotError SubmitScreenshot(uint screenshotHandle, EVRScreenshotType type, string pchSourcePreviewFilename, string pchSourceVRFilename)
    Parameters
    Type Name Description
    System.UInt32 screenshotHandle
    EVRScreenshotType type
    System.String pchSourcePreviewFilename
    System.String pchSourceVRFilename
    Returns
    Type Description
    EVRScreenshotError

    TakeStereoScreenshot(ref UInt32, String, String)

    Declaration
    public EVRScreenshotError TakeStereoScreenshot(ref uint pOutScreenshotHandle, string pchPreviewFilename, string pchVRFilename)
    Parameters
    Type Name Description
    System.UInt32 pOutScreenshotHandle
    System.String pchPreviewFilename
    System.String pchVRFilename
    Returns
    Type Description
    EVRScreenshotError

    UpdateScreenshotProgress(UInt32, Single)

    Declaration
    public EVRScreenshotError UpdateScreenshotProgress(uint screenshotHandle, float flProgress)
    Parameters
    Type Name Description
    System.UInt32 screenshotHandle
    System.Single flProgress
    Returns
    Type Description
    EVRScreenshotError
    In This Article
    • Methods
      • GetScreenshotPropertyFilename(UInt32, EVRScreenshotPropertyFilenames, StringBuilder, UInt32, ref EVRScreenshotError)
      • GetScreenshotPropertyType(UInt32, ref EVRScreenshotError)
      • HookScreenshot(EVRScreenshotType[])
      • RequestScreenshot(ref UInt32, EVRScreenshotType, String, String)
      • SubmitScreenshot(UInt32, EVRScreenshotType, String, String)
      • TakeStereoScreenshot(ref UInt32, String, String)
      • UpdateScreenshotProgress(UInt32, Single)
    Back to top Copyright (c) Valve Corporation, All rights reserved.