idx int64 0 63k | question stringlengths 61 4.03k | target stringlengths 6 1.23k |
|---|---|---|
59,600 | def getEyeOutputViewport ( self , eEye ) : fn = self . function_table . getEyeOutputViewport pnX = c_uint32 ( ) pnY = c_uint32 ( ) pnWidth = c_uint32 ( ) pnHeight = c_uint32 ( ) fn ( eEye , byref ( pnX ) , byref ( pnY ) , byref ( pnWidth ) , byref ( pnHeight ) ) return pnX . value , pnY . value , pnWidth . value , pnHeight . value | Gets the viewport in the frame buffer to draw the output of the distortion into |
59,601 | def getCameraErrorNameFromEnum ( self , eCameraError ) : fn = self . function_table . getCameraErrorNameFromEnum result = fn ( eCameraError ) return result | Returns a string for an error |
59,602 | def hasCamera ( self , nDeviceIndex ) : fn = self . function_table . hasCamera pHasCamera = openvr_bool ( ) result = fn ( nDeviceIndex , byref ( pHasCamera ) ) return result , pHasCamera | For convenience same as tracked property request Prop_HasCamera_Bool |
59,603 | def acquireVideoStreamingService ( self , nDeviceIndex ) : fn = self . function_table . acquireVideoStreamingService pHandle = TrackedCameraHandle_t ( ) result = fn ( nDeviceIndex , byref ( pHandle ) ) return result , pHandle | Acquiring streaming service permits video streaming for the caller . Releasing hints the system that video services do not need to be maintained for this client . If the camera has not already been activated a one time spin up may incur some auto exposure as well as initial streaming frame delays . The camera should be considered a global resource accessible for shared consumption but not exclusive to any caller . The camera may go inactive due to lack of active consumers or headset idleness . |
59,604 | def getVideoStreamFrameBuffer ( self , hTrackedCamera , eFrameType , pFrameBuffer , nFrameBufferSize , nFrameHeaderSize ) : fn = self . function_table . getVideoStreamFrameBuffer pFrameHeader = CameraVideoStreamFrameHeader_t ( ) result = fn ( hTrackedCamera , eFrameType , pFrameBuffer , nFrameBufferSize , byref ( pFrameHeader ) , nFrameHeaderSize ) return result , pFrameHeader | Copies the image frame into a caller s provided buffer . The image data is currently provided as RGBA data 4 bytes per pixel . A caller can provide null for the framebuffer or frameheader if not desired . Requesting the frame header first followed by the frame buffer allows the caller to determine if the frame as advanced per the frame header sequence . If there is no frame available yet due to initial camera spinup or re - activation the error will be VRTrackedCameraError_NoFrameAvailable . Ideally a caller should be polling at ~16ms intervals |
59,605 | def getVideoStreamTextureGL ( self , hTrackedCamera , eFrameType , nFrameHeaderSize ) : fn = self . function_table . getVideoStreamTextureGL pglTextureId = glUInt_t ( ) pFrameHeader = CameraVideoStreamFrameHeader_t ( ) result = fn ( hTrackedCamera , eFrameType , byref ( pglTextureId ) , byref ( pFrameHeader ) , nFrameHeaderSize ) return result , pglTextureId , pFrameHeader | Access a shared GL texture for the specified tracked camera stream |
59,606 | def addApplicationManifest ( self , pchApplicationManifestFullPath , bTemporary ) : fn = self . function_table . addApplicationManifest result = fn ( pchApplicationManifestFullPath , bTemporary ) return result | Adds an application manifest to the list to load when building the list of installed applications . Temporary manifests are not automatically loaded |
59,607 | def removeApplicationManifest ( self , pchApplicationManifestFullPath ) : fn = self . function_table . removeApplicationManifest result = fn ( pchApplicationManifestFullPath ) return result | Removes an application manifest from the list to load when building the list of installed applications . |
59,608 | def isApplicationInstalled ( self , pchAppKey ) : fn = self . function_table . isApplicationInstalled result = fn ( pchAppKey ) return result | Returns true if an application is installed |
59,609 | def getApplicationKeyByProcessId ( self , unProcessId , pchAppKeyBuffer , unAppKeyBufferLen ) : fn = self . function_table . getApplicationKeyByProcessId result = fn ( unProcessId , pchAppKeyBuffer , unAppKeyBufferLen ) return result | Returns the key of the application for the specified Process Id . The buffer should be at least k_unMaxApplicationKeyLength in order to fit the key . |
59,610 | def launchApplication ( self , pchAppKey ) : fn = self . function_table . launchApplication result = fn ( pchAppKey ) return result | Launches the application . The existing scene application will exit and then the new application will start . This call is not valid for dashboard overlay applications . |
59,611 | def launchApplicationFromMimeType ( self , pchMimeType , pchArgs ) : fn = self . function_table . launchApplicationFromMimeType result = fn ( pchMimeType , pchArgs ) return result | launches the application currently associated with this mime type and passes it the option args typically the filename or object name of the item being launched |
59,612 | def launchDashboardOverlay ( self , pchAppKey ) : fn = self . function_table . launchDashboardOverlay result = fn ( pchAppKey ) return result | Launches the dashboard overlay application if it is not already running . This call is only valid for dashboard overlay applications . |
59,613 | def cancelApplicationLaunch ( self , pchAppKey ) : fn = self . function_table . cancelApplicationLaunch result = fn ( pchAppKey ) return result | Cancel a pending launch for an application |
59,614 | def getApplicationProcessId ( self , pchAppKey ) : fn = self . function_table . getApplicationProcessId result = fn ( pchAppKey ) return result | Returns the process ID for an application . Return 0 if the application was not found or is not running . |
59,615 | def getApplicationsErrorNameFromEnum ( self , error ) : fn = self . function_table . getApplicationsErrorNameFromEnum result = fn ( error ) return result | Returns a string for an applications error |
59,616 | def getApplicationPropertyString ( self , pchAppKey , eProperty , pchPropertyValueBuffer , unPropertyValueBufferLen ) : fn = self . function_table . getApplicationPropertyString peError = EVRApplicationError ( ) result = fn ( pchAppKey , eProperty , pchPropertyValueBuffer , unPropertyValueBufferLen , byref ( peError ) ) return result , peError | Returns a value for an application property . The required buffer size to fit this value will be returned . |
59,617 | def getApplicationPropertyBool ( self , pchAppKey , eProperty ) : fn = self . function_table . getApplicationPropertyBool peError = EVRApplicationError ( ) result = fn ( pchAppKey , eProperty , byref ( peError ) ) return result , peError | Returns a bool value for an application property . Returns false in all error cases . |
59,618 | def setApplicationAutoLaunch ( self , pchAppKey , bAutoLaunch ) : fn = self . function_table . setApplicationAutoLaunch result = fn ( pchAppKey , bAutoLaunch ) return result | Sets the application auto - launch flag . This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool . |
59,619 | def getApplicationAutoLaunch ( self , pchAppKey ) : fn = self . function_table . getApplicationAutoLaunch result = fn ( pchAppKey ) return result | Gets the application auto - launch flag . This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool . |
59,620 | def setDefaultApplicationForMimeType ( self , pchAppKey , pchMimeType ) : fn = self . function_table . setDefaultApplicationForMimeType result = fn ( pchAppKey , pchMimeType ) return result | Adds this mime - type to the list of supported mime types for this application |
59,621 | def getDefaultApplicationForMimeType ( self , pchMimeType , pchAppKeyBuffer , unAppKeyBufferLen ) : fn = self . function_table . getDefaultApplicationForMimeType result = fn ( pchMimeType , pchAppKeyBuffer , unAppKeyBufferLen ) return result | return the app key that will open this mime type |
59,622 | def getApplicationSupportedMimeTypes ( self , pchAppKey , pchMimeTypesBuffer , unMimeTypesBuffer ) : fn = self . function_table . getApplicationSupportedMimeTypes result = fn ( pchAppKey , pchMimeTypesBuffer , unMimeTypesBuffer ) return result | Get the list of supported mime types for this application comma - delimited |
59,623 | def getApplicationsThatSupportMimeType ( self , pchMimeType , pchAppKeysThatSupportBuffer , unAppKeysThatSupportBuffer ) : fn = self . function_table . getApplicationsThatSupportMimeType result = fn ( pchMimeType , pchAppKeysThatSupportBuffer , unAppKeysThatSupportBuffer ) return result | Get the list of app - keys that support this mime type comma - delimited the return value is number of bytes you need to return the full string |
59,624 | def getApplicationLaunchArguments ( self , unHandle , pchArgs , unArgs ) : fn = self . function_table . getApplicationLaunchArguments result = fn ( unHandle , pchArgs , unArgs ) return result | Get the args list from an app launch that had the process already running you call this when you get a VREvent_ApplicationMimeTypeLoad |
59,625 | def getStartingApplication ( self , pchAppKeyBuffer , unAppKeyBufferLen ) : fn = self . function_table . getStartingApplication result = fn ( pchAppKeyBuffer , unAppKeyBufferLen ) return result | Returns the app key for the application that is starting up |
59,626 | def getApplicationsTransitionStateNameFromEnum ( self , state ) : fn = self . function_table . getApplicationsTransitionStateNameFromEnum result = fn ( state ) return result | Returns a string for an application transition state |
59,627 | def launchInternalProcess ( self , pchBinaryPath , pchArguments , pchWorkingDirectory ) : fn = self . function_table . launchInternalProcess result = fn ( pchBinaryPath , pchArguments , pchWorkingDirectory ) return result | Starts a subprocess within the calling application . This suppresses all application transition UI and automatically identifies the new executable as part of the same application . On success the calling process should exit immediately . If working directory is NULL or the directory portion of the binary path will be the working directory . |
59,628 | def getBoundsColor ( self , nNumOutputColors , flCollisionBoundsFadeDistance ) : fn = self . function_table . getBoundsColor pOutputColorArray = HmdColor_t ( ) pOutputCameraColor = HmdColor_t ( ) fn ( byref ( pOutputColorArray ) , nNumOutputColors , flCollisionBoundsFadeDistance , byref ( pOutputCameraColor ) ) return pOutputColorArray , pOutputCameraColor | Get the current chaperone bounds draw color and brightness |
59,629 | def commitWorkingCopy ( self , configFile ) : fn = self . function_table . commitWorkingCopy result = fn ( configFile ) return result | Saves the current working copy to disk |
59,630 | def getWorkingCollisionBoundsInfo ( self ) : fn = self . function_table . getWorkingCollisionBoundsInfo pQuadsBuffer = HmdQuad_t ( ) punQuadsCount = c_uint32 ( ) result = fn ( byref ( pQuadsBuffer ) , byref ( punQuadsCount ) ) return result , pQuadsBuffer , punQuadsCount . value | Returns the number of Quads if the buffer points to null . Otherwise it returns Quads into the buffer up to the max specified from the working copy . |
59,631 | def getWorkingSeatedZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . getWorkingSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) result = fn ( byref ( pmatSeatedZeroPoseToRawTrackingPose ) ) return result , pmatSeatedZeroPoseToRawTrackingPose | Returns the preferred seated position from the working copy . |
59,632 | def getWorkingStandingZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . getWorkingStandingZeroPoseToRawTrackingPose pmatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) result = fn ( byref ( pmatStandingZeroPoseToRawTrackingPose ) ) return result , pmatStandingZeroPoseToRawTrackingPose | Returns the standing origin from the working copy . |
59,633 | def setWorkingPlayAreaSize ( self , sizeX , sizeZ ) : fn = self . function_table . setWorkingPlayAreaSize fn ( sizeX , sizeZ ) | Sets the Play Area in the working copy . |
59,634 | def setWorkingSeatedZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . setWorkingSeatedZeroPoseToRawTrackingPose pMatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) fn ( byref ( pMatSeatedZeroPoseToRawTrackingPose ) ) return pMatSeatedZeroPoseToRawTrackingPose | Sets the preferred seated position in the working copy . |
59,635 | 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 . |
59,636 | def getLiveSeatedZeroPoseToRawTrackingPose ( self ) : fn = self . function_table . getLiveSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t ( ) result = fn ( byref ( pmatSeatedZeroPoseToRawTrackingPose ) ) return result , pmatSeatedZeroPoseToRawTrackingPose | Returns the preferred seated position . |
59,637 | 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 . |
59,638 | 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 . |
59,639 | def getCurrentFadeColor ( self , bBackground ) : fn = self . function_table . getCurrentFadeColor result = fn ( bBackground ) return result | Get current fade color value . |
59,640 | def fadeGrid ( self , fSeconds , bFadeIn ) : fn = self . function_table . fadeGrid fn ( fSeconds , bFadeIn ) | Fading the Grid in or out in fSeconds |
59,641 | 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 . |
59,642 | 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 . |
59,643 | 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 . |
59,644 | 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 . |
59,645 | 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 . |
59,646 | 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 . |
59,647 | def setOverlayName ( self , ulOverlayHandle , pchName ) : fn = self . function_table . setOverlayName result = fn ( ulOverlayHandle , pchName ) return result | set the name to use for this overlay |
59,648 | 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 . |
59,649 | 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 |
59,650 | 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 |
59,651 | 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 |
59,652 | 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 |
59,653 | 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 . |
59,654 | 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 . |
59,655 | 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 . |
59,656 | 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 . |
59,657 | 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 |
59,658 | 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 . |
59,659 | 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 |
59,660 | 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 |
59,661 | 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 . |
59,662 | 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 . |
59,663 | 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 . |
59,664 | 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 . |
59,665 | 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 . |
59,666 | 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 |
59,667 | 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 . |
59,668 | 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 . |
59,669 | 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 . |
59,670 | 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 . |
59,671 | 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 . |
59,672 | 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 . |
59,673 | 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 . |
59,674 | 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 . |
59,675 | 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 . |
59,676 | 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 |
59,677 | 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 . |
59,678 | 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 . |
59,679 | def isOverlayVisible ( self , ulOverlayHandle ) : fn = self . function_table . isOverlayVisible result = fn ( ulOverlayHandle ) return result | Returns true if the overlay is visible . |
59,680 | 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 |
59,681 | 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 . |
59,682 | def setOverlayInputMethod ( self , ulOverlayHandle , eInputMethod ) : fn = self . function_table . setOverlayInputMethod result = fn ( ulOverlayHandle , eInputMethod ) return result | Sets the input settings for the specified overlay . |
59,683 | 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 . |
59,684 | 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 . |
59,685 | 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 |
59,686 | def setGamepadFocusOverlay ( self , ulNewFocusOverlay ) : fn = self . function_table . setGamepadFocusOverlay result = fn ( ulNewFocusOverlay ) return result | Sets the current Gamepad focus overlay |
59,687 | 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 |
59,688 | 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 |
59,689 | 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 . |
59,690 | 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 . |
59,691 | 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 . |
59,692 | 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 . |
59,693 | 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 . |
59,694 | 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 |
59,695 | 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 |
59,696 | 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 |
59,697 | 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 |
59,698 | 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 |
59,699 | 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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.