Wiki Page Content

Differences between revisions 1 and 6 (spanning 5 versions)
Revision 1 as of 2010-03-17 18:21:44
Size: 1068
Editor: SheenaSmith
Comment: create page, add content (Rev 5540)
Revision 6 as of 2013-10-05 13:03:02
Size: 1433
Editor: Zalerinian
Comment: Formatting; Added related function SDL_GameControllerEventState; Added note about using -1, 0, or 1 for SDL_QUERY/IGNORE/ENABLE; Added code example
Deletions are marked like this. Additions are marked like this.
Line 16: Line 16:
||'''state'''||can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE||
<<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.)>>
||'''state'''||can be one of SDL_QUERY, SDL_IGNORE, or SDL_ENABLE||
Note: You may use -1, 0, or 1 in place of SDL_QUERY, SDL_IGNORE, or SDL_ENABLE respectively.
Line 20: Line 20:
Returns ^1 if enabled, 0 if disabled^, or a negative error code on failure; call [[SDL_GetError]]() for more information. 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.
Line 24: Line 26:
You can add your code example here cout << SDL_JoystickEventState(SDL_QUERY) << endl; // 1
cout << SDL_JoystickEventState(SDL_IGNORE) << endl; // 0
cout << SDL_JoystickEventState(SDL_QUERY) << endl; // 0
Line 28: Line 32:
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. If joystick events are disabled, you must call [[SDL_JoystickUpdate]]() yourself and manually check the state of the joystick when you want joystick information.

Note: It is recommended that you leave Joystick Event Handling enabled.
Warning: Calling this function may delete all events currently in SDL's event queue.
Line 31: Line 38:
 .[[SDL_GameControllerEventState]]

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_IGNORE, or SDL_ENABLE

Note: You may use -1, 0, or 1 in place of SDL_QUERY, SDL_IGNORE, or SDL_ENABLE respectively.

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

cout << SDL_JoystickEventState(SDL_QUERY)  << endl;  // 1
cout << SDL_JoystickEventState(SDL_IGNORE) << endl;  // 0
cout << SDL_JoystickEventState(SDL_QUERY)  << endl;  // 0

Remarks

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

Note: It is recommended that you leave Joystick Event Handling enabled. 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