Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The TDx_InputDevice::GetProperty() method will retrieve a variety of property information from the input device.
Error values that can be generated are:
DIERR_INVALIDPARAM
DIERR_NOTINITIALIZED
DIERR_OBJECTNOTFOUND
DIERR_UNSUPPORTED
- Parameters
Prop
The Prop property identifies the property that is to be retrieved.
This is one of the predefined values below or a pointer a GUID identifying the property.
DIPROP_AUTOCENTER
Determine if the device is self centering.
The associated TDIPropDWORD::Data property will be set to DIPROPAUTOCENTER_ON or DIPROPAUTOCENTER_OFF.
Not all devices support auto centering and sometimes the autocentering mechanism can interfere with force feedback effects.
DIPROP_AXISMODE
Retrieve the axis mode.
The associated TDIPropDWORD::Data property will be set to DIPROPAXISMODE_REL or DIPROPAXISMODE_ABS.
DIPROP_BUFFERSIZE
Retrive the buffer size.
The associated TDIPropDWORD::Data property will be set to the retrieved value.
This indicates the amount of data the device can buffer between calls to TDx_InputDevice::GetDeviceData() without data being lost.
DIPROP_DEADZONE
Retrieve the deadzone value for a joystick.
The associated TDIPropDWORD::Data property will be set to the retrieved value, which will be in the range 0 to 10000.
DIPROP_FFGAIN
Retrieve the gain setting of the device.
The associated TDIPropDWORD::Data property will be set to the retrieved value, which will be in the range 0 to 10000.
DIPROP_FFLOAD
Retrieve the percentage of the device's memory is currently in use.
The associated TDIPropDWORD::Data property will be set to the retrieved value, which will be in the range 0 to 100.
DIPROP_GRANULARITY
Retrieve the input granularity.
The associated TDIPropDWORD::Data property will be set to the retrieved value, which represents the smallest amount of axis movement a device can report.
DIPROP_GUIDANDPATH
Retrieve the class identifier and device interface for the device.
The associated TDIPropGuidAndPath::Class and TDIPropGuidAndPath::Path properties will be set to the retrieved values, which allow unsupported operations to be performed on a HID.
DIPROP_INSTANCENAME
Retrieve the friendly instance name of the device.
The associated TDIPropString::String property will be set to the retrieved name, which will be something like 'joystick 2' or 'mouse 1'.
DIPROP_PRODUCTNAME
Retrieve the friendly product name of the device.
The associated TDIPropString::String property will be set to the retrieved name, which will be something like 'FlightMaster' or 'Super Trackball 3'.
DIPROP_RANGE
Retrieve the range of values the device object can report.
The associated TDIPropRange::Min and TDIPropRange::Max properties will be set to the retrieved ranges.
DIPROP_SATURATION
Retrieve the current saturation zone value for a joystick.
The associated TDIPropDWORD::Data property will be set to the retrieved value, which represents the point on an axis where the device is considered to have reached its most extreeme position.
Property
The Property parameter references a single TDIProperty-derived component: TDIPropRange, TDIPropDWORD, TDIPropString or TDIPropGuidAndPath, depending on the kind of property being set.
- See Also
- Top
TDx_Input_Library v2.00 Component Reference
|
|
|
[ TDx_InputDevice::GetProperty() ] [ next: Poll() ] [ prev: GetObjectInfo() ] public:
virtual bool __fastcall GetProperty( REFGUID pProp, TDIProperty* pProperty );
TDX_INPUTDEVICE::GETPROPERTY()
[ component method ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|