repo
stringlengths 7
55
| path
stringlengths 4
127
| func_name
stringlengths 1
88
| original_string
stringlengths 75
19.8k
| language
stringclasses 1
value | code
stringlengths 75
19.8k
| code_tokens
sequence | docstring
stringlengths 3
17.3k
| docstring_tokens
sequence | sha
stringlengths 40
40
| url
stringlengths 87
242
| partition
stringclasses 1
value |
|---|---|---|---|---|---|---|---|---|---|---|---|
cmbruns/pyopenvr | src/openvr/__init__.py | IVRChaperoneSetup.setWorkingStandingZeroPoseToRawTrackingPose | def setWorkingStandingZeroPoseToRawTrackingPose(self):
"""Sets the preferred standing position in the working copy."""
fn = self.function_table.setWorkingStandingZeroPoseToRawTrackingPose
pMatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t()
fn(byref(pMatStandingZeroPoseToRawTrackingPose))
return pMatStandingZeroPoseToRawTrackingPose | python | def setWorkingStandingZeroPoseToRawTrackingPose(self):
"""Sets the preferred standing position in the working copy."""
fn = self.function_table.setWorkingStandingZeroPoseToRawTrackingPose
pMatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t()
fn(byref(pMatStandingZeroPoseToRawTrackingPose))
return pMatStandingZeroPoseToRawTrackingPose | [
"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. | [
"Sets",
"the",
"preferred",
"standing",
"position",
"in",
"the",
"working",
"copy",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3931-L3937 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRChaperoneSetup.getLiveSeatedZeroPoseToRawTrackingPose | def getLiveSeatedZeroPoseToRawTrackingPose(self):
"""Returns the preferred seated position."""
fn = self.function_table.getLiveSeatedZeroPoseToRawTrackingPose
pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose))
return result, pmatSeatedZeroPoseToRawTrackingPose | python | def getLiveSeatedZeroPoseToRawTrackingPose(self):
"""Returns the preferred seated position."""
fn = self.function_table.getLiveSeatedZeroPoseToRawTrackingPose
pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose))
return result, pmatSeatedZeroPoseToRawTrackingPose | [
"def",
"getLiveSeatedZeroPoseToRawTrackingPose",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getLiveSeatedZeroPoseToRawTrackingPose",
"pmatSeatedZeroPoseToRawTrackingPose",
"=",
"HmdMatrix34_t",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pmatSeatedZeroPoseToRawTrackingPose",
")",
")",
"return",
"result",
",",
"pmatSeatedZeroPoseToRawTrackingPose"
] | Returns the preferred seated position. | [
"Returns",
"the",
"preferred",
"seated",
"position",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3945-L3951 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.getLastPoses | def getLastPoses(self, unRenderPoseArrayCount, unGamePoseArrayCount):
"""Get the last set of poses returned by WaitGetPoses."""
fn = self.function_table.getLastPoses
pRenderPoseArray = TrackedDevicePose_t()
pGamePoseArray = TrackedDevicePose_t()
result = fn(byref(pRenderPoseArray), unRenderPoseArrayCount, byref(pGamePoseArray), unGamePoseArrayCount)
return result, pRenderPoseArray, pGamePoseArray | python | def getLastPoses(self, unRenderPoseArrayCount, unGamePoseArrayCount):
"""Get the last set of poses returned by WaitGetPoses."""
fn = self.function_table.getLastPoses
pRenderPoseArray = TrackedDevicePose_t()
pGamePoseArray = TrackedDevicePose_t()
result = fn(byref(pRenderPoseArray), unRenderPoseArrayCount, byref(pGamePoseArray), unGamePoseArrayCount)
return result, pRenderPoseArray, pGamePoseArray | [
"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. | [
"Get",
"the",
"last",
"set",
"of",
"poses",
"returned",
"by",
"WaitGetPoses",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4075-L4082 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.getLastPoseForTrackedDeviceIndex | def getLastPoseForTrackedDeviceIndex(self, unDeviceIndex):
"""
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.
"""
fn = self.function_table.getLastPoseForTrackedDeviceIndex
pOutputPose = TrackedDevicePose_t()
pOutputGamePose = TrackedDevicePose_t()
result = fn(unDeviceIndex, byref(pOutputPose), byref(pOutputGamePose))
return result, pOutputPose, pOutputGamePose | python | def getLastPoseForTrackedDeviceIndex(self, unDeviceIndex):
"""
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.
"""
fn = self.function_table.getLastPoseForTrackedDeviceIndex
pOutputPose = TrackedDevicePose_t()
pOutputGamePose = TrackedDevicePose_t()
result = fn(unDeviceIndex, byref(pOutputPose), byref(pOutputGamePose))
return result, pOutputPose, pOutputGamePose | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4084-L4095 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.getCurrentFadeColor | def getCurrentFadeColor(self, bBackground):
"""Get current fade color value."""
fn = self.function_table.getCurrentFadeColor
result = fn(bBackground)
return result | python | def getCurrentFadeColor(self, bBackground):
"""Get current fade color value."""
fn = self.function_table.getCurrentFadeColor
result = fn(bBackground)
return result | [
"def",
"getCurrentFadeColor",
"(",
"self",
",",
"bBackground",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getCurrentFadeColor",
"result",
"=",
"fn",
"(",
"bBackground",
")",
"return",
"result"
] | Get current fade color value. | [
"Get",
"current",
"fade",
"color",
"value",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4188-L4193 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.fadeGrid | def fadeGrid(self, fSeconds, bFadeIn):
"""Fading the Grid in or out in fSeconds"""
fn = self.function_table.fadeGrid
fn(fSeconds, bFadeIn) | python | def fadeGrid(self, fSeconds, bFadeIn):
"""Fading the Grid in or out in fSeconds"""
fn = self.function_table.fadeGrid
fn(fSeconds, bFadeIn) | [
"def",
"fadeGrid",
"(",
"self",
",",
"fSeconds",
",",
"bFadeIn",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"fadeGrid",
"fn",
"(",
"fSeconds",
",",
"bFadeIn",
")"
] | Fading the Grid in or out in fSeconds | [
"Fading",
"the",
"Grid",
"in",
"or",
"out",
"in",
"fSeconds"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4195-L4199 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.getMirrorTextureD3D11 | def getMirrorTextureD3D11(self, eEye, pD3D11DeviceOrResource):
"""
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.
"""
fn = self.function_table.getMirrorTextureD3D11
ppD3D11ShaderResourceView = c_void_p()
result = fn(eEye, pD3D11DeviceOrResource, byref(ppD3D11ShaderResourceView))
return result, ppD3D11ShaderResourceView.value | python | def getMirrorTextureD3D11(self, eEye, pD3D11DeviceOrResource):
"""
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.
"""
fn = self.function_table.getMirrorTextureD3D11
ppD3D11ShaderResourceView = c_void_p()
result = fn(eEye, pD3D11DeviceOrResource, byref(ppD3D11ShaderResourceView))
return result, ppD3D11ShaderResourceView.value | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4331-L4340 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRCompositor.getMirrorTextureGL | def getMirrorTextureGL(self, eEye):
"""Access to mirror textures from OpenGL."""
fn = self.function_table.getMirrorTextureGL
pglTextureId = glUInt_t()
pglSharedTextureHandle = glSharedTextureHandle_t()
result = fn(eEye, byref(pglTextureId), byref(pglSharedTextureHandle))
return result, pglTextureId, pglSharedTextureHandle | python | def getMirrorTextureGL(self, eEye):
"""Access to mirror textures from OpenGL."""
fn = self.function_table.getMirrorTextureGL
pglTextureId = glUInt_t()
pglSharedTextureHandle = glSharedTextureHandle_t()
result = fn(eEye, byref(pglTextureId), byref(pglSharedTextureHandle))
return result, pglTextureId, pglSharedTextureHandle | [
"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. | [
"Access",
"to",
"mirror",
"textures",
"from",
"OpenGL",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4346-L4353 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.findOverlay | def findOverlay(self, pchOverlayKey):
"""Finds an existing overlay with the specified key."""
fn = self.function_table.findOverlay
pOverlayHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, byref(pOverlayHandle))
return result, pOverlayHandle | python | def findOverlay(self, pchOverlayKey):
"""Finds an existing overlay with the specified key."""
fn = self.function_table.findOverlay
pOverlayHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, byref(pOverlayHandle))
return result, pOverlayHandle | [
"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. | [
"Finds",
"an",
"existing",
"overlay",
"with",
"the",
"specified",
"key",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4541-L4547 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.createOverlay | def createOverlay(self, pchOverlayKey, pchOverlayName):
"""Creates a new named overlay. All overlays start hidden and with default settings."""
fn = self.function_table.createOverlay
pOverlayHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, pchOverlayName, byref(pOverlayHandle))
return result, pOverlayHandle | python | def createOverlay(self, pchOverlayKey, pchOverlayName):
"""Creates a new named overlay. All overlays start hidden and with default settings."""
fn = self.function_table.createOverlay
pOverlayHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, pchOverlayName, byref(pOverlayHandle))
return result, pOverlayHandle | [
"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. | [
"Creates",
"a",
"new",
"named",
"overlay",
".",
"All",
"overlays",
"start",
"hidden",
"and",
"with",
"default",
"settings",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4549-L4555 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.destroyOverlay | def destroyOverlay(self, ulOverlayHandle):
"""
Destroys the specified overlay. When an application calls VR_Shutdown all overlays created by that app are
automatically destroyed.
"""
fn = self.function_table.destroyOverlay
result = fn(ulOverlayHandle)
return result | python | def destroyOverlay(self, ulOverlayHandle):
"""
Destroys the specified overlay. When an application calls VR_Shutdown all overlays created by that app are
automatically destroyed.
"""
fn = self.function_table.destroyOverlay
result = fn(ulOverlayHandle)
return result | [
"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. | [
"Destroys",
"the",
"specified",
"overlay",
".",
"When",
"an",
"application",
"calls",
"VR_Shutdown",
"all",
"overlays",
"created",
"by",
"that",
"app",
"are",
"automatically",
"destroyed",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4557-L4565 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayKey | def getOverlayKey(self, ulOverlayHandle, pchValue, unBufferSize):
"""
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.
"""
fn = self.function_table.getOverlayKey
pError = EVROverlayError()
result = fn(ulOverlayHandle, pchValue, unBufferSize, byref(pError))
return result, pError | python | def getOverlayKey(self, ulOverlayHandle, pchValue, unBufferSize):
"""
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.
"""
fn = self.function_table.getOverlayKey
pError = EVROverlayError()
result = fn(ulOverlayHandle, pchValue, unBufferSize, byref(pError))
return result, pError | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4590-L4599 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayName | def setOverlayName(self, ulOverlayHandle, pchName):
"""set the name to use for this overlay"""
fn = self.function_table.setOverlayName
result = fn(ulOverlayHandle, pchName)
return result | python | def setOverlayName(self, ulOverlayHandle, pchName):
"""set the name to use for this overlay"""
fn = self.function_table.setOverlayName
result = fn(ulOverlayHandle, pchName)
return result | [
"def",
"setOverlayName",
"(",
"self",
",",
"ulOverlayHandle",
",",
"pchName",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setOverlayName",
"result",
"=",
"fn",
"(",
"ulOverlayHandle",
",",
"pchName",
")",
"return",
"result"
] | set the name to use for this overlay | [
"set",
"the",
"name",
"to",
"use",
"for",
"this",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4612-L4617 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayImageData | def getOverlayImageData(self, ulOverlayHandle, pvBuffer, unBufferSize):
"""
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.
"""
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 | python | def getOverlayImageData(self, ulOverlayHandle, pvBuffer, unBufferSize):
"""
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.
"""
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 | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4619-L4629 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayErrorNameFromEnum | def getOverlayErrorNameFromEnum(self, error):
"""
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
"""
fn = self.function_table.getOverlayErrorNameFromEnum
result = fn(error)
return result | python | def getOverlayErrorNameFromEnum(self, error):
"""
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
"""
fn = self.function_table.getOverlayErrorNameFromEnum
result = fn(error)
return result | [
"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 | [
"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"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4631-L4639 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayRenderingPid | def getOverlayRenderingPid(self, ulOverlayHandle):
"""Gets the pid that is allowed to render to this overlay"""
fn = self.function_table.getOverlayRenderingPid
result = fn(ulOverlayHandle)
return result | python | def getOverlayRenderingPid(self, ulOverlayHandle):
"""Gets the pid that is allowed to render to this overlay"""
fn = self.function_table.getOverlayRenderingPid
result = fn(ulOverlayHandle)
return result | [
"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 | [
"Gets",
"the",
"pid",
"that",
"is",
"allowed",
"to",
"render",
"to",
"this",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4651-L4656 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayFlag | def setOverlayFlag(self, ulOverlayHandle, eOverlayFlag, bEnabled):
"""Specify flag setting for a given overlay"""
fn = self.function_table.setOverlayFlag
result = fn(ulOverlayHandle, eOverlayFlag, bEnabled)
return result | python | def setOverlayFlag(self, ulOverlayHandle, eOverlayFlag, bEnabled):
"""Specify flag setting for a given overlay"""
fn = self.function_table.setOverlayFlag
result = fn(ulOverlayHandle, eOverlayFlag, bEnabled)
return result | [
"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 | [
"Specify",
"flag",
"setting",
"for",
"a",
"given",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4658-L4663 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayFlag | def getOverlayFlag(self, ulOverlayHandle, eOverlayFlag):
"""Sets flag setting for a given overlay"""
fn = self.function_table.getOverlayFlag
pbEnabled = openvr_bool()
result = fn(ulOverlayHandle, eOverlayFlag, byref(pbEnabled))
return result, pbEnabled | python | def getOverlayFlag(self, ulOverlayHandle, eOverlayFlag):
"""Sets flag setting for a given overlay"""
fn = self.function_table.getOverlayFlag
pbEnabled = openvr_bool()
result = fn(ulOverlayHandle, eOverlayFlag, byref(pbEnabled))
return result, pbEnabled | [
"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 | [
"Sets",
"flag",
"setting",
"for",
"a",
"given",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4665-L4671 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayColor | def setOverlayColor(self, ulOverlayHandle, fRed, fGreen, fBlue):
"""Sets the color tint of the overlay quad. Use 0.0 to 1.0 per channel."""
fn = self.function_table.setOverlayColor
result = fn(ulOverlayHandle, fRed, fGreen, fBlue)
return result | python | def setOverlayColor(self, ulOverlayHandle, fRed, fGreen, fBlue):
"""Sets the color tint of the overlay quad. Use 0.0 to 1.0 per channel."""
fn = self.function_table.setOverlayColor
result = fn(ulOverlayHandle, fRed, fGreen, fBlue)
return result | [
"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. | [
"Sets",
"the",
"color",
"tint",
"of",
"the",
"overlay",
"quad",
".",
"Use",
"0",
".",
"0",
"to",
"1",
".",
"0",
"per",
"channel",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4673-L4678 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayColor | def getOverlayColor(self, ulOverlayHandle):
"""Gets the color tint of the overlay quad."""
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 | python | def getOverlayColor(self, ulOverlayHandle):
"""Gets the color tint of the overlay quad."""
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 | [
"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. | [
"Gets",
"the",
"color",
"tint",
"of",
"the",
"overlay",
"quad",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4680-L4688 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayAlpha | def setOverlayAlpha(self, ulOverlayHandle, fAlpha):
"""Sets the alpha of the overlay quad. Use 1.0 for 100 percent opacity to 0.0 for 0 percent opacity."""
fn = self.function_table.setOverlayAlpha
result = fn(ulOverlayHandle, fAlpha)
return result | python | def setOverlayAlpha(self, ulOverlayHandle, fAlpha):
"""Sets the alpha of the overlay quad. Use 1.0 for 100 percent opacity to 0.0 for 0 percent opacity."""
fn = self.function_table.setOverlayAlpha
result = fn(ulOverlayHandle, fAlpha)
return result | [
"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. | [
"Sets",
"the",
"alpha",
"of",
"the",
"overlay",
"quad",
".",
"Use",
"1",
".",
"0",
"for",
"100",
"percent",
"opacity",
"to",
"0",
".",
"0",
"for",
"0",
"percent",
"opacity",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4690-L4695 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTexelAspect | def setOverlayTexelAspect(self, ulOverlayHandle, fTexelAspect):
"""
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.
"""
fn = self.function_table.setOverlayTexelAspect
result = fn(ulOverlayHandle, fTexelAspect)
return result | python | def setOverlayTexelAspect(self, ulOverlayHandle, fTexelAspect):
"""
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.
"""
fn = self.function_table.setOverlayTexelAspect
result = fn(ulOverlayHandle, fTexelAspect)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4705-L4713 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTexelAspect | def getOverlayTexelAspect(self, ulOverlayHandle):
"""Gets the aspect ratio of the texels in the overlay. Defaults to 1.0"""
fn = self.function_table.getOverlayTexelAspect
pfTexelAspect = c_float()
result = fn(ulOverlayHandle, byref(pfTexelAspect))
return result, pfTexelAspect.value | python | def getOverlayTexelAspect(self, ulOverlayHandle):
"""Gets the aspect ratio of the texels in the overlay. Defaults to 1.0"""
fn = self.function_table.getOverlayTexelAspect
pfTexelAspect = c_float()
result = fn(ulOverlayHandle, byref(pfTexelAspect))
return result, pfTexelAspect.value | [
"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 | [
"Gets",
"the",
"aspect",
"ratio",
"of",
"the",
"texels",
"in",
"the",
"overlay",
".",
"Defaults",
"to",
"1",
".",
"0"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4715-L4721 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlaySortOrder | def getOverlaySortOrder(self, ulOverlayHandle):
"""Gets the sort order of the overlay. See SetOverlaySortOrder for how this works."""
fn = self.function_table.getOverlaySortOrder
punSortOrder = c_uint32()
result = fn(ulOverlayHandle, byref(punSortOrder))
return result, punSortOrder.value | python | def getOverlaySortOrder(self, ulOverlayHandle):
"""Gets the sort order of the overlay. See SetOverlaySortOrder for how this works."""
fn = self.function_table.getOverlaySortOrder
punSortOrder = c_uint32()
result = fn(ulOverlayHandle, byref(punSortOrder))
return result, punSortOrder.value | [
"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. | [
"Gets",
"the",
"sort",
"order",
"of",
"the",
"overlay",
".",
"See",
"SetOverlaySortOrder",
"for",
"how",
"this",
"works",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4737-L4743 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayWidthInMeters | def setOverlayWidthInMeters(self, ulOverlayHandle, fWidthInMeters):
"""Sets the width of the overlay quad in meters. By default overlays are rendered on a quad that is 1 meter across"""
fn = self.function_table.setOverlayWidthInMeters
result = fn(ulOverlayHandle, fWidthInMeters)
return result | python | def setOverlayWidthInMeters(self, ulOverlayHandle, fWidthInMeters):
"""Sets the width of the overlay quad in meters. By default overlays are rendered on a quad that is 1 meter across"""
fn = self.function_table.setOverlayWidthInMeters
result = fn(ulOverlayHandle, fWidthInMeters)
return result | [
"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 | [
"Sets",
"the",
"width",
"of",
"the",
"overlay",
"quad",
"in",
"meters",
".",
"By",
"default",
"overlays",
"are",
"rendered",
"on",
"a",
"quad",
"that",
"is",
"1",
"meter",
"across"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4745-L4750 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayWidthInMeters | def getOverlayWidthInMeters(self, ulOverlayHandle):
"""Returns the width of the overlay quad in meters. By default overlays are rendered on a quad that is 1 meter across"""
fn = self.function_table.getOverlayWidthInMeters
pfWidthInMeters = c_float()
result = fn(ulOverlayHandle, byref(pfWidthInMeters))
return result, pfWidthInMeters.value | python | def getOverlayWidthInMeters(self, ulOverlayHandle):
"""Returns the width of the overlay quad in meters. By default overlays are rendered on a quad that is 1 meter across"""
fn = self.function_table.getOverlayWidthInMeters
pfWidthInMeters = c_float()
result = fn(ulOverlayHandle, byref(pfWidthInMeters))
return result, pfWidthInMeters.value | [
"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 | [
"Returns",
"the",
"width",
"of",
"the",
"overlay",
"quad",
"in",
"meters",
".",
"By",
"default",
"overlays",
"are",
"rendered",
"on",
"a",
"quad",
"that",
"is",
"1",
"meter",
"across"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4752-L4758 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayAutoCurveDistanceRangeInMeters | def setOverlayAutoCurveDistanceRangeInMeters(self, ulOverlayHandle, fMinDistanceInMeters, fMaxDistanceInMeters):
"""
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.
"""
fn = self.function_table.setOverlayAutoCurveDistanceRangeInMeters
result = fn(ulOverlayHandle, fMinDistanceInMeters, fMaxDistanceInMeters)
return result | python | def setOverlayAutoCurveDistanceRangeInMeters(self, ulOverlayHandle, fMinDistanceInMeters, fMaxDistanceInMeters):
"""
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.
"""
fn = self.function_table.setOverlayAutoCurveDistanceRangeInMeters
result = fn(ulOverlayHandle, fMinDistanceInMeters, fMaxDistanceInMeters)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4760-L4768 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayAutoCurveDistanceRangeInMeters | def getOverlayAutoCurveDistanceRangeInMeters(self, ulOverlayHandle):
"""
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.
"""
fn = self.function_table.getOverlayAutoCurveDistanceRangeInMeters
pfMinDistanceInMeters = c_float()
pfMaxDistanceInMeters = c_float()
result = fn(ulOverlayHandle, byref(pfMinDistanceInMeters), byref(pfMaxDistanceInMeters))
return result, pfMinDistanceInMeters.value, pfMaxDistanceInMeters.value | python | def getOverlayAutoCurveDistanceRangeInMeters(self, ulOverlayHandle):
"""
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.
"""
fn = self.function_table.getOverlayAutoCurveDistanceRangeInMeters
pfMinDistanceInMeters = c_float()
pfMaxDistanceInMeters = c_float()
result = fn(ulOverlayHandle, byref(pfMinDistanceInMeters), byref(pfMaxDistanceInMeters))
return result, pfMinDistanceInMeters.value, pfMaxDistanceInMeters.value | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4770-L4780 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTextureColorSpace | def setOverlayTextureColorSpace(self, ulOverlayHandle, eTextureColorSpace):
"""
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.
"""
fn = self.function_table.setOverlayTextureColorSpace
result = fn(ulOverlayHandle, eTextureColorSpace)
return result | python | def setOverlayTextureColorSpace(self, ulOverlayHandle, eTextureColorSpace):
"""
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.
"""
fn = self.function_table.setOverlayTextureColorSpace
result = fn(ulOverlayHandle, eTextureColorSpace)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4782-L4790 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTextureColorSpace | def getOverlayTextureColorSpace(self, ulOverlayHandle):
"""Gets the overlay's current colorspace setting."""
fn = self.function_table.getOverlayTextureColorSpace
peTextureColorSpace = EColorSpace()
result = fn(ulOverlayHandle, byref(peTextureColorSpace))
return result, peTextureColorSpace | python | def getOverlayTextureColorSpace(self, ulOverlayHandle):
"""Gets the overlay's current colorspace setting."""
fn = self.function_table.getOverlayTextureColorSpace
peTextureColorSpace = EColorSpace()
result = fn(ulOverlayHandle, byref(peTextureColorSpace))
return result, peTextureColorSpace | [
"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. | [
"Gets",
"the",
"overlay",
"s",
"current",
"colorspace",
"setting",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4792-L4798 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTextureBounds | def setOverlayTextureBounds(self, ulOverlayHandle):
"""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."""
fn = self.function_table.setOverlayTextureBounds
pOverlayTextureBounds = VRTextureBounds_t()
result = fn(ulOverlayHandle, byref(pOverlayTextureBounds))
return result, pOverlayTextureBounds | python | def setOverlayTextureBounds(self, ulOverlayHandle):
"""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."""
fn = self.function_table.setOverlayTextureBounds
pOverlayTextureBounds = VRTextureBounds_t()
result = fn(ulOverlayHandle, byref(pOverlayTextureBounds))
return result, pOverlayTextureBounds | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4800-L4806 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayRenderModel | def getOverlayRenderModel(self, ulOverlayHandle, pchValue, unBufferSize):
"""Gets render model to draw behind this overlay"""
fn = self.function_table.getOverlayRenderModel
pColor = HmdColor_t()
pError = EVROverlayError()
result = fn(ulOverlayHandle, pchValue, unBufferSize, byref(pColor), byref(pError))
return result, pColor, pError | python | def getOverlayRenderModel(self, ulOverlayHandle, pchValue, unBufferSize):
"""Gets render model to draw behind this overlay"""
fn = self.function_table.getOverlayRenderModel
pColor = HmdColor_t()
pError = EVROverlayError()
result = fn(ulOverlayHandle, pchValue, unBufferSize, byref(pColor), byref(pError))
return result, pColor, pError | [
"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 | [
"Gets",
"render",
"model",
"to",
"draw",
"behind",
"this",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4816-L4823 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayRenderModel | def setOverlayRenderModel(self, ulOverlayHandle, pchRenderModel):
"""
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.
"""
fn = self.function_table.setOverlayRenderModel
pColor = HmdColor_t()
result = fn(ulOverlayHandle, pchRenderModel, byref(pColor))
return result, pColor | python | def setOverlayRenderModel(self, ulOverlayHandle, pchRenderModel):
"""
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.
"""
fn = self.function_table.setOverlayRenderModel
pColor = HmdColor_t()
result = fn(ulOverlayHandle, pchRenderModel, byref(pColor))
return result, pColor | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4825-L4834 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTransformType | def getOverlayTransformType(self, ulOverlayHandle):
"""Returns the transform type of this overlay."""
fn = self.function_table.getOverlayTransformType
peTransformType = VROverlayTransformType()
result = fn(ulOverlayHandle, byref(peTransformType))
return result, peTransformType | python | def getOverlayTransformType(self, ulOverlayHandle):
"""Returns the transform type of this overlay."""
fn = self.function_table.getOverlayTransformType
peTransformType = VROverlayTransformType()
result = fn(ulOverlayHandle, byref(peTransformType))
return result, peTransformType | [
"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. | [
"Returns",
"the",
"transform",
"type",
"of",
"this",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4836-L4842 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTransformAbsolute | def setOverlayTransformAbsolute(self, ulOverlayHandle, eTrackingOrigin):
"""Sets the transform to absolute tracking origin."""
fn = self.function_table.setOverlayTransformAbsolute
pmatTrackingOriginToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, eTrackingOrigin, byref(pmatTrackingOriginToOverlayTransform))
return result, pmatTrackingOriginToOverlayTransform | python | def setOverlayTransformAbsolute(self, ulOverlayHandle, eTrackingOrigin):
"""Sets the transform to absolute tracking origin."""
fn = self.function_table.setOverlayTransformAbsolute
pmatTrackingOriginToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, eTrackingOrigin, byref(pmatTrackingOriginToOverlayTransform))
return result, pmatTrackingOriginToOverlayTransform | [
"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. | [
"Sets",
"the",
"transform",
"to",
"absolute",
"tracking",
"origin",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4844-L4850 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTransformAbsolute | def getOverlayTransformAbsolute(self, ulOverlayHandle):
"""Gets the transform if it is absolute. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformAbsolute
peTrackingOrigin = ETrackingUniverseOrigin()
pmatTrackingOriginToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(peTrackingOrigin), byref(pmatTrackingOriginToOverlayTransform))
return result, peTrackingOrigin, pmatTrackingOriginToOverlayTransform | python | def getOverlayTransformAbsolute(self, ulOverlayHandle):
"""Gets the transform if it is absolute. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformAbsolute
peTrackingOrigin = ETrackingUniverseOrigin()
pmatTrackingOriginToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(peTrackingOrigin), byref(pmatTrackingOriginToOverlayTransform))
return result, peTrackingOrigin, pmatTrackingOriginToOverlayTransform | [
"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. | [
"Gets",
"the",
"transform",
"if",
"it",
"is",
"absolute",
".",
"Returns",
"an",
"error",
"if",
"the",
"transform",
"is",
"some",
"other",
"type",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4852-L4859 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTransformTrackedDeviceRelative | def setOverlayTransformTrackedDeviceRelative(self, ulOverlayHandle, unTrackedDevice):
"""Sets the transform to relative to the transform of the specified tracked device."""
fn = self.function_table.setOverlayTransformTrackedDeviceRelative
pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, unTrackedDevice, byref(pmatTrackedDeviceToOverlayTransform))
return result, pmatTrackedDeviceToOverlayTransform | python | def setOverlayTransformTrackedDeviceRelative(self, ulOverlayHandle, unTrackedDevice):
"""Sets the transform to relative to the transform of the specified tracked device."""
fn = self.function_table.setOverlayTransformTrackedDeviceRelative
pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, unTrackedDevice, byref(pmatTrackedDeviceToOverlayTransform))
return result, pmatTrackedDeviceToOverlayTransform | [
"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. | [
"Sets",
"the",
"transform",
"to",
"relative",
"to",
"the",
"transform",
"of",
"the",
"specified",
"tracked",
"device",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4861-L4867 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTransformTrackedDeviceRelative | def getOverlayTransformTrackedDeviceRelative(self, ulOverlayHandle):
"""Gets the transform if it is relative to a tracked device. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformTrackedDeviceRelative
punTrackedDevice = TrackedDeviceIndex_t()
pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(punTrackedDevice), byref(pmatTrackedDeviceToOverlayTransform))
return result, punTrackedDevice, pmatTrackedDeviceToOverlayTransform | python | def getOverlayTransformTrackedDeviceRelative(self, ulOverlayHandle):
"""Gets the transform if it is relative to a tracked device. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformTrackedDeviceRelative
punTrackedDevice = TrackedDeviceIndex_t()
pmatTrackedDeviceToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(punTrackedDevice), byref(pmatTrackedDeviceToOverlayTransform))
return result, punTrackedDevice, pmatTrackedDeviceToOverlayTransform | [
"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. | [
"Gets",
"the",
"transform",
"if",
"it",
"is",
"relative",
"to",
"a",
"tracked",
"device",
".",
"Returns",
"an",
"error",
"if",
"the",
"transform",
"is",
"some",
"other",
"type",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4869-L4876 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTransformTrackedDeviceComponent | def setOverlayTransformTrackedDeviceComponent(self, ulOverlayHandle, unDeviceIndex, pchComponentName):
"""
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.
"""
fn = self.function_table.setOverlayTransformTrackedDeviceComponent
result = fn(ulOverlayHandle, unDeviceIndex, pchComponentName)
return result | python | def setOverlayTransformTrackedDeviceComponent(self, ulOverlayHandle, unDeviceIndex, pchComponentName):
"""
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.
"""
fn = self.function_table.setOverlayTransformTrackedDeviceComponent
result = fn(ulOverlayHandle, unDeviceIndex, pchComponentName)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4878-L4886 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTransformTrackedDeviceComponent | def getOverlayTransformTrackedDeviceComponent(self, ulOverlayHandle, pchComponentName, unComponentNameSize):
"""Gets the transform information when the overlay is rendering on a component."""
fn = self.function_table.getOverlayTransformTrackedDeviceComponent
punDeviceIndex = TrackedDeviceIndex_t()
result = fn(ulOverlayHandle, byref(punDeviceIndex), pchComponentName, unComponentNameSize)
return result, punDeviceIndex | python | def getOverlayTransformTrackedDeviceComponent(self, ulOverlayHandle, pchComponentName, unComponentNameSize):
"""Gets the transform information when the overlay is rendering on a component."""
fn = self.function_table.getOverlayTransformTrackedDeviceComponent
punDeviceIndex = TrackedDeviceIndex_t()
result = fn(ulOverlayHandle, byref(punDeviceIndex), pchComponentName, unComponentNameSize)
return result, punDeviceIndex | [
"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. | [
"Gets",
"the",
"transform",
"information",
"when",
"the",
"overlay",
"is",
"rendering",
"on",
"a",
"component",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4888-L4894 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTransformOverlayRelative | def getOverlayTransformOverlayRelative(self, ulOverlayHandle):
"""Gets the transform if it is relative to another overlay. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformOverlayRelative
ulOverlayHandleParent = VROverlayHandle_t()
pmatParentOverlayToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(ulOverlayHandleParent), byref(pmatParentOverlayToOverlayTransform))
return result, ulOverlayHandleParent, pmatParentOverlayToOverlayTransform | python | def getOverlayTransformOverlayRelative(self, ulOverlayHandle):
"""Gets the transform if it is relative to another overlay. Returns an error if the transform is some other type."""
fn = self.function_table.getOverlayTransformOverlayRelative
ulOverlayHandleParent = VROverlayHandle_t()
pmatParentOverlayToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, byref(ulOverlayHandleParent), byref(pmatParentOverlayToOverlayTransform))
return result, ulOverlayHandleParent, pmatParentOverlayToOverlayTransform | [
"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. | [
"Gets",
"the",
"transform",
"if",
"it",
"is",
"relative",
"to",
"another",
"overlay",
".",
"Returns",
"an",
"error",
"if",
"the",
"transform",
"is",
"some",
"other",
"type",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4896-L4903 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayTransformOverlayRelative | def setOverlayTransformOverlayRelative(self, ulOverlayHandle, ulOverlayHandleParent):
"""Sets the transform to relative to the transform of the specified overlay. This overlays visibility will also track the parents visibility"""
fn = self.function_table.setOverlayTransformOverlayRelative
pmatParentOverlayToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, ulOverlayHandleParent, byref(pmatParentOverlayToOverlayTransform))
return result, pmatParentOverlayToOverlayTransform | python | def setOverlayTransformOverlayRelative(self, ulOverlayHandle, ulOverlayHandleParent):
"""Sets the transform to relative to the transform of the specified overlay. This overlays visibility will also track the parents visibility"""
fn = self.function_table.setOverlayTransformOverlayRelative
pmatParentOverlayToOverlayTransform = HmdMatrix34_t()
result = fn(ulOverlayHandle, ulOverlayHandleParent, byref(pmatParentOverlayToOverlayTransform))
return result, pmatParentOverlayToOverlayTransform | [
"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 | [
"Sets",
"the",
"transform",
"to",
"relative",
"to",
"the",
"transform",
"of",
"the",
"specified",
"overlay",
".",
"This",
"overlays",
"visibility",
"will",
"also",
"track",
"the",
"parents",
"visibility"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4905-L4911 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.showOverlay | def showOverlay(self, ulOverlayHandle):
"""Shows the VR overlay. For dashboard overlays, only the Dashboard Manager is allowed to call this."""
fn = self.function_table.showOverlay
result = fn(ulOverlayHandle)
return result | python | def showOverlay(self, ulOverlayHandle):
"""Shows the VR overlay. For dashboard overlays, only the Dashboard Manager is allowed to call this."""
fn = self.function_table.showOverlay
result = fn(ulOverlayHandle)
return result | [
"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. | [
"Shows",
"the",
"VR",
"overlay",
".",
"For",
"dashboard",
"overlays",
"only",
"the",
"Dashboard",
"Manager",
"is",
"allowed",
"to",
"call",
"this",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4913-L4918 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.hideOverlay | def hideOverlay(self, ulOverlayHandle):
"""Hides the VR overlay. For dashboard overlays, only the Dashboard Manager is allowed to call this."""
fn = self.function_table.hideOverlay
result = fn(ulOverlayHandle)
return result | python | def hideOverlay(self, ulOverlayHandle):
"""Hides the VR overlay. For dashboard overlays, only the Dashboard Manager is allowed to call this."""
fn = self.function_table.hideOverlay
result = fn(ulOverlayHandle)
return result | [
"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. | [
"Hides",
"the",
"VR",
"overlay",
".",
"For",
"dashboard",
"overlays",
"only",
"the",
"Dashboard",
"Manager",
"is",
"allowed",
"to",
"call",
"this",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4920-L4925 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.isOverlayVisible | def isOverlayVisible(self, ulOverlayHandle):
"""Returns true if the overlay is visible."""
fn = self.function_table.isOverlayVisible
result = fn(ulOverlayHandle)
return result | python | def isOverlayVisible(self, ulOverlayHandle):
"""Returns true if the overlay is visible."""
fn = self.function_table.isOverlayVisible
result = fn(ulOverlayHandle)
return result | [
"def",
"isOverlayVisible",
"(",
"self",
",",
"ulOverlayHandle",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"isOverlayVisible",
"result",
"=",
"fn",
"(",
"ulOverlayHandle",
")",
"return",
"result"
] | Returns true if the overlay is visible. | [
"Returns",
"true",
"if",
"the",
"overlay",
"is",
"visible",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4927-L4932 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.pollNextOverlayEvent | def pollNextOverlayEvent(self, ulOverlayHandle, uncbVREvent):
"""
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
"""
fn = self.function_table.pollNextOverlayEvent
pEvent = VREvent_t()
result = fn(ulOverlayHandle, byref(pEvent), uncbVREvent)
return result, pEvent | python | def pollNextOverlayEvent(self, ulOverlayHandle, uncbVREvent):
"""
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
"""
fn = self.function_table.pollNextOverlayEvent
pEvent = VREvent_t()
result = fn(ulOverlayHandle, byref(pEvent), uncbVREvent)
return result, pEvent | [
"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 | [
"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"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4942-L4951 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayInputMethod | def getOverlayInputMethod(self, ulOverlayHandle):
"""Returns the current input settings for the specified overlay."""
fn = self.function_table.getOverlayInputMethod
peInputMethod = VROverlayInputMethod()
result = fn(ulOverlayHandle, byref(peInputMethod))
return result, peInputMethod | python | def getOverlayInputMethod(self, ulOverlayHandle):
"""Returns the current input settings for the specified overlay."""
fn = self.function_table.getOverlayInputMethod
peInputMethod = VROverlayInputMethod()
result = fn(ulOverlayHandle, byref(peInputMethod))
return result, peInputMethod | [
"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. | [
"Returns",
"the",
"current",
"input",
"settings",
"for",
"the",
"specified",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4953-L4959 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayInputMethod | def setOverlayInputMethod(self, ulOverlayHandle, eInputMethod):
"""Sets the input settings for the specified overlay."""
fn = self.function_table.setOverlayInputMethod
result = fn(ulOverlayHandle, eInputMethod)
return result | python | def setOverlayInputMethod(self, ulOverlayHandle, eInputMethod):
"""Sets the input settings for the specified overlay."""
fn = self.function_table.setOverlayInputMethod
result = fn(ulOverlayHandle, eInputMethod)
return result | [
"def",
"setOverlayInputMethod",
"(",
"self",
",",
"ulOverlayHandle",
",",
"eInputMethod",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setOverlayInputMethod",
"result",
"=",
"fn",
"(",
"ulOverlayHandle",
",",
"eInputMethod",
")",
"return",
"result"
] | Sets the input settings for the specified overlay. | [
"Sets",
"the",
"input",
"settings",
"for",
"the",
"specified",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4961-L4966 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayMouseScale | def getOverlayMouseScale(self, ulOverlayHandle):
"""
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.
"""
fn = self.function_table.getOverlayMouseScale
pvecMouseScale = HmdVector2_t()
result = fn(ulOverlayHandle, byref(pvecMouseScale))
return result, pvecMouseScale | python | def getOverlayMouseScale(self, ulOverlayHandle):
"""
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.
"""
fn = self.function_table.getOverlayMouseScale
pvecMouseScale = HmdVector2_t()
result = fn(ulOverlayHandle, byref(pvecMouseScale))
return result, pvecMouseScale | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4968-L4977 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.computeOverlayIntersection | def computeOverlayIntersection(self, ulOverlayHandle):
"""
Computes the overlay-space pixel coordinates of where the ray intersects the overlay with the
specified settings. Returns false if there is no intersection.
"""
fn = self.function_table.computeOverlayIntersection
pParams = VROverlayIntersectionParams_t()
pResults = VROverlayIntersectionResults_t()
result = fn(ulOverlayHandle, byref(pParams), byref(pResults))
return result, pParams, pResults | python | def computeOverlayIntersection(self, ulOverlayHandle):
"""
Computes the overlay-space pixel coordinates of where the ray intersects the overlay with the
specified settings. Returns false if there is no intersection.
"""
fn = self.function_table.computeOverlayIntersection
pParams = VROverlayIntersectionParams_t()
pResults = VROverlayIntersectionResults_t()
result = fn(ulOverlayHandle, byref(pParams), byref(pResults))
return result, pParams, pResults | [
"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. | [
"Computes",
"the",
"overlay",
"-",
"space",
"pixel",
"coordinates",
"of",
"where",
"the",
"ray",
"intersects",
"the",
"overlay",
"with",
"the",
"specified",
"settings",
".",
"Returns",
"false",
"if",
"there",
"is",
"no",
"intersection",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L4990-L5000 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.isHoverTargetOverlay | def isHoverTargetOverlay(self, ulOverlayHandle):
"""
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
"""
fn = self.function_table.isHoverTargetOverlay
result = fn(ulOverlayHandle)
return result | python | def isHoverTargetOverlay(self, ulOverlayHandle):
"""
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
"""
fn = self.function_table.isHoverTargetOverlay
result = fn(ulOverlayHandle)
return result | [
"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 | [
"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"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5002-L5010 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setGamepadFocusOverlay | def setGamepadFocusOverlay(self, ulNewFocusOverlay):
"""Sets the current Gamepad focus overlay"""
fn = self.function_table.setGamepadFocusOverlay
result = fn(ulNewFocusOverlay)
return result | python | def setGamepadFocusOverlay(self, ulNewFocusOverlay):
"""Sets the current Gamepad focus overlay"""
fn = self.function_table.setGamepadFocusOverlay
result = fn(ulNewFocusOverlay)
return result | [
"def",
"setGamepadFocusOverlay",
"(",
"self",
",",
"ulNewFocusOverlay",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setGamepadFocusOverlay",
"result",
"=",
"fn",
"(",
"ulNewFocusOverlay",
")",
"return",
"result"
] | Sets the current Gamepad focus overlay | [
"Sets",
"the",
"current",
"Gamepad",
"focus",
"overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5019-L5024 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayNeighbor | def setOverlayNeighbor(self, eDirection, ulFrom, ulTo):
"""
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
"""
fn = self.function_table.setOverlayNeighbor
result = fn(eDirection, ulFrom, ulTo)
return result | python | def setOverlayNeighbor(self, eDirection, ulFrom, ulTo):
"""
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
"""
fn = self.function_table.setOverlayNeighbor
result = fn(eDirection, ulFrom, ulTo)
return result | [
"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 | [
"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"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5026-L5035 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.moveGamepadFocusToNeighbor | def moveGamepadFocusToNeighbor(self, eDirection, ulFrom):
"""
Changes the Gamepad focus from one overlay to one of its neighbors. Returns VROverlayError_NoNeighbor if there is no
neighbor in that direction
"""
fn = self.function_table.moveGamepadFocusToNeighbor
result = fn(eDirection, ulFrom)
return result | python | def moveGamepadFocusToNeighbor(self, eDirection, ulFrom):
"""
Changes the Gamepad focus from one overlay to one of its neighbors. Returns VROverlayError_NoNeighbor if there is no
neighbor in that direction
"""
fn = self.function_table.moveGamepadFocusToNeighbor
result = fn(eDirection, ulFrom)
return result | [
"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 | [
"Changes",
"the",
"Gamepad",
"focus",
"from",
"one",
"overlay",
"to",
"one",
"of",
"its",
"neighbors",
".",
"Returns",
"VROverlayError_NoNeighbor",
"if",
"there",
"is",
"no",
"neighbor",
"in",
"that",
"direction"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5037-L5045 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayDualAnalogTransform | def setOverlayDualAnalogTransform(self, ulOverlay, eWhich, fRadius):
"""Sets the analog input to Dual Analog coordinate scale for the specified overlay."""
fn = self.function_table.setOverlayDualAnalogTransform
pvCenter = HmdVector2_t()
result = fn(ulOverlay, eWhich, byref(pvCenter), fRadius)
return result, pvCenter | python | def setOverlayDualAnalogTransform(self, ulOverlay, eWhich, fRadius):
"""Sets the analog input to Dual Analog coordinate scale for the specified overlay."""
fn = self.function_table.setOverlayDualAnalogTransform
pvCenter = HmdVector2_t()
result = fn(ulOverlay, eWhich, byref(pvCenter), fRadius)
return result, pvCenter | [
"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. | [
"Sets",
"the",
"analog",
"input",
"to",
"Dual",
"Analog",
"coordinate",
"scale",
"for",
"the",
"specified",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5047-L5053 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayDualAnalogTransform | def getOverlayDualAnalogTransform(self, ulOverlay, eWhich):
"""Gets the analog input to Dual Analog coordinate scale for the specified overlay."""
fn = self.function_table.getOverlayDualAnalogTransform
pvCenter = HmdVector2_t()
pfRadius = c_float()
result = fn(ulOverlay, eWhich, byref(pvCenter), byref(pfRadius))
return result, pvCenter, pfRadius.value | python | def getOverlayDualAnalogTransform(self, ulOverlay, eWhich):
"""Gets the analog input to Dual Analog coordinate scale for the specified overlay."""
fn = self.function_table.getOverlayDualAnalogTransform
pvCenter = HmdVector2_t()
pfRadius = c_float()
result = fn(ulOverlay, eWhich, byref(pvCenter), byref(pfRadius))
return result, pvCenter, pfRadius.value | [
"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. | [
"Gets",
"the",
"analog",
"input",
"to",
"Dual",
"Analog",
"coordinate",
"scale",
"for",
"the",
"specified",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5055-L5062 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.clearOverlayTexture | def clearOverlayTexture(self, ulOverlayHandle):
"""Use this to tell the overlay system to release the texture set for this overlay."""
fn = self.function_table.clearOverlayTexture
result = fn(ulOverlayHandle)
return result | python | def clearOverlayTexture(self, ulOverlayHandle):
"""Use this to tell the overlay system to release the texture set for this overlay."""
fn = self.function_table.clearOverlayTexture
result = fn(ulOverlayHandle)
return result | [
"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. | [
"Use",
"this",
"to",
"tell",
"the",
"overlay",
"system",
"to",
"release",
"the",
"texture",
"set",
"for",
"this",
"overlay",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5076-L5081 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setOverlayRaw | def setOverlayRaw(self, ulOverlayHandle, pvBuffer, unWidth, unHeight, unDepth):
"""
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.
"""
fn = self.function_table.setOverlayRaw
result = fn(ulOverlayHandle, pvBuffer, unWidth, unHeight, unDepth)
return result | python | def setOverlayRaw(self, ulOverlayHandle, pvBuffer, unWidth, unHeight, unDepth):
"""
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.
"""
fn = self.function_table.setOverlayRaw
result = fn(ulOverlayHandle, pvBuffer, unWidth, unHeight, unDepth)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5083-L5091 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.releaseNativeOverlayHandle | def releaseNativeOverlayHandle(self, ulOverlayHandle, pNativeTextureHandle):
"""
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.
"""
fn = self.function_table.releaseNativeOverlayHandle
result = fn(ulOverlayHandle, pNativeTextureHandle)
return result | python | def releaseNativeOverlayHandle(self, ulOverlayHandle, pNativeTextureHandle):
"""
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.
"""
fn = self.function_table.releaseNativeOverlayHandle
result = fn(ulOverlayHandle, pNativeTextureHandle)
return result | [
"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. | [
"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",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5124-L5132 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getOverlayTextureSize | def getOverlayTextureSize(self, ulOverlayHandle):
"""Get the size of the overlay texture"""
fn = self.function_table.getOverlayTextureSize
pWidth = c_uint32()
pHeight = c_uint32()
result = fn(ulOverlayHandle, byref(pWidth), byref(pHeight))
return result, pWidth.value, pHeight.value | python | def getOverlayTextureSize(self, ulOverlayHandle):
"""Get the size of the overlay texture"""
fn = self.function_table.getOverlayTextureSize
pWidth = c_uint32()
pHeight = c_uint32()
result = fn(ulOverlayHandle, byref(pWidth), byref(pHeight))
return result, pWidth.value, pHeight.value | [
"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 | [
"Get",
"the",
"size",
"of",
"the",
"overlay",
"texture"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5134-L5141 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.createDashboardOverlay | def createDashboardOverlay(self, pchOverlayKey, pchOverlayFriendlyName):
"""Creates a dashboard overlay and returns its handle"""
fn = self.function_table.createDashboardOverlay
pMainHandle = VROverlayHandle_t()
pThumbnailHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, pchOverlayFriendlyName, byref(pMainHandle), byref(pThumbnailHandle))
return result, pMainHandle, pThumbnailHandle | python | def createDashboardOverlay(self, pchOverlayKey, pchOverlayFriendlyName):
"""Creates a dashboard overlay and returns its handle"""
fn = self.function_table.createDashboardOverlay
pMainHandle = VROverlayHandle_t()
pThumbnailHandle = VROverlayHandle_t()
result = fn(pchOverlayKey, pchOverlayFriendlyName, byref(pMainHandle), byref(pThumbnailHandle))
return result, pMainHandle, pThumbnailHandle | [
"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 | [
"Creates",
"a",
"dashboard",
"overlay",
"and",
"returns",
"its",
"handle"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5143-L5150 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.isActiveDashboardOverlay | def isActiveDashboardOverlay(self, ulOverlayHandle):
"""returns true if the dashboard is visible and the specified overlay is the active system Overlay"""
fn = self.function_table.isActiveDashboardOverlay
result = fn(ulOverlayHandle)
return result | python | def isActiveDashboardOverlay(self, ulOverlayHandle):
"""returns true if the dashboard is visible and the specified overlay is the active system Overlay"""
fn = self.function_table.isActiveDashboardOverlay
result = fn(ulOverlayHandle)
return result | [
"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 | [
"returns",
"true",
"if",
"the",
"dashboard",
"is",
"visible",
"and",
"the",
"specified",
"overlay",
"is",
"the",
"active",
"system",
"Overlay"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5159-L5164 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setDashboardOverlaySceneProcess | def setDashboardOverlaySceneProcess(self, ulOverlayHandle, unProcessId):
"""Sets the dashboard overlay to only appear when the specified process ID has scene focus"""
fn = self.function_table.setDashboardOverlaySceneProcess
result = fn(ulOverlayHandle, unProcessId)
return result | python | def setDashboardOverlaySceneProcess(self, ulOverlayHandle, unProcessId):
"""Sets the dashboard overlay to only appear when the specified process ID has scene focus"""
fn = self.function_table.setDashboardOverlaySceneProcess
result = fn(ulOverlayHandle, unProcessId)
return result | [
"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 | [
"Sets",
"the",
"dashboard",
"overlay",
"to",
"only",
"appear",
"when",
"the",
"specified",
"process",
"ID",
"has",
"scene",
"focus"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5166-L5171 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getDashboardOverlaySceneProcess | def getDashboardOverlaySceneProcess(self, ulOverlayHandle):
"""Gets the process ID that this dashboard overlay requires to have scene focus"""
fn = self.function_table.getDashboardOverlaySceneProcess
punProcessId = c_uint32()
result = fn(ulOverlayHandle, byref(punProcessId))
return result, punProcessId.value | python | def getDashboardOverlaySceneProcess(self, ulOverlayHandle):
"""Gets the process ID that this dashboard overlay requires to have scene focus"""
fn = self.function_table.getDashboardOverlaySceneProcess
punProcessId = c_uint32()
result = fn(ulOverlayHandle, byref(punProcessId))
return result, punProcessId.value | [
"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 | [
"Gets",
"the",
"process",
"ID",
"that",
"this",
"dashboard",
"overlay",
"requires",
"to",
"have",
"scene",
"focus"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5173-L5179 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.showKeyboard | def showKeyboard(self, eInputMode, eLineInputMode, pchDescription, unCharMax, pchExistingText, bUseMinimalMode, uUserValue):
"""Show the virtual keyboard to accept input"""
fn = self.function_table.showKeyboard
result = fn(eInputMode, eLineInputMode, pchDescription, unCharMax, pchExistingText, bUseMinimalMode, uUserValue)
return result | python | def showKeyboard(self, eInputMode, eLineInputMode, pchDescription, unCharMax, pchExistingText, bUseMinimalMode, uUserValue):
"""Show the virtual keyboard to accept input"""
fn = self.function_table.showKeyboard
result = fn(eInputMode, eLineInputMode, pchDescription, unCharMax, pchExistingText, bUseMinimalMode, uUserValue)
return result | [
"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 | [
"Show",
"the",
"virtual",
"keyboard",
"to",
"accept",
"input"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5194-L5199 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.getKeyboardText | def getKeyboardText(self, pchText, cchText):
"""Get the text that was entered into the text input"""
fn = self.function_table.getKeyboardText
result = fn(pchText, cchText)
return result | python | def getKeyboardText(self, pchText, cchText):
"""Get the text that was entered into the text input"""
fn = self.function_table.getKeyboardText
result = fn(pchText, cchText)
return result | [
"def",
"getKeyboardText",
"(",
"self",
",",
"pchText",
",",
"cchText",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getKeyboardText",
"result",
"=",
"fn",
"(",
"pchText",
",",
"cchText",
")",
"return",
"result"
] | Get the text that was entered into the text input | [
"Get",
"the",
"text",
"that",
"was",
"entered",
"into",
"the",
"text",
"input"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5206-L5211 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.setKeyboardTransformAbsolute | def setKeyboardTransformAbsolute(self, eTrackingOrigin):
"""Set the position of the keyboard in world space"""
fn = self.function_table.setKeyboardTransformAbsolute
pmatTrackingOriginToKeyboardTransform = HmdMatrix34_t()
fn(eTrackingOrigin, byref(pmatTrackingOriginToKeyboardTransform))
return pmatTrackingOriginToKeyboardTransform | python | def setKeyboardTransformAbsolute(self, eTrackingOrigin):
"""Set the position of the keyboard in world space"""
fn = self.function_table.setKeyboardTransformAbsolute
pmatTrackingOriginToKeyboardTransform = HmdMatrix34_t()
fn(eTrackingOrigin, byref(pmatTrackingOriginToKeyboardTransform))
return pmatTrackingOriginToKeyboardTransform | [
"def",
"setKeyboardTransformAbsolute",
"(",
"self",
",",
"eTrackingOrigin",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setKeyboardTransformAbsolute",
"pmatTrackingOriginToKeyboardTransform",
"=",
"HmdMatrix34_t",
"(",
")",
"fn",
"(",
"eTrackingOrigin",
",",
"byref",
"(",
"pmatTrackingOriginToKeyboardTransform",
")",
")",
"return",
"pmatTrackingOriginToKeyboardTransform"
] | Set the position of the keyboard in world space | [
"Set",
"the",
"position",
"of",
"the",
"keyboard",
"in",
"world",
"space"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5219-L5225 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVROverlay.showMessageOverlay | def showMessageOverlay(self, pchText, pchCaption, pchButton0Text, pchButton1Text, pchButton2Text, pchButton3Text):
"""Show the message overlay. This will block and return you a result."""
fn = self.function_table.showMessageOverlay
result = fn(pchText, pchCaption, pchButton0Text, pchButton1Text, pchButton2Text, pchButton3Text)
return result | python | def showMessageOverlay(self, pchText, pchCaption, pchButton0Text, pchButton1Text, pchButton2Text, pchButton3Text):
"""Show the message overlay. This will block and return you a result."""
fn = self.function_table.showMessageOverlay
result = fn(pchText, pchCaption, pchButton0Text, pchButton1Text, pchButton2Text, pchButton3Text)
return result | [
"def",
"showMessageOverlay",
"(",
"self",
",",
"pchText",
",",
"pchCaption",
",",
"pchButton0Text",
",",
"pchButton1Text",
",",
"pchButton2Text",
",",
"pchButton3Text",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"showMessageOverlay",
"result",
"=",
"fn",
"(",
"pchText",
",",
"pchCaption",
",",
"pchButton0Text",
",",
"pchButton1Text",
",",
"pchButton2Text",
",",
"pchButton3Text",
")",
"return",
"result"
] | Show the message overlay. This will block and return you a result. | [
"Show",
"the",
"message",
"overlay",
".",
"This",
"will",
"block",
"and",
"return",
"you",
"a",
"result",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5250-L5255 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.freeRenderModel | def freeRenderModel(self):
"""
Frees a previously returned render model
It is safe to call this on a null ptr.
"""
fn = self.function_table.freeRenderModel
pRenderModel = RenderModel_t()
fn(byref(pRenderModel))
return pRenderModel | python | def freeRenderModel(self):
"""
Frees a previously returned render model
It is safe to call this on a null ptr.
"""
fn = self.function_table.freeRenderModel
pRenderModel = RenderModel_t()
fn(byref(pRenderModel))
return pRenderModel | [
"def",
"freeRenderModel",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"freeRenderModel",
"pRenderModel",
"=",
"RenderModel_t",
"(",
")",
"fn",
"(",
"byref",
"(",
"pRenderModel",
")",
")",
"return",
"pRenderModel"
] | Frees a previously returned render model
It is safe to call this on a null ptr. | [
"Frees",
"a",
"previously",
"returned",
"render",
"model",
"It",
"is",
"safe",
"to",
"call",
"this",
"on",
"a",
"null",
"ptr",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5322-L5331 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.loadTexture_Async | def loadTexture_Async(self, textureId):
"""Loads and returns a texture for use in the application."""
fn = self.function_table.loadTexture_Async
ppTexture = POINTER(RenderModel_TextureMap_t)()
result = fn(textureId, byref(ppTexture))
return result, ppTexture | python | def loadTexture_Async(self, textureId):
"""Loads and returns a texture for use in the application."""
fn = self.function_table.loadTexture_Async
ppTexture = POINTER(RenderModel_TextureMap_t)()
result = fn(textureId, byref(ppTexture))
return result, ppTexture | [
"def",
"loadTexture_Async",
"(",
"self",
",",
"textureId",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"loadTexture_Async",
"ppTexture",
"=",
"POINTER",
"(",
"RenderModel_TextureMap_t",
")",
"(",
")",
"result",
"=",
"fn",
"(",
"textureId",
",",
"byref",
"(",
"ppTexture",
")",
")",
"return",
"result",
",",
"ppTexture"
] | Loads and returns a texture for use in the application. | [
"Loads",
"and",
"returns",
"a",
"texture",
"for",
"use",
"in",
"the",
"application",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5333-L5339 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.freeTexture | def freeTexture(self):
"""
Frees a previously returned texture
It is safe to call this on a null ptr.
"""
fn = self.function_table.freeTexture
pTexture = RenderModel_TextureMap_t()
fn(byref(pTexture))
return pTexture | python | def freeTexture(self):
"""
Frees a previously returned texture
It is safe to call this on a null ptr.
"""
fn = self.function_table.freeTexture
pTexture = RenderModel_TextureMap_t()
fn(byref(pTexture))
return pTexture | [
"def",
"freeTexture",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"freeTexture",
"pTexture",
"=",
"RenderModel_TextureMap_t",
"(",
")",
"fn",
"(",
"byref",
"(",
"pTexture",
")",
")",
"return",
"pTexture"
] | Frees a previously returned texture
It is safe to call this on a null ptr. | [
"Frees",
"a",
"previously",
"returned",
"texture",
"It",
"is",
"safe",
"to",
"call",
"this",
"on",
"a",
"null",
"ptr",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5341-L5350 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.loadTextureD3D11_Async | def loadTextureD3D11_Async(self, textureId, pD3D11Device):
"""Creates a D3D11 texture and loads data into it."""
fn = self.function_table.loadTextureD3D11_Async
ppD3D11Texture2D = c_void_p()
result = fn(textureId, pD3D11Device, byref(ppD3D11Texture2D))
return result, ppD3D11Texture2D.value | python | def loadTextureD3D11_Async(self, textureId, pD3D11Device):
"""Creates a D3D11 texture and loads data into it."""
fn = self.function_table.loadTextureD3D11_Async
ppD3D11Texture2D = c_void_p()
result = fn(textureId, pD3D11Device, byref(ppD3D11Texture2D))
return result, ppD3D11Texture2D.value | [
"def",
"loadTextureD3D11_Async",
"(",
"self",
",",
"textureId",
",",
"pD3D11Device",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"loadTextureD3D11_Async",
"ppD3D11Texture2D",
"=",
"c_void_p",
"(",
")",
"result",
"=",
"fn",
"(",
"textureId",
",",
"pD3D11Device",
",",
"byref",
"(",
"ppD3D11Texture2D",
")",
")",
"return",
"result",
",",
"ppD3D11Texture2D",
".",
"value"
] | Creates a D3D11 texture and loads data into it. | [
"Creates",
"a",
"D3D11",
"texture",
"and",
"loads",
"data",
"into",
"it",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5352-L5358 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.loadIntoTextureD3D11_Async | def loadIntoTextureD3D11_Async(self, textureId, pDstTexture):
"""Helper function to copy the bits into an existing texture."""
fn = self.function_table.loadIntoTextureD3D11_Async
result = fn(textureId, pDstTexture)
return result | python | def loadIntoTextureD3D11_Async(self, textureId, pDstTexture):
"""Helper function to copy the bits into an existing texture."""
fn = self.function_table.loadIntoTextureD3D11_Async
result = fn(textureId, pDstTexture)
return result | [
"def",
"loadIntoTextureD3D11_Async",
"(",
"self",
",",
"textureId",
",",
"pDstTexture",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"loadIntoTextureD3D11_Async",
"result",
"=",
"fn",
"(",
"textureId",
",",
"pDstTexture",
")",
"return",
"result"
] | Helper function to copy the bits into an existing texture. | [
"Helper",
"function",
"to",
"copy",
"the",
"bits",
"into",
"an",
"existing",
"texture",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5360-L5365 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getRenderModelName | def getRenderModelName(self, unRenderModelIndex, pchRenderModelName, unRenderModelNameLen):
"""
Use this to get the names of available render models. Index does not correlate to a tracked device index, but
is only used for iterating over all available render models. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name.
"""
fn = self.function_table.getRenderModelName
result = fn(unRenderModelIndex, pchRenderModelName, unRenderModelNameLen)
return result | python | def getRenderModelName(self, unRenderModelIndex, pchRenderModelName, unRenderModelNameLen):
"""
Use this to get the names of available render models. Index does not correlate to a tracked device index, but
is only used for iterating over all available render models. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name.
"""
fn = self.function_table.getRenderModelName
result = fn(unRenderModelIndex, pchRenderModelName, unRenderModelNameLen)
return result | [
"def",
"getRenderModelName",
"(",
"self",
",",
"unRenderModelIndex",
",",
"pchRenderModelName",
",",
"unRenderModelNameLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getRenderModelName",
"result",
"=",
"fn",
"(",
"unRenderModelIndex",
",",
"pchRenderModelName",
",",
"unRenderModelNameLen",
")",
"return",
"result"
] | Use this to get the names of available render models. Index does not correlate to a tracked device index, but
is only used for iterating over all available render models. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name. | [
"Use",
"this",
"to",
"get",
"the",
"names",
"of",
"available",
"render",
"models",
".",
"Index",
"does",
"not",
"correlate",
"to",
"a",
"tracked",
"device",
"index",
"but",
"is",
"only",
"used",
"for",
"iterating",
"over",
"all",
"available",
"render",
"models",
".",
"If",
"the",
"index",
"is",
"out",
"of",
"range",
"this",
"function",
"will",
"return",
"0",
".",
"Otherwise",
"it",
"will",
"return",
"the",
"size",
"of",
"the",
"buffer",
"required",
"for",
"the",
"name",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5373-L5382 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getComponentName | def getComponentName(self, pchRenderModelName, unComponentIndex, pchComponentName, unComponentNameLen):
"""
Use this to get the names of available components. Index does not correlate to a tracked device index, but
is only used for iterating over all available components. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name.
"""
fn = self.function_table.getComponentName
result = fn(pchRenderModelName, unComponentIndex, pchComponentName, unComponentNameLen)
return result | python | def getComponentName(self, pchRenderModelName, unComponentIndex, pchComponentName, unComponentNameLen):
"""
Use this to get the names of available components. Index does not correlate to a tracked device index, but
is only used for iterating over all available components. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name.
"""
fn = self.function_table.getComponentName
result = fn(pchRenderModelName, unComponentIndex, pchComponentName, unComponentNameLen)
return result | [
"def",
"getComponentName",
"(",
"self",
",",
"pchRenderModelName",
",",
"unComponentIndex",
",",
"pchComponentName",
",",
"unComponentNameLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getComponentName",
"result",
"=",
"fn",
"(",
"pchRenderModelName",
",",
"unComponentIndex",
",",
"pchComponentName",
",",
"unComponentNameLen",
")",
"return",
"result"
] | Use this to get the names of available components. Index does not correlate to a tracked device index, but
is only used for iterating over all available components. If the index is out of range, this function will return 0.
Otherwise, it will return the size of the buffer required for the name. | [
"Use",
"this",
"to",
"get",
"the",
"names",
"of",
"available",
"components",
".",
"Index",
"does",
"not",
"correlate",
"to",
"a",
"tracked",
"device",
"index",
"but",
"is",
"only",
"used",
"for",
"iterating",
"over",
"all",
"available",
"components",
".",
"If",
"the",
"index",
"is",
"out",
"of",
"range",
"this",
"function",
"will",
"return",
"0",
".",
"Otherwise",
"it",
"will",
"return",
"the",
"size",
"of",
"the",
"buffer",
"required",
"for",
"the",
"name",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5406-L5415 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getComponentState | def getComponentState(self, pchRenderModelName, pchComponentName):
"""This version of GetComponentState takes a controller state block instead of an action origin. This function is deprecated. You should use the new input system and GetComponentStateForDevicePath instead."""
fn = self.function_table.getComponentState
pControllerState = VRControllerState_t()
pState = RenderModel_ControllerMode_State_t()
pComponentState = RenderModel_ComponentState_t()
result = fn(pchRenderModelName, pchComponentName, byref(pControllerState), byref(pState), byref(pComponentState))
return result, pControllerState, pState, pComponentState | python | def getComponentState(self, pchRenderModelName, pchComponentName):
"""This version of GetComponentState takes a controller state block instead of an action origin. This function is deprecated. You should use the new input system and GetComponentStateForDevicePath instead."""
fn = self.function_table.getComponentState
pControllerState = VRControllerState_t()
pState = RenderModel_ControllerMode_State_t()
pComponentState = RenderModel_ComponentState_t()
result = fn(pchRenderModelName, pchComponentName, byref(pControllerState), byref(pState), byref(pComponentState))
return result, pControllerState, pState, pComponentState | [
"def",
"getComponentState",
"(",
"self",
",",
"pchRenderModelName",
",",
"pchComponentName",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getComponentState",
"pControllerState",
"=",
"VRControllerState_t",
"(",
")",
"pState",
"=",
"RenderModel_ControllerMode_State_t",
"(",
")",
"pComponentState",
"=",
"RenderModel_ComponentState_t",
"(",
")",
"result",
"=",
"fn",
"(",
"pchRenderModelName",
",",
"pchComponentName",
",",
"byref",
"(",
"pControllerState",
")",
",",
"byref",
"(",
"pState",
")",
",",
"byref",
"(",
"pComponentState",
")",
")",
"return",
"result",
",",
"pControllerState",
",",
"pState",
",",
"pComponentState"
] | This version of GetComponentState takes a controller state block instead of an action origin. This function is deprecated. You should use the new input system and GetComponentStateForDevicePath instead. | [
"This",
"version",
"of",
"GetComponentState",
"takes",
"a",
"controller",
"state",
"block",
"instead",
"of",
"an",
"action",
"origin",
".",
"This",
"function",
"is",
"deprecated",
".",
"You",
"should",
"use",
"the",
"new",
"input",
"system",
"and",
"GetComponentStateForDevicePath",
"instead",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5456-L5464 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.renderModelHasComponent | def renderModelHasComponent(self, pchRenderModelName, pchComponentName):
"""Returns true if the render model has a component with the specified name"""
fn = self.function_table.renderModelHasComponent
result = fn(pchRenderModelName, pchComponentName)
return result | python | def renderModelHasComponent(self, pchRenderModelName, pchComponentName):
"""Returns true if the render model has a component with the specified name"""
fn = self.function_table.renderModelHasComponent
result = fn(pchRenderModelName, pchComponentName)
return result | [
"def",
"renderModelHasComponent",
"(",
"self",
",",
"pchRenderModelName",
",",
"pchComponentName",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"renderModelHasComponent",
"result",
"=",
"fn",
"(",
"pchRenderModelName",
",",
"pchComponentName",
")",
"return",
"result"
] | Returns true if the render model has a component with the specified name | [
"Returns",
"true",
"if",
"the",
"render",
"model",
"has",
"a",
"component",
"with",
"the",
"specified",
"name"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5466-L5471 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getRenderModelThumbnailURL | def getRenderModelThumbnailURL(self, pchRenderModelName, pchThumbnailURL, unThumbnailURLLen):
"""Returns the URL of the thumbnail image for this rendermodel"""
fn = self.function_table.getRenderModelThumbnailURL
peError = EVRRenderModelError()
result = fn(pchRenderModelName, pchThumbnailURL, unThumbnailURLLen, byref(peError))
return result, peError | python | def getRenderModelThumbnailURL(self, pchRenderModelName, pchThumbnailURL, unThumbnailURLLen):
"""Returns the URL of the thumbnail image for this rendermodel"""
fn = self.function_table.getRenderModelThumbnailURL
peError = EVRRenderModelError()
result = fn(pchRenderModelName, pchThumbnailURL, unThumbnailURLLen, byref(peError))
return result, peError | [
"def",
"getRenderModelThumbnailURL",
"(",
"self",
",",
"pchRenderModelName",
",",
"pchThumbnailURL",
",",
"unThumbnailURLLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getRenderModelThumbnailURL",
"peError",
"=",
"EVRRenderModelError",
"(",
")",
"result",
"=",
"fn",
"(",
"pchRenderModelName",
",",
"pchThumbnailURL",
",",
"unThumbnailURLLen",
",",
"byref",
"(",
"peError",
")",
")",
"return",
"result",
",",
"peError"
] | Returns the URL of the thumbnail image for this rendermodel | [
"Returns",
"the",
"URL",
"of",
"the",
"thumbnail",
"image",
"for",
"this",
"rendermodel"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5473-L5479 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getRenderModelOriginalPath | def getRenderModelOriginalPath(self, pchRenderModelName, pchOriginalPath, unOriginalPathLen):
"""
Provides a render model path that will load the unskinned model if the model name provided has been replace by the user. If the model
hasn't been replaced the path value will still be a valid path to load the model. Pass this to LoadRenderModel_Async, etc. to load the
model.
"""
fn = self.function_table.getRenderModelOriginalPath
peError = EVRRenderModelError()
result = fn(pchRenderModelName, pchOriginalPath, unOriginalPathLen, byref(peError))
return result, peError | python | def getRenderModelOriginalPath(self, pchRenderModelName, pchOriginalPath, unOriginalPathLen):
"""
Provides a render model path that will load the unskinned model if the model name provided has been replace by the user. If the model
hasn't been replaced the path value will still be a valid path to load the model. Pass this to LoadRenderModel_Async, etc. to load the
model.
"""
fn = self.function_table.getRenderModelOriginalPath
peError = EVRRenderModelError()
result = fn(pchRenderModelName, pchOriginalPath, unOriginalPathLen, byref(peError))
return result, peError | [
"def",
"getRenderModelOriginalPath",
"(",
"self",
",",
"pchRenderModelName",
",",
"pchOriginalPath",
",",
"unOriginalPathLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getRenderModelOriginalPath",
"peError",
"=",
"EVRRenderModelError",
"(",
")",
"result",
"=",
"fn",
"(",
"pchRenderModelName",
",",
"pchOriginalPath",
",",
"unOriginalPathLen",
",",
"byref",
"(",
"peError",
")",
")",
"return",
"result",
",",
"peError"
] | Provides a render model path that will load the unskinned model if the model name provided has been replace by the user. If the model
hasn't been replaced the path value will still be a valid path to load the model. Pass this to LoadRenderModel_Async, etc. to load the
model. | [
"Provides",
"a",
"render",
"model",
"path",
"that",
"will",
"load",
"the",
"unskinned",
"model",
"if",
"the",
"model",
"name",
"provided",
"has",
"been",
"replace",
"by",
"the",
"user",
".",
"If",
"the",
"model",
"hasn",
"t",
"been",
"replaced",
"the",
"path",
"value",
"will",
"still",
"be",
"a",
"valid",
"path",
"to",
"load",
"the",
"model",
".",
"Pass",
"this",
"to",
"LoadRenderModel_Async",
"etc",
".",
"to",
"load",
"the",
"model",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5481-L5491 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRRenderModels.getRenderModelErrorNameFromEnum | def getRenderModelErrorNameFromEnum(self, error):
"""Returns a string for a render model error"""
fn = self.function_table.getRenderModelErrorNameFromEnum
result = fn(error)
return result | python | def getRenderModelErrorNameFromEnum(self, error):
"""Returns a string for a render model error"""
fn = self.function_table.getRenderModelErrorNameFromEnum
result = fn(error)
return result | [
"def",
"getRenderModelErrorNameFromEnum",
"(",
"self",
",",
"error",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getRenderModelErrorNameFromEnum",
"result",
"=",
"fn",
"(",
"error",
")",
"return",
"result"
] | Returns a string for a render model error | [
"Returns",
"a",
"string",
"for",
"a",
"render",
"model",
"error"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5493-L5498 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRNotifications.removeNotification | def removeNotification(self, notificationId):
"""Destroy a notification, hiding it first if it currently shown to the user."""
fn = self.function_table.removeNotification
result = fn(notificationId)
return result | python | def removeNotification(self, notificationId):
"""Destroy a notification, hiding it first if it currently shown to the user."""
fn = self.function_table.removeNotification
result = fn(notificationId)
return result | [
"def",
"removeNotification",
"(",
"self",
",",
"notificationId",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"removeNotification",
"result",
"=",
"fn",
"(",
"notificationId",
")",
"return",
"result"
] | Destroy a notification, hiding it first if it currently shown to the user. | [
"Destroy",
"a",
"notification",
"hiding",
"it",
"first",
"if",
"it",
"currently",
"shown",
"to",
"the",
"user",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5541-L5546 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRScreenshots.hookScreenshot | def hookScreenshot(self, numTypes):
"""
Called by the running VR application to indicate that it
wishes to be in charge of screenshots. If the
application does not call this, the Compositor will only
support VRScreenshotType_Stereo screenshots that will be
captured without notification to the running app.
Once hooked your application will receive a
VREvent_RequestScreenshot event when the user presses the
buttons to take a screenshot.
"""
fn = self.function_table.hookScreenshot
pSupportedTypes = EVRScreenshotType()
result = fn(byref(pSupportedTypes), numTypes)
return result, pSupportedTypes | python | def hookScreenshot(self, numTypes):
"""
Called by the running VR application to indicate that it
wishes to be in charge of screenshots. If the
application does not call this, the Compositor will only
support VRScreenshotType_Stereo screenshots that will be
captured without notification to the running app.
Once hooked your application will receive a
VREvent_RequestScreenshot event when the user presses the
buttons to take a screenshot.
"""
fn = self.function_table.hookScreenshot
pSupportedTypes = EVRScreenshotType()
result = fn(byref(pSupportedTypes), numTypes)
return result, pSupportedTypes | [
"def",
"hookScreenshot",
"(",
"self",
",",
"numTypes",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"hookScreenshot",
"pSupportedTypes",
"=",
"EVRScreenshotType",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pSupportedTypes",
")",
",",
"numTypes",
")",
"return",
"result",
",",
"pSupportedTypes"
] | Called by the running VR application to indicate that it
wishes to be in charge of screenshots. If the
application does not call this, the Compositor will only
support VRScreenshotType_Stereo screenshots that will be
captured without notification to the running app.
Once hooked your application will receive a
VREvent_RequestScreenshot event when the user presses the
buttons to take a screenshot. | [
"Called",
"by",
"the",
"running",
"VR",
"application",
"to",
"indicate",
"that",
"it",
"wishes",
"to",
"be",
"in",
"charge",
"of",
"screenshots",
".",
"If",
"the",
"application",
"does",
"not",
"call",
"this",
"the",
"Compositor",
"will",
"only",
"support",
"VRScreenshotType_Stereo",
"screenshots",
"that",
"will",
"be",
"captured",
"without",
"notification",
"to",
"the",
"running",
"app",
".",
"Once",
"hooked",
"your",
"application",
"will",
"receive",
"a",
"VREvent_RequestScreenshot",
"event",
"when",
"the",
"user",
"presses",
"the",
"buttons",
"to",
"take",
"a",
"screenshot",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5727-L5742 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRScreenshots.getScreenshotPropertyType | def getScreenshotPropertyType(self, screenshotHandle):
"""
When your application receives a
VREvent_RequestScreenshot event, call these functions to get
the details of the screenshot request.
"""
fn = self.function_table.getScreenshotPropertyType
pError = EVRScreenshotError()
result = fn(screenshotHandle, byref(pError))
return result, pError | python | def getScreenshotPropertyType(self, screenshotHandle):
"""
When your application receives a
VREvent_RequestScreenshot event, call these functions to get
the details of the screenshot request.
"""
fn = self.function_table.getScreenshotPropertyType
pError = EVRScreenshotError()
result = fn(screenshotHandle, byref(pError))
return result, pError | [
"def",
"getScreenshotPropertyType",
"(",
"self",
",",
"screenshotHandle",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getScreenshotPropertyType",
"pError",
"=",
"EVRScreenshotError",
"(",
")",
"result",
"=",
"fn",
"(",
"screenshotHandle",
",",
"byref",
"(",
"pError",
")",
")",
"return",
"result",
",",
"pError"
] | When your application receives a
VREvent_RequestScreenshot event, call these functions to get
the details of the screenshot request. | [
"When",
"your",
"application",
"receives",
"a",
"VREvent_RequestScreenshot",
"event",
"call",
"these",
"functions",
"to",
"get",
"the",
"details",
"of",
"the",
"screenshot",
"request",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5744-L5754 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRScreenshots.updateScreenshotProgress | def updateScreenshotProgress(self, screenshotHandle, flProgress):
"""
Call this if the application is taking the screen shot
will take more than a few ms processing. This will result
in an overlay being presented that shows a completion
bar.
"""
fn = self.function_table.updateScreenshotProgress
result = fn(screenshotHandle, flProgress)
return result | python | def updateScreenshotProgress(self, screenshotHandle, flProgress):
"""
Call this if the application is taking the screen shot
will take more than a few ms processing. This will result
in an overlay being presented that shows a completion
bar.
"""
fn = self.function_table.updateScreenshotProgress
result = fn(screenshotHandle, flProgress)
return result | [
"def",
"updateScreenshotProgress",
"(",
"self",
",",
"screenshotHandle",
",",
"flProgress",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"updateScreenshotProgress",
"result",
"=",
"fn",
"(",
"screenshotHandle",
",",
"flProgress",
")",
"return",
"result"
] | Call this if the application is taking the screen shot
will take more than a few ms processing. This will result
in an overlay being presented that shows a completion
bar. | [
"Call",
"this",
"if",
"the",
"application",
"is",
"taking",
"the",
"screen",
"shot",
"will",
"take",
"more",
"than",
"a",
"few",
"ms",
"processing",
".",
"This",
"will",
"result",
"in",
"an",
"overlay",
"being",
"presented",
"that",
"shows",
"a",
"completion",
"bar",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5768-L5778 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRScreenshots.takeStereoScreenshot | def takeStereoScreenshot(self, pchPreviewFilename, pchVRFilename):
"""
Tells the compositor to take an internal screenshot of
type VRScreenshotType_Stereo. It will take the current
submitted scene textures of the running application and
write them into the preview image and a side-by-side file
for the VR image.
This is similar to request screenshot, but doesn't ever
talk to the application, just takes the shot and submits.
"""
fn = self.function_table.takeStereoScreenshot
pOutScreenshotHandle = ScreenshotHandle_t()
result = fn(byref(pOutScreenshotHandle), pchPreviewFilename, pchVRFilename)
return result, pOutScreenshotHandle | python | def takeStereoScreenshot(self, pchPreviewFilename, pchVRFilename):
"""
Tells the compositor to take an internal screenshot of
type VRScreenshotType_Stereo. It will take the current
submitted scene textures of the running application and
write them into the preview image and a side-by-side file
for the VR image.
This is similar to request screenshot, but doesn't ever
talk to the application, just takes the shot and submits.
"""
fn = self.function_table.takeStereoScreenshot
pOutScreenshotHandle = ScreenshotHandle_t()
result = fn(byref(pOutScreenshotHandle), pchPreviewFilename, pchVRFilename)
return result, pOutScreenshotHandle | [
"def",
"takeStereoScreenshot",
"(",
"self",
",",
"pchPreviewFilename",
",",
"pchVRFilename",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"takeStereoScreenshot",
"pOutScreenshotHandle",
"=",
"ScreenshotHandle_t",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pOutScreenshotHandle",
")",
",",
"pchPreviewFilename",
",",
"pchVRFilename",
")",
"return",
"result",
",",
"pOutScreenshotHandle"
] | Tells the compositor to take an internal screenshot of
type VRScreenshotType_Stereo. It will take the current
submitted scene textures of the running application and
write them into the preview image and a side-by-side file
for the VR image.
This is similar to request screenshot, but doesn't ever
talk to the application, just takes the shot and submits. | [
"Tells",
"the",
"compositor",
"to",
"take",
"an",
"internal",
"screenshot",
"of",
"type",
"VRScreenshotType_Stereo",
".",
"It",
"will",
"take",
"the",
"current",
"submitted",
"scene",
"textures",
"of",
"the",
"running",
"application",
"and",
"write",
"them",
"into",
"the",
"preview",
"image",
"and",
"a",
"side",
"-",
"by",
"-",
"side",
"file",
"for",
"the",
"VR",
"image",
".",
"This",
"is",
"similar",
"to",
"request",
"screenshot",
"but",
"doesn",
"t",
"ever",
"talk",
"to",
"the",
"application",
"just",
"takes",
"the",
"shot",
"and",
"submits",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5780-L5794 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRResources.loadSharedResource | def loadSharedResource(self, pchResourceName, pchBuffer, unBufferLen):
"""
Loads the specified resource into the provided buffer if large enough.
Returns the size in bytes of the buffer required to hold the specified resource.
"""
fn = self.function_table.loadSharedResource
result = fn(pchResourceName, pchBuffer, unBufferLen)
return result | python | def loadSharedResource(self, pchResourceName, pchBuffer, unBufferLen):
"""
Loads the specified resource into the provided buffer if large enough.
Returns the size in bytes of the buffer required to hold the specified resource.
"""
fn = self.function_table.loadSharedResource
result = fn(pchResourceName, pchBuffer, unBufferLen)
return result | [
"def",
"loadSharedResource",
"(",
"self",
",",
"pchResourceName",
",",
"pchBuffer",
",",
"unBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"loadSharedResource",
"result",
"=",
"fn",
"(",
"pchResourceName",
",",
"pchBuffer",
",",
"unBufferLen",
")",
"return",
"result"
] | Loads the specified resource into the provided buffer if large enough.
Returns the size in bytes of the buffer required to hold the specified resource. | [
"Loads",
"the",
"specified",
"resource",
"into",
"the",
"provided",
"buffer",
"if",
"large",
"enough",
".",
"Returns",
"the",
"size",
"in",
"bytes",
"of",
"the",
"buffer",
"required",
"to",
"hold",
"the",
"specified",
"resource",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5837-L5845 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRResources.getResourceFullPath | def getResourceFullPath(self, pchResourceName, pchResourceTypeDirectory, pchPathBuffer, unBufferLen):
"""
Provides the full path to the specified resource. Resource names can include named directories for
drivers and other things, and this resolves all of those and returns the actual physical path.
pchResourceTypeDirectory is the subdirectory of resources to look in.
"""
fn = self.function_table.getResourceFullPath
result = fn(pchResourceName, pchResourceTypeDirectory, pchPathBuffer, unBufferLen)
return result | python | def getResourceFullPath(self, pchResourceName, pchResourceTypeDirectory, pchPathBuffer, unBufferLen):
"""
Provides the full path to the specified resource. Resource names can include named directories for
drivers and other things, and this resolves all of those and returns the actual physical path.
pchResourceTypeDirectory is the subdirectory of resources to look in.
"""
fn = self.function_table.getResourceFullPath
result = fn(pchResourceName, pchResourceTypeDirectory, pchPathBuffer, unBufferLen)
return result | [
"def",
"getResourceFullPath",
"(",
"self",
",",
"pchResourceName",
",",
"pchResourceTypeDirectory",
",",
"pchPathBuffer",
",",
"unBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getResourceFullPath",
"result",
"=",
"fn",
"(",
"pchResourceName",
",",
"pchResourceTypeDirectory",
",",
"pchPathBuffer",
",",
"unBufferLen",
")",
"return",
"result"
] | Provides the full path to the specified resource. Resource names can include named directories for
drivers and other things, and this resolves all of those and returns the actual physical path.
pchResourceTypeDirectory is the subdirectory of resources to look in. | [
"Provides",
"the",
"full",
"path",
"to",
"the",
"specified",
"resource",
".",
"Resource",
"names",
"can",
"include",
"named",
"directories",
"for",
"drivers",
"and",
"other",
"things",
"and",
"this",
"resolves",
"all",
"of",
"those",
"and",
"returns",
"the",
"actual",
"physical",
"path",
".",
"pchResourceTypeDirectory",
"is",
"the",
"subdirectory",
"of",
"resources",
"to",
"look",
"in",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5847-L5856 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRDriverManager.getDriverName | def getDriverName(self, nDriver, pchValue, unBufferSize):
"""Returns the length of the number of bytes necessary to hold this string including the trailing null."""
fn = self.function_table.getDriverName
result = fn(nDriver, pchValue, unBufferSize)
return result | python | def getDriverName(self, nDriver, pchValue, unBufferSize):
"""Returns the length of the number of bytes necessary to hold this string including the trailing null."""
fn = self.function_table.getDriverName
result = fn(nDriver, pchValue, unBufferSize)
return result | [
"def",
"getDriverName",
"(",
"self",
",",
"nDriver",
",",
"pchValue",
",",
"unBufferSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getDriverName",
"result",
"=",
"fn",
"(",
"nDriver",
",",
"pchValue",
",",
"unBufferSize",
")",
"return",
"result"
] | Returns the length of the number of bytes necessary to hold this string including the trailing null. | [
"Returns",
"the",
"length",
"of",
"the",
"number",
"of",
"bytes",
"necessary",
"to",
"hold",
"this",
"string",
"including",
"the",
"trailing",
"null",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5886-L5891 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getActionSetHandle | def getActionSetHandle(self, pchActionSetName):
"""Returns a handle for an action set. This handle is used for all performance-sensitive calls."""
fn = self.function_table.getActionSetHandle
pHandle = VRActionSetHandle_t()
result = fn(pchActionSetName, byref(pHandle))
return result, pHandle | python | def getActionSetHandle(self, pchActionSetName):
"""Returns a handle for an action set. This handle is used for all performance-sensitive calls."""
fn = self.function_table.getActionSetHandle
pHandle = VRActionSetHandle_t()
result = fn(pchActionSetName, byref(pHandle))
return result, pHandle | [
"def",
"getActionSetHandle",
"(",
"self",
",",
"pchActionSetName",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getActionSetHandle",
"pHandle",
"=",
"VRActionSetHandle_t",
"(",
")",
"result",
"=",
"fn",
"(",
"pchActionSetName",
",",
"byref",
"(",
"pHandle",
")",
")",
"return",
"result",
",",
"pHandle"
] | Returns a handle for an action set. This handle is used for all performance-sensitive calls. | [
"Returns",
"a",
"handle",
"for",
"an",
"action",
"set",
".",
"This",
"handle",
"is",
"used",
"for",
"all",
"performance",
"-",
"sensitive",
"calls",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5955-L5961 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getActionHandle | def getActionHandle(self, pchActionName):
"""Returns a handle for an action. This handle is used for all performance-sensitive calls."""
fn = self.function_table.getActionHandle
pHandle = VRActionHandle_t()
result = fn(pchActionName, byref(pHandle))
return result, pHandle | python | def getActionHandle(self, pchActionName):
"""Returns a handle for an action. This handle is used for all performance-sensitive calls."""
fn = self.function_table.getActionHandle
pHandle = VRActionHandle_t()
result = fn(pchActionName, byref(pHandle))
return result, pHandle | [
"def",
"getActionHandle",
"(",
"self",
",",
"pchActionName",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getActionHandle",
"pHandle",
"=",
"VRActionHandle_t",
"(",
")",
"result",
"=",
"fn",
"(",
"pchActionName",
",",
"byref",
"(",
"pHandle",
")",
")",
"return",
"result",
",",
"pHandle"
] | Returns a handle for an action. This handle is used for all performance-sensitive calls. | [
"Returns",
"a",
"handle",
"for",
"an",
"action",
".",
"This",
"handle",
"is",
"used",
"for",
"all",
"performance",
"-",
"sensitive",
"calls",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5963-L5969 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getDigitalActionData | def getDigitalActionData(self, action, unActionDataSize, ulRestrictToDevice):
"""
Reads the state of a digital action given its handle. This will return VRInputError_WrongType if the type of
action is something other than digital
"""
fn = self.function_table.getDigitalActionData
pActionData = InputDigitalActionData_t()
result = fn(action, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | python | def getDigitalActionData(self, action, unActionDataSize, ulRestrictToDevice):
"""
Reads the state of a digital action given its handle. This will return VRInputError_WrongType if the type of
action is something other than digital
"""
fn = self.function_table.getDigitalActionData
pActionData = InputDigitalActionData_t()
result = fn(action, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | [
"def",
"getDigitalActionData",
"(",
"self",
",",
"action",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getDigitalActionData",
"pActionData",
"=",
"InputDigitalActionData_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pActionData",
")",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
"return",
"result",
",",
"pActionData"
] | Reads the state of a digital action given its handle. This will return VRInputError_WrongType if the type of
action is something other than digital | [
"Reads",
"the",
"state",
"of",
"a",
"digital",
"action",
"given",
"its",
"handle",
".",
"This",
"will",
"return",
"VRInputError_WrongType",
"if",
"the",
"type",
"of",
"action",
"is",
"something",
"other",
"than",
"digital"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L5990-L5999 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getAnalogActionData | def getAnalogActionData(self, action, unActionDataSize, ulRestrictToDevice):
"""
Reads the state of an analog action given its handle. This will return VRInputError_WrongType if the type of
action is something other than analog
"""
fn = self.function_table.getAnalogActionData
pActionData = InputAnalogActionData_t()
result = fn(action, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | python | def getAnalogActionData(self, action, unActionDataSize, ulRestrictToDevice):
"""
Reads the state of an analog action given its handle. This will return VRInputError_WrongType if the type of
action is something other than analog
"""
fn = self.function_table.getAnalogActionData
pActionData = InputAnalogActionData_t()
result = fn(action, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | [
"def",
"getAnalogActionData",
"(",
"self",
",",
"action",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getAnalogActionData",
"pActionData",
"=",
"InputAnalogActionData_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pActionData",
")",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
"return",
"result",
",",
"pActionData"
] | Reads the state of an analog action given its handle. This will return VRInputError_WrongType if the type of
action is something other than analog | [
"Reads",
"the",
"state",
"of",
"an",
"analog",
"action",
"given",
"its",
"handle",
".",
"This",
"will",
"return",
"VRInputError_WrongType",
"if",
"the",
"type",
"of",
"action",
"is",
"something",
"other",
"than",
"analog"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6001-L6010 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getPoseActionData | def getPoseActionData(self, action, eOrigin, fPredictedSecondsFromNow, unActionDataSize, ulRestrictToDevice):
"""Reads the state of a pose action given its handle."""
fn = self.function_table.getPoseActionData
pActionData = InputPoseActionData_t()
result = fn(action, eOrigin, fPredictedSecondsFromNow, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | python | def getPoseActionData(self, action, eOrigin, fPredictedSecondsFromNow, unActionDataSize, ulRestrictToDevice):
"""Reads the state of a pose action given its handle."""
fn = self.function_table.getPoseActionData
pActionData = InputPoseActionData_t()
result = fn(action, eOrigin, fPredictedSecondsFromNow, byref(pActionData), unActionDataSize, ulRestrictToDevice)
return result, pActionData | [
"def",
"getPoseActionData",
"(",
"self",
",",
"action",
",",
"eOrigin",
",",
"fPredictedSecondsFromNow",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getPoseActionData",
"pActionData",
"=",
"InputPoseActionData_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"eOrigin",
",",
"fPredictedSecondsFromNow",
",",
"byref",
"(",
"pActionData",
")",
",",
"unActionDataSize",
",",
"ulRestrictToDevice",
")",
"return",
"result",
",",
"pActionData"
] | Reads the state of a pose action given its handle. | [
"Reads",
"the",
"state",
"of",
"a",
"pose",
"action",
"given",
"its",
"handle",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6012-L6018 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getSkeletalActionData | def getSkeletalActionData(self, action, unActionDataSize):
"""Reads the state of a skeletal action given its handle."""
fn = self.function_table.getSkeletalActionData
pActionData = InputSkeletalActionData_t()
result = fn(action, byref(pActionData), unActionDataSize)
return result, pActionData | python | def getSkeletalActionData(self, action, unActionDataSize):
"""Reads the state of a skeletal action given its handle."""
fn = self.function_table.getSkeletalActionData
pActionData = InputSkeletalActionData_t()
result = fn(action, byref(pActionData), unActionDataSize)
return result, pActionData | [
"def",
"getSkeletalActionData",
"(",
"self",
",",
"action",
",",
"unActionDataSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getSkeletalActionData",
"pActionData",
"=",
"InputSkeletalActionData_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pActionData",
")",
",",
"unActionDataSize",
")",
"return",
"result",
",",
"pActionData"
] | Reads the state of a skeletal action given its handle. | [
"Reads",
"the",
"state",
"of",
"a",
"skeletal",
"action",
"given",
"its",
"handle",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6020-L6026 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getBoneCount | def getBoneCount(self, action):
"""Reads the number of bones in skeleton associated with the given action"""
fn = self.function_table.getBoneCount
pBoneCount = c_uint32()
result = fn(action, byref(pBoneCount))
return result, pBoneCount.value | python | def getBoneCount(self, action):
"""Reads the number of bones in skeleton associated with the given action"""
fn = self.function_table.getBoneCount
pBoneCount = c_uint32()
result = fn(action, byref(pBoneCount))
return result, pBoneCount.value | [
"def",
"getBoneCount",
"(",
"self",
",",
"action",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getBoneCount",
"pBoneCount",
"=",
"c_uint32",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pBoneCount",
")",
")",
"return",
"result",
",",
"pBoneCount",
".",
"value"
] | Reads the number of bones in skeleton associated with the given action | [
"Reads",
"the",
"number",
"of",
"bones",
"in",
"skeleton",
"associated",
"with",
"the",
"given",
"action"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6028-L6034 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getBoneHierarchy | def getBoneHierarchy(self, action, unIndexArayCount):
"""Fills the given array with the index of each bone's parent in the skeleton associated with the given action"""
fn = self.function_table.getBoneHierarchy
pParentIndices = BoneIndex_t()
result = fn(action, byref(pParentIndices), unIndexArayCount)
return result, pParentIndices | python | def getBoneHierarchy(self, action, unIndexArayCount):
"""Fills the given array with the index of each bone's parent in the skeleton associated with the given action"""
fn = self.function_table.getBoneHierarchy
pParentIndices = BoneIndex_t()
result = fn(action, byref(pParentIndices), unIndexArayCount)
return result, pParentIndices | [
"def",
"getBoneHierarchy",
"(",
"self",
",",
"action",
",",
"unIndexArayCount",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getBoneHierarchy",
"pParentIndices",
"=",
"BoneIndex_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pParentIndices",
")",
",",
"unIndexArayCount",
")",
"return",
"result",
",",
"pParentIndices"
] | Fills the given array with the index of each bone's parent in the skeleton associated with the given action | [
"Fills",
"the",
"given",
"array",
"with",
"the",
"index",
"of",
"each",
"bone",
"s",
"parent",
"in",
"the",
"skeleton",
"associated",
"with",
"the",
"given",
"action"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6036-L6042 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getBoneName | def getBoneName(self, action, nBoneIndex, pchBoneName, unNameBufferSize):
"""Fills the given buffer with the name of the bone at the given index in the skeleton associated with the given action"""
fn = self.function_table.getBoneName
result = fn(action, nBoneIndex, pchBoneName, unNameBufferSize)
return result | python | def getBoneName(self, action, nBoneIndex, pchBoneName, unNameBufferSize):
"""Fills the given buffer with the name of the bone at the given index in the skeleton associated with the given action"""
fn = self.function_table.getBoneName
result = fn(action, nBoneIndex, pchBoneName, unNameBufferSize)
return result | [
"def",
"getBoneName",
"(",
"self",
",",
"action",
",",
"nBoneIndex",
",",
"pchBoneName",
",",
"unNameBufferSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getBoneName",
"result",
"=",
"fn",
"(",
"action",
",",
"nBoneIndex",
",",
"pchBoneName",
",",
"unNameBufferSize",
")",
"return",
"result"
] | Fills the given buffer with the name of the bone at the given index in the skeleton associated with the given action | [
"Fills",
"the",
"given",
"buffer",
"with",
"the",
"name",
"of",
"the",
"bone",
"at",
"the",
"given",
"index",
"in",
"the",
"skeleton",
"associated",
"with",
"the",
"given",
"action"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6044-L6049 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getSkeletalReferenceTransforms | def getSkeletalReferenceTransforms(self, action, eTransformSpace, eReferencePose, unTransformArrayCount):
"""Fills the given buffer with the transforms for a specific static skeletal reference pose"""
fn = self.function_table.getSkeletalReferenceTransforms
pTransformArray = VRBoneTransform_t()
result = fn(action, eTransformSpace, eReferencePose, byref(pTransformArray), unTransformArrayCount)
return result, pTransformArray | python | def getSkeletalReferenceTransforms(self, action, eTransformSpace, eReferencePose, unTransformArrayCount):
"""Fills the given buffer with the transforms for a specific static skeletal reference pose"""
fn = self.function_table.getSkeletalReferenceTransforms
pTransformArray = VRBoneTransform_t()
result = fn(action, eTransformSpace, eReferencePose, byref(pTransformArray), unTransformArrayCount)
return result, pTransformArray | [
"def",
"getSkeletalReferenceTransforms",
"(",
"self",
",",
"action",
",",
"eTransformSpace",
",",
"eReferencePose",
",",
"unTransformArrayCount",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getSkeletalReferenceTransforms",
"pTransformArray",
"=",
"VRBoneTransform_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"eTransformSpace",
",",
"eReferencePose",
",",
"byref",
"(",
"pTransformArray",
")",
",",
"unTransformArrayCount",
")",
"return",
"result",
",",
"pTransformArray"
] | Fills the given buffer with the transforms for a specific static skeletal reference pose | [
"Fills",
"the",
"given",
"buffer",
"with",
"the",
"transforms",
"for",
"a",
"specific",
"static",
"skeletal",
"reference",
"pose"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6051-L6057 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getSkeletalTrackingLevel | def getSkeletalTrackingLevel(self, action):
"""Reads the level of accuracy to which the controller is able to track the user to recreate a skeletal pose"""
fn = self.function_table.getSkeletalTrackingLevel
pSkeletalTrackingLevel = EVRSkeletalTrackingLevel()
result = fn(action, byref(pSkeletalTrackingLevel))
return result, pSkeletalTrackingLevel | python | def getSkeletalTrackingLevel(self, action):
"""Reads the level of accuracy to which the controller is able to track the user to recreate a skeletal pose"""
fn = self.function_table.getSkeletalTrackingLevel
pSkeletalTrackingLevel = EVRSkeletalTrackingLevel()
result = fn(action, byref(pSkeletalTrackingLevel))
return result, pSkeletalTrackingLevel | [
"def",
"getSkeletalTrackingLevel",
"(",
"self",
",",
"action",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getSkeletalTrackingLevel",
"pSkeletalTrackingLevel",
"=",
"EVRSkeletalTrackingLevel",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"byref",
"(",
"pSkeletalTrackingLevel",
")",
")",
"return",
"result",
",",
"pSkeletalTrackingLevel"
] | Reads the level of accuracy to which the controller is able to track the user to recreate a skeletal pose | [
"Reads",
"the",
"level",
"of",
"accuracy",
"to",
"which",
"the",
"controller",
"is",
"able",
"to",
"track",
"the",
"user",
"to",
"recreate",
"a",
"skeletal",
"pose"
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6059-L6065 | train |
cmbruns/pyopenvr | src/openvr/__init__.py | IVRInput.getSkeletalBoneData | def getSkeletalBoneData(self, action, eTransformSpace, eMotionRange, unTransformArrayCount):
"""Reads the state of the skeletal bone data associated with this action and copies it into the given buffer."""
fn = self.function_table.getSkeletalBoneData
pTransformArray = VRBoneTransform_t()
result = fn(action, eTransformSpace, eMotionRange, byref(pTransformArray), unTransformArrayCount)
return result, pTransformArray | python | def getSkeletalBoneData(self, action, eTransformSpace, eMotionRange, unTransformArrayCount):
"""Reads the state of the skeletal bone data associated with this action and copies it into the given buffer."""
fn = self.function_table.getSkeletalBoneData
pTransformArray = VRBoneTransform_t()
result = fn(action, eTransformSpace, eMotionRange, byref(pTransformArray), unTransformArrayCount)
return result, pTransformArray | [
"def",
"getSkeletalBoneData",
"(",
"self",
",",
"action",
",",
"eTransformSpace",
",",
"eMotionRange",
",",
"unTransformArrayCount",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getSkeletalBoneData",
"pTransformArray",
"=",
"VRBoneTransform_t",
"(",
")",
"result",
"=",
"fn",
"(",
"action",
",",
"eTransformSpace",
",",
"eMotionRange",
",",
"byref",
"(",
"pTransformArray",
")",
",",
"unTransformArrayCount",
")",
"return",
"result",
",",
"pTransformArray"
] | Reads the state of the skeletal bone data associated with this action and copies it into the given buffer. | [
"Reads",
"the",
"state",
"of",
"the",
"skeletal",
"bone",
"data",
"associated",
"with",
"this",
"action",
"and",
"copies",
"it",
"into",
"the",
"given",
"buffer",
"."
] | 68395d26bb3df6ab1f0f059c38d441f962938be6 | https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L6067-L6073 | train |
Subsets and Splits