wiki.icculus.org
[ front page | index | search | recent changes | git repo | offline html ]

ControllerImage_CreateGamepadDeviceByInstance

Create an device object to obtain image data for a specific SDL_JoystickID.

Header File

Defined in <controllerimage.h>

Syntax

ControllerImage_Device * ControllerImage_CreateGamepadDeviceByInstance(SDL_JoystickID jsid);

Function Parameters

SDL_JoystickID jsid an SDL joystick instance to look up.

Return Value

(ControllerImage_Device *) Returns a new device object on success, false on error; call SDL_GetError() for details.

Remarks

Once a device object is created, it can be used to obtain image data, either as SDL_Surface objects, or raw SVG image format strings.

This function uses an SDL_JoystickID to look up data, which is convenient for preparing image data for a controller that hasn't yet been opened, or perhaps an SDL joystick that doesn't have a real gamepad mapping. One can also use ControllerImage_CreateGamepadDevice() for gamepads that are opened, and ControllerImage_CreateGamepadDeviceByIdString() for looking up by GUID or a standard name string.

When done with the returned device object, dispose of it with ControllerImage_DestroyDevice().

Thread Safety

This function is not thread safe.

Version

This function is available since ControllerImage 1.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryControllerImage


[ edit | delete | history | feedback | raw ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.