idx
int64
0
252k
question
stringlengths
48
5.28k
target
stringlengths
5
1.23k
248,500
def setWorkingStandingZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . setWorkingStandingZeroPoseToRawTrackingPose pMatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) fn ( byref ( pMatStandingZeroPoseToRawTrackingPose ) ) return pMatStandingZeroPoseToRawTrackingPose
Sets the preferred standing position in the working copy .
248,501
def getLiveSeatedZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . getLiveSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) result = fn ( byref ( pmatSeatedZeroPoseToRawTrackingPose ) ) return result , pmatSeatedZeroPoseToRawTrackingPose
Returns the preferred seated position .
248,502
def getLastPoses ( self , unRenderPoseArrayCount , unGamePoseArrayCount ) : fn = self . function_table . getLastPoses pRenderPoseArray = TrackedDevicePose_t ( ) pGamePoseArray = TrackedDevicePose_t ( ) result = fn ( byref ( pRenderPoseArray ) , unRenderPoseArrayCount , byref ( pGamePoseArray ) , unGamePoseArrayCount ) return result , pRenderPoseArray , pGamePoseArray
Get the last set of poses returned by WaitGetPoses .
248,503
def getLastPoseForTrackedDeviceIndex ( self , unDeviceIndex ) : fn = self . function_table . getLastPoseForTrackedDeviceIndex pOutputPose = TrackedDevicePose_t ( ) pOutputGamePose = TrackedDevicePose_t ( ) result = fn ( unDeviceIndex , byref ( pOutputPose ) , byref ( pOutputGamePose ) ) return result , pOutputPose , pOutputGamePose
Interface for accessing last set of poses returned by WaitGetPoses one at a time . Returns VRCompositorError_IndexOutOfRange if unDeviceIndex not less than k_unMaxTrackedDeviceCount otherwise VRCompositorError_None . It is okay to pass NULL for either pose if you only want one of the values .
248,504
def getCurrentFadeColor ( self , bBackground ) : fn = self . function_table . getCurrentFadeColor result = fn ( bBackground ) return result
Get current fade color value .
248,505
def fadeGrid ( self , fSeconds , bFadeIn ) : fn = self . function_table . fadeGrid fn ( fSeconds , bFadeIn )
Fading the Grid in or out in fSeconds
248,506
def getMirrorTextureD3D11 ( self , eEye , pD3D11DeviceOrResource ) : fn = self . function_table . getMirrorTextureD3D11 ppD3D11ShaderResourceView = c_void_p ( ) result = fn ( eEye , pD3D11DeviceOrResource , byref ( ppD3D11ShaderResourceView ) ) return result , ppD3D11ShaderResourceView . value
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 .
248,507
def getMirrorTextureGL ( self , eEye ) : fn = self . function_table . getMirrorTextureGL pglTextureId = glUInt_t ( ) pglSharedTextureHandle = glSharedTextureHandle_t ( ) result = fn ( eEye , byref ( pglTextureId ) , byref ( pglSharedTextureHandle ) ) return result , pglTextureId , pglSharedTextureHandle
Access to mirror textures from OpenGL .
248,508
def findOverlay ( self , pchOverlayKey ) : fn = self . function_table . findOverlay pOverlayHandle = VROverlayHandle_t ( ) result = fn ( pchOverlayKey , byref ( pOverlayHandle ) ) return result , pOverlayHandle
Finds an existing overlay with the specified key .
248,509
def createOverlay ( self , pchOverlayKey , pchOverlayName ) : fn = self . function_table . createOverlay pOverlayHandle = VROverlayHandle_t ( ) result = fn ( pchOverlayKey , pchOverlayName , byref ( pOverlayHandle ) ) return result , pOverlayHandle
Creates a new named overlay . All overlays start hidden and with default settings .
248,510
def destroyOverlay ( self , ulOverlayHandle ) : fn = self . function_table . destroyOverlay result = fn ( ulOverlayHandle ) return result
Destroys the specified overlay . When an application calls VR_Shutdown all overlays created by that app are automatically destroyed .
248,511
def getOverlayKey ( self , ulOverlayHandle , pchValue , unBufferSize ) : fn = self . function_table . getOverlayKey pError = EVROverlayError ( ) result = fn ( ulOverlayHandle , pchValue , unBufferSize , byref ( pError ) ) return result , pError
Fills the provided buffer with the string key of the overlay . Returns the size of buffer required to store the key including the terminating null character . k_unVROverlayMaxKeyLength will be enough bytes to fit the string .
248,512
def setOverlayName ( self , ulOverlayHandle , pchName ) : fn = self . function_table . setOverlayName result = fn ( ulOverlayHandle , pchName ) return result
set the name to use for this overlay
248,513
def getOverlayImageData ( self , ulOverlayHandle , pvBuffer , unBufferSize ) : fn = self . function_table . getOverlayImageData punWidth = c_uint32 ( ) punHeight = c_uint32 ( ) result = fn ( ulOverlayHandle , pvBuffer , unBufferSize , byref ( punWidth ) , byref ( punHeight ) ) return result , punWidth . value , punHeight . value
Gets the raw image data from an overlay . Overlay image data is always returned as RGBA data 4 bytes per pixel . If the buffer is not large enough width and height will be set and VROverlayError_ArrayTooSmall is returned .
248,514
def getOverlayErrorNameFromEnum ( self , error ) : fn = self . function_table . getOverlayErrorNameFromEnum result = fn ( error ) return result
returns a string that corresponds with the specified overlay error . The string will be the name of the error enum value for all valid error codes
248,515
def getOverlayRenderingPid ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayRenderingPid result = fn ( ulOverlayHandle ) return result
Gets the pid that is allowed to render to this overlay
248,516
def setOverlayFlag ( self , ulOverlayHandle , eOverlayFlag , bEnabled ) : fn = self . function_table . setOverlayFlag result = fn ( ulOverlayHandle , eOverlayFlag , bEnabled ) return result
Specify flag setting for a given overlay
248,517
def getOverlayFlag ( self , ulOverlayHandle , eOverlayFlag ) : fn = self . function_table . getOverlayFlag pbEnabled = openvr_bool ( ) result = fn ( ulOverlayHandle , eOverlayFlag , byref ( pbEnabled ) ) return result , pbEnabled
Sets flag setting for a given overlay
248,518
def setOverlayColor ( self , ulOverlayHandle , fRed , fGreen , fBlue ) : fn = self . function_table . setOverlayColor result = fn ( ulOverlayHandle , fRed , fGreen , fBlue ) return result
Sets the color tint of the overlay quad . Use 0 . 0 to 1 . 0 per channel .
248,519
def getOverlayColor ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayColor pfRed = c_float ( ) pfGreen = c_float ( ) pfBlue = c_float ( ) result = fn ( ulOverlayHandle , byref ( pfRed ) , byref ( pfGreen ) , byref ( pfBlue ) ) return result , pfRed . value , pfGreen . value , pfBlue . value
Gets the color tint of the overlay quad .
248,520
def setOverlayAlpha ( self , ulOverlayHandle , fAlpha ) : fn = self . function_table . setOverlayAlpha result = fn ( ulOverlayHandle , fAlpha ) return result
Sets the alpha of the overlay quad . Use 1 . 0 for 100 percent opacity to 0 . 0 for 0 percent opacity .
248,521
def setOverlayTexelAspect ( self , ulOverlayHandle , fTexelAspect ) : fn = self . function_table . setOverlayTexelAspect result = fn ( ulOverlayHandle , fTexelAspect ) return result
Sets the aspect ratio of the texels in the overlay . 1 . 0 means the texels are square . 2 . 0 means the texels are twice as wide as they are tall . Defaults to 1 . 0 .
248,522
def getOverlayTexelAspect ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTexelAspect pfTexelAspect = c_float ( ) result = fn ( ulOverlayHandle , byref ( pfTexelAspect ) ) return result , pfTexelAspect . value
Gets the aspect ratio of the texels in the overlay . Defaults to 1 . 0
248,523
def getOverlaySortOrder ( self , ulOverlayHandle ) : fn = self . function_table . getOverlaySortOrder punSortOrder = c_uint32 ( ) result = fn ( ulOverlayHandle , byref ( punSortOrder ) ) return result , punSortOrder . value
Gets the sort order of the overlay . See SetOverlaySortOrder for how this works .
248,524
def setOverlayWidthInMeters ( self , ulOverlayHandle , fWidthInMeters ) : fn = self . function_table . setOverlayWidthInMeters result = fn ( ulOverlayHandle , fWidthInMeters ) return result
Sets the width of the overlay quad in meters . By default overlays are rendered on a quad that is 1 meter across
248,525
def getOverlayWidthInMeters ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayWidthInMeters pfWidthInMeters = c_float ( ) result = fn ( ulOverlayHandle , byref ( pfWidthInMeters ) ) return result , pfWidthInMeters . value
Returns the width of the overlay quad in meters . By default overlays are rendered on a quad that is 1 meter across
248,526
def setOverlayAutoCurveDistanceRangeInMeters ( self , ulOverlayHandle , fMinDistanceInMeters , fMaxDistanceInMeters ) : fn = self . function_table . setOverlayAutoCurveDistanceRangeInMeters result = fn ( ulOverlayHandle , fMinDistanceInMeters , fMaxDistanceInMeters ) return result
For high - quality curved overlays only sets the distance range in meters from the overlay used to automatically curve the surface around the viewer . Min is distance is when the surface will be most curved . Max is when least curved .
248,527
def getOverlayAutoCurveDistanceRangeInMeters ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayAutoCurveDistanceRangeInMeters pfMinDistanceInMeters = c_float ( ) pfMaxDistanceInMeters = c_float ( ) result = fn ( ulOverlayHandle , byref ( pfMinDistanceInMeters ) , byref ( pfMaxDistanceInMeters ) ) return result , pfMinDistanceInMeters . value , pfMaxDistanceInMeters . value
For high - quality curved overlays only gets the distance range in meters from the overlay used to automatically curve the surface around the viewer . Min is distance is when the surface will be most curved . Max is when least curved .
248,528
def setOverlayTextureColorSpace ( self , ulOverlayHandle , eTextureColorSpace ) : fn = self . function_table . setOverlayTextureColorSpace result = fn ( ulOverlayHandle , eTextureColorSpace ) return result
Sets the colorspace the overlay texture s data is in . Defaults to auto . If the texture needs to be resolved you should call SetOverlayTexture with the appropriate colorspace instead .
248,529
def getOverlayTextureColorSpace ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTextureColorSpace peTextureColorSpace = EColorSpace ( ) result = fn ( ulOverlayHandle , byref ( peTextureColorSpace ) ) return result , peTextureColorSpace
Gets the overlay s current colorspace setting .
248,530
def setOverlayTextureBounds ( self , ulOverlayHandle ) : fn = self . function_table . setOverlayTextureBounds pOverlayTextureBounds = VRTextureBounds_t ( ) result = fn ( ulOverlayHandle , byref ( pOverlayTextureBounds ) ) return result , pOverlayTextureBounds
Sets the part of the texture to use for the overlay . UV Min is the upper left corner and UV Max is the lower right corner .
248,531
def getOverlayRenderModel ( self , ulOverlayHandle , pchValue , unBufferSize ) : fn = self . function_table . getOverlayRenderModel pColor = HmdColor_t ( ) pError = EVROverlayError ( ) result = fn ( ulOverlayHandle , pchValue , unBufferSize , byref ( pColor ) , byref ( pError ) ) return result , pColor , pError
Gets render model to draw behind this overlay
248,532
def setOverlayRenderModel ( self , ulOverlayHandle , pchRenderModel ) : fn = self . function_table . setOverlayRenderModel pColor = HmdColor_t ( ) result = fn ( ulOverlayHandle , pchRenderModel , byref ( pColor ) ) return result , pColor
Sets render model to draw behind this overlay and the vertex color to use pass null for pColor to match the overlays vertex color . The model is scaled by the same amount as the overlay with a default of 1m .
248,533
def getOverlayTransformType ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTransformType peTransformType = VROverlayTransformType ( ) result = fn ( ulOverlayHandle , byref ( peTransformType ) ) return result , peTransformType
Returns the transform type of this overlay .
248,534
def setOverlayTransformAbsolute ( self , ulOverlayHandle , eTrackingOrigin ) : fn = self . function_table . setOverlayTransformAbsolute pmatTrackingOriginToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , eTrackingOrigin , byref ( pmatTrackingOriginToOverlayTransform ) ) return result , pmatTrackingOriginToOverlayTransform
Sets the transform to absolute tracking origin .
248,535
def getOverlayTransformAbsolute ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTransformAbsolute peTrackingOrigin = ETrackingUniverseOrigin ( ) pmatTrackingOriginToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , byref ( peTrackingOrigin ) , byref ( pmatTrackingOriginToOverlayTransform ) ) return result , peTrackingOrigin , pmatTrackingOriginToOverlayTransform
Gets the transform if it is absolute . Returns an error if the transform is some other type .
248,536
def setOverlayTransformTrackedDeviceRelative ( self , ulOverlayHandle , unTrackedDevice ) : fn = self . function_table . setOverlayTransformTrackedDeviceRelative pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , unTrackedDevice , byref ( pmatTrackedDeviceToOverlayTransform ) ) return result , pmatTrackedDeviceToOverlayTransform
Sets the transform to relative to the transform of the specified tracked device .
248,537
def getOverlayTransformTrackedDeviceRelative ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTransformTrackedDeviceRelative punTrackedDevice = TrackedDeviceIndex_t ( ) pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , byref ( punTrackedDevice ) , byref ( pmatTrackedDeviceToOverlayTransform ) ) return result , punTrackedDevice , pmatTrackedDeviceToOverlayTransform
Gets the transform if it is relative to a tracked device . Returns an error if the transform is some other type .
248,538
def setOverlayTransformTrackedDeviceComponent ( self , ulOverlayHandle , unDeviceIndex , pchComponentName ) : fn = self . function_table . setOverlayTransformTrackedDeviceComponent result = fn ( ulOverlayHandle , unDeviceIndex , pchComponentName ) return result
Sets the transform to draw the overlay on a rendermodel component mesh instead of a quad . This will only draw when the system is drawing the device . Overlays with this transform type cannot receive mouse events .
248,539
def getOverlayTransformTrackedDeviceComponent ( self , ulOverlayHandle , pchComponentName , unComponentNameSize ) : fn = self . function_table . getOverlayTransformTrackedDeviceComponent punDeviceIndex = TrackedDeviceIndex_t ( ) result = fn ( ulOverlayHandle , byref ( punDeviceIndex ) , pchComponentName , unComponentNameSize ) return result , punDeviceIndex
Gets the transform information when the overlay is rendering on a component .
248,540
def getOverlayTransformOverlayRelative ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTransformOverlayRelative ulOverlayHandleParent = VROverlayHandle_t ( ) pmatParentOverlayToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , byref ( ulOverlayHandleParent ) , byref ( pmatParentOverlayToOverlayTransform ) ) return result , ulOverlayHandleParent , pmatParentOverlayToOverlayTransform
Gets the transform if it is relative to another overlay . Returns an error if the transform is some other type .
248,541
def setOverlayTransformOverlayRelative ( self , ulOverlayHandle , ulOverlayHandleParent ) : fn = self . function_table . setOverlayTransformOverlayRelative pmatParentOverlayToOverlayTransform = HmdMatrix34_t ( ) result = fn ( ulOverlayHandle , ulOverlayHandleParent , byref ( pmatParentOverlayToOverlayTransform ) ) return result , pmatParentOverlayToOverlayTransform
Sets the transform to relative to the transform of the specified overlay . This overlays visibility will also track the parents visibility
248,542
def showOverlay ( self , ulOverlayHandle ) : fn = self . function_table . showOverlay result = fn ( ulOverlayHandle ) return result
Shows the VR overlay . For dashboard overlays only the Dashboard Manager is allowed to call this .
248,543
def hideOverlay ( self , ulOverlayHandle ) : fn = self . function_table . hideOverlay result = fn ( ulOverlayHandle ) return result
Hides the VR overlay . For dashboard overlays only the Dashboard Manager is allowed to call this .
248,544
def isOverlayVisible ( self , ulOverlayHandle ) : fn = self . function_table . isOverlayVisible result = fn ( ulOverlayHandle ) return result
Returns true if the overlay is visible .
248,545
def pollNextOverlayEvent ( self , ulOverlayHandle , uncbVREvent ) : fn = self . function_table . pollNextOverlayEvent pEvent = VREvent_t ( ) result = fn ( ulOverlayHandle , byref ( pEvent ) , uncbVREvent ) return result , pEvent
Returns true and fills the event with the next event on the overlay s event queue if there is one . If there are no events this method returns false . uncbVREvent should be the size in bytes of the VREvent_t struct
248,546
def getOverlayInputMethod ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayInputMethod peInputMethod = VROverlayInputMethod ( ) result = fn ( ulOverlayHandle , byref ( peInputMethod ) ) return result , peInputMethod
Returns the current input settings for the specified overlay .
248,547
def setOverlayInputMethod ( self , ulOverlayHandle , eInputMethod ) : fn = self . function_table . setOverlayInputMethod result = fn ( ulOverlayHandle , eInputMethod ) return result
Sets the input settings for the specified overlay .
248,548
def getOverlayMouseScale ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayMouseScale pvecMouseScale = HmdVector2_t ( ) result = fn ( ulOverlayHandle , byref ( pvecMouseScale ) ) return result , pvecMouseScale
Gets the mouse scaling factor that is used for mouse events . The actual texture may be a different size but this is typically the size of the underlying UI in pixels .
248,549
def computeOverlayIntersection ( self , ulOverlayHandle ) : fn = self . function_table . computeOverlayIntersection pParams = VROverlayIntersectionParams_t ( ) pResults = VROverlayIntersectionResults_t ( ) result = fn ( ulOverlayHandle , byref ( pParams ) , byref ( pResults ) ) return result , pParams , pResults
Computes the overlay - space pixel coordinates of where the ray intersects the overlay with the specified settings . Returns false if there is no intersection .
248,550
def isHoverTargetOverlay ( self , ulOverlayHandle ) : fn = self . function_table . isHoverTargetOverlay result = fn ( ulOverlayHandle ) return result
Returns true if the specified overlay is the hover target . An overlay is the hover target when it is the last overlay moused over by the virtual mouse pointer
248,551
def setGamepadFocusOverlay ( self , ulNewFocusOverlay ) : fn = self . function_table . setGamepadFocusOverlay result = fn ( ulNewFocusOverlay ) return result
Sets the current Gamepad focus overlay
248,552
def setOverlayNeighbor ( self , eDirection , ulFrom , ulTo ) : fn = self . function_table . setOverlayNeighbor result = fn ( eDirection , ulFrom , ulTo ) return result
Sets an overlay s neighbor . This will also set the neighbor of the to overlay to point back to the from overlay . If an overlay s neighbor is set to invalid both ends will be cleared
248,553
def moveGamepadFocusToNeighbor ( self , eDirection , ulFrom ) : fn = self . function_table . moveGamepadFocusToNeighbor result = fn ( eDirection , ulFrom ) return result
Changes the Gamepad focus from one overlay to one of its neighbors . Returns VROverlayError_NoNeighbor if there is no neighbor in that direction
248,554
def setOverlayDualAnalogTransform ( self , ulOverlay , eWhich , fRadius ) : fn = self . function_table . setOverlayDualAnalogTransform pvCenter = HmdVector2_t ( ) result = fn ( ulOverlay , eWhich , byref ( pvCenter ) , fRadius ) return result , pvCenter
Sets the analog input to Dual Analog coordinate scale for the specified overlay .
248,555
def getOverlayDualAnalogTransform ( self , ulOverlay , eWhich ) : fn = self . function_table . getOverlayDualAnalogTransform pvCenter = HmdVector2_t ( ) pfRadius = c_float ( ) result = fn ( ulOverlay , eWhich , byref ( pvCenter ) , byref ( pfRadius ) ) return result , pvCenter , pfRadius . value
Gets the analog input to Dual Analog coordinate scale for the specified overlay .
248,556
def clearOverlayTexture ( self , ulOverlayHandle ) : fn = self . function_table . clearOverlayTexture result = fn ( ulOverlayHandle ) return result
Use this to tell the overlay system to release the texture set for this overlay .
248,557
def setOverlayRaw ( self , ulOverlayHandle , pvBuffer , unWidth , unHeight , unDepth ) : fn = self . function_table . setOverlayRaw result = fn ( ulOverlayHandle , pvBuffer , unWidth , unHeight , unDepth ) return result
Separate interface for providing the data as a stream of bytes but there is an upper bound on data that can be sent . This function can only be called by the overlay s renderer process .
248,558
def releaseNativeOverlayHandle ( self , ulOverlayHandle , pNativeTextureHandle ) : fn = self . function_table . releaseNativeOverlayHandle result = fn ( ulOverlayHandle , pNativeTextureHandle ) return result
Release the pNativeTextureHandle provided from the GetOverlayTexture call this allows the system to free the underlying GPU resources for this object so only do it once you stop rendering this texture .
248,559
def getOverlayTextureSize ( self , ulOverlayHandle ) : fn = self . function_table . getOverlayTextureSize pWidth = c_uint32 ( ) pHeight = c_uint32 ( ) result = fn ( ulOverlayHandle , byref ( pWidth ) , byref ( pHeight ) ) return result , pWidth . value , pHeight . value
Get the size of the overlay texture
248,560
def createDashboardOverlay ( self , pchOverlayKey , pchOverlayFriendlyName ) : fn = self . function_table . createDashboardOverlay pMainHandle = VROverlayHandle_t ( ) pThumbnailHandle = VROverlayHandle_t ( ) result = fn ( pchOverlayKey , pchOverlayFriendlyName , byref ( pMainHandle ) , byref ( pThumbnailHandle ) ) return result , pMainHandle , pThumbnailHandle
Creates a dashboard overlay and returns its handle
248,561
def isActiveDashboardOverlay ( self , ulOverlayHandle ) : fn = self . function_table . isActiveDashboardOverlay result = fn ( ulOverlayHandle ) return result
returns true if the dashboard is visible and the specified overlay is the active system Overlay
248,562
def setDashboardOverlaySceneProcess ( self , ulOverlayHandle , unProcessId ) : fn = self . function_table . setDashboardOverlaySceneProcess result = fn ( ulOverlayHandle , unProcessId ) return result
Sets the dashboard overlay to only appear when the specified process ID has scene focus
248,563
def getDashboardOverlaySceneProcess ( self , ulOverlayHandle ) : fn = self . function_table . getDashboardOverlaySceneProcess punProcessId = c_uint32 ( ) result = fn ( ulOverlayHandle , byref ( punProcessId ) ) return result , punProcessId . value
Gets the process ID that this dashboard overlay requires to have scene focus
248,564
def showKeyboard ( self , eInputMode , eLineInputMode , pchDescription , unCharMax , pchExistingText , bUseMinimalMode , uUserValue ) : fn = self . function_table . showKeyboard result = fn ( eInputMode , eLineInputMode , pchDescription , unCharMax , pchExistingText , bUseMinimalMode , uUserValue ) return result
Show the virtual keyboard to accept input
248,565
def getKeyboardText ( self , pchText , cchText ) : fn = self . function_table . getKeyboardText result = fn ( pchText , cchText ) return result
Get the text that was entered into the text input
248,566
def setKeyboardTransformAbsolute ( self , eTrackingOrigin ) : fn = self . function_table . setKeyboardTransformAbsolute pmatTrackingOriginToKeyboardTransform = HmdMatrix34_t ( ) fn ( eTrackingOrigin , byref ( pmatTrackingOriginToKeyboardTransform ) ) return pmatTrackingOriginToKeyboardTransform
Set the position of the keyboard in world space
248,567
def showMessageOverlay ( self , pchText , pchCaption , pchButton0Text , pchButton1Text , pchButton2Text , pchButton3Text ) : fn = self . function_table . showMessageOverlay result = fn ( pchText , pchCaption , pchButton0Text , pchButton1Text , pchButton2Text , pchButton3Text ) return result
Show the message overlay . This will block and return you a result .
248,568
def freeRenderModel ( self ) : fn = self . function_table . freeRenderModel pRenderModel = RenderModel_t ( ) fn ( byref ( pRenderModel ) ) return pRenderModel
Frees a previously returned render model It is safe to call this on a null ptr .
248,569
def loadTexture_Async ( self , textureId ) : fn = self . function_table . loadTexture_Async ppTexture = POINTER ( RenderModel_TextureMap_t ) ( ) result = fn ( textureId , byref ( ppTexture ) ) return result , ppTexture
Loads and returns a texture for use in the application .
248,570
def freeTexture ( self ) : fn = self . function_table . freeTexture pTexture = RenderModel_TextureMap_t ( ) fn ( byref ( pTexture ) ) return pTexture
Frees a previously returned texture It is safe to call this on a null ptr .
248,571
def loadTextureD3D11_Async ( self , textureId , pD3D11Device ) : fn = self . function_table . loadTextureD3D11_Async ppD3D11Texture2D = c_void_p ( ) result = fn ( textureId , pD3D11Device , byref ( ppD3D11Texture2D ) ) return result , ppD3D11Texture2D . value
Creates a D3D11 texture and loads data into it .
248,572
def loadIntoTextureD3D11_Async ( self , textureId , pDstTexture ) : fn = self . function_table . loadIntoTextureD3D11_Async result = fn ( textureId , pDstTexture ) return result
Helper function to copy the bits into an existing texture .
248,573
def getRenderModelName ( self , unRenderModelIndex , pchRenderModelName , unRenderModelNameLen ) : fn = self . function_table . getRenderModelName result = fn ( unRenderModelIndex , pchRenderModelName , unRenderModelNameLen ) return result
Use this to get the names of available render models . Index does not correlate to a tracked device index but is only used for iterating over all available render models . If the index is out of range this function will return 0 . Otherwise it will return the size of the buffer required for the name .
248,574
def getComponentName ( self , pchRenderModelName , unComponentIndex , pchComponentName , unComponentNameLen ) : fn = self . function_table . getComponentName result = fn ( pchRenderModelName , unComponentIndex , pchComponentName , unComponentNameLen ) return result
Use this to get the names of available components . Index does not correlate to a tracked device index but is only used for iterating over all available components . If the index is out of range this function will return 0 . Otherwise it will return the size of the buffer required for the name .
248,575
def getComponentState ( self , pchRenderModelName , pchComponentName ) : fn = self . function_table . getComponentState pControllerState = VRControllerState_t ( ) pState = RenderModel_ControllerMode_State_t ( ) pComponentState = RenderModel_ComponentState_t ( ) result = fn ( pchRenderModelName , pchComponentName , byref ( pControllerState ) , byref ( pState ) , byref ( pComponentState ) ) return result , pControllerState , pState , pComponentState
This version of GetComponentState takes a controller state block instead of an action origin . This function is deprecated . You should use the new input system and GetComponentStateForDevicePath instead .
248,576
def renderModelHasComponent ( self , pchRenderModelName , pchComponentName ) : fn = self . function_table . renderModelHasComponent result = fn ( pchRenderModelName , pchComponentName ) return result
Returns true if the render model has a component with the specified name
248,577
def getRenderModelThumbnailURL ( self , pchRenderModelName , pchThumbnailURL , unThumbnailURLLen ) : fn = self . function_table . getRenderModelThumbnailURL peError = EVRRenderModelError ( ) result = fn ( pchRenderModelName , pchThumbnailURL , unThumbnailURLLen , byref ( peError ) ) return result , peError
Returns the URL of the thumbnail image for this rendermodel
248,578
def getRenderModelOriginalPath ( self , pchRenderModelName , pchOriginalPath , unOriginalPathLen ) : fn = self . function_table . getRenderModelOriginalPath peError = EVRRenderModelError ( ) result = fn ( pchRenderModelName , pchOriginalPath , unOriginalPathLen , byref ( peError ) ) return result , peError
Provides a render model path that will load the unskinned model if the model name provided has been replace by the user . If the model hasn t been replaced the path value will still be a valid path to load the model . Pass this to LoadRenderModel_Async etc . to load the model .
248,579
def getRenderModelErrorNameFromEnum ( self , error ) : fn = self . function_table . getRenderModelErrorNameFromEnum result = fn ( error ) return result
Returns a string for a render model error
248,580
def removeNotification ( self , notificationId ) : fn = self . function_table . removeNotification result = fn ( notificationId ) return result
Destroy a notification hiding it first if it currently shown to the user .
248,581
def hookScreenshot ( self , numTypes ) : fn = self . function_table . hookScreenshot pSupportedTypes = EVRScreenshotType ( ) result = fn ( byref ( pSupportedTypes ) , numTypes ) return result , pSupportedTypes
Called by the running VR application to indicate that it wishes to be in charge of screenshots . If the application does not call this the Compositor will only support VRScreenshotType_Stereo screenshots that will be captured without notification to the running app . Once hooked your application will receive a VREvent_RequestScreenshot event when the user presses the buttons to take a screenshot .
248,582
def getScreenshotPropertyType ( self , screenshotHandle ) : fn = self . function_table . getScreenshotPropertyType pError = EVRScreenshotError ( ) result = fn ( screenshotHandle , byref ( pError ) ) return result , pError
When your application receives a VREvent_RequestScreenshot event call these functions to get the details of the screenshot request .
248,583
def updateScreenshotProgress ( self , screenshotHandle , flProgress ) : fn = self . function_table . updateScreenshotProgress result = fn ( screenshotHandle , flProgress ) return result
Call this if the application is taking the screen shot will take more than a few ms processing . This will result in an overlay being presented that shows a completion bar .
248,584
def takeStereoScreenshot ( self , pchPreviewFilename , pchVRFilename ) : fn = self . function_table . takeStereoScreenshot pOutScreenshotHandle = ScreenshotHandle_t ( ) result = fn ( byref ( pOutScreenshotHandle ) , pchPreviewFilename , pchVRFilename ) return result , pOutScreenshotHandle
Tells the compositor to take an internal screenshot of type VRScreenshotType_Stereo . It will take the current submitted scene textures of the running application and write them into the preview image and a side - by - side file for the VR image . This is similar to request screenshot but doesn t ever talk to the application just takes the shot and submits .
248,585
def loadSharedResource ( self , pchResourceName , pchBuffer , unBufferLen ) : fn = self . function_table . loadSharedResource result = fn ( pchResourceName , pchBuffer , unBufferLen ) return result
Loads the specified resource into the provided buffer if large enough . Returns the size in bytes of the buffer required to hold the specified resource .
248,586
def getResourceFullPath ( self , pchResourceName , pchResourceTypeDirectory , pchPathBuffer , unBufferLen ) : fn = self . function_table . getResourceFullPath result = fn ( pchResourceName , pchResourceTypeDirectory , pchPathBuffer , unBufferLen ) return result
Provides the full path to the specified resource . Resource names can include named directories for drivers and other things and this resolves all of those and returns the actual physical path . pchResourceTypeDirectory is the subdirectory of resources to look in .
248,587
def getDriverName ( self , nDriver , pchValue , unBufferSize ) : fn = self . function_table . getDriverName result = fn ( nDriver , pchValue , unBufferSize ) return result
Returns the length of the number of bytes necessary to hold this string including the trailing null .
248,588
def getActionSetHandle ( self , pchActionSetName ) : fn = self . function_table . getActionSetHandle pHandle = VRActionSetHandle_t ( ) result = fn ( pchActionSetName , byref ( pHandle ) ) return result , pHandle
Returns a handle for an action set . This handle is used for all performance - sensitive calls .
248,589
def getActionHandle ( self , pchActionName ) : fn = self . function_table . getActionHandle pHandle = VRActionHandle_t ( ) result = fn ( pchActionName , byref ( pHandle ) ) return result , pHandle
Returns a handle for an action . This handle is used for all performance - sensitive calls .
248,590
def getDigitalActionData ( self , action , unActionDataSize , ulRestrictToDevice ) : fn = self . function_table . getDigitalActionData pActionData = InputDigitalActionData_t ( ) result = fn ( action , byref ( pActionData ) , unActionDataSize , ulRestrictToDevice ) return result , pActionData
Reads the state of a digital action given its handle . This will return VRInputError_WrongType if the type of action is something other than digital
248,591
def getAnalogActionData ( self , action , unActionDataSize , ulRestrictToDevice ) : fn = self . function_table . getAnalogActionData pActionData = InputAnalogActionData_t ( ) result = fn ( action , byref ( pActionData ) , unActionDataSize , ulRestrictToDevice ) return result , pActionData
Reads the state of an analog action given its handle . This will return VRInputError_WrongType if the type of action is something other than analog
248,592
def getPoseActionData ( self , action , eOrigin , fPredictedSecondsFromNow , unActionDataSize , ulRestrictToDevice ) : fn = self . function_table . getPoseActionData pActionData = InputPoseActionData_t ( ) result = fn ( action , eOrigin , fPredictedSecondsFromNow , byref ( pActionData ) , unActionDataSize , ulRestrictToDevice ) return result , pActionData
Reads the state of a pose action given its handle .
248,593
def getSkeletalActionData ( self , action , unActionDataSize ) : fn = self . function_table . getSkeletalActionData pActionData = InputSkeletalActionData_t ( ) result = fn ( action , byref ( pActionData ) , unActionDataSize ) return result , pActionData
Reads the state of a skeletal action given its handle .
248,594
def getBoneCount ( self , action ) : fn = self . function_table . getBoneCount pBoneCount = c_uint32 ( ) result = fn ( action , byref ( pBoneCount ) ) return result , pBoneCount . value
Reads the number of bones in skeleton associated with the given action
248,595
def getBoneHierarchy ( self , action , unIndexArayCount ) : fn = self . function_table . getBoneHierarchy pParentIndices = BoneIndex_t ( ) result = fn ( action , byref ( pParentIndices ) , unIndexArayCount ) return result , pParentIndices
Fills the given array with the index of each bone s parent in the skeleton associated with the given action
248,596
def getBoneName ( self , action , nBoneIndex , pchBoneName , unNameBufferSize ) : fn = self . function_table . getBoneName result = fn ( action , nBoneIndex , pchBoneName , unNameBufferSize ) return result
Fills the given buffer with the name of the bone at the given index in the skeleton associated with the given action
248,597
def getSkeletalReferenceTransforms ( self , action , eTransformSpace , eReferencePose , unTransformArrayCount ) : fn = self . function_table . getSkeletalReferenceTransforms pTransformArray = VRBoneTransform_t ( ) result = fn ( action , eTransformSpace , eReferencePose , byref ( pTransformArray ) , unTransformArrayCount ) return result , pTransformArray
Fills the given buffer with the transforms for a specific static skeletal reference pose
248,598
def getSkeletalTrackingLevel ( self , action ) : fn = self . function_table . getSkeletalTrackingLevel pSkeletalTrackingLevel = EVRSkeletalTrackingLevel ( ) result = fn ( action , byref ( pSkeletalTrackingLevel ) ) return result , pSkeletalTrackingLevel
Reads the level of accuracy to which the controller is able to track the user to recreate a skeletal pose
248,599
def getSkeletalBoneData ( self , action , eTransformSpace , eMotionRange , unTransformArrayCount ) : fn = self . function_table . getSkeletalBoneData pTransformArray = VRBoneTransform_t ( ) result = fn ( action , eTransformSpace , eMotionRange , byref ( pTransformArray ) , unTransformArrayCount ) return result , pTransformArray
Reads the state of the skeletal bone data associated with this action and copies it into the given buffer .