Class GorgonGamingDeviceAxisInfo

Information about a gaming device axis.

Inheritance
object
GorgonGamingDeviceAxisInfo
Inherited Members
Namespace: Gorgon.Input
Assembly: Gorgon.Input.dll
Syntax
public class GorgonGamingDeviceAxisInfo
Remarks

This will provide information about the range of movement for the axis, as well as a default value for when the axis is centered or whatever the resting position may be. This default is set by the IGorgonGamingDeviceDriver upon enumeration of the devices.

Constructors

| Edit this page View Source

GorgonGamingDeviceAxisInfo(GamingDeviceAxis, GorgonRange, int)

Initializes a new instance of the GorgonGamingDeviceAxisInfo struct.

Declaration
public GorgonGamingDeviceAxisInfo(GamingDeviceAxis axis, GorgonRange range, int defaultValue)
Parameters
Type Name Description
GamingDeviceAxis axis

The identifier for the axis.
GorgonRange range

The range of the axis.
int defaultValue

The default value for the axis when in resting position.

Properties

| Edit this page View Source

Axis

Property to return the identifier for the axis.

Declaration
public GamingDeviceAxis Axis { get; }
Property Value
Type Description
GamingDeviceAxis
| Edit this page View Source

DefaultValue

Property to return the default value for the resting position of the axis.

Declaration
public int DefaultValue { get; }
Property Value
Type Description
int
Remarks

This is the value that will be returned when the device axis is stationary. For example, if the range of the axis is between 0 and 16384, then 8192 may be the default value, or it may be zero depending on the type of axis.

| Edit this page View Source

Range

Property to return the range of the axis.

Declaration
public GorgonRange Range { get; }
Property Value
Type Description
GorgonRange
Remarks

This value will vary depending on the underlying provider used for the physical device.

Methods

| Edit this page View Source

ToString()

Returns a string that represents this instance.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance.
Overrides

Extension Methods