Wiki Page Content

Differences between revisions 4 and 5
Revision 4 as of 2010-10-11 21:41:50
Size: 1630
Editor: SheenaSmith
Comment: minor change
Revision 5 as of 2013-09-01 18:36:08
Size: 1641
Comment: Updated usage of Color2 macro.
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
<<Color2(green,Confused - seems like '''state''' should be an integer but these are not integers. Since RV is also an integer I'm not sure where this info belongs. Is this an error? Should this be somehow liked to [[SDL_EventState]]()?)>> <<Color2(col=green,text="Confused - seems like '''state''' should be an integer but these are not integers. Since RV is also an integer I'm not sure where this info belongs. Is this an error? Should this be somehow liked to [[SDL_EventState]]()?")>>

DRAFT

SDL_JoystickEventState

Use this function to enable/disable joystick event polling.

Syntax

int SDL_JoystickEventState(int state)

Function Parameters

state

can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE

Confused - seems like state should be an integer but these are not integers. Since RV is also an integer I'm not sure where this info belongs. Is this an error? Should this be somehow liked to SDL_EventState()?

Return Value

Returns 1 if enabled, 0 if disabled, or a negative error code on failure; call SDL_GetError() for more information.

*
If state is SDL_QUERY then the current state is returned, otherwise the new processing state is returned.
*

Code Examples

You can add your code example here

Remarks

*
This function is used to enable or disable joystick event processing.
*

If joystick events are disabled, you must call SDL_JoystickUpdate() yourself and to manually? check the state of the joystick when you want joystick information.

*
Note: Joystick event handling is preferred.

Note: Even if joystick event processing is enabled, individual joysticks must be opened before they generate events.

Warning: Calling this function may delete all events currently in SDL's event queue.
*


CategoryAPI, CategoryJoystick

None: SDL_JoystickEventState (last edited 2015-10-29 21:39:34 by PhilippWiesemann)

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