Wiki Page Content

Differences between revisions 3 and 4
Revision 3 as of 2019-02-24 05:05:18
Size: 1843
Editor: DanielG
Comment: link SDL_GameControllerButtonBind struct
Revision 4 as of 2019-02-24 05:54:12
Size: 1980
Editor: DanielG
Comment: improve return value description
Deletions are marked like this. Additions are marked like this.
Line 10: Line 10:
Use this function to get the SDL joystick layer binding for a controller button mapping. Use this function to get the SDL joystick layer binding for a controller axis mapping.
Line 29: Line 29:
Returns a binding on success or an empty binding on failure. Returns a [[SDL_GameControllerButtonBind]] describing the bind.<<BR>>
On failure (like the given Controller axis doesn't exist on the device), its `.bindType` will be `SDL_CONTROLLER_BINDTYPE_NONE`.

DRAFT

SDL_GameControllerGetBindForAxis

Use this function to get the SDL joystick layer binding for a controller axis mapping.

Syntax

SDL_GameControllerButtonBind SDL_GameControllerGetBindForAxis(SDL_GameController*    gamecontroller,
                                                              SDL_GameControllerAxis axis)

Function Parameters

gamecontroller

a game controller

axis

an axis enum value (one of the SDL_GameControllerAxis values)

Return Value

Returns a SDL_GameControllerButtonBind describing the bind.
On failure (like the given Controller axis doesn't exist on the device), its .bindType will be SDL_CONTROLLER_BINDTYPE_NONE.

Code Examples

You can add your code example here

Remarks

You can add useful comments here

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryGameController

None: SDL_GameControllerGetBindForAxis (last edited 2019-02-24 05:54:12 by DanielG)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit