DeviceProperties Class (Microsoft.DirectX.DirectInput)

Article
06/29/2006

Various properties you can get or set on a device.

Definition

Visual Basic Public Class DeviceProperties
Inherits Object

C# public class DeviceProperties : Object

C++ public ref class DeviceProperties : Object

JScript public class DeviceProperties extends Object

Members Table

The following table lists the members exposed by the object.

Methods

Method Description

GetApplicationData Retrieves the application-defined value associated with an in-game action.

GetCalibrationPoints Retrieves calibration points used for the adjustment of incoming raw data.

GetDeadZone Retrieves a value for the dead zone of a joystick, in the range from 0 through 10,000, where 0 indicates that there is no dead zone, 5,000 indicates that the dead zone extends over 50 percent of the physical range of the axis on both sides of center, and 10,000 indicates that the entire physical range of the axis is dead. When the axis is within the dead zone, it is reported as being at the center of its range.

GetGranularity Retrieves the input granularity. Granularity represents the smallest distance over which the object reports movement. Most axis objects have a granularity of one; that is, all values are possible. Some axes have a larger granularity. For example, the wheel axis on a mouse can have a granularity of 20; that is, all reported changes in position are multiples of 20. In other words, when the user turns the wheel slowly, the device reports a position of 0, then 20, then 40, and so on. This is a read-only property.

GetKeyName Retrieves the localized key name for a keyboard key

GetLogicalRange Retrieves the range of the raw data returned for axes on a HID. Devices can return negative values.

GetPhysicalRange Retrieves the range of data for axes as suggested by the manufacturer of a HID. Values can be negative. Normally DirectInput returns values from 0 through 0×FFFF, but the range can be made to conform to the manufacturer's suggested range by using the Range property.

GetRange Retrieves the range of values an object can possibly report. For some devices, this is a read-only property.

GetSaturation Retrieves a value for the saturation zones of a joystick, in the range from 0 through 10,000. The saturation level is the point at which the axis is considered to be at its most extreme position. For example, if the saturation level is set to 9,500, the axis reaches the extreme of its range when it has moved 95 percent of the physical distance from its center position (or from the dead zone).

GetScanCode Retrieves the scan code for a keyboard key.

SetApplicationData Sets the application-defined value associated with an in-game action.

SetCalibrationPoints Sets calibration points used for the adjustment of incoming raw data.

SetDeadZone Sets the value for the dead zone of a joystick, in the range from 0 through 10,000, where 0 indicates that there is no dead zone, 5,000 indicates that the dead zone extends over 50 percent of the physical range of the axis on both sides of center, and 10,000 indicates that the entire physical range of the axis is dead. When the axis is within the dead zone, it is reported as being at the center of its range. This setting can be applied to either the entire device or to a specific axis.

SetRange Sets the range of values an object can possibly report.

SetSaturation Sets the value for the saturation zones of a joystick, in the range from 0 through 10,000. The saturation level is the point at which the axis is considered to be at its most extreme position. For example, if the saturation level is set to 9,500, the axis reaches the extreme of its range when it has moved 95 percent of the physical distance from its center position (or from the dead zone). This setting can be applied to either the entire device or a specific axis.

Properties

Property Description

AutoCenter Specifies whether device objects are self centering. This setting applies to the entire device, rather than to any particular object.

AxisModeAbsolute Gets or sets a value showing the the axis mode as absolute.

BufferSize Sets the input buffer size.

ForceFeedbackGain Sets the gain for the device.

ForceFeedbackLoad Retrieves the memory load for a device.

JoystickId Returns the instance number of a joystick.

PortDisplayName Retrieves the human-readable display name of the port to which this device is connected. Not generally used by applications.

ProductName Retrieves the friendly product name of the device.

TypeName Predefined property that retrieves the type name of a device. For most game controllers, this is the registry key name under REGSTR_PATH_JOYOEM from which static device settings can be retrieved, but predefined joystick types have special names consisting of a number sign (#) followed by a character dependent on the type. This value might not be available for all devices.

UserName Retrieves the user name for a user currently assigned to a device

VendorIdentityProductId Read-only device property that retrieves the vendor identity (ID) and product ID of a HID device.

Method	Description
GetApplicationData	Retrieves the application-defined value associated with an in-game action.
GetCalibrationPoints	Retrieves calibration points used for the adjustment of incoming raw data.
GetDeadZone	Retrieves a value for the dead zone of a joystick, in the range from 0 through 10,000, where 0 indicates that there is no dead zone, 5,000 indicates that the dead zone extends over 50 percent of the physical range of the axis on both sides of center, and 10,000 indicates that the entire physical range of the axis is dead. When the axis is within the dead zone, it is reported as being at the center of its range.
GetGranularity	Retrieves the input granularity. Granularity represents the smallest distance over which the object reports movement. Most axis objects have a granularity of one; that is, all values are possible. Some axes have a larger granularity. For example, the wheel axis on a mouse can have a granularity of 20; that is, all reported changes in position are multiples of 20. In other words, when the user turns the wheel slowly, the device reports a position of 0, then 20, then 40, and so on. This is a read-only property.
GetKeyName	Retrieves the localized key name for a keyboard key
GetLogicalRange	Retrieves the range of the raw data returned for axes on a HID. Devices can return negative values.
GetPhysicalRange	Retrieves the range of data for axes as suggested by the manufacturer of a HID. Values can be negative. Normally DirectInput returns values from 0 through 0×FFFF, but the range can be made to conform to the manufacturer's suggested range by using the Range property.
GetRange	Retrieves the range of values an object can possibly report. For some devices, this is a read-only property.
GetSaturation	Retrieves a value for the saturation zones of a joystick, in the range from 0 through 10,000. The saturation level is the point at which the axis is considered to be at its most extreme position. For example, if the saturation level is set to 9,500, the axis reaches the extreme of its range when it has moved 95 percent of the physical distance from its center position (or from the dead zone).
GetScanCode	Retrieves the scan code for a keyboard key.
SetApplicationData	Sets the application-defined value associated with an in-game action.
SetCalibrationPoints	Sets calibration points used for the adjustment of incoming raw data.
SetDeadZone	Sets the value for the dead zone of a joystick, in the range from 0 through 10,000, where 0 indicates that there is no dead zone, 5,000 indicates that the dead zone extends over 50 percent of the physical range of the axis on both sides of center, and 10,000 indicates that the entire physical range of the axis is dead. When the axis is within the dead zone, it is reported as being at the center of its range. This setting can be applied to either the entire device or to a specific axis.
SetRange	Sets the range of values an object can possibly report.
SetSaturation	Sets the value for the saturation zones of a joystick, in the range from 0 through 10,000. The saturation level is the point at which the axis is considered to be at its most extreme position. For example, if the saturation level is set to 9,500, the axis reaches the extreme of its range when it has moved 95 percent of the physical distance from its center position (or from the dead zone). This setting can be applied to either the entire device or a specific axis.

Property	Description
AutoCenter	Specifies whether device objects are self centering. This setting applies to the entire device, rather than to any particular object.
AxisModeAbsolute	Gets or sets a value showing the the axis mode as absolute.
BufferSize	Sets the input buffer size.
ForceFeedbackGain	Sets the gain for the device.
ForceFeedbackLoad	Retrieves the memory load for a device.
JoystickId	Returns the instance number of a joystick.
PortDisplayName	Retrieves the human-readable display name of the port to which this device is connected. Not generally used by applications.
ProductName	Retrieves the friendly product name of the device.
TypeName	Predefined property that retrieves the type name of a device. For most game controllers, this is the registry key name under REGSTR_PATH_JOYOEM from which static device settings can be retrieved, but predefined joystick types have special names consisting of a number sign (#) followed by a character dependent on the type. This value might not be available for all devices.
UserName	Retrieves the user name for a user currently assigned to a device
VendorIdentityProductId	Read-only device property that retrieves the vendor identity (ID) and product ID of a HID device.

Inheritance Hierarchy

Object

DeviceProperties

Class Information

Namespace Microsoft.DirectX.DirectInput

Assembly Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)

Strong Name Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Visual Basic	Public Class DeviceProperties Inherits Object
C#	public class DeviceProperties : Object
C++	public ref class DeviceProperties : Object
JScript	public class DeviceProperties extends Object

Namespace	Microsoft.DirectX.DirectInput
Assembly	Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)
Strong Name	Microsoft.DirectX.DirectInput, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

DeviceProperties Class (Microsoft.DirectX.DirectInput)

Additional resources