Wiki Page Content

DRAFT

SDL_GameControllerOpen

Use this function to open a gamecontroller for use.

Syntax

SDL_GameController* SDL_GameControllerOpen(int joystick_index)

Function Parameters

joystick_index

the device_index of a device, up to SDL_NumJoysticks()

Return Value

Returns a gamecontroller identifier or NULL if an error occurred; call SDL_GetError() for more information.

Code Examples

/* Open the first available controller. */
SDL_GameController *controller = NULL;
for (int i = 0; i < SDL_NumJoysticks(); ++i) {
    if (SDL_IsGameController(i)) {
        controller = SDL_GameControllerOpen(i);
        if (controller) {
            break;
        } else {
            fprintf(stderr, "Could not open gamecontroller %i: %s\n", i, SDL_GetError());
        }
    }
}

Remarks

joystick_index is the same as the device_index passed to SDL_JoystickOpen().

The index passed as an argument refers to the N'th game controller on the system. This index is not the value which will identify this controller in future controller events. The joystick's instance id (SDL_JoystickID) will be used there instead.

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryGameController

None: SDL_GameControllerOpen (last edited 2016-04-10 22:49:34 by PhilippWiesemann)

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