mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-12 17:51:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify requirements for receiving joystick events

Browse Source 
As of c5694b3013 this is now consistent
enough across platforms to describe.

Fixes #887.

[ci skip]
This commit is contained in:
Camilla Löwy 2017-02-01 04:55:46 +01:00
parent 6801478a13
commit a46c95c7f2
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/input.dox
View File

@ -590,6 +590,12 @@ void joystick_callback(int jid, int event)
} }
@endcode @endcode
For joystick connection and disconnection events to be delivered on all
platforms, you need to call one of the [event processing](@ref events)
functions. Joystick disconnection may also be detected and the callback
called by joystick functions. The function will then return whatever it
returns for a disconnected joystick.
@section time Time input @section time Time input

6
include/GLFW/glfw3.h
View File

@ -4032,6 +4032,12 @@ GLFWAPI const char* glfwGetJoystickName(int jid);
* currently set callback. This is called when a joystick is connected to or * currently set callback. This is called when a joystick is connected to or
* disconnected from the system. * disconnected from the system.
* *
* For joystick connection and disconnection events to be delivered on all
* platforms, you need to call one of the [event processing](@ref events)
* functions. Joystick disconnection may also be detected and the callback
* called by joystick functions. The function will then return whatever it
* returns for a disconnected joystick.
*
* @param[in] cbfun The new callback, or `NULL` to remove the currently set * @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback. * callback.
* @return The previously set callback, or `NULL` if no callback was set or the * @return The previously set callback, or `NULL` if no callback was set or the