Added SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS to the documentation for the joystick and game controller APIs
authorSam Lantinga <slouken@libsdl.org>
Wed, 03 Jul 2013 12:31:40 -0700
changeset 7341 675c85d46f30
parent 7340 72134ccb9502
child 7342 4828e86c6010
Added SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS to the documentation for the joystick and game controller APIs
include/SDL_gamecontroller.h
include/SDL_joystick.h
--- a/include/SDL_gamecontroller.h	Tue Jun 04 12:02:18 2013 -0400
+++ b/include/SDL_gamecontroller.h	Wed Jul 03 12:31:40 2013 -0700
@@ -44,6 +44,10 @@
  *  In order to use these functions, SDL_Init() must have been called
  *  with the ::SDL_INIT_JOYSTICK flag.  This causes SDL to scan the system
  *  for game controllers, and load appropriate drivers.
+ *
+ *  If you would like to receive controller updates while the application
+ *  is in the background, you should set the following hint before calling
+ *  SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
  */
 
 /* The gamecontroller structure used to identify an SDL game controller */
--- a/include/SDL_joystick.h	Tue Jun 04 12:02:18 2013 -0400
+++ b/include/SDL_joystick.h	Wed Jul 03 12:31:40 2013 -0700
@@ -54,6 +54,10 @@
  *  In order to use these functions, SDL_Init() must have been called
  *  with the ::SDL_INIT_JOYSTICK flag.  This causes SDL to scan the system
  *  for joysticks, and load appropriate drivers.
+ *
+ *  If you would like to receive joystick updates while the application
+ *  is in the background, you should set the following hint before calling
+ *  SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
  */
 
 /* The joystick structure used to identify an SDL joystick */