bool GetBoolTrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, TrackedPropertyError *pError = 0L )
float GetFloatTrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, TrackedPropertyError *pError = 0L )
int32_t GetInt32TrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, TrackedPropertyError *pError = 0L )
uint64_t GetUint64TrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, TrackedPropertyError *pError = 0L )
HmdMatrix34_t GetMatrix34TrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, TrackedPropertyError *pError = 0L )
uint32_t GetStringTrackedDeviceProperty( vr::TrackedDeviceIndex_t unDeviceIndex, TrackedDeviceProperty prop, char *pchValue, uint32_t unBufferSize, TrackedPropertyError *pError = 0L )
vr::TrackedDeviceIndex unDeviceIndex
- Index of the device to get the property for.vr::TrackedDeviceProperty prop
- Which property to get.vr::TrackedPropertyError *pError
- The error returned when attempting to fetch this property. This can be NULL if the caller doesn't care about the source of a property error.char *pchValue
- The buffer to store string properties in. unBufferSize
should be the size of this buffer.uint32_t unBufferSize
- The size of the buffer pointed to by pchValue
.Description
Returns a static property for a tracked device. The different typed GetXTrackedDeviceProperty functions return a value on failure that is generally reasonable for that type:
String Properties
Because the application owns the buffer to fill with a string property, retrieving a string property is a little different. GetStringTrackedDeviceProperty
returns the number of bytes necessary to hold the string, including the trailing null. If the buffer wasn't large enough it passes back TrackedProp_BufferTooSmall as the error and doesn't fill the string into the buffer.
Strings will generally fit in buffers of k_unTrackingStringSize characters.
Property Errors
TrackedPropertyError will be one of:
TrackedProp_Success
- The property request was successful.TrackedProp_WrongDataType
- The property was requested with the wrong typed function.TrackedProp_WrongDeviceClass
- The property was requested on a tracked device with the wrong class.TrackedProp_BufferTooSmall
- The string property will not fit in the provided buffer. The buffer size needed is returned.TrackedProp_UnknownProperty
- The property enum value is unknown.TrackedProp_InvalidDevice
- The tracked device index was invalid.TrackedProp_CouldNotContactServer
- OpenVR could not contact vrserver to query the device for this property.TrackedProp_ValueNotProvidedByDevice
- The driver for this device returned that it does not provide this specific property for this device.TrackedProp_StringExceedsMaximumLength
- The string property value returned by a driver exceeded the maximum property length of 32k.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4