id
int32 0
252k
| 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
list | docstring
stringlengths 3
17.3k
| docstring_tokens
list | sha
stringlengths 40
40
| url
stringlengths 87
242
|
|---|---|---|---|---|---|---|---|---|---|---|---|
15,600
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.getControllerState
|
def getControllerState(self, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)):
"""
Fills the supplied struct with the current state of the controller. Returns false if the controller index
is invalid. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.getControllerState
pControllerState = VRControllerState_t()
result = fn(unControllerDeviceIndex, byref(pControllerState), unControllerStateSize)
return result, pControllerState
|
python
|
def getControllerState(self, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)):
"""
Fills the supplied struct with the current state of the controller. Returns false if the controller index
is invalid. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.getControllerState
pControllerState = VRControllerState_t()
result = fn(unControllerDeviceIndex, byref(pControllerState), unControllerStateSize)
return result, pControllerState
|
[
"def",
"getControllerState",
"(",
"self",
",",
"unControllerDeviceIndex",
",",
"unControllerStateSize",
"=",
"sizeof",
"(",
"VRControllerState_t",
")",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getControllerState",
"pControllerState",
"=",
"VRControllerState_t",
"(",
")",
"result",
"=",
"fn",
"(",
"unControllerDeviceIndex",
",",
"byref",
"(",
"pControllerState",
")",
",",
"unControllerStateSize",
")",
"return",
"result",
",",
"pControllerState"
] |
Fills the supplied struct with the current state of the controller. Returns false if the controller index
is invalid. This function is deprecated in favor of the new IVRInput system.
|
[
"Fills",
"the",
"supplied",
"struct",
"with",
"the",
"current",
"state",
"of",
"the",
"controller",
".",
"Returns",
"false",
"if",
"the",
"controller",
"index",
"is",
"invalid",
".",
"This",
"function",
"is",
"deprecated",
"in",
"favor",
"of",
"the",
"new",
"IVRInput",
"system",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3018-L3027
|
15,601
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.getControllerStateWithPose
|
def getControllerStateWithPose(self, eOrigin, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)):
"""
fills the supplied struct with the current state of the controller and the provided pose with the pose of
the controller when the controller state was updated most recently. Use this form if you need a precise controller
pose as input to your application when the user presses or releases a button. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.getControllerStateWithPose
pControllerState = VRControllerState_t()
pTrackedDevicePose = TrackedDevicePose_t()
result = fn(eOrigin, unControllerDeviceIndex, byref(pControllerState), unControllerStateSize, byref(pTrackedDevicePose))
return result, pControllerState, pTrackedDevicePose
|
python
|
def getControllerStateWithPose(self, eOrigin, unControllerDeviceIndex, unControllerStateSize=sizeof(VRControllerState_t)):
"""
fills the supplied struct with the current state of the controller and the provided pose with the pose of
the controller when the controller state was updated most recently. Use this form if you need a precise controller
pose as input to your application when the user presses or releases a button. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.getControllerStateWithPose
pControllerState = VRControllerState_t()
pTrackedDevicePose = TrackedDevicePose_t()
result = fn(eOrigin, unControllerDeviceIndex, byref(pControllerState), unControllerStateSize, byref(pTrackedDevicePose))
return result, pControllerState, pTrackedDevicePose
|
[
"def",
"getControllerStateWithPose",
"(",
"self",
",",
"eOrigin",
",",
"unControllerDeviceIndex",
",",
"unControllerStateSize",
"=",
"sizeof",
"(",
"VRControllerState_t",
")",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getControllerStateWithPose",
"pControllerState",
"=",
"VRControllerState_t",
"(",
")",
"pTrackedDevicePose",
"=",
"TrackedDevicePose_t",
"(",
")",
"result",
"=",
"fn",
"(",
"eOrigin",
",",
"unControllerDeviceIndex",
",",
"byref",
"(",
"pControllerState",
")",
",",
"unControllerStateSize",
",",
"byref",
"(",
"pTrackedDevicePose",
")",
")",
"return",
"result",
",",
"pControllerState",
",",
"pTrackedDevicePose"
] |
fills the supplied struct with the current state of the controller and the provided pose with the pose of
the controller when the controller state was updated most recently. Use this form if you need a precise controller
pose as input to your application when the user presses or releases a button. This function is deprecated in favor of the new IVRInput system.
|
[
"fills",
"the",
"supplied",
"struct",
"with",
"the",
"current",
"state",
"of",
"the",
"controller",
"and",
"the",
"provided",
"pose",
"with",
"the",
"pose",
"of",
"the",
"controller",
"when",
"the",
"controller",
"state",
"was",
"updated",
"most",
"recently",
".",
"Use",
"this",
"form",
"if",
"you",
"need",
"a",
"precise",
"controller",
"pose",
"as",
"input",
"to",
"your",
"application",
"when",
"the",
"user",
"presses",
"or",
"releases",
"a",
"button",
".",
"This",
"function",
"is",
"deprecated",
"in",
"favor",
"of",
"the",
"new",
"IVRInput",
"system",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3029-L3040
|
15,602
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.triggerHapticPulse
|
def triggerHapticPulse(self, unControllerDeviceIndex, unAxisId, usDurationMicroSec):
"""
Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller
and axis combination for 5ms. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.triggerHapticPulse
fn(unControllerDeviceIndex, unAxisId, usDurationMicroSec)
|
python
|
def triggerHapticPulse(self, unControllerDeviceIndex, unAxisId, usDurationMicroSec):
"""
Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller
and axis combination for 5ms. This function is deprecated in favor of the new IVRInput system.
"""
fn = self.function_table.triggerHapticPulse
fn(unControllerDeviceIndex, unAxisId, usDurationMicroSec)
|
[
"def",
"triggerHapticPulse",
"(",
"self",
",",
"unControllerDeviceIndex",
",",
"unAxisId",
",",
"usDurationMicroSec",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"triggerHapticPulse",
"fn",
"(",
"unControllerDeviceIndex",
",",
"unAxisId",
",",
"usDurationMicroSec",
")"
] |
Trigger a single haptic pulse on a controller. After this call the application may not trigger another haptic pulse on this controller
and axis combination for 5ms. This function is deprecated in favor of the new IVRInput system.
|
[
"Trigger",
"a",
"single",
"haptic",
"pulse",
"on",
"a",
"controller",
".",
"After",
"this",
"call",
"the",
"application",
"may",
"not",
"trigger",
"another",
"haptic",
"pulse",
"on",
"this",
"controller",
"and",
"axis",
"combination",
"for",
"5ms",
".",
"This",
"function",
"is",
"deprecated",
"in",
"favor",
"of",
"the",
"new",
"IVRInput",
"system",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3042-L3049
|
15,603
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.getButtonIdNameFromEnum
|
def getButtonIdNameFromEnum(self, eButtonId):
"""returns the name of an EVRButtonId enum value. This function is deprecated in favor of the new IVRInput system."""
fn = self.function_table.getButtonIdNameFromEnum
result = fn(eButtonId)
return result
|
python
|
def getButtonIdNameFromEnum(self, eButtonId):
"""returns the name of an EVRButtonId enum value. This function is deprecated in favor of the new IVRInput system."""
fn = self.function_table.getButtonIdNameFromEnum
result = fn(eButtonId)
return result
|
[
"def",
"getButtonIdNameFromEnum",
"(",
"self",
",",
"eButtonId",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getButtonIdNameFromEnum",
"result",
"=",
"fn",
"(",
"eButtonId",
")",
"return",
"result"
] |
returns the name of an EVRButtonId enum value. This function is deprecated in favor of the new IVRInput system.
|
[
"returns",
"the",
"name",
"of",
"an",
"EVRButtonId",
"enum",
"value",
".",
"This",
"function",
"is",
"deprecated",
"in",
"favor",
"of",
"the",
"new",
"IVRInput",
"system",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3051-L3056
|
15,604
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.getControllerAxisTypeNameFromEnum
|
def getControllerAxisTypeNameFromEnum(self, eAxisType):
"""returns the name of an EVRControllerAxisType enum value. This function is deprecated in favor of the new IVRInput system."""
fn = self.function_table.getControllerAxisTypeNameFromEnum
result = fn(eAxisType)
return result
|
python
|
def getControllerAxisTypeNameFromEnum(self, eAxisType):
"""returns the name of an EVRControllerAxisType enum value. This function is deprecated in favor of the new IVRInput system."""
fn = self.function_table.getControllerAxisTypeNameFromEnum
result = fn(eAxisType)
return result
|
[
"def",
"getControllerAxisTypeNameFromEnum",
"(",
"self",
",",
"eAxisType",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getControllerAxisTypeNameFromEnum",
"result",
"=",
"fn",
"(",
"eAxisType",
")",
"return",
"result"
] |
returns the name of an EVRControllerAxisType enum value. This function is deprecated in favor of the new IVRInput system.
|
[
"returns",
"the",
"name",
"of",
"an",
"EVRControllerAxisType",
"enum",
"value",
".",
"This",
"function",
"is",
"deprecated",
"in",
"favor",
"of",
"the",
"new",
"IVRInput",
"system",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3058-L3063
|
15,605
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRSystem.driverDebugRequest
|
def driverDebugRequest(self, unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize):
"""
Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k,
but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated.
The size of the response including its terminating null is returned.
"""
fn = self.function_table.driverDebugRequest
result = fn(unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize)
return result
|
python
|
def driverDebugRequest(self, unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize):
"""
Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k,
but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated.
The size of the response including its terminating null is returned.
"""
fn = self.function_table.driverDebugRequest
result = fn(unDeviceIndex, pchRequest, pchResponseBuffer, unResponseBufferSize)
return result
|
[
"def",
"driverDebugRequest",
"(",
"self",
",",
"unDeviceIndex",
",",
"pchRequest",
",",
"pchResponseBuffer",
",",
"unResponseBufferSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"driverDebugRequest",
"result",
"=",
"fn",
"(",
"unDeviceIndex",
",",
"pchRequest",
",",
"pchResponseBuffer",
",",
"unResponseBufferSize",
")",
"return",
"result"
] |
Sends a request to the driver for the specified device and returns the response. The maximum response size is 32k,
but this method can be called with a smaller buffer. If the response exceeds the size of the buffer, it is truncated.
The size of the response including its terminating null is returned.
|
[
"Sends",
"a",
"request",
"to",
"the",
"driver",
"for",
"the",
"specified",
"device",
"and",
"returns",
"the",
"response",
".",
"The",
"maximum",
"response",
"size",
"is",
"32k",
"but",
"this",
"method",
"can",
"be",
"called",
"with",
"a",
"smaller",
"buffer",
".",
"If",
"the",
"response",
"exceeds",
"the",
"size",
"of",
"the",
"buffer",
"it",
"is",
"truncated",
".",
"The",
"size",
"of",
"the",
"response",
"including",
"its",
"terminating",
"null",
"is",
"returned",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3105-L3114
|
15,606
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRExtendedDisplay.getWindowBounds
|
def getWindowBounds(self):
"""Size and position that the window needs to be on the VR display."""
fn = self.function_table.getWindowBounds
pnX = c_int32()
pnY = c_int32()
pnWidth = c_uint32()
pnHeight = c_uint32()
fn(byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight))
return pnX.value, pnY.value, pnWidth.value, pnHeight.value
|
python
|
def getWindowBounds(self):
"""Size and position that the window needs to be on the VR display."""
fn = self.function_table.getWindowBounds
pnX = c_int32()
pnY = c_int32()
pnWidth = c_uint32()
pnHeight = c_uint32()
fn(byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight))
return pnX.value, pnY.value, pnWidth.value, pnHeight.value
|
[
"def",
"getWindowBounds",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getWindowBounds",
"pnX",
"=",
"c_int32",
"(",
")",
"pnY",
"=",
"c_int32",
"(",
")",
"pnWidth",
"=",
"c_uint32",
"(",
")",
"pnHeight",
"=",
"c_uint32",
"(",
")",
"fn",
"(",
"byref",
"(",
"pnX",
")",
",",
"byref",
"(",
"pnY",
")",
",",
"byref",
"(",
"pnWidth",
")",
",",
"byref",
"(",
"pnHeight",
")",
")",
"return",
"pnX",
".",
"value",
",",
"pnY",
".",
"value",
",",
"pnWidth",
".",
"value",
",",
"pnHeight",
".",
"value"
] |
Size and position that the window needs to be on the VR display.
|
[
"Size",
"and",
"position",
"that",
"the",
"window",
"needs",
"to",
"be",
"on",
"the",
"VR",
"display",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3176-L3185
|
15,607
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRExtendedDisplay.getEyeOutputViewport
|
def getEyeOutputViewport(self, eEye):
"""Gets the viewport in the frame buffer to draw the output of the distortion into"""
fn = self.function_table.getEyeOutputViewport
pnX = c_uint32()
pnY = c_uint32()
pnWidth = c_uint32()
pnHeight = c_uint32()
fn(eEye, byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight))
return pnX.value, pnY.value, pnWidth.value, pnHeight.value
|
python
|
def getEyeOutputViewport(self, eEye):
"""Gets the viewport in the frame buffer to draw the output of the distortion into"""
fn = self.function_table.getEyeOutputViewport
pnX = c_uint32()
pnY = c_uint32()
pnWidth = c_uint32()
pnHeight = c_uint32()
fn(eEye, byref(pnX), byref(pnY), byref(pnWidth), byref(pnHeight))
return pnX.value, pnY.value, pnWidth.value, pnHeight.value
|
[
"def",
"getEyeOutputViewport",
"(",
"self",
",",
"eEye",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getEyeOutputViewport",
"pnX",
"=",
"c_uint32",
"(",
")",
"pnY",
"=",
"c_uint32",
"(",
")",
"pnWidth",
"=",
"c_uint32",
"(",
")",
"pnHeight",
"=",
"c_uint32",
"(",
")",
"fn",
"(",
"eEye",
",",
"byref",
"(",
"pnX",
")",
",",
"byref",
"(",
"pnY",
")",
",",
"byref",
"(",
"pnWidth",
")",
",",
"byref",
"(",
"pnHeight",
")",
")",
"return",
"pnX",
".",
"value",
",",
"pnY",
".",
"value",
",",
"pnWidth",
".",
"value",
",",
"pnHeight",
".",
"value"
] |
Gets the viewport in the frame buffer to draw the output of the distortion into
|
[
"Gets",
"the",
"viewport",
"in",
"the",
"frame",
"buffer",
"to",
"draw",
"the",
"output",
"of",
"the",
"distortion",
"into"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3187-L3196
|
15,608
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRTrackedCamera.getCameraErrorNameFromEnum
|
def getCameraErrorNameFromEnum(self, eCameraError):
"""Returns a string for an error"""
fn = self.function_table.getCameraErrorNameFromEnum
result = fn(eCameraError)
return result
|
python
|
def getCameraErrorNameFromEnum(self, eCameraError):
"""Returns a string for an error"""
fn = self.function_table.getCameraErrorNameFromEnum
result = fn(eCameraError)
return result
|
[
"def",
"getCameraErrorNameFromEnum",
"(",
"self",
",",
"eCameraError",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getCameraErrorNameFromEnum",
"result",
"=",
"fn",
"(",
"eCameraError",
")",
"return",
"result"
] |
Returns a string for an error
|
[
"Returns",
"a",
"string",
"for",
"an",
"error"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3243-L3248
|
15,609
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRTrackedCamera.hasCamera
|
def hasCamera(self, nDeviceIndex):
"""For convenience, same as tracked property request Prop_HasCamera_Bool"""
fn = self.function_table.hasCamera
pHasCamera = openvr_bool()
result = fn(nDeviceIndex, byref(pHasCamera))
return result, pHasCamera
|
python
|
def hasCamera(self, nDeviceIndex):
"""For convenience, same as tracked property request Prop_HasCamera_Bool"""
fn = self.function_table.hasCamera
pHasCamera = openvr_bool()
result = fn(nDeviceIndex, byref(pHasCamera))
return result, pHasCamera
|
[
"def",
"hasCamera",
"(",
"self",
",",
"nDeviceIndex",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"hasCamera",
"pHasCamera",
"=",
"openvr_bool",
"(",
")",
"result",
"=",
"fn",
"(",
"nDeviceIndex",
",",
"byref",
"(",
"pHasCamera",
")",
")",
"return",
"result",
",",
"pHasCamera"
] |
For convenience, same as tracked property request Prop_HasCamera_Bool
|
[
"For",
"convenience",
"same",
"as",
"tracked",
"property",
"request",
"Prop_HasCamera_Bool"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3250-L3256
|
15,610
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRTrackedCamera.acquireVideoStreamingService
|
def acquireVideoStreamingService(self, nDeviceIndex):
"""
Acquiring streaming service permits video streaming for the caller. Releasing hints the system that video services do not need to be maintained for this client.
If the camera has not already been activated, a one time spin up may incur some auto exposure as well as initial streaming frame delays.
The camera should be considered a global resource accessible for shared consumption but not exclusive to any caller.
The camera may go inactive due to lack of active consumers or headset idleness.
"""
fn = self.function_table.acquireVideoStreamingService
pHandle = TrackedCameraHandle_t()
result = fn(nDeviceIndex, byref(pHandle))
return result, pHandle
|
python
|
def acquireVideoStreamingService(self, nDeviceIndex):
"""
Acquiring streaming service permits video streaming for the caller. Releasing hints the system that video services do not need to be maintained for this client.
If the camera has not already been activated, a one time spin up may incur some auto exposure as well as initial streaming frame delays.
The camera should be considered a global resource accessible for shared consumption but not exclusive to any caller.
The camera may go inactive due to lack of active consumers or headset idleness.
"""
fn = self.function_table.acquireVideoStreamingService
pHandle = TrackedCameraHandle_t()
result = fn(nDeviceIndex, byref(pHandle))
return result, pHandle
|
[
"def",
"acquireVideoStreamingService",
"(",
"self",
",",
"nDeviceIndex",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"acquireVideoStreamingService",
"pHandle",
"=",
"TrackedCameraHandle_t",
"(",
")",
"result",
"=",
"fn",
"(",
"nDeviceIndex",
",",
"byref",
"(",
"pHandle",
")",
")",
"return",
"result",
",",
"pHandle"
] |
Acquiring streaming service permits video streaming for the caller. Releasing hints the system that video services do not need to be maintained for this client.
If the camera has not already been activated, a one time spin up may incur some auto exposure as well as initial streaming frame delays.
The camera should be considered a global resource accessible for shared consumption but not exclusive to any caller.
The camera may go inactive due to lack of active consumers or headset idleness.
|
[
"Acquiring",
"streaming",
"service",
"permits",
"video",
"streaming",
"for",
"the",
"caller",
".",
"Releasing",
"hints",
"the",
"system",
"that",
"video",
"services",
"do",
"not",
"need",
"to",
"be",
"maintained",
"for",
"this",
"client",
".",
"If",
"the",
"camera",
"has",
"not",
"already",
"been",
"activated",
"a",
"one",
"time",
"spin",
"up",
"may",
"incur",
"some",
"auto",
"exposure",
"as",
"well",
"as",
"initial",
"streaming",
"frame",
"delays",
".",
"The",
"camera",
"should",
"be",
"considered",
"a",
"global",
"resource",
"accessible",
"for",
"shared",
"consumption",
"but",
"not",
"exclusive",
"to",
"any",
"caller",
".",
"The",
"camera",
"may",
"go",
"inactive",
"due",
"to",
"lack",
"of",
"active",
"consumers",
"or",
"headset",
"idleness",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3281-L3292
|
15,611
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRTrackedCamera.getVideoStreamFrameBuffer
|
def getVideoStreamFrameBuffer(self, hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, nFrameHeaderSize):
"""
Copies the image frame into a caller's provided buffer. The image data is currently provided as RGBA data, 4 bytes per pixel.
A caller can provide null for the framebuffer or frameheader if not desired. Requesting the frame header first, followed by the frame buffer allows
the caller to determine if the frame as advanced per the frame header sequence.
If there is no frame available yet, due to initial camera spinup or re-activation, the error will be VRTrackedCameraError_NoFrameAvailable.
Ideally a caller should be polling at ~16ms intervals
"""
fn = self.function_table.getVideoStreamFrameBuffer
pFrameHeader = CameraVideoStreamFrameHeader_t()
result = fn(hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, byref(pFrameHeader), nFrameHeaderSize)
return result, pFrameHeader
|
python
|
def getVideoStreamFrameBuffer(self, hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, nFrameHeaderSize):
"""
Copies the image frame into a caller's provided buffer. The image data is currently provided as RGBA data, 4 bytes per pixel.
A caller can provide null for the framebuffer or frameheader if not desired. Requesting the frame header first, followed by the frame buffer allows
the caller to determine if the frame as advanced per the frame header sequence.
If there is no frame available yet, due to initial camera spinup or re-activation, the error will be VRTrackedCameraError_NoFrameAvailable.
Ideally a caller should be polling at ~16ms intervals
"""
fn = self.function_table.getVideoStreamFrameBuffer
pFrameHeader = CameraVideoStreamFrameHeader_t()
result = fn(hTrackedCamera, eFrameType, pFrameBuffer, nFrameBufferSize, byref(pFrameHeader), nFrameHeaderSize)
return result, pFrameHeader
|
[
"def",
"getVideoStreamFrameBuffer",
"(",
"self",
",",
"hTrackedCamera",
",",
"eFrameType",
",",
"pFrameBuffer",
",",
"nFrameBufferSize",
",",
"nFrameHeaderSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getVideoStreamFrameBuffer",
"pFrameHeader",
"=",
"CameraVideoStreamFrameHeader_t",
"(",
")",
"result",
"=",
"fn",
"(",
"hTrackedCamera",
",",
"eFrameType",
",",
"pFrameBuffer",
",",
"nFrameBufferSize",
",",
"byref",
"(",
"pFrameHeader",
")",
",",
"nFrameHeaderSize",
")",
"return",
"result",
",",
"pFrameHeader"
] |
Copies the image frame into a caller's provided buffer. The image data is currently provided as RGBA data, 4 bytes per pixel.
A caller can provide null for the framebuffer or frameheader if not desired. Requesting the frame header first, followed by the frame buffer allows
the caller to determine if the frame as advanced per the frame header sequence.
If there is no frame available yet, due to initial camera spinup or re-activation, the error will be VRTrackedCameraError_NoFrameAvailable.
Ideally a caller should be polling at ~16ms intervals
|
[
"Copies",
"the",
"image",
"frame",
"into",
"a",
"caller",
"s",
"provided",
"buffer",
".",
"The",
"image",
"data",
"is",
"currently",
"provided",
"as",
"RGBA",
"data",
"4",
"bytes",
"per",
"pixel",
".",
"A",
"caller",
"can",
"provide",
"null",
"for",
"the",
"framebuffer",
"or",
"frameheader",
"if",
"not",
"desired",
".",
"Requesting",
"the",
"frame",
"header",
"first",
"followed",
"by",
"the",
"frame",
"buffer",
"allows",
"the",
"caller",
"to",
"determine",
"if",
"the",
"frame",
"as",
"advanced",
"per",
"the",
"frame",
"header",
"sequence",
".",
"If",
"there",
"is",
"no",
"frame",
"available",
"yet",
"due",
"to",
"initial",
"camera",
"spinup",
"or",
"re",
"-",
"activation",
"the",
"error",
"will",
"be",
"VRTrackedCameraError_NoFrameAvailable",
".",
"Ideally",
"a",
"caller",
"should",
"be",
"polling",
"at",
"~16ms",
"intervals"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3299-L3311
|
15,612
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRTrackedCamera.getVideoStreamTextureGL
|
def getVideoStreamTextureGL(self, hTrackedCamera, eFrameType, nFrameHeaderSize):
"""Access a shared GL texture for the specified tracked camera stream"""
fn = self.function_table.getVideoStreamTextureGL
pglTextureId = glUInt_t()
pFrameHeader = CameraVideoStreamFrameHeader_t()
result = fn(hTrackedCamera, eFrameType, byref(pglTextureId), byref(pFrameHeader), nFrameHeaderSize)
return result, pglTextureId, pFrameHeader
|
python
|
def getVideoStreamTextureGL(self, hTrackedCamera, eFrameType, nFrameHeaderSize):
"""Access a shared GL texture for the specified tracked camera stream"""
fn = self.function_table.getVideoStreamTextureGL
pglTextureId = glUInt_t()
pFrameHeader = CameraVideoStreamFrameHeader_t()
result = fn(hTrackedCamera, eFrameType, byref(pglTextureId), byref(pFrameHeader), nFrameHeaderSize)
return result, pglTextureId, pFrameHeader
|
[
"def",
"getVideoStreamTextureGL",
"(",
"self",
",",
"hTrackedCamera",
",",
"eFrameType",
",",
"nFrameHeaderSize",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getVideoStreamTextureGL",
"pglTextureId",
"=",
"glUInt_t",
"(",
")",
"pFrameHeader",
"=",
"CameraVideoStreamFrameHeader_t",
"(",
")",
"result",
"=",
"fn",
"(",
"hTrackedCamera",
",",
"eFrameType",
",",
"byref",
"(",
"pglTextureId",
")",
",",
"byref",
"(",
"pFrameHeader",
")",
",",
"nFrameHeaderSize",
")",
"return",
"result",
",",
"pglTextureId",
",",
"pFrameHeader"
] |
Access a shared GL texture for the specified tracked camera stream
|
[
"Access",
"a",
"shared",
"GL",
"texture",
"for",
"the",
"specified",
"tracked",
"camera",
"stream"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3339-L3346
|
15,613
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.addApplicationManifest
|
def addApplicationManifest(self, pchApplicationManifestFullPath, bTemporary):
"""
Adds an application manifest to the list to load when building the list of installed applications.
Temporary manifests are not automatically loaded
"""
fn = self.function_table.addApplicationManifest
result = fn(pchApplicationManifestFullPath, bTemporary)
return result
|
python
|
def addApplicationManifest(self, pchApplicationManifestFullPath, bTemporary):
"""
Adds an application manifest to the list to load when building the list of installed applications.
Temporary manifests are not automatically loaded
"""
fn = self.function_table.addApplicationManifest
result = fn(pchApplicationManifestFullPath, bTemporary)
return result
|
[
"def",
"addApplicationManifest",
"(",
"self",
",",
"pchApplicationManifestFullPath",
",",
"bTemporary",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"addApplicationManifest",
"result",
"=",
"fn",
"(",
"pchApplicationManifestFullPath",
",",
"bTemporary",
")",
"return",
"result"
] |
Adds an application manifest to the list to load when building the list of installed applications.
Temporary manifests are not automatically loaded
|
[
"Adds",
"an",
"application",
"manifest",
"to",
"the",
"list",
"to",
"load",
"when",
"building",
"the",
"list",
"of",
"installed",
"applications",
".",
"Temporary",
"manifests",
"are",
"not",
"automatically",
"loaded"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3404-L3412
|
15,614
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.removeApplicationManifest
|
def removeApplicationManifest(self, pchApplicationManifestFullPath):
"""Removes an application manifest from the list to load when building the list of installed applications."""
fn = self.function_table.removeApplicationManifest
result = fn(pchApplicationManifestFullPath)
return result
|
python
|
def removeApplicationManifest(self, pchApplicationManifestFullPath):
"""Removes an application manifest from the list to load when building the list of installed applications."""
fn = self.function_table.removeApplicationManifest
result = fn(pchApplicationManifestFullPath)
return result
|
[
"def",
"removeApplicationManifest",
"(",
"self",
",",
"pchApplicationManifestFullPath",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"removeApplicationManifest",
"result",
"=",
"fn",
"(",
"pchApplicationManifestFullPath",
")",
"return",
"result"
] |
Removes an application manifest from the list to load when building the list of installed applications.
|
[
"Removes",
"an",
"application",
"manifest",
"from",
"the",
"list",
"to",
"load",
"when",
"building",
"the",
"list",
"of",
"installed",
"applications",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3414-L3419
|
15,615
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.isApplicationInstalled
|
def isApplicationInstalled(self, pchAppKey):
"""Returns true if an application is installed"""
fn = self.function_table.isApplicationInstalled
result = fn(pchAppKey)
return result
|
python
|
def isApplicationInstalled(self, pchAppKey):
"""Returns true if an application is installed"""
fn = self.function_table.isApplicationInstalled
result = fn(pchAppKey)
return result
|
[
"def",
"isApplicationInstalled",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"isApplicationInstalled",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Returns true if an application is installed
|
[
"Returns",
"true",
"if",
"an",
"application",
"is",
"installed"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3421-L3426
|
15,616
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationKeyByProcessId
|
def getApplicationKeyByProcessId(self, unProcessId, pchAppKeyBuffer, unAppKeyBufferLen):
"""
Returns the key of the application for the specified Process Id. The buffer should be at least
k_unMaxApplicationKeyLength in order to fit the key.
"""
fn = self.function_table.getApplicationKeyByProcessId
result = fn(unProcessId, pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
python
|
def getApplicationKeyByProcessId(self, unProcessId, pchAppKeyBuffer, unAppKeyBufferLen):
"""
Returns the key of the application for the specified Process Id. The buffer should be at least
k_unMaxApplicationKeyLength in order to fit the key.
"""
fn = self.function_table.getApplicationKeyByProcessId
result = fn(unProcessId, pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
[
"def",
"getApplicationKeyByProcessId",
"(",
"self",
",",
"unProcessId",
",",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationKeyByProcessId",
"result",
"=",
"fn",
"(",
"unProcessId",
",",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
"return",
"result"
] |
Returns the key of the application for the specified Process Id. The buffer should be at least
k_unMaxApplicationKeyLength in order to fit the key.
|
[
"Returns",
"the",
"key",
"of",
"the",
"application",
"for",
"the",
"specified",
"Process",
"Id",
".",
"The",
"buffer",
"should",
"be",
"at",
"least",
"k_unMaxApplicationKeyLength",
"in",
"order",
"to",
"fit",
"the",
"key",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3446-L3454
|
15,617
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.launchApplication
|
def launchApplication(self, pchAppKey):
"""
Launches the application. The existing scene application will exit and then the new application will start.
This call is not valid for dashboard overlay applications.
"""
fn = self.function_table.launchApplication
result = fn(pchAppKey)
return result
|
python
|
def launchApplication(self, pchAppKey):
"""
Launches the application. The existing scene application will exit and then the new application will start.
This call is not valid for dashboard overlay applications.
"""
fn = self.function_table.launchApplication
result = fn(pchAppKey)
return result
|
[
"def",
"launchApplication",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"launchApplication",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Launches the application. The existing scene application will exit and then the new application will start.
This call is not valid for dashboard overlay applications.
|
[
"Launches",
"the",
"application",
".",
"The",
"existing",
"scene",
"application",
"will",
"exit",
"and",
"then",
"the",
"new",
"application",
"will",
"start",
".",
"This",
"call",
"is",
"not",
"valid",
"for",
"dashboard",
"overlay",
"applications",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3456-L3464
|
15,618
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.launchApplicationFromMimeType
|
def launchApplicationFromMimeType(self, pchMimeType, pchArgs):
"""launches the application currently associated with this mime type and passes it the option args, typically the filename or object name of the item being launched"""
fn = self.function_table.launchApplicationFromMimeType
result = fn(pchMimeType, pchArgs)
return result
|
python
|
def launchApplicationFromMimeType(self, pchMimeType, pchArgs):
"""launches the application currently associated with this mime type and passes it the option args, typically the filename or object name of the item being launched"""
fn = self.function_table.launchApplicationFromMimeType
result = fn(pchMimeType, pchArgs)
return result
|
[
"def",
"launchApplicationFromMimeType",
"(",
"self",
",",
"pchMimeType",
",",
"pchArgs",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"launchApplicationFromMimeType",
"result",
"=",
"fn",
"(",
"pchMimeType",
",",
"pchArgs",
")",
"return",
"result"
] |
launches the application currently associated with this mime type and passes it the option args, typically the filename or object name of the item being launched
|
[
"launches",
"the",
"application",
"currently",
"associated",
"with",
"this",
"mime",
"type",
"and",
"passes",
"it",
"the",
"option",
"args",
"typically",
"the",
"filename",
"or",
"object",
"name",
"of",
"the",
"item",
"being",
"launched"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3477-L3482
|
15,619
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.launchDashboardOverlay
|
def launchDashboardOverlay(self, pchAppKey):
"""
Launches the dashboard overlay application if it is not already running. This call is only valid for
dashboard overlay applications.
"""
fn = self.function_table.launchDashboardOverlay
result = fn(pchAppKey)
return result
|
python
|
def launchDashboardOverlay(self, pchAppKey):
"""
Launches the dashboard overlay application if it is not already running. This call is only valid for
dashboard overlay applications.
"""
fn = self.function_table.launchDashboardOverlay
result = fn(pchAppKey)
return result
|
[
"def",
"launchDashboardOverlay",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"launchDashboardOverlay",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Launches the dashboard overlay application if it is not already running. This call is only valid for
dashboard overlay applications.
|
[
"Launches",
"the",
"dashboard",
"overlay",
"application",
"if",
"it",
"is",
"not",
"already",
"running",
".",
"This",
"call",
"is",
"only",
"valid",
"for",
"dashboard",
"overlay",
"applications",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3484-L3492
|
15,620
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.cancelApplicationLaunch
|
def cancelApplicationLaunch(self, pchAppKey):
"""Cancel a pending launch for an application"""
fn = self.function_table.cancelApplicationLaunch
result = fn(pchAppKey)
return result
|
python
|
def cancelApplicationLaunch(self, pchAppKey):
"""Cancel a pending launch for an application"""
fn = self.function_table.cancelApplicationLaunch
result = fn(pchAppKey)
return result
|
[
"def",
"cancelApplicationLaunch",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"cancelApplicationLaunch",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Cancel a pending launch for an application
|
[
"Cancel",
"a",
"pending",
"launch",
"for",
"an",
"application"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3494-L3499
|
15,621
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationProcessId
|
def getApplicationProcessId(self, pchAppKey):
"""Returns the process ID for an application. Return 0 if the application was not found or is not running."""
fn = self.function_table.getApplicationProcessId
result = fn(pchAppKey)
return result
|
python
|
def getApplicationProcessId(self, pchAppKey):
"""Returns the process ID for an application. Return 0 if the application was not found or is not running."""
fn = self.function_table.getApplicationProcessId
result = fn(pchAppKey)
return result
|
[
"def",
"getApplicationProcessId",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationProcessId",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Returns the process ID for an application. Return 0 if the application was not found or is not running.
|
[
"Returns",
"the",
"process",
"ID",
"for",
"an",
"application",
".",
"Return",
"0",
"if",
"the",
"application",
"was",
"not",
"found",
"or",
"is",
"not",
"running",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3513-L3518
|
15,622
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationsErrorNameFromEnum
|
def getApplicationsErrorNameFromEnum(self, error):
"""Returns a string for an applications error"""
fn = self.function_table.getApplicationsErrorNameFromEnum
result = fn(error)
return result
|
python
|
def getApplicationsErrorNameFromEnum(self, error):
"""Returns a string for an applications error"""
fn = self.function_table.getApplicationsErrorNameFromEnum
result = fn(error)
return result
|
[
"def",
"getApplicationsErrorNameFromEnum",
"(",
"self",
",",
"error",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationsErrorNameFromEnum",
"result",
"=",
"fn",
"(",
"error",
")",
"return",
"result"
] |
Returns a string for an applications error
|
[
"Returns",
"a",
"string",
"for",
"an",
"applications",
"error"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3520-L3525
|
15,623
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationPropertyString
|
def getApplicationPropertyString(self, pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen):
"""Returns a value for an application property. The required buffer size to fit this value will be returned."""
fn = self.function_table.getApplicationPropertyString
peError = EVRApplicationError()
result = fn(pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen, byref(peError))
return result, peError
|
python
|
def getApplicationPropertyString(self, pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen):
"""Returns a value for an application property. The required buffer size to fit this value will be returned."""
fn = self.function_table.getApplicationPropertyString
peError = EVRApplicationError()
result = fn(pchAppKey, eProperty, pchPropertyValueBuffer, unPropertyValueBufferLen, byref(peError))
return result, peError
|
[
"def",
"getApplicationPropertyString",
"(",
"self",
",",
"pchAppKey",
",",
"eProperty",
",",
"pchPropertyValueBuffer",
",",
"unPropertyValueBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationPropertyString",
"peError",
"=",
"EVRApplicationError",
"(",
")",
"result",
"=",
"fn",
"(",
"pchAppKey",
",",
"eProperty",
",",
"pchPropertyValueBuffer",
",",
"unPropertyValueBufferLen",
",",
"byref",
"(",
"peError",
")",
")",
"return",
"result",
",",
"peError"
] |
Returns a value for an application property. The required buffer size to fit this value will be returned.
|
[
"Returns",
"a",
"value",
"for",
"an",
"application",
"property",
".",
"The",
"required",
"buffer",
"size",
"to",
"fit",
"this",
"value",
"will",
"be",
"returned",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3527-L3533
|
15,624
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationPropertyBool
|
def getApplicationPropertyBool(self, pchAppKey, eProperty):
"""Returns a bool value for an application property. Returns false in all error cases."""
fn = self.function_table.getApplicationPropertyBool
peError = EVRApplicationError()
result = fn(pchAppKey, eProperty, byref(peError))
return result, peError
|
python
|
def getApplicationPropertyBool(self, pchAppKey, eProperty):
"""Returns a bool value for an application property. Returns false in all error cases."""
fn = self.function_table.getApplicationPropertyBool
peError = EVRApplicationError()
result = fn(pchAppKey, eProperty, byref(peError))
return result, peError
|
[
"def",
"getApplicationPropertyBool",
"(",
"self",
",",
"pchAppKey",
",",
"eProperty",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationPropertyBool",
"peError",
"=",
"EVRApplicationError",
"(",
")",
"result",
"=",
"fn",
"(",
"pchAppKey",
",",
"eProperty",
",",
"byref",
"(",
"peError",
")",
")",
"return",
"result",
",",
"peError"
] |
Returns a bool value for an application property. Returns false in all error cases.
|
[
"Returns",
"a",
"bool",
"value",
"for",
"an",
"application",
"property",
".",
"Returns",
"false",
"in",
"all",
"error",
"cases",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3535-L3541
|
15,625
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.setApplicationAutoLaunch
|
def setApplicationAutoLaunch(self, pchAppKey, bAutoLaunch):
"""Sets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool."""
fn = self.function_table.setApplicationAutoLaunch
result = fn(pchAppKey, bAutoLaunch)
return result
|
python
|
def setApplicationAutoLaunch(self, pchAppKey, bAutoLaunch):
"""Sets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool."""
fn = self.function_table.setApplicationAutoLaunch
result = fn(pchAppKey, bAutoLaunch)
return result
|
[
"def",
"setApplicationAutoLaunch",
"(",
"self",
",",
"pchAppKey",
",",
"bAutoLaunch",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setApplicationAutoLaunch",
"result",
"=",
"fn",
"(",
"pchAppKey",
",",
"bAutoLaunch",
")",
"return",
"result"
] |
Sets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool.
|
[
"Sets",
"the",
"application",
"auto",
"-",
"launch",
"flag",
".",
"This",
"is",
"only",
"valid",
"for",
"applications",
"which",
"return",
"true",
"for",
"VRApplicationProperty_IsDashboardOverlay_Bool",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3551-L3556
|
15,626
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationAutoLaunch
|
def getApplicationAutoLaunch(self, pchAppKey):
"""Gets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool."""
fn = self.function_table.getApplicationAutoLaunch
result = fn(pchAppKey)
return result
|
python
|
def getApplicationAutoLaunch(self, pchAppKey):
"""Gets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool."""
fn = self.function_table.getApplicationAutoLaunch
result = fn(pchAppKey)
return result
|
[
"def",
"getApplicationAutoLaunch",
"(",
"self",
",",
"pchAppKey",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationAutoLaunch",
"result",
"=",
"fn",
"(",
"pchAppKey",
")",
"return",
"result"
] |
Gets the application auto-launch flag. This is only valid for applications which return true for VRApplicationProperty_IsDashboardOverlay_Bool.
|
[
"Gets",
"the",
"application",
"auto",
"-",
"launch",
"flag",
".",
"This",
"is",
"only",
"valid",
"for",
"applications",
"which",
"return",
"true",
"for",
"VRApplicationProperty_IsDashboardOverlay_Bool",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3558-L3563
|
15,627
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.setDefaultApplicationForMimeType
|
def setDefaultApplicationForMimeType(self, pchAppKey, pchMimeType):
"""Adds this mime-type to the list of supported mime types for this application"""
fn = self.function_table.setDefaultApplicationForMimeType
result = fn(pchAppKey, pchMimeType)
return result
|
python
|
def setDefaultApplicationForMimeType(self, pchAppKey, pchMimeType):
"""Adds this mime-type to the list of supported mime types for this application"""
fn = self.function_table.setDefaultApplicationForMimeType
result = fn(pchAppKey, pchMimeType)
return result
|
[
"def",
"setDefaultApplicationForMimeType",
"(",
"self",
",",
"pchAppKey",
",",
"pchMimeType",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setDefaultApplicationForMimeType",
"result",
"=",
"fn",
"(",
"pchAppKey",
",",
"pchMimeType",
")",
"return",
"result"
] |
Adds this mime-type to the list of supported mime types for this application
|
[
"Adds",
"this",
"mime",
"-",
"type",
"to",
"the",
"list",
"of",
"supported",
"mime",
"types",
"for",
"this",
"application"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3565-L3570
|
15,628
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getDefaultApplicationForMimeType
|
def getDefaultApplicationForMimeType(self, pchMimeType, pchAppKeyBuffer, unAppKeyBufferLen):
"""return the app key that will open this mime type"""
fn = self.function_table.getDefaultApplicationForMimeType
result = fn(pchMimeType, pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
python
|
def getDefaultApplicationForMimeType(self, pchMimeType, pchAppKeyBuffer, unAppKeyBufferLen):
"""return the app key that will open this mime type"""
fn = self.function_table.getDefaultApplicationForMimeType
result = fn(pchMimeType, pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
[
"def",
"getDefaultApplicationForMimeType",
"(",
"self",
",",
"pchMimeType",
",",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getDefaultApplicationForMimeType",
"result",
"=",
"fn",
"(",
"pchMimeType",
",",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
"return",
"result"
] |
return the app key that will open this mime type
|
[
"return",
"the",
"app",
"key",
"that",
"will",
"open",
"this",
"mime",
"type"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3572-L3577
|
15,629
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationSupportedMimeTypes
|
def getApplicationSupportedMimeTypes(self, pchAppKey, pchMimeTypesBuffer, unMimeTypesBuffer):
"""Get the list of supported mime types for this application, comma-delimited"""
fn = self.function_table.getApplicationSupportedMimeTypes
result = fn(pchAppKey, pchMimeTypesBuffer, unMimeTypesBuffer)
return result
|
python
|
def getApplicationSupportedMimeTypes(self, pchAppKey, pchMimeTypesBuffer, unMimeTypesBuffer):
"""Get the list of supported mime types for this application, comma-delimited"""
fn = self.function_table.getApplicationSupportedMimeTypes
result = fn(pchAppKey, pchMimeTypesBuffer, unMimeTypesBuffer)
return result
|
[
"def",
"getApplicationSupportedMimeTypes",
"(",
"self",
",",
"pchAppKey",
",",
"pchMimeTypesBuffer",
",",
"unMimeTypesBuffer",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationSupportedMimeTypes",
"result",
"=",
"fn",
"(",
"pchAppKey",
",",
"pchMimeTypesBuffer",
",",
"unMimeTypesBuffer",
")",
"return",
"result"
] |
Get the list of supported mime types for this application, comma-delimited
|
[
"Get",
"the",
"list",
"of",
"supported",
"mime",
"types",
"for",
"this",
"application",
"comma",
"-",
"delimited"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3579-L3584
|
15,630
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationsThatSupportMimeType
|
def getApplicationsThatSupportMimeType(self, pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer):
"""Get the list of app-keys that support this mime type, comma-delimited, the return value is number of bytes you need to return the full string"""
fn = self.function_table.getApplicationsThatSupportMimeType
result = fn(pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer)
return result
|
python
|
def getApplicationsThatSupportMimeType(self, pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer):
"""Get the list of app-keys that support this mime type, comma-delimited, the return value is number of bytes you need to return the full string"""
fn = self.function_table.getApplicationsThatSupportMimeType
result = fn(pchMimeType, pchAppKeysThatSupportBuffer, unAppKeysThatSupportBuffer)
return result
|
[
"def",
"getApplicationsThatSupportMimeType",
"(",
"self",
",",
"pchMimeType",
",",
"pchAppKeysThatSupportBuffer",
",",
"unAppKeysThatSupportBuffer",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationsThatSupportMimeType",
"result",
"=",
"fn",
"(",
"pchMimeType",
",",
"pchAppKeysThatSupportBuffer",
",",
"unAppKeysThatSupportBuffer",
")",
"return",
"result"
] |
Get the list of app-keys that support this mime type, comma-delimited, the return value is number of bytes you need to return the full string
|
[
"Get",
"the",
"list",
"of",
"app",
"-",
"keys",
"that",
"support",
"this",
"mime",
"type",
"comma",
"-",
"delimited",
"the",
"return",
"value",
"is",
"number",
"of",
"bytes",
"you",
"need",
"to",
"return",
"the",
"full",
"string"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3586-L3591
|
15,631
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationLaunchArguments
|
def getApplicationLaunchArguments(self, unHandle, pchArgs, unArgs):
"""Get the args list from an app launch that had the process already running, you call this when you get a VREvent_ApplicationMimeTypeLoad"""
fn = self.function_table.getApplicationLaunchArguments
result = fn(unHandle, pchArgs, unArgs)
return result
|
python
|
def getApplicationLaunchArguments(self, unHandle, pchArgs, unArgs):
"""Get the args list from an app launch that had the process already running, you call this when you get a VREvent_ApplicationMimeTypeLoad"""
fn = self.function_table.getApplicationLaunchArguments
result = fn(unHandle, pchArgs, unArgs)
return result
|
[
"def",
"getApplicationLaunchArguments",
"(",
"self",
",",
"unHandle",
",",
"pchArgs",
",",
"unArgs",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationLaunchArguments",
"result",
"=",
"fn",
"(",
"unHandle",
",",
"pchArgs",
",",
"unArgs",
")",
"return",
"result"
] |
Get the args list from an app launch that had the process already running, you call this when you get a VREvent_ApplicationMimeTypeLoad
|
[
"Get",
"the",
"args",
"list",
"from",
"an",
"app",
"launch",
"that",
"had",
"the",
"process",
"already",
"running",
"you",
"call",
"this",
"when",
"you",
"get",
"a",
"VREvent_ApplicationMimeTypeLoad"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3593-L3598
|
15,632
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getStartingApplication
|
def getStartingApplication(self, pchAppKeyBuffer, unAppKeyBufferLen):
"""Returns the app key for the application that is starting up"""
fn = self.function_table.getStartingApplication
result = fn(pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
python
|
def getStartingApplication(self, pchAppKeyBuffer, unAppKeyBufferLen):
"""Returns the app key for the application that is starting up"""
fn = self.function_table.getStartingApplication
result = fn(pchAppKeyBuffer, unAppKeyBufferLen)
return result
|
[
"def",
"getStartingApplication",
"(",
"self",
",",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getStartingApplication",
"result",
"=",
"fn",
"(",
"pchAppKeyBuffer",
",",
"unAppKeyBufferLen",
")",
"return",
"result"
] |
Returns the app key for the application that is starting up
|
[
"Returns",
"the",
"app",
"key",
"for",
"the",
"application",
"that",
"is",
"starting",
"up"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3600-L3605
|
15,633
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.getApplicationsTransitionStateNameFromEnum
|
def getApplicationsTransitionStateNameFromEnum(self, state):
"""Returns a string for an application transition state"""
fn = self.function_table.getApplicationsTransitionStateNameFromEnum
result = fn(state)
return result
|
python
|
def getApplicationsTransitionStateNameFromEnum(self, state):
"""Returns a string for an application transition state"""
fn = self.function_table.getApplicationsTransitionStateNameFromEnum
result = fn(state)
return result
|
[
"def",
"getApplicationsTransitionStateNameFromEnum",
"(",
"self",
",",
"state",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getApplicationsTransitionStateNameFromEnum",
"result",
"=",
"fn",
"(",
"state",
")",
"return",
"result"
] |
Returns a string for an application transition state
|
[
"Returns",
"a",
"string",
"for",
"an",
"application",
"transition",
"state"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3630-L3635
|
15,634
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRApplications.launchInternalProcess
|
def launchInternalProcess(self, pchBinaryPath, pchArguments, pchWorkingDirectory):
"""
Starts a subprocess within the calling application. This
suppresses all application transition UI and automatically identifies the new executable
as part of the same application. On success the calling process should exit immediately.
If working directory is NULL or "" the directory portion of the binary path will be
the working directory.
"""
fn = self.function_table.launchInternalProcess
result = fn(pchBinaryPath, pchArguments, pchWorkingDirectory)
return result
|
python
|
def launchInternalProcess(self, pchBinaryPath, pchArguments, pchWorkingDirectory):
"""
Starts a subprocess within the calling application. This
suppresses all application transition UI and automatically identifies the new executable
as part of the same application. On success the calling process should exit immediately.
If working directory is NULL or "" the directory portion of the binary path will be
the working directory.
"""
fn = self.function_table.launchInternalProcess
result = fn(pchBinaryPath, pchArguments, pchWorkingDirectory)
return result
|
[
"def",
"launchInternalProcess",
"(",
"self",
",",
"pchBinaryPath",
",",
"pchArguments",
",",
"pchWorkingDirectory",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"launchInternalProcess",
"result",
"=",
"fn",
"(",
"pchBinaryPath",
",",
"pchArguments",
",",
"pchWorkingDirectory",
")",
"return",
"result"
] |
Starts a subprocess within the calling application. This
suppresses all application transition UI and automatically identifies the new executable
as part of the same application. On success the calling process should exit immediately.
If working directory is NULL or "" the directory portion of the binary path will be
the working directory.
|
[
"Starts",
"a",
"subprocess",
"within",
"the",
"calling",
"application",
".",
"This",
"suppresses",
"all",
"application",
"transition",
"UI",
"and",
"automatically",
"identifies",
"the",
"new",
"executable",
"as",
"part",
"of",
"the",
"same",
"application",
".",
"On",
"success",
"the",
"calling",
"process",
"should",
"exit",
"immediately",
".",
"If",
"working",
"directory",
"is",
"NULL",
"or",
"the",
"directory",
"portion",
"of",
"the",
"binary",
"path",
"will",
"be",
"the",
"working",
"directory",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3644-L3655
|
15,635
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperone.getBoundsColor
|
def getBoundsColor(self, nNumOutputColors, flCollisionBoundsFadeDistance):
"""Get the current chaperone bounds draw color and brightness"""
fn = self.function_table.getBoundsColor
pOutputColorArray = HmdColor_t()
pOutputCameraColor = HmdColor_t()
fn(byref(pOutputColorArray), nNumOutputColors, flCollisionBoundsFadeDistance, byref(pOutputCameraColor))
return pOutputColorArray, pOutputCameraColor
|
python
|
def getBoundsColor(self, nNumOutputColors, flCollisionBoundsFadeDistance):
"""Get the current chaperone bounds draw color and brightness"""
fn = self.function_table.getBoundsColor
pOutputColorArray = HmdColor_t()
pOutputCameraColor = HmdColor_t()
fn(byref(pOutputColorArray), nNumOutputColors, flCollisionBoundsFadeDistance, byref(pOutputCameraColor))
return pOutputColorArray, pOutputCameraColor
|
[
"def",
"getBoundsColor",
"(",
"self",
",",
"nNumOutputColors",
",",
"flCollisionBoundsFadeDistance",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getBoundsColor",
"pOutputColorArray",
"=",
"HmdColor_t",
"(",
")",
"pOutputCameraColor",
"=",
"HmdColor_t",
"(",
")",
"fn",
"(",
"byref",
"(",
"pOutputColorArray",
")",
",",
"nNumOutputColors",
",",
"flCollisionBoundsFadeDistance",
",",
"byref",
"(",
"pOutputCameraColor",
")",
")",
"return",
"pOutputColorArray",
",",
"pOutputCameraColor"
] |
Get the current chaperone bounds draw color and brightness
|
[
"Get",
"the",
"current",
"chaperone",
"bounds",
"draw",
"color",
"and",
"brightness"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3749-L3756
|
15,636
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.commitWorkingCopy
|
def commitWorkingCopy(self, configFile):
"""Saves the current working copy to disk"""
fn = self.function_table.commitWorkingCopy
result = fn(configFile)
return result
|
python
|
def commitWorkingCopy(self, configFile):
"""Saves the current working copy to disk"""
fn = self.function_table.commitWorkingCopy
result = fn(configFile)
return result
|
[
"def",
"commitWorkingCopy",
"(",
"self",
",",
"configFile",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"commitWorkingCopy",
"result",
"=",
"fn",
"(",
"configFile",
")",
"return",
"result"
] |
Saves the current working copy to disk
|
[
"Saves",
"the",
"current",
"working",
"copy",
"to",
"disk"
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3817-L3822
|
15,637
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.getWorkingCollisionBoundsInfo
|
def getWorkingCollisionBoundsInfo(self):
"""
Returns the number of Quads if the buffer points to null. Otherwise it returns Quads
into the buffer up to the max specified from the working copy.
"""
fn = self.function_table.getWorkingCollisionBoundsInfo
pQuadsBuffer = HmdQuad_t()
punQuadsCount = c_uint32()
result = fn(byref(pQuadsBuffer), byref(punQuadsCount))
return result, pQuadsBuffer, punQuadsCount.value
|
python
|
def getWorkingCollisionBoundsInfo(self):
"""
Returns the number of Quads if the buffer points to null. Otherwise it returns Quads
into the buffer up to the max specified from the working copy.
"""
fn = self.function_table.getWorkingCollisionBoundsInfo
pQuadsBuffer = HmdQuad_t()
punQuadsCount = c_uint32()
result = fn(byref(pQuadsBuffer), byref(punQuadsCount))
return result, pQuadsBuffer, punQuadsCount.value
|
[
"def",
"getWorkingCollisionBoundsInfo",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getWorkingCollisionBoundsInfo",
"pQuadsBuffer",
"=",
"HmdQuad_t",
"(",
")",
"punQuadsCount",
"=",
"c_uint32",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pQuadsBuffer",
")",
",",
"byref",
"(",
"punQuadsCount",
")",
")",
"return",
"result",
",",
"pQuadsBuffer",
",",
"punQuadsCount",
".",
"value"
] |
Returns the number of Quads if the buffer points to null. Otherwise it returns Quads
into the buffer up to the max specified from the working copy.
|
[
"Returns",
"the",
"number",
"of",
"Quads",
"if",
"the",
"buffer",
"points",
"to",
"null",
".",
"Otherwise",
"it",
"returns",
"Quads",
"into",
"the",
"buffer",
"up",
"to",
"the",
"max",
"specified",
"from",
"the",
"working",
"copy",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3861-L3871
|
15,638
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.getWorkingSeatedZeroPoseToRawTrackingPose
|
def getWorkingSeatedZeroPoseToRawTrackingPose(self):
"""Returns the preferred seated position from the working copy."""
fn = self.function_table.getWorkingSeatedZeroPoseToRawTrackingPose
pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose))
return result, pmatSeatedZeroPoseToRawTrackingPose
|
python
|
def getWorkingSeatedZeroPoseToRawTrackingPose(self):
"""Returns the preferred seated position from the working copy."""
fn = self.function_table.getWorkingSeatedZeroPoseToRawTrackingPose
pmatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatSeatedZeroPoseToRawTrackingPose))
return result, pmatSeatedZeroPoseToRawTrackingPose
|
[
"def",
"getWorkingSeatedZeroPoseToRawTrackingPose",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getWorkingSeatedZeroPoseToRawTrackingPose",
"pmatSeatedZeroPoseToRawTrackingPose",
"=",
"HmdMatrix34_t",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pmatSeatedZeroPoseToRawTrackingPose",
")",
")",
"return",
"result",
",",
"pmatSeatedZeroPoseToRawTrackingPose"
] |
Returns the preferred seated position from the working copy.
|
[
"Returns",
"the",
"preferred",
"seated",
"position",
"from",
"the",
"working",
"copy",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3885-L3891
|
15,639
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.getWorkingStandingZeroPoseToRawTrackingPose
|
def getWorkingStandingZeroPoseToRawTrackingPose(self):
"""Returns the standing origin from the working copy."""
fn = self.function_table.getWorkingStandingZeroPoseToRawTrackingPose
pmatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatStandingZeroPoseToRawTrackingPose))
return result, pmatStandingZeroPoseToRawTrackingPose
|
python
|
def getWorkingStandingZeroPoseToRawTrackingPose(self):
"""Returns the standing origin from the working copy."""
fn = self.function_table.getWorkingStandingZeroPoseToRawTrackingPose
pmatStandingZeroPoseToRawTrackingPose = HmdMatrix34_t()
result = fn(byref(pmatStandingZeroPoseToRawTrackingPose))
return result, pmatStandingZeroPoseToRawTrackingPose
|
[
"def",
"getWorkingStandingZeroPoseToRawTrackingPose",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"getWorkingStandingZeroPoseToRawTrackingPose",
"pmatStandingZeroPoseToRawTrackingPose",
"=",
"HmdMatrix34_t",
"(",
")",
"result",
"=",
"fn",
"(",
"byref",
"(",
"pmatStandingZeroPoseToRawTrackingPose",
")",
")",
"return",
"result",
",",
"pmatStandingZeroPoseToRawTrackingPose"
] |
Returns the standing origin from the working copy.
|
[
"Returns",
"the",
"standing",
"origin",
"from",
"the",
"working",
"copy",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3893-L3899
|
15,640
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.setWorkingPlayAreaSize
|
def setWorkingPlayAreaSize(self, sizeX, sizeZ):
"""Sets the Play Area in the working copy."""
fn = self.function_table.setWorkingPlayAreaSize
fn(sizeX, sizeZ)
|
python
|
def setWorkingPlayAreaSize(self, sizeX, sizeZ):
"""Sets the Play Area in the working copy."""
fn = self.function_table.setWorkingPlayAreaSize
fn(sizeX, sizeZ)
|
[
"def",
"setWorkingPlayAreaSize",
"(",
"self",
",",
"sizeX",
",",
"sizeZ",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setWorkingPlayAreaSize",
"fn",
"(",
"sizeX",
",",
"sizeZ",
")"
] |
Sets the Play Area in the working copy.
|
[
"Sets",
"the",
"Play",
"Area",
"in",
"the",
"working",
"copy",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3901-L3905
|
15,641
|
cmbruns/pyopenvr
|
src/openvr/__init__.py
|
IVRChaperoneSetup.setWorkingSeatedZeroPoseToRawTrackingPose
|
def setWorkingSeatedZeroPoseToRawTrackingPose(self):
"""Sets the preferred seated position in the working copy."""
fn = self.function_table.setWorkingSeatedZeroPoseToRawTrackingPose
pMatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
fn(byref(pMatSeatedZeroPoseToRawTrackingPose))
return pMatSeatedZeroPoseToRawTrackingPose
|
python
|
def setWorkingSeatedZeroPoseToRawTrackingPose(self):
"""Sets the preferred seated position in the working copy."""
fn = self.function_table.setWorkingSeatedZeroPoseToRawTrackingPose
pMatSeatedZeroPoseToRawTrackingPose = HmdMatrix34_t()
fn(byref(pMatSeatedZeroPoseToRawTrackingPose))
return pMatSeatedZeroPoseToRawTrackingPose
|
[
"def",
"setWorkingSeatedZeroPoseToRawTrackingPose",
"(",
"self",
")",
":",
"fn",
"=",
"self",
".",
"function_table",
".",
"setWorkingSeatedZeroPoseToRawTrackingPose",
"pMatSeatedZeroPoseToRawTrackingPose",
"=",
"HmdMatrix34_t",
"(",
")",
"fn",
"(",
"byref",
"(",
"pMatSeatedZeroPoseToRawTrackingPose",
")",
")",
"return",
"pMatSeatedZeroPoseToRawTrackingPose"
] |
Sets the preferred seated position in the working copy.
|
[
"Sets",
"the",
"preferred",
"seated",
"position",
"in",
"the",
"working",
"copy",
"."
] |
68395d26bb3df6ab1f0f059c38d441f962938be6
|
https://github.com/cmbruns/pyopenvr/blob/68395d26bb3df6ab1f0f059c38d441f962938be6/src/openvr/__init__.py#L3923-L3929
|
15,642
|
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
|
15,643
|
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
|
15,644
|
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
|
15,645
|
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
|
15,646
|
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
|
15,647
|
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
|
15,648
|
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
|
15,649
|
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
|
15,650
|
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
|
15,651
|
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
|
15,652
|
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
|
15,653
|
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
|
15,654
|
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
|
15,655
|
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
|
15,656
|
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
|
15,657
|
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
|
15,658
|
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
|
15,659
|
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
|
15,660
|
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
|
15,661
|
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
|
15,662
|
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
|
15,663
|
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
|
15,664
|
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
|
15,665
|
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
|
15,666
|
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
|
15,667
|
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
|
15,668
|
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
|
15,669
|
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
|
15,670
|
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
|
15,671
|
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
|
15,672
|
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
|
15,673
|
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
|
15,674
|
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
|
15,675
|
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
|
15,676
|
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
|
15,677
|
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
|
15,678
|
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
|
15,679
|
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
|
15,680
|
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
|
15,681
|
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
|
15,682
|
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
|
15,683
|
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
|
15,684
|
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
|
15,685
|
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
|
15,686
|
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
|
15,687
|
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
|
15,688
|
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
|
15,689
|
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
|
15,690
|
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
|
15,691
|
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
|
15,692
|
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
|
15,693
|
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
|
15,694
|
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
|
15,695
|
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
|
15,696
|
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
|
15,697
|
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
|
15,698
|
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
|
15,699
|
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
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.