org.libsdl

Class SDL_GameController

java.lang.Object

org.libsdl.SDL_GameController

public final class SDL_GameController
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
boolean	addMapping(java.lang.String mappingString)
static boolean	addMappingsFromFile(java.lang.String path)
static boolean	addMappingsFromFile(java.lang.String path, java.lang.Class sourceClass) This method adds mappings held in the specified file.
void	close()
boolean	equals(java.lang.Object o)
static boolean	eventStateEnable()
static boolean	eventStateIgnore()
static boolean	eventStateQuery()
static SDL_GameController	GameControllerFromInstanceID(SDL_GameControllerID joyid)
static java.lang.String	GameControllerNameForIndex(int device_index) Get the implementation dependent name of a game controller.
static SDL_GameController	GameControllerOpen(int i)
static void	GameControllerUpdate()
boolean	getAttached()
float	getAxis(int axis)
boolean	getButton(int button)
int	getPlayerIndex() Get the player index of an opened game controller, or -1 if it's not available For XInput controllers this returns the XInput user index.
int	getType() Return the type of this currently opened controller
int	hashCode()
boolean	isGameController(int joystick_index)
java.lang.String	name()
static SDL_GameController	SDL_GameControllerFromPlayerIndex(int player_index) Return the SDL_GameController associated with a player index.
void	setPlayerIndex(int player_index) Set the player index of an opened game controller

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close()

getAttached

public boolean getAttached()

getAxis

public float getAxis(int axis)

getButton

public boolean getButton(int button)

name

public java.lang.String name()

addMappingsFromFile

public static boolean addMappingsFromFile(java.lang.String path,
                                          java.lang.Class sourceClass)
                                   throws java.io.IOException,
                                          java.lang.IllegalStateException,
                                          SDL_Error

This method adds mappings held in the specified file. The file is copied to the temp folder so that it can be read by the native code (if running from a .jar for instance)

Parameters:

path - The path to the file containing controller mappings.

Throws:

java.io.IOException - if the file cannot be read, copied to a temp folder, or deleted.

java.lang.IllegalStateException - if the mappings cannot be applied to SDL

SDL_Error

addMappingsFromFile

public static boolean addMappingsFromFile(java.lang.String path)
                                   throws java.io.IOException,
                                          java.lang.IllegalStateException,
                                          SDL_Error

Throws:

java.io.IOException

java.lang.IllegalStateException

SDL_Error

addMapping

public boolean addMapping(java.lang.String mappingString)
                   throws SDL_Error

Throws:

SDL_Error

eventStateQuery

public static boolean eventStateQuery()
                               throws SDL_Error

Throws:

SDL_Error

eventStateIgnore

public static boolean eventStateIgnore()
                                throws SDL_Error

Throws:

SDL_Error

eventStateEnable

public static boolean eventStateEnable()
                                throws SDL_Error

Throws:

SDL_Error

GameControllerFromInstanceID

public static SDL_GameController GameControllerFromInstanceID(SDL_GameControllerID joyid)

SDL_GameControllerFromPlayerIndex

public static SDL_GameController SDL_GameControllerFromPlayerIndex(int player_index)

Return the SDL_GameController associated with a player index.

GameControllerNameForIndex

public static java.lang.String GameControllerNameForIndex(int device_index)

Get the implementation dependent name of a game controller. This can be called before any controllers are opened. If no name can be found, this function returns NULL.

getType

public int getType()

Return the type of this currently opened controller

getPlayerIndex

public int getPlayerIndex()

Get the player index of an opened game controller, or -1 if it's not available For XInput controllers this returns the XInput user index.

setPlayerIndex

public void setPlayerIndex(int player_index)

Set the player index of an opened game controller

GameControllerOpen

public static SDL_GameController GameControllerOpen(int i)

GameControllerUpdate

public static void GameControllerUpdate()

isGameController

public boolean isGameController(int joystick_index)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object