savioratharv/fyp_eval · Datasets at Hugging Face

Code stringlengths 103 85.9k	Summary listlengths 0 94
Please provide a description of the function:def getProjectionMatrix(self, eEye, fNearZ, fFarZ): fn = self.function_table.getProjectionMatrix result = fn(eEye, fNearZ, fFarZ) return result	[ "The projection matrix for the specified eye" ]
Please provide a description of the function:def getProjectionRaw(self, eEye): fn = self.function_table.getProjectionRaw pfLeft = c_float() pfRight = c_float() pfTop = c_float() pfBottom = c_float() fn(eEye, byref(pfLeft), byref(pfRight), byref(pfTop), byref(pfB...	[ "\n The components necessary to build your own projection matrix in case your\n application is doing something fancy like infinite Z\n " ]
Please provide a description of the function:def computeDistortion(self, eEye, fU, fV): fn = self.function_table.computeDistortion pDistortionCoordinates = DistortionCoordinates_t() result = fn(eEye, fU, fV, byref(pDistortionCoordinates)) return result, pDistortionCoordinates	[ "\n Gets the result of the distortion function for the specified eye and input UVs. UVs go from 0,0 in \n the upper left of that eye's viewport and 1,1 in the lower right of that eye's viewport.\n Returns true for success. Otherwise, returns false, and distortion coordinates are not suitable.\n...
Please provide a description of the function:def getEyeToHeadTransform(self, eEye): fn = self.function_table.getEyeToHeadTransform result = fn(eEye) return result	[ "\n Returns the transform from eye space to the head space. Eye space is the per-eye flavor of head\n space that provides stereo disparity. Instead of Model * View * Projection the sequence is Model * View * Eye^-1 * Projection. \n Normally View and Eye^-1 will be multiplied together and treate...
Please provide a description of the function:def getTimeSinceLastVsync(self): fn = self.function_table.getTimeSinceLastVsync pfSecondsSinceLastVsync = c_float() pulFrameCounter = c_uint64() result = fn(byref(pfSecondsSinceLastVsync), byref(pulFrameCounter)) return resul...	[ "\n Returns the number of elapsed seconds since the last recorded vsync event. This \n will come from a vsync timer event in the timer if possible or from the application-reported\n time if that is not available. If no vsync times are available the function will \n return zero for vs...
Please provide a description of the function:def getDXGIOutputInfo(self): fn = self.function_table.getDXGIOutputInfo pnAdapterIndex = c_int32() fn(byref(pnAdapterIndex)) return pnAdapterIndex.value	[ "\n [D3D10/11 Only]\n Returns the adapter index and output index that the user should pass into EnumAdapters and EnumOutputs\n to create the device and swap chain in DX10 and DX11. If an error occurs both indices will be set to -1.\n " ]
Please provide a description of the function:def getOutputDevice(self, textureType): fn = self.function_table.getOutputDevice pnDevice = c_uint64() pInstance = VkInstance_T() fn(byref(pnDevice), textureType, byref(pInstance)) return pnDevice.value, pInstance	[ "\n * Returns platform- and texture-type specific adapter identification so that applications and the\n compositor are creating textures and swap chains on the same GPU. If an error occurs the device\n will be set to 0.\n pInstance is an optional parameter that is required only when text...
Please provide a description of the function:def setDisplayVisibility(self, bIsVisibleOnDesktop): fn = self.function_table.setDisplayVisibility result = fn(bIsVisibleOnDesktop) return result	[ "Set the display visibility (true = extended, false = direct mode). Return value of true indicates that the change was successful." ]
Please provide a description of the function:def getDeviceToAbsoluteTrackingPose(self, eOrigin, fPredictedSecondsToPhotonsFromNow, unTrackedDevicePoseArrayCount, pTrackedDevicePoseArray=None): fn = self.function_table.getDeviceToAbsoluteTrackingPose if pTrackedDevicePoseArray is None: ...	[ "\n The pose that the tracker thinks that the HMD will be in at the specified number of seconds into the \n future. Pass 0 to get the state at the instant the method is called. Most of the time the application should\n calculate the time until the photons will be emitted from the display and pa...
Please provide a description of the function:def getSortedTrackedDeviceIndicesOfClass(self, eTrackedDeviceClass, unTrackedDeviceIndexArrayCount, unRelativeToTrackedDeviceIndex): fn = self.function_table.getSortedTrackedDeviceIndicesOfClass punTrackedDeviceIndexArray = TrackedDeviceIndex_t() ...	[ "\n Get a sorted array of device indices of a given class of tracked devices (e.g. controllers). Devices are sorted right to left\n relative to the specified tracked device (default: hmd -- pass in -1 for absolute tracking space). Returns the number of devices\n in the list, or the size of th...
Please provide a description of the function:def getTrackedDeviceActivityLevel(self, unDeviceId): fn = self.function_table.getTrackedDeviceActivityLevel result = fn(unDeviceId) return result	[ "Returns the level of activity on the device." ]
Please provide a description of the function:def applyTransform(self): fn = self.function_table.applyTransform pOutputPose = TrackedDevicePose_t() pTrackedDevicePose = TrackedDevicePose_t() pTransform = HmdMatrix34_t() fn(byref(pOutputPose), byref(pTrackedDevicePose), b...	[ "\n Convenience utility to apply the specified transform to the specified pose.\n This properly transforms all pose components, including velocity and angular velocity\n " ]
Please provide a description of the function:def getTrackedDeviceIndexForControllerRole(self, unDeviceType): fn = self.function_table.getTrackedDeviceIndexForControllerRole result = fn(unDeviceType) return result	[ "Returns the device index associated with a specific role, for example the left hand or the right hand. This function is deprecated in favor of the new IVRInput system." ]
Please provide a description of the function:def getControllerRoleForTrackedDeviceIndex(self, unDeviceIndex): fn = self.function_table.getControllerRoleForTrackedDeviceIndex result = fn(unDeviceIndex) return result	[ "Returns the controller type associated with a device index. This function is deprecated in favor of the new IVRInput system." ]
Please provide a description of the function:def getTrackedDeviceClass(self, unDeviceIndex): fn = self.function_table.getTrackedDeviceClass result = fn(unDeviceIndex) return result	[ "\n Returns the device class of a tracked device. If there has not been a device connected in this slot\n since the application started this function will return TrackedDevice_Invalid. For previous detected\n devices the function will return the previously observed device class. \n * To ...
Please provide a description of the function:def isTrackedDeviceConnected(self, unDeviceIndex): fn = self.function_table.isTrackedDeviceConnected result = fn(unDeviceIndex) return result	[ "Returns true if there is a device connected in this slot." ]
Please provide a description of the function:def getBoolTrackedDeviceProperty(self, unDeviceIndex, prop): fn = self.function_table.getBoolTrackedDeviceProperty pError = ETrackedPropertyError() result = fn(unDeviceIndex, prop, byref(pError)) return result, pError	[ "Returns a bool property. If the device index is not valid or the property is not a bool type this function will return false." ]
Please provide a description of the function:def getArrayTrackedDeviceProperty(self, unDeviceIndex, prop, propType, pBuffer, unBufferSize): fn = self.function_table.getArrayTrackedDeviceProperty pError = ETrackedPropertyError() result = fn(unDeviceIndex, prop, propType, pBuffer, unBuff...	[ "\n Returns an array of one type of property. If the device index is not valid or the property is not a single value or an array of the specified type,\n this function will return 0. Otherwise it returns the number of bytes necessary to hold the array of properties. If unBufferSize is\n greater...
Please provide a description of the function:def getStringTrackedDeviceProperty(self, unDeviceIndex, prop): fn = self.function_table.getStringTrackedDeviceProperty pError = ETrackedPropertyError() # TODO: automate this string argument manipulation **** unRequiredBufferLen = fn(...	[ "\n Returns a string property. If the device index is not valid or the property is not a string type this function will \n return 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing\n null. Strings will always fit in buffers of k_unMaxP...
Please provide a description of the function:def getPropErrorNameFromEnum(self, error): fn = self.function_table.getPropErrorNameFromEnum result = fn(error) return result	[ "\n returns a string that corresponds with the specified property error. The string will be the name \n of the error enum value for all valid error codes\n " ]
Please provide a description of the function:def pollNextEvent(self, pEvent): fn = self.function_table.pollNextEvent result = fn(byref(pEvent), sizeof(VREvent_t)) return result != 0	[ "\n Returns true and fills the event with the next event on the queue if there is one. If there are no events\n this method returns false. uncbVREvent should be the size in bytes of the VREvent_t struct\n " ]
Please provide a description of the function:def pollNextEventWithPose(self, eOrigin, uncbVREvent): fn = self.function_table.pollNextEventWithPose pEvent = VREvent_t() pTrackedDevicePose = TrackedDevicePose_t() result = fn(eOrigin, byref(pEvent), uncbVREvent, byref(pTrackedDevi...	[ "\n Returns true and fills the event with the next event on the queue if there is one. If there are no events\n this method returns false. Fills in the pose of the associated tracked device in the provided pose struct. \n This pose will always be older than the call to this function and should ...
Please provide a description of the function:def getEventTypeNameFromEnum(self, eType): fn = self.function_table.getEventTypeNameFromEnum result = fn(eType) return result	[ "returns the name of an EVREvent enum value" ]
Please provide a description of the function:def getHiddenAreaMesh(self, eEye, type_): fn = self.function_table.getHiddenAreaMesh result = fn(eEye, type_) return result	[ "\n Returns the hidden area mesh for the current HMD. The pixels covered by this mesh will never be seen by the user after the lens distortion is\n applied based on visibility to the panels. If this HMD does not have a hidden area mesh, the vertex data and count will be NULL and 0 respectively.\n ...
Please provide a description of the function:def getControllerState(self, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)): fn = self.function_table.getControllerState pControllerState = VRControllerState_t() result = fn(unControllerDeviceIndex, byref(pContro...	[ "\n Fills the supplied struct with the current state of the controller. Returns false if the controller index\n is invalid. This function is deprecated in favor of the new IVRInput system.\n " ]
Please provide a description of the function:def getControllerStateWithPose(self, eOrigin, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)): fn = self.function_table.getControllerStateWithPose pControllerState = VRControllerState_t() pTrackedDevicePose = Trac...	[ "\n fills the supplied struct with the current state of the controller and the provided pose with the pose of \n the controller when the controller state was updated most recently. Use this form if you need a precise controller\n pose as input to your application when the user presses or releas...
Please provide a description of the function:def triggerHapticPulse(self, unControllerDeviceIndex, unAxisId, usDurationMicroSec): fn = self.function_table.triggerHapticPulse fn(unControllerDeviceIndex, unAxisId, usDurationMicroSec)	[ "\n Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller\n and axis combination for 5ms. This function is deprecated in favor of the new IVRInput system.\n " ]
Please provide a description of the function:def getButtonIdNameFromEnum(self, eButtonId): fn = self.function_table.getButtonIdNameFromEnum result = fn(eButtonId) return result	[ "returns the name of an EVRButtonId enum value. This function is deprecated in favor of the new IVRInput system." ]
Please provide a description of the function:def getControllerAxisTypeNameFromEnum(self, eAxisType): fn = self.function_table.getControllerAxisTypeNameFromEnum result = fn(eAxisType) return result	[ "returns the name of an EVRControllerAxisType enum value. This function is deprecated in favor of the new IVRInput system." ]
Please provide a description of the function:def driverDebugRequest(self, unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize): fn = self.function_table.driverDebugRequest result = fn(unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize) return result	[ "\n Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k,\n but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated. \n The size of the response including its terminating nu...
Please provide a description of the function:def performFirmwareUpdate(self, unDeviceIndex): fn = self.function_table.performFirmwareUpdate result = fn(unDeviceIndex) return result	[ "\n Performs the actual firmware update if applicable. \n The following events will be sent, if VRFirmwareError_None was returned: VREvent_FirmwareUpdateStarted, VREvent_FirmwareUpdateFinished \n Use the properties Prop_Firmware_UpdateAvailable_Bool, Prop_Firmware_ManualUpdate_Bool, and Prop_Fi...
Please provide a description of the function:def getWindowBounds(self): fn = self.function_table.getWindowBounds pnX = c_int32() pnY = c_int32() pnWidth = c_uint32() pnHeight = c_uint32() fn(byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight)) return...	[ "Size and position that the window needs to be on the VR display." ]
Please provide a description of the function: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(p...	[ "Gets the viewport in the frame buffer to draw the output of the distortion into" ]
Please provide a description of the function:def getDXGIOutputInfo(self): fn = self.function_table.getDXGIOutputInfo pnAdapterIndex = c_int32() pnAdapterOutputIndex = c_int32() fn(byref(pnAdapterIndex), byref(pnAdapterOutputIndex)) return pnAdapterIndex.value, pnAdapter...	[ "\n [D3D10/11 Only]\n Returns the adapter index and output index that the user should pass into EnumAdapters and EnumOutputs\n to create the device and swap chain in DX10 and DX11. If an error occurs both indices will be set to -1.\n " ]
Please provide a description of the function:def getCameraErrorNameFromEnum(self, eCameraError): fn = self.function_table.getCameraErrorNameFromEnum result = fn(eCameraError) return result	[ "Returns a string for an error" ]
Please provide a description of the function: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" ]
Please provide a description of the function:def getCameraFrameSize(self, nDeviceIndex, eFrameType): fn = self.function_table.getCameraFrameSize pnWidth = c_uint32() pnHeight = c_uint32() pnFrameBufferSize = c_uint32() result = fn(nDeviceIndex, eFrameType, byref(pnWidth...	[ "Gets size of the image frame." ]
Please provide a description of the function:def acquireVideoStreamingService(self, nDeviceIndex): fn = self.function_table.acquireVideoStreamingService pHandle = TrackedCameraHandle_t() result = fn(nDeviceIndex, byref(pHandle)) return result, pHandle	[ "\n 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.\n 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...
Please provide a description of the function:def getVideoStreamFrameBuffer(self, hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, nFrameHeaderSize): fn = self.function_table.getVideoStreamFrameBuffer pFrameHeader = CameraVideoStreamFrameHeader_t() result = fn(hTrackedCamera,...	[ "\n Copies the image frame into a caller's provided buffer. The image data is currently provided as RGBA data, 4 bytes per pixel.\n A caller can provide null for the framebuffer or frameheader if not desired. Requesting the frame header first, followed by the frame buffer allows\n the caller to...
Please provide a description of the function:def getVideoStreamTextureSize(self, nDeviceIndex, eFrameType): fn = self.function_table.getVideoStreamTextureSize pTextureBounds = VRTextureBounds_t() pnWidth = c_uint32() pnHeight = c_uint32() result = fn(nDeviceIndex, eFram...	[ "Gets size of the image frame." ]
Please provide a description of the function:def getVideoStreamTextureGL(self, hTrackedCamera, eFrameType, nFrameHeaderSize): fn = self.function_table.getVideoStreamTextureGL pglTextureId = glUInt_t() pFrameHeader = CameraVideoStreamFrameHeader_t() result = fn(hTrackedCamera, e...	[ "Access a shared GL texture for the specified tracked camera stream" ]
Please provide a description of the function:def addApplicationManifest(self, pchApplicationManifestFullPath, bTemporary): fn = self.function_table.addApplicationManifest result = fn(pchApplicationManifestFullPath, bTemporary) return result	[ "\n Adds an application manifest to the list to load when building the list of installed applications. \n Temporary manifests are not automatically loaded\n " ]
Please provide a description of the function: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." ]
Please provide a description of the function:def isApplicationInstalled(self, pchAppKey): fn = self.function_table.isApplicationInstalled result = fn(pchAppKey) return result	[ "Returns true if an application is installed" ]
Please provide a description of the function:def launchApplication(self, pchAppKey): fn = self.function_table.launchApplication result = fn(pchAppKey) return result	[ "\n Launches the application. The existing scene application will exit and then the new application will start.\n This call is not valid for dashboard overlay applications.\n " ]
Please provide a description of the function:def launchTemplateApplication(self, pchTemplateAppKey, pchNewAppKey, unKeys): fn = self.function_table.launchTemplateApplication pKeys = AppOverrideKeys_t() result = fn(pchTemplateAppKey, pchNewAppKey, byref(pKeys), unKeys) return re...	[ "\n Launches an instance of an application of type template, with its app key being pchNewAppKey (which must be unique) and optionally override sections\n from the manifest file via AppOverrideKeys_t\n " ]
Please provide a description of the function: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" ]
Please provide a description of the function:def launchDashboardOverlay(self, pchAppKey): fn = self.function_table.launchDashboardOverlay result = fn(pchAppKey) return result	[ "\n Launches the dashboard overlay application if it is not already running. This call is only valid for \n dashboard overlay applications.\n " ]
Please provide a description of the function:def cancelApplicationLaunch(self, pchAppKey): fn = self.function_table.cancelApplicationLaunch result = fn(pchAppKey) return result	[ "Cancel a pending launch for an application" ]
Please provide a description of the function:def identifyApplication(self, unProcessId, pchAppKey): fn = self.function_table.identifyApplication result = fn(unProcessId, pchAppKey) return result	[ "\n Identifies a running application. OpenVR can't always tell which process started in response\n to a URL. This function allows a URL handler (or the process itself) to identify the app key \n for the now running application. Passing a process ID of 0 identifies the calling process. \n ...
Please provide a description of the function:def getApplicationsErrorNameFromEnum(self, error): fn = self.function_table.getApplicationsErrorNameFromEnum result = fn(error) return result	[ "Returns a string for an applications error" ]
Please provide a description of the function:def getApplicationPropertyString(self, pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen): fn = self.function_table.getApplicationPropertyString peError = EVRApplicationError() result = fn(pchAppKey, eProperty, pchProper...	[ "Returns a value for an application property. The required buffer size to fit this value will be returned." ]
Please provide a description of the function: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." ]
Please provide a description of the function: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." ]
Please provide a description of the function: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." ]
Please provide a description of the function: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" ]
Please provide a description of the function: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" ]
Please provide a description of the function: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" ]
Please provide a description of the function:def getApplicationsThatSupportMimeType(self, pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer): fn = self.function_table.getApplicationsThatSupportMimeType result = fn(pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSuppor...	[ "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" ]
Please provide a description of the function: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" ]
Please provide a description of the function: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" ]
Please provide a description of the function:def performApplicationPrelaunchCheck(self, pchAppKey): fn = self.function_table.performApplicationPrelaunchCheck result = fn(pchAppKey) return result	[ "\n Returns errors that would prevent the specified application from launching immediately. Calling this function will\n cause the current scene application to quit, so only call it when you are actually about to launch something else.\n What the caller should do about these failures depends on...
Please provide a description of the function:def getApplicationsTransitionStateNameFromEnum(self, state): fn = self.function_table.getApplicationsTransitionStateNameFromEnum result = fn(state) return result	[ "Returns a string for an application transition state" ]
Please provide a description of the function:def launchInternalProcess(self, pchBinaryPath, pchArguments, pchWorkingDirectory): fn = self.function_table.launchInternalProcess result = fn(pchBinaryPath, pchArguments, pchWorkingDirectory) return result	[ "\n Starts a subprocess within the calling application. This\n suppresses all application transition UI and automatically identifies the new executable \n as part of the same application. On success the calling process should exit immediately. \n If working directory is NULL or \"\" the ...
Please provide a description of the function:def getPlayAreaSize(self): fn = self.function_table.getPlayAreaSize pSizeX = c_float() pSizeZ = c_float() result = fn(byref(pSizeX), byref(pSizeZ)) return result, pSizeX.value, pSizeZ.value	[ "\n Returns the width and depth of the Play Area (formerly named Soft Bounds) in X and Z. \n Tracking space center (0,0,0) is the center of the Play Area.\n " ]
Please provide a description of the function:def getPlayAreaRect(self): fn = self.function_table.getPlayAreaRect rect = HmdQuad_t() result = fn(byref(rect)) return result, rect	[ "\n Returns the 4 corner positions of the Play Area (formerly named Soft Bounds).\n Corners are in counter-clockwise order.\n Standing center (0,0,0) is the center of the Play Area.\n It's a rectangle.\n 2 sides are parallel to the X axis and 2 sides are parallel to the Z axis.\n ...
Please provide a description of the function:def getBoundsColor(self, nNumOutputColors, flCollisionBoundsFadeDistance): fn = self.function_table.getBoundsColor pOutputColorArray = HmdColor_t() pOutputCameraColor = HmdColor_t() fn(byref(pOutputColorArray), nNumOutputColors, flCo...	[ "Get the current chaperone bounds draw color and brightness" ]
Please provide a description of the function:def commitWorkingCopy(self, configFile): fn = self.function_table.commitWorkingCopy result = fn(configFile) return result	[ "Saves the current working copy to disk" ]
Please provide a description of the function:def getWorkingPlayAreaRect(self): fn = self.function_table.getWorkingPlayAreaRect rect = HmdQuad_t() result = fn(byref(rect)) return result, rect	[ "\n Returns the 4 corner positions of the Play Area (formerly named Soft Bounds) from the working copy.\n Corners are in clockwise order.\n Tracking space center (0,0,0) is the center of the Play Area.\n It's a rectangle.\n 2 sides are parallel to the X axis and 2 sides are parall...
Please provide a description of the function:def getWorkingCollisionBoundsInfo(self): fn = self.function_table.getWorkingCollisionBoundsInfo pQuadsBuffer = HmdQuad_t() punQuadsCount = c_uint32() result = fn(byref(pQuadsBuffer), byref(punQuadsCount)) return result, pQuad...	[ "\n Returns the number of Quads if the buffer points to null. Otherwise it returns Quads \n into the buffer up to the max specified from the working copy.\n " ]
Please provide a description of the function:def getWorkingSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.getWorkingSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose)) ret...	[ "Returns the preferred seated position from the working copy." ]
Please provide a description of the function:def getWorkingStandingZeroPoseToRawTrackingPose(self): fn = self.function_table.getWorkingStandingZeroPoseToRawTrackingPose pmatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatStandingZeroPoseToRawTrackingPose)) ...	[ "Returns the standing origin from the working copy." ]
Please provide a description of the function:def setWorkingPlayAreaSize(self, sizeX, sizeZ): fn = self.function_table.setWorkingPlayAreaSize fn(sizeX, sizeZ)	[ "Sets the Play Area in the working copy." ]
Please provide a description of the function:def setWorkingCollisionBoundsInfo(self, unQuadsCount): fn = self.function_table.setWorkingCollisionBoundsInfo pQuadsBuffer = HmdQuad_t() fn(byref(pQuadsBuffer), unQuadsCount) return pQuadsBuffer	[ "Sets the Collision Bounds in the working copy." ]
Please provide a description of the function:def setWorkingPerimeter(self, unPointCount): fn = self.function_table.setWorkingPerimeter pPointBuffer = HmdVector2_t() fn(byref(pPointBuffer), unPointCount) return pPointBuffer	[ "Sets the Collision Bounds in the working copy." ]
Please provide a description of the function:def setWorkingSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.setWorkingSeatedZeroPoseToRawTrackingPose pMatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() fn(byref(pMatSeatedZeroPoseToRawTrackingPose)) return pMatS...	[ "Sets the preferred seated position in the working copy." ]
Please provide a description of the function:def setWorkingStandingZeroPoseToRawTrackingPose(self): fn = self.function_table.setWorkingStandingZeroPoseToRawTrackingPose pMatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t() fn(byref(pMatStandingZeroPoseToRawTrackingPose)) retu...	[ "Sets the preferred standing position in the working copy." ]
Please provide a description of the function:def getLiveSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.getLiveSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose)) return re...	[ "Returns the preferred seated position." ]
Please provide a description of the function:def waitGetPoses(self, pRenderPoseArray, unRenderPoseArrayCount, pGamePoseArray, unGamePoseArrayCount): fn = self.function_table.waitGetPoses # TODO: Automate this manual translation # Convert non-pointer python arguments to pointers ...	[ "\n Scene applications should call this function to get poses to render with (and optionally poses predicted an additional frame out to use for gameplay).\n This function will block until \"running start\" milliseconds before the start of the frame, and should be called at the last moment before needi...
Please provide a description of the function:def getLastPoses(self, unRenderPoseArrayCount, unGamePoseArrayCount): fn = self.function_table.getLastPoses pRenderPoseArray = TrackedDevicePose_t() pGamePoseArray = TrackedDevicePose_t() result = fn(byref(pRenderPoseArray), unRender...	[ "Get the last set of poses returned by WaitGetPoses." ]
Please provide a description of the function:def getLastPoseForTrackedDeviceIndex(self, unDeviceIndex): fn = self.function_table.getLastPoseForTrackedDeviceIndex pOutputPose = TrackedDevicePose_t() pOutputGamePose = TrackedDevicePose_t() result = fn(unDeviceIndex, byref(pOutput...	[ "\n Interface for accessing last set of poses returned by WaitGetPoses one at a time.\n Returns VRCompositorError_IndexOutOfRange if unDeviceIndex not less than k_unMaxTrackedDeviceCount otherwise VRCompositorError_None.\n It is okay to pass NULL for either pose if you only want one of the valu...
Please provide a description of the function:def submit(self, eEye, pTexture, pBounds=None, nSubmitFlags=Submit_Default): fn = self.function_table.submit result = fn(eEye, byref(pTexture), pBounds, nSubmitFlags) return result	[ "\n Updated scene texture to display. If pBounds is NULL the entire texture will be used. If called from an OpenGL app, consider adding a glFlush after\n Submitting both frames to signal the driver to start processing, otherwise it may wait until the command buffer fills up, causing the app to miss f...
Please provide a description of the function:def getFrameTiming(self, unFramesAgo): fn = self.function_table.getFrameTiming pTiming = Compositor_FrameTiming() result = fn(byref(pTiming), unFramesAgo) return result, pTiming	[ "\n Returns true if timing data is filled it. Sets oldest timing info if nFramesAgo is larger than the stored history.\n Be sure to set timing.size = sizeof(Compositor_FrameTiming) on struct passed in before calling this function.\n " ]
Please provide a description of the function:def getFrameTimings(self, nFrames): fn = self.function_table.getFrameTimings pTiming = Compositor_FrameTiming() result = fn(byref(pTiming), nFrames) return result, pTiming	[ "\n Interface for copying a range of timing data. Frames are returned in ascending order (oldest to newest) with the last being the most recent frame.\n Only the first entry's m_nSize needs to be set, as the rest will be inferred from that. Returns total number of entries filled out.\n " ]
Please provide a description of the function:def getCumulativeStats(self, nStatsSizeInBytes): fn = self.function_table.getCumulativeStats pStats = Compositor_CumulativeStats() fn(byref(pStats), nStatsSizeInBytes) return pStats	[ "Fills out stats accumulated for the last connected application. Pass in sizeof( Compositor_CumulativeStats ) as second parameter." ]
Please provide a description of the function:def fadeToColor(self, fSeconds, fRed, fGreen, fBlue, fAlpha, bBackground): fn = self.function_table.fadeToColor fn(fSeconds, fRed, fGreen, fBlue, fAlpha, bBackground)	[ "\n Fades the view on the HMD to the specified color. The fade will take fSeconds, and the color values are between\n 0.0 and 1.0. This color is faded on top of the scene based on the alpha parameter. Removing the fade color instantly \n would be FadeToColor( 0.0, 0.0, 0.0, 0.0, 0.0 ). Values ...
Please provide a description of the function:def getCurrentFadeColor(self, bBackground): fn = self.function_table.getCurrentFadeColor result = fn(bBackground) return result	[ "Get current fade color value." ]
Please provide a description of the function:def fadeGrid(self, fSeconds, bFadeIn): fn = self.function_table.fadeGrid fn(fSeconds, bFadeIn)	[ "Fading the Grid in or out in fSeconds" ]
Please provide a description of the function:def setSkyboxOverride(self, unTextureCount): fn = self.function_table.setSkyboxOverride pTextures = Texture_t() result = fn(byref(pTextures), unTextureCount) return result, pTextures	[ "\n Override the skybox used in the compositor (e.g. for during level loads when the app can't feed scene images fast enough)\n Order is Front, Back, Left, Right, Top, Bottom. If only a single texture is passed, it is assumed in lat-long format.\n If two are passed, it is assumed a lat-long st...
Please provide a description of the function:def getMirrorTextureD3D11(self, eEye, pD3D11DeviceOrResource): fn = self.function_table.getMirrorTextureD3D11 ppD3D11ShaderResourceView = c_void_p() result = fn(eEye, pD3D11DeviceOrResource, byref(ppD3D11ShaderResourceView)) return r...	[ "\n Opens a shared D3D11 texture with the undistorted composited image for each eye. Use ReleaseMirrorTextureD3D11 when finished\n instead of calling Release on the resource itself.\n " ]
Please provide a description of the function:def getMirrorTextureGL(self, eEye): fn = self.function_table.getMirrorTextureGL pglTextureId = glUInt_t() pglSharedTextureHandle = glSharedTextureHandle_t() result = fn(eEye, byref(pglTextureId), byref(pglSharedTextureHandle)) ...	[ "Access to mirror textures from OpenGL." ]
Please provide a description of the function: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." ]
Please provide a description of the function: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." ]
Please provide a description of the function:def destroyOverlay(self, ulOverlayHandle): fn = self.function_table.destroyOverlay result = fn(ulOverlayHandle) return result	[ "\n Destroys the specified overlay. When an application calls VR_Shutdown all overlays created by that app are\n automatically destroyed.\n " ]
Please provide a description of the function:def setHighQualityOverlay(self, ulOverlayHandle): fn = self.function_table.setHighQualityOverlay result = fn(ulOverlayHandle) return result	[ "\n Specify which overlay to use the high quality render path. This overlay will be composited in during the distortion pass which\n results in it drawing on top of everything else, but also at a higher quality as it samples the source texture directly rather than\n rasterizing into each eye's...
Please provide a description of the function:def setOverlayName(self, ulOverlayHandle, pchName): fn = self.function_table.setOverlayName result = fn(ulOverlayHandle, pchName) return result	[ "set the name to use for this overlay" ]
Please provide a description of the function:def getOverlayImageData(self, ulOverlayHandle, pvBuffer, unBufferSize): fn = self.function_table.getOverlayImageData punWidth = c_uint32() punHeight = c_uint32() result = fn(ulOverlayHandle, pvBuffer, unBufferSize, byref(punWidth), b...	[ "\n 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 \n will be set and VROverlayError_ArrayTooSmall is returned.\n " ]
Please provide a description of the function:def getOverlayErrorNameFromEnum(self, error): fn = self.function_table.getOverlayErrorNameFromEnum result = fn(error) return result	[ "\n returns a string that corresponds with the specified overlay error. The string will be the name \n of the error enum value for all valid error codes\n " ]
Please provide a description of the function:def setOverlayRenderingPid(self, ulOverlayHandle, unPID): fn = self.function_table.setOverlayRenderingPid result = fn(ulOverlayHandle, unPID) return result	[ "\n Sets the pid that is allowed to render to this overlay (the creator pid is always allow to render),\n by default this is the pid of the process that made the overlay\n " ]
Please provide a description of the function: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" ]

Please provide a description of the function:def getProjectionMatrix(self, eEye, fNearZ, fFarZ): fn = self.function_table.getProjectionMatrix result = fn(eEye, fNearZ, fFarZ) return result

[ "The projection matrix for the specified eye" ]

Please provide a description of the function:def getProjectionRaw(self, eEye): fn = self.function_table.getProjectionRaw pfLeft = c_float() pfRight = c_float() pfTop = c_float() pfBottom = c_float() fn(eEye, byref(pfLeft), byref(pfRight), byref(pfTop), byref(pfB...

[ "\n The components necessary to build your own projection matrix in case your\n application is doing something fancy like infinite Z\n " ]

Please provide a description of the function:def computeDistortion(self, eEye, fU, fV): fn = self.function_table.computeDistortion pDistortionCoordinates = DistortionCoordinates_t() result = fn(eEye, fU, fV, byref(pDistortionCoordinates)) return result, pDistortionCoordinates

[ "\n Gets the result of the distortion function for the specified eye and input UVs. UVs go from 0,0 in \n the upper left of that eye's viewport and 1,1 in the lower right of that eye's viewport.\n Returns true for success. Otherwise, returns false, and distortion coordinates are not suitable.\n...

Please provide a description of the function:def getEyeToHeadTransform(self, eEye): fn = self.function_table.getEyeToHeadTransform result = fn(eEye) return result

[ "\n Returns the transform from eye space to the head space. Eye space is the per-eye flavor of head\n space that provides stereo disparity. Instead of Model * View * Projection the sequence is Model * View * Eye^-1 * Projection. \n Normally View and Eye^-1 will be multiplied together and treate...

Please provide a description of the function:def getTimeSinceLastVsync(self): fn = self.function_table.getTimeSinceLastVsync pfSecondsSinceLastVsync = c_float() pulFrameCounter = c_uint64() result = fn(byref(pfSecondsSinceLastVsync), byref(pulFrameCounter)) return resul...

[ "\n Returns the number of elapsed seconds since the last recorded vsync event. This \n will come from a vsync timer event in the timer if possible or from the application-reported\n time if that is not available. If no vsync times are available the function will \n return zero for vs...

Please provide a description of the function:def getDXGIOutputInfo(self): fn = self.function_table.getDXGIOutputInfo pnAdapterIndex = c_int32() fn(byref(pnAdapterIndex)) return pnAdapterIndex.value

[ "\n [D3D10/11 Only]\n Returns the adapter index and output index that the user should pass into EnumAdapters and EnumOutputs\n to create the device and swap chain in DX10 and DX11. If an error occurs both indices will be set to -1.\n " ]

Please provide a description of the function:def getOutputDevice(self, textureType): fn = self.function_table.getOutputDevice pnDevice = c_uint64() pInstance = VkInstance_T() fn(byref(pnDevice), textureType, byref(pInstance)) return pnDevice.value, pInstance

[ "\n * Returns platform- and texture-type specific adapter identification so that applications and the\n compositor are creating textures and swap chains on the same GPU. If an error occurs the device\n will be set to 0.\n pInstance is an optional parameter that is required only when text...

Please provide a description of the function:def setDisplayVisibility(self, bIsVisibleOnDesktop): fn = self.function_table.setDisplayVisibility result = fn(bIsVisibleOnDesktop) return result

[ "Set the display visibility (true = extended, false = direct mode). Return value of true indicates that the change was successful." ]

Please provide a description of the function:def getDeviceToAbsoluteTrackingPose(self, eOrigin, fPredictedSecondsToPhotonsFromNow, unTrackedDevicePoseArrayCount, pTrackedDevicePoseArray=None): fn = self.function_table.getDeviceToAbsoluteTrackingPose if pTrackedDevicePoseArray is None: ...

[ "\n The pose that the tracker thinks that the HMD will be in at the specified number of seconds into the \n future. Pass 0 to get the state at the instant the method is called. Most of the time the application should\n calculate the time until the photons will be emitted from the display and pa...

Please provide a description of the function:def getSortedTrackedDeviceIndicesOfClass(self, eTrackedDeviceClass, unTrackedDeviceIndexArrayCount, unRelativeToTrackedDeviceIndex): fn = self.function_table.getSortedTrackedDeviceIndicesOfClass punTrackedDeviceIndexArray = TrackedDeviceIndex_t() ...

[ "\n Get a sorted array of device indices of a given class of tracked devices (e.g. controllers). Devices are sorted right to left\n relative to the specified tracked device (default: hmd -- pass in -1 for absolute tracking space). Returns the number of devices\n in the list, or the size of th...

Please provide a description of the function:def getTrackedDeviceActivityLevel(self, unDeviceId): fn = self.function_table.getTrackedDeviceActivityLevel result = fn(unDeviceId) return result

[ "Returns the level of activity on the device." ]

Please provide a description of the function:def applyTransform(self): fn = self.function_table.applyTransform pOutputPose = TrackedDevicePose_t() pTrackedDevicePose = TrackedDevicePose_t() pTransform = HmdMatrix34_t() fn(byref(pOutputPose), byref(pTrackedDevicePose), b...

[ "\n Convenience utility to apply the specified transform to the specified pose.\n This properly transforms all pose components, including velocity and angular velocity\n " ]

Please provide a description of the function:def getTrackedDeviceIndexForControllerRole(self, unDeviceType): fn = self.function_table.getTrackedDeviceIndexForControllerRole result = fn(unDeviceType) return result

[ "Returns the device index associated with a specific role, for example the left hand or the right hand. This function is deprecated in favor of the new IVRInput system." ]

Please provide a description of the function:def getControllerRoleForTrackedDeviceIndex(self, unDeviceIndex): fn = self.function_table.getControllerRoleForTrackedDeviceIndex result = fn(unDeviceIndex) return result

[ "Returns the controller type associated with a device index. This function is deprecated in favor of the new IVRInput system." ]

Please provide a description of the function:def getTrackedDeviceClass(self, unDeviceIndex): fn = self.function_table.getTrackedDeviceClass result = fn(unDeviceIndex) return result

[ "\n Returns the device class of a tracked device. If there has not been a device connected in this slot\n since the application started this function will return TrackedDevice_Invalid. For previous detected\n devices the function will return the previously observed device class. \n * To ...

Please provide a description of the function:def isTrackedDeviceConnected(self, unDeviceIndex): fn = self.function_table.isTrackedDeviceConnected result = fn(unDeviceIndex) return result

[ "Returns true if there is a device connected in this slot." ]

Please provide a description of the function:def getBoolTrackedDeviceProperty(self, unDeviceIndex, prop): fn = self.function_table.getBoolTrackedDeviceProperty pError = ETrackedPropertyError() result = fn(unDeviceIndex, prop, byref(pError)) return result, pError

[ "Returns a bool property. If the device index is not valid or the property is not a bool type this function will return false." ]

Please provide a description of the function:def getArrayTrackedDeviceProperty(self, unDeviceIndex, prop, propType, pBuffer, unBufferSize): fn = self.function_table.getArrayTrackedDeviceProperty pError = ETrackedPropertyError() result = fn(unDeviceIndex, prop, propType, pBuffer, unBuff...

[ "\n Returns an array of one type of property. If the device index is not valid or the property is not a single value or an array of the specified type,\n this function will return 0. Otherwise it returns the number of bytes necessary to hold the array of properties. If unBufferSize is\n greater...

Please provide a description of the function:def getStringTrackedDeviceProperty(self, unDeviceIndex, prop): fn = self.function_table.getStringTrackedDeviceProperty pError = ETrackedPropertyError() # TODO: automate this string argument manipulation **** unRequiredBufferLen = fn(...

[ "\n Returns a string property. If the device index is not valid or the property is not a string type this function will \n return 0. Otherwise it returns the length of the number of bytes necessary to hold this string including the trailing\n null. Strings will always fit in buffers of k_unMaxP...

Please provide a description of the function:def getPropErrorNameFromEnum(self, error): fn = self.function_table.getPropErrorNameFromEnum result = fn(error) return result

[ "\n returns a string that corresponds with the specified property error. The string will be the name \n of the error enum value for all valid error codes\n " ]

Please provide a description of the function:def pollNextEvent(self, pEvent): fn = self.function_table.pollNextEvent result = fn(byref(pEvent), sizeof(VREvent_t)) return result != 0

[ "\n Returns true and fills the event with the next event on the queue if there is one. If there are no events\n this method returns false. uncbVREvent should be the size in bytes of the VREvent_t struct\n " ]

Please provide a description of the function:def pollNextEventWithPose(self, eOrigin, uncbVREvent): fn = self.function_table.pollNextEventWithPose pEvent = VREvent_t() pTrackedDevicePose = TrackedDevicePose_t() result = fn(eOrigin, byref(pEvent), uncbVREvent, byref(pTrackedDevi...

[ "\n Returns true and fills the event with the next event on the queue if there is one. If there are no events\n this method returns false. Fills in the pose of the associated tracked device in the provided pose struct. \n This pose will always be older than the call to this function and should ...

Please provide a description of the function:def getEventTypeNameFromEnum(self, eType): fn = self.function_table.getEventTypeNameFromEnum result = fn(eType) return result

[ "returns the name of an EVREvent enum value" ]

Please provide a description of the function:def getHiddenAreaMesh(self, eEye, type_): fn = self.function_table.getHiddenAreaMesh result = fn(eEye, type_) return result

[ "\n Returns the hidden area mesh for the current HMD. The pixels covered by this mesh will never be seen by the user after the lens distortion is\n applied based on visibility to the panels. If this HMD does not have a hidden area mesh, the vertex data and count will be NULL and 0 respectively.\n ...

Please provide a description of the function:def getControllerState(self, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)): fn = self.function_table.getControllerState pControllerState = VRControllerState_t() result = fn(unControllerDeviceIndex, byref(pContro...

[ "\n Fills the supplied struct with the current state of the controller. Returns false if the controller index\n is invalid. This function is deprecated in favor of the new IVRInput system.\n " ]

Please provide a description of the function:def getControllerStateWithPose(self, eOrigin, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)): fn = self.function_table.getControllerStateWithPose pControllerState = VRControllerState_t() pTrackedDevicePose = Trac...

[ "\n fills the supplied struct with the current state of the controller and the provided pose with the pose of \n the controller when the controller state was updated most recently. Use this form if you need a precise controller\n pose as input to your application when the user presses or releas...

Please provide a description of the function:def triggerHapticPulse(self, unControllerDeviceIndex, unAxisId, usDurationMicroSec): fn = self.function_table.triggerHapticPulse fn(unControllerDeviceIndex, unAxisId, usDurationMicroSec)

[ "\n Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller\n and axis combination for 5ms. This function is deprecated in favor of the new IVRInput system.\n " ]

Please provide a description of the function:def getButtonIdNameFromEnum(self, eButtonId): fn = self.function_table.getButtonIdNameFromEnum result = fn(eButtonId) return result

[ "returns the name of an EVRButtonId enum value. This function is deprecated in favor of the new IVRInput system." ]

Please provide a description of the function:def getControllerAxisTypeNameFromEnum(self, eAxisType): fn = self.function_table.getControllerAxisTypeNameFromEnum result = fn(eAxisType) return result

[ "returns the name of an EVRControllerAxisType enum value. This function is deprecated in favor of the new IVRInput system." ]

Please provide a description of the function:def driverDebugRequest(self, unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize): fn = self.function_table.driverDebugRequest result = fn(unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize) return result

[ "\n Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k,\n but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated. \n The size of the response including its terminating nu...

Please provide a description of the function:def performFirmwareUpdate(self, unDeviceIndex): fn = self.function_table.performFirmwareUpdate result = fn(unDeviceIndex) return result

[ "\n Performs the actual firmware update if applicable. \n The following events will be sent, if VRFirmwareError_None was returned: VREvent_FirmwareUpdateStarted, VREvent_FirmwareUpdateFinished \n Use the properties Prop_Firmware_UpdateAvailable_Bool, Prop_Firmware_ManualUpdate_Bool, and Prop_Fi...

Please provide a description of the function:def getWindowBounds(self): fn = self.function_table.getWindowBounds pnX = c_int32() pnY = c_int32() pnWidth = c_uint32() pnHeight = c_uint32() fn(byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight)) return...

[ "Size and position that the window needs to be on the VR display." ]

Please provide a description of the function: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(p...

[ "Gets the viewport in the frame buffer to draw the output of the distortion into" ]

Please provide a description of the function:def getDXGIOutputInfo(self): fn = self.function_table.getDXGIOutputInfo pnAdapterIndex = c_int32() pnAdapterOutputIndex = c_int32() fn(byref(pnAdapterIndex), byref(pnAdapterOutputIndex)) return pnAdapterIndex.value, pnAdapter...

[ "\n [D3D10/11 Only]\n Returns the adapter index and output index that the user should pass into EnumAdapters and EnumOutputs\n to create the device and swap chain in DX10 and DX11. If an error occurs both indices will be set to -1.\n " ]

Please provide a description of the function:def getCameraErrorNameFromEnum(self, eCameraError): fn = self.function_table.getCameraErrorNameFromEnum result = fn(eCameraError) return result

[ "Returns a string for an error" ]

Please provide a description of the function: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" ]

Please provide a description of the function:def getCameraFrameSize(self, nDeviceIndex, eFrameType): fn = self.function_table.getCameraFrameSize pnWidth = c_uint32() pnHeight = c_uint32() pnFrameBufferSize = c_uint32() result = fn(nDeviceIndex, eFrameType, byref(pnWidth...

[ "Gets size of the image frame." ]

Please provide a description of the function:def acquireVideoStreamingService(self, nDeviceIndex): fn = self.function_table.acquireVideoStreamingService pHandle = TrackedCameraHandle_t() result = fn(nDeviceIndex, byref(pHandle)) return result, pHandle

[ "\n 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.\n 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...

Please provide a description of the function:def getVideoStreamFrameBuffer(self, hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, nFrameHeaderSize): fn = self.function_table.getVideoStreamFrameBuffer pFrameHeader = CameraVideoStreamFrameHeader_t() result = fn(hTrackedCamera,...

[ "\n Copies the image frame into a caller's provided buffer. The image data is currently provided as RGBA data, 4 bytes per pixel.\n A caller can provide null for the framebuffer or frameheader if not desired. Requesting the frame header first, followed by the frame buffer allows\n the caller to...

Please provide a description of the function:def getVideoStreamTextureSize(self, nDeviceIndex, eFrameType): fn = self.function_table.getVideoStreamTextureSize pTextureBounds = VRTextureBounds_t() pnWidth = c_uint32() pnHeight = c_uint32() result = fn(nDeviceIndex, eFram...

[ "Gets size of the image frame." ]

Please provide a description of the function:def getVideoStreamTextureGL(self, hTrackedCamera, eFrameType, nFrameHeaderSize): fn = self.function_table.getVideoStreamTextureGL pglTextureId = glUInt_t() pFrameHeader = CameraVideoStreamFrameHeader_t() result = fn(hTrackedCamera, e...

[ "Access a shared GL texture for the specified tracked camera stream" ]

Please provide a description of the function:def addApplicationManifest(self, pchApplicationManifestFullPath, bTemporary): fn = self.function_table.addApplicationManifest result = fn(pchApplicationManifestFullPath, bTemporary) return result

[ "\n Adds an application manifest to the list to load when building the list of installed applications. \n Temporary manifests are not automatically loaded\n " ]

Please provide a description of the function: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." ]

Please provide a description of the function:def isApplicationInstalled(self, pchAppKey): fn = self.function_table.isApplicationInstalled result = fn(pchAppKey) return result

[ "Returns true if an application is installed" ]

Please provide a description of the function:def launchApplication(self, pchAppKey): fn = self.function_table.launchApplication result = fn(pchAppKey) return result

[ "\n Launches the application. The existing scene application will exit and then the new application will start.\n This call is not valid for dashboard overlay applications.\n " ]

Please provide a description of the function:def launchTemplateApplication(self, pchTemplateAppKey, pchNewAppKey, unKeys): fn = self.function_table.launchTemplateApplication pKeys = AppOverrideKeys_t() result = fn(pchTemplateAppKey, pchNewAppKey, byref(pKeys), unKeys) return re...

[ "\n Launches an instance of an application of type template, with its app key being pchNewAppKey (which must be unique) and optionally override sections\n from the manifest file via AppOverrideKeys_t\n " ]

Please provide a description of the function: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" ]

Please provide a description of the function:def launchDashboardOverlay(self, pchAppKey): fn = self.function_table.launchDashboardOverlay result = fn(pchAppKey) return result

[ "\n Launches the dashboard overlay application if it is not already running. This call is only valid for \n dashboard overlay applications.\n " ]

Please provide a description of the function:def cancelApplicationLaunch(self, pchAppKey): fn = self.function_table.cancelApplicationLaunch result = fn(pchAppKey) return result

[ "Cancel a pending launch for an application" ]

Please provide a description of the function:def identifyApplication(self, unProcessId, pchAppKey): fn = self.function_table.identifyApplication result = fn(unProcessId, pchAppKey) return result

[ "\n Identifies a running application. OpenVR can't always tell which process started in response\n to a URL. This function allows a URL handler (or the process itself) to identify the app key \n for the now running application. Passing a process ID of 0 identifies the calling process. \n ...

Please provide a description of the function:def getApplicationsErrorNameFromEnum(self, error): fn = self.function_table.getApplicationsErrorNameFromEnum result = fn(error) return result

[ "Returns a string for an applications error" ]

Please provide a description of the function:def getApplicationPropertyString(self, pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen): fn = self.function_table.getApplicationPropertyString peError = EVRApplicationError() result = fn(pchAppKey, eProperty, pchProper...

[ "Returns a value for an application property. The required buffer size to fit this value will be returned." ]

Please provide a description of the function: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." ]

Please provide a description of the function: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." ]

Please provide a description of the function: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." ]

Please provide a description of the function: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" ]

Please provide a description of the function: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" ]

Please provide a description of the function: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" ]

Please provide a description of the function:def getApplicationsThatSupportMimeType(self, pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer): fn = self.function_table.getApplicationsThatSupportMimeType result = fn(pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSuppor...

[ "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" ]

Please provide a description of the function: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" ]

Please provide a description of the function: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" ]

Please provide a description of the function:def performApplicationPrelaunchCheck(self, pchAppKey): fn = self.function_table.performApplicationPrelaunchCheck result = fn(pchAppKey) return result

[ "\n Returns errors that would prevent the specified application from launching immediately. Calling this function will\n cause the current scene application to quit, so only call it when you are actually about to launch something else.\n What the caller should do about these failures depends on...

Please provide a description of the function:def getApplicationsTransitionStateNameFromEnum(self, state): fn = self.function_table.getApplicationsTransitionStateNameFromEnum result = fn(state) return result

[ "Returns a string for an application transition state" ]

Please provide a description of the function:def launchInternalProcess(self, pchBinaryPath, pchArguments, pchWorkingDirectory): fn = self.function_table.launchInternalProcess result = fn(pchBinaryPath, pchArguments, pchWorkingDirectory) return result

[ "\n Starts a subprocess within the calling application. This\n suppresses all application transition UI and automatically identifies the new executable \n as part of the same application. On success the calling process should exit immediately. \n If working directory is NULL or \"\" the ...

Please provide a description of the function:def getPlayAreaSize(self): fn = self.function_table.getPlayAreaSize pSizeX = c_float() pSizeZ = c_float() result = fn(byref(pSizeX), byref(pSizeZ)) return result, pSizeX.value, pSizeZ.value

[ "\n Returns the width and depth of the Play Area (formerly named Soft Bounds) in X and Z. \n Tracking space center (0,0,0) is the center of the Play Area.\n " ]

Please provide a description of the function:def getPlayAreaRect(self): fn = self.function_table.getPlayAreaRect rect = HmdQuad_t() result = fn(byref(rect)) return result, rect

[ "\n Returns the 4 corner positions of the Play Area (formerly named Soft Bounds).\n Corners are in counter-clockwise order.\n Standing center (0,0,0) is the center of the Play Area.\n It's a rectangle.\n 2 sides are parallel to the X axis and 2 sides are parallel to the Z axis.\n ...

Please provide a description of the function:def getBoundsColor(self, nNumOutputColors, flCollisionBoundsFadeDistance): fn = self.function_table.getBoundsColor pOutputColorArray = HmdColor_t() pOutputCameraColor = HmdColor_t() fn(byref(pOutputColorArray), nNumOutputColors, flCo...

[ "Get the current chaperone bounds draw color and brightness" ]

Please provide a description of the function:def commitWorkingCopy(self, configFile): fn = self.function_table.commitWorkingCopy result = fn(configFile) return result

[ "Saves the current working copy to disk" ]

Please provide a description of the function:def getWorkingPlayAreaRect(self): fn = self.function_table.getWorkingPlayAreaRect rect = HmdQuad_t() result = fn(byref(rect)) return result, rect

[ "\n Returns the 4 corner positions of the Play Area (formerly named Soft Bounds) from the working copy.\n Corners are in clockwise order.\n Tracking space center (0,0,0) is the center of the Play Area.\n It's a rectangle.\n 2 sides are parallel to the X axis and 2 sides are parall...

Please provide a description of the function:def getWorkingCollisionBoundsInfo(self): fn = self.function_table.getWorkingCollisionBoundsInfo pQuadsBuffer = HmdQuad_t() punQuadsCount = c_uint32() result = fn(byref(pQuadsBuffer), byref(punQuadsCount)) return result, pQuad...

[ "\n Returns the number of Quads if the buffer points to null. Otherwise it returns Quads \n into the buffer up to the max specified from the working copy.\n " ]

Please provide a description of the function:def getWorkingSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.getWorkingSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose)) ret...

[ "Returns the preferred seated position from the working copy." ]

Please provide a description of the function:def getWorkingStandingZeroPoseToRawTrackingPose(self): fn = self.function_table.getWorkingStandingZeroPoseToRawTrackingPose pmatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatStandingZeroPoseToRawTrackingPose)) ...

[ "Returns the standing origin from the working copy." ]

Please provide a description of the function:def setWorkingPlayAreaSize(self, sizeX, sizeZ): fn = self.function_table.setWorkingPlayAreaSize fn(sizeX, sizeZ)

[ "Sets the Play Area in the working copy." ]

Please provide a description of the function:def setWorkingCollisionBoundsInfo(self, unQuadsCount): fn = self.function_table.setWorkingCollisionBoundsInfo pQuadsBuffer = HmdQuad_t() fn(byref(pQuadsBuffer), unQuadsCount) return pQuadsBuffer

[ "Sets the Collision Bounds in the working copy." ]

Please provide a description of the function:def setWorkingPerimeter(self, unPointCount): fn = self.function_table.setWorkingPerimeter pPointBuffer = HmdVector2_t() fn(byref(pPointBuffer), unPointCount) return pPointBuffer

[ "Sets the Collision Bounds in the working copy." ]

Please provide a description of the function:def setWorkingSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.setWorkingSeatedZeroPoseToRawTrackingPose pMatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() fn(byref(pMatSeatedZeroPoseToRawTrackingPose)) return pMatS...

[ "Sets the preferred seated position in the working copy." ]

Please provide a description of the function:def setWorkingStandingZeroPoseToRawTrackingPose(self): fn = self.function_table.setWorkingStandingZeroPoseToRawTrackingPose pMatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t() fn(byref(pMatStandingZeroPoseToRawTrackingPose)) retu...

[ "Sets the preferred standing position in the working copy." ]

Please provide a description of the function:def getLiveSeatedZeroPoseToRawTrackingPose(self): fn = self.function_table.getLiveSeatedZeroPoseToRawTrackingPose pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t() result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose)) return re...

[ "Returns the preferred seated position." ]

Please provide a description of the function:def waitGetPoses(self, pRenderPoseArray, unRenderPoseArrayCount, pGamePoseArray, unGamePoseArrayCount): fn = self.function_table.waitGetPoses # TODO: Automate this manual translation # Convert non-pointer python arguments to pointers ...

[ "\n Scene applications should call this function to get poses to render with (and optionally poses predicted an additional frame out to use for gameplay).\n This function will block until \"running start\" milliseconds before the start of the frame, and should be called at the last moment before needi...

Please provide a description of the function:def getLastPoses(self, unRenderPoseArrayCount, unGamePoseArrayCount): fn = self.function_table.getLastPoses pRenderPoseArray = TrackedDevicePose_t() pGamePoseArray = TrackedDevicePose_t() result = fn(byref(pRenderPoseArray), unRender...

[ "Get the last set of poses returned by WaitGetPoses." ]

Please provide a description of the function:def getLastPoseForTrackedDeviceIndex(self, unDeviceIndex): fn = self.function_table.getLastPoseForTrackedDeviceIndex pOutputPose = TrackedDevicePose_t() pOutputGamePose = TrackedDevicePose_t() result = fn(unDeviceIndex, byref(pOutput...

[ "\n Interface for accessing last set of poses returned by WaitGetPoses one at a time.\n Returns VRCompositorError_IndexOutOfRange if unDeviceIndex not less than k_unMaxTrackedDeviceCount otherwise VRCompositorError_None.\n It is okay to pass NULL for either pose if you only want one of the valu...

Please provide a description of the function:def submit(self, eEye, pTexture, pBounds=None, nSubmitFlags=Submit_Default): fn = self.function_table.submit result = fn(eEye, byref(pTexture), pBounds, nSubmitFlags) return result

[ "\n Updated scene texture to display. If pBounds is NULL the entire texture will be used. If called from an OpenGL app, consider adding a glFlush after\n Submitting both frames to signal the driver to start processing, otherwise it may wait until the command buffer fills up, causing the app to miss f...

Please provide a description of the function:def getFrameTiming(self, unFramesAgo): fn = self.function_table.getFrameTiming pTiming = Compositor_FrameTiming() result = fn(byref(pTiming), unFramesAgo) return result, pTiming

[ "\n Returns true if timing data is filled it. Sets oldest timing info if nFramesAgo is larger than the stored history.\n Be sure to set timing.size = sizeof(Compositor_FrameTiming) on struct passed in before calling this function.\n " ]

Please provide a description of the function:def getFrameTimings(self, nFrames): fn = self.function_table.getFrameTimings pTiming = Compositor_FrameTiming() result = fn(byref(pTiming), nFrames) return result, pTiming

[ "\n Interface for copying a range of timing data. Frames are returned in ascending order (oldest to newest) with the last being the most recent frame.\n Only the first entry's m_nSize needs to be set, as the rest will be inferred from that. Returns total number of entries filled out.\n " ]

Please provide a description of the function:def getCumulativeStats(self, nStatsSizeInBytes): fn = self.function_table.getCumulativeStats pStats = Compositor_CumulativeStats() fn(byref(pStats), nStatsSizeInBytes) return pStats

[ "Fills out stats accumulated for the last connected application. Pass in sizeof( Compositor_CumulativeStats ) as second parameter." ]

Please provide a description of the function:def fadeToColor(self, fSeconds, fRed, fGreen, fBlue, fAlpha, bBackground): fn = self.function_table.fadeToColor fn(fSeconds, fRed, fGreen, fBlue, fAlpha, bBackground)

[ "\n Fades the view on the HMD to the specified color. The fade will take fSeconds, and the color values are between\n 0.0 and 1.0. This color is faded on top of the scene based on the alpha parameter. Removing the fade color instantly \n would be FadeToColor( 0.0, 0.0, 0.0, 0.0, 0.0 ). Values ...

Please provide a description of the function:def getCurrentFadeColor(self, bBackground): fn = self.function_table.getCurrentFadeColor result = fn(bBackground) return result

[ "Get current fade color value." ]

Please provide a description of the function:def fadeGrid(self, fSeconds, bFadeIn): fn = self.function_table.fadeGrid fn(fSeconds, bFadeIn)

[ "Fading the Grid in or out in fSeconds" ]

Please provide a description of the function:def setSkyboxOverride(self, unTextureCount): fn = self.function_table.setSkyboxOverride pTextures = Texture_t() result = fn(byref(pTextures), unTextureCount) return result, pTextures

[ "\n Override the skybox used in the compositor (e.g. for during level loads when the app can't feed scene images fast enough)\n Order is Front, Back, Left, Right, Top, Bottom. If only a single texture is passed, it is assumed in lat-long format.\n If two are passed, it is assumed a lat-long st...

Please provide a description of the function:def getMirrorTextureD3D11(self, eEye, pD3D11DeviceOrResource): fn = self.function_table.getMirrorTextureD3D11 ppD3D11ShaderResourceView = c_void_p() result = fn(eEye, pD3D11DeviceOrResource, byref(ppD3D11ShaderResourceView)) return r...

[ "\n Opens a shared D3D11 texture with the undistorted composited image for each eye. Use ReleaseMirrorTextureD3D11 when finished\n instead of calling Release on the resource itself.\n " ]

Please provide a description of the function:def getMirrorTextureGL(self, eEye): fn = self.function_table.getMirrorTextureGL pglTextureId = glUInt_t() pglSharedTextureHandle = glSharedTextureHandle_t() result = fn(eEye, byref(pglTextureId), byref(pglSharedTextureHandle)) ...

[ "Access to mirror textures from OpenGL." ]

Please provide a description of the function: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." ]

Please provide a description of the function: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." ]

Please provide a description of the function:def destroyOverlay(self, ulOverlayHandle): fn = self.function_table.destroyOverlay result = fn(ulOverlayHandle) return result

[ "\n Destroys the specified overlay. When an application calls VR_Shutdown all overlays created by that app are\n automatically destroyed.\n " ]

Please provide a description of the function:def setHighQualityOverlay(self, ulOverlayHandle): fn = self.function_table.setHighQualityOverlay result = fn(ulOverlayHandle) return result

[ "\n Specify which overlay to use the high quality render path. This overlay will be composited in during the distortion pass which\n results in it drawing on top of everything else, but also at a higher quality as it samples the source texture directly rather than\n rasterizing into each eye's...

Please provide a description of the function:def setOverlayName(self, ulOverlayHandle, pchName): fn = self.function_table.setOverlayName result = fn(ulOverlayHandle, pchName) return result

[ "set the name to use for this overlay" ]

Please provide a description of the function:def getOverlayImageData(self, ulOverlayHandle, pvBuffer, unBufferSize): fn = self.function_table.getOverlayImageData punWidth = c_uint32() punHeight = c_uint32() result = fn(ulOverlayHandle, pvBuffer, unBufferSize, byref(punWidth), b...

[ "\n 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 \n will be set and VROverlayError_ArrayTooSmall is returned.\n " ]

Please provide a description of the function:def getOverlayErrorNameFromEnum(self, error): fn = self.function_table.getOverlayErrorNameFromEnum result = fn(error) return result

[ "\n returns a string that corresponds with the specified overlay error. The string will be the name \n of the error enum value for all valid error codes\n " ]

Please provide a description of the function:def setOverlayRenderingPid(self, ulOverlayHandle, unPID): fn = self.function_table.setOverlayRenderingPid result = fn(ulOverlayHandle, unPID) return result

[ "\n Sets the pid that is allowed to render to this overlay (the creator pid is always allow to render),\n by default this is the pid of the process that made the overlay\n " ]

Please provide a description of the function: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" ]