Skip to content

TSdlGamepadBinding

A mapping between one joystick input to a gamepad control.

A gamepad has a collection of several bindings, to say, for example, when joystick button number 5 is pressed, that should be treated like the gamepad's "start" button.

SDL has these bindings built-in for many popular controllers, and can add more with a simple text string. Those strings are parsed into a collection of these structs to make it easier to operate on the data.

Definition

Unit: Neslib.Sdl3.Input

type TSdlGamepadBinding = record ... end;

See Also

Properties

Name Description
InputAxisIndex Input axis index (for Axis types)
InputAxisMax Input maximum axis value (for Axis types)
InputAxisMin Input minimum axis value (for Axis types)
InputButtonIndex Input button index (for Button types)
InputHatIndex Input hat index (for Hat types)
InputHatMask Input hat mask (for Hat types)
InputType Input (source) type
OutputAxis Output axis (for Axis types)
OutputAxisMax Output maximum axis value (for Axis types)
OutputAxisMin Output minimum axis value (for Axis types)
OutputButton Output button (for Button types)
OutputType Output (destination) type

Operators

Name Description
Equal(TSdlGamepadBinding, TSdlGamepadBinding) Used to compare against another TSdlGamepadBinding.
Equal(TSdlGamepadBinding, Pointer) Used to compare against nil.
Implicit Used to set the value to nil.
NotEqual(TSdlGamepadBinding, TSdlGamepadBinding) Used to compare against another TSdlGamepadBinding.
NotEqual(TSdlGamepadBinding, Pointer) Used to compare against nil.

Property Descriptions

InputAxisIndex

Input axis index (for Axis types)

property InputAxisIndex: Integer read GetInputAxisIndex

Type: Integer


InputAxisMax

Input maximum axis value (for Axis types)

property InputAxisMax: Integer read GetInputAxisMax

Type: Integer


InputAxisMin

Input minimum axis value (for Axis types)

property InputAxisMin: Integer read GetInputAxisMin

Type: Integer


InputButtonIndex

Input button index (for Button types)

property InputButtonIndex: Integer read GetInputButtonIndex

Type: Integer


InputHatIndex

Input hat index (for Hat types)

property InputHatIndex: Integer read GetInputHatIndex

Type: Integer


InputHatMask

Input hat mask (for Hat types)

property InputHatMask: Integer read GetInputHatMask

Type: Integer


InputType

Input (source) type

property InputType: TSdlGamepadBindingType read GetInputType

Type: TSdlGamepadBindingType


OutputAxis

Output axis (for Axis types)

property OutputAxis: TSdlGamepadAxis read GetOutputAxis

Type: TSdlGamepadAxis


OutputAxisMax

Output maximum axis value (for Axis types)

property OutputAxisMax: Integer read GetOutputAxisMax

Type: Integer


OutputAxisMin

Output minimum axis value (for Axis types)

property OutputAxisMin: Integer read GetOutputAxisMin

Type: Integer


OutputButton

Output button (for Button types)

property OutputButton: TSdlGamepadButton read GetOutputButton

Type: TSdlGamepadButton


OutputType

Output (destination) type

property OutputType: TSdlGamepadBindingType read GetOutputType

Type: TSdlGamepadBindingType


Operator Descriptions

Equal(TSdlGamepadBinding, TSdlGamepadBinding)

Used to compare against another TSdlGamepadBinding.

class operator Equal(const ALeft, ARight: TSdlGamepadBinding): Boolean; inline; static

Parameters

ALeft: TSdlGamepadBinding

ARight: TSdlGamepadBinding

Returns

Boolean


Equal(TSdlGamepadBinding, Pointer)

Used to compare against nil.

class operator Equal(const ALeft: TSdlGamepadBinding; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TSdlGamepadBinding

ARight: Pointer

Returns

Boolean


Implicit(Pointer)

Used to set the value to nil.

class operator Implicit(const AValue: Pointer): TSdlGamepadBinding; inline; static

Parameters

AValue: Pointer

Returns

TSdlGamepadBinding


NotEqual(TSdlGamepadBinding, TSdlGamepadBinding)

Used to compare against another TSdlGamepadBinding.

class operator NotEqual(const ALeft, ARight: TSdlGamepadBinding): Boolean; inline; static

Parameters

ALeft: TSdlGamepadBinding

ARight: TSdlGamepadBinding

Returns

Boolean


NotEqual(TSdlGamepadBinding, Pointer)

Used to compare against nil.

class operator NotEqual(const ALeft: TSdlGamepadBinding; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TSdlGamepadBinding

ARight: Pointer

Returns

Boolean