Source

pygame / src / doc / joystick_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEJOYSTICK "pygame module for interacting with joystick devices"

#define DOC_PYGAMEJOYSTICKINIT "init() -> None\ninitialize the joystick module"

#define DOC_PYGAMEJOYSTICKQUIT "quit() -> None\nuninitialize the joystick module"

#define DOC_PYGAMEJOYSTICKGETINIT "get_init() -> bool\ntrue if the joystick module is initialized"

#define DOC_PYGAMEJOYSTICKGETCOUNT "get_count() -> count\nnumber of joysticks on the system"

#define DOC_PYGAMEJOYSTICKJOYSTICK "Joystick(id) -> Joystick\ncreate a new Joystick object"

#define DOC_JOYSTICKINIT "init() -> None\ninitialize the Joystick"

#define DOC_JOYSTICKQUIT "quit() -> None\nuninitialize the Joystick"

#define DOC_JOYSTICKGETINIT "get_init() -> bool\ncheck if the Joystick is initialized"

#define DOC_JOYSTICKGETID "get_id() -> int\nget the Joystick ID"

#define DOC_JOYSTICKGETNAME "get_name() -> string\nget the Joystick system name"

#define DOC_JOYSTICKGETNUMAXES "get_numaxes() -> int\nget the number of axes on a Joystick"

#define DOC_JOYSTICKGETAXIS "get_axis(axis_number) -> float\nget the current position of an axis"

#define DOC_JOYSTICKGETNUMBALLS "get_numballs() -> int\nget the number of trackballs on a Joystick"

#define DOC_JOYSTICKGETBALL "get_ball(ball_number) -> x, y\nget the relative position of a trackball"

#define DOC_JOYSTICKGETNUMBUTTONS "get_numbuttons() -> int\nget the number of buttons on a Joystick"

#define DOC_JOYSTICKGETBUTTON "get_button(button) -> bool\nget the current button state"

#define DOC_JOYSTICKGETNUMHATS "get_numhats() -> int\nget the number of hat controls on a Joystick"

#define DOC_JOYSTICKGETHAT "get_hat(hat_number) -> x, y\nget the position of a joystick hat"



/* Docs in a comment... slightly easier to read. */

/*

pygame.joystick
pygame module for interacting with joystick devices

pygame.joystick.init
 init() -> None
initialize the joystick module

pygame.joystick.quit
 quit() -> None
uninitialize the joystick module

pygame.joystick.get_init
 get_init() -> bool
true if the joystick module is initialized

pygame.joystick.get_count
 get_count() -> count
number of joysticks on the system

pygame.joystick.Joystick
 Joystick(id) -> Joystick
create a new Joystick object

pygame.joystick.Joystick.init
 init() -> None
initialize the Joystick

pygame.joystick.Joystick.quit
 quit() -> None
uninitialize the Joystick

pygame.joystick.Joystick.get_init
 get_init() -> bool
check if the Joystick is initialized

pygame.joystick.Joystick.get_id
 get_id() -> int
get the Joystick ID

pygame.joystick.Joystick.get_name
 get_name() -> string
get the Joystick system name

pygame.joystick.Joystick.get_numaxes
 get_numaxes() -> int
get the number of axes on a Joystick

pygame.joystick.Joystick.get_axis
 get_axis(axis_number) -> float
get the current position of an axis

pygame.joystick.Joystick.get_numballs
 get_numballs() -> int
get the number of trackballs on a Joystick

pygame.joystick.Joystick.get_ball
 get_ball(ball_number) -> x, y
get the relative position of a trackball

pygame.joystick.Joystick.get_numbuttons
 get_numbuttons() -> int
get the number of buttons on a Joystick

pygame.joystick.Joystick.get_button
 get_button(button) -> bool
get the current button state

pygame.joystick.Joystick.get_numhats
 get_numhats() -> int
get the number of hat controls on a Joystick

pygame.joystick.Joystick.get_hat
 get_hat(hat_number) -> x, y
get the position of a joystick hat

*/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.