Documentation work

Elaborate on what 'work' means in the context of joystick input.
This commit is contained in:
Camilla Löwy 2026-01-22 16:23:40 +01:00
parent 2d7ae8f2d0
commit bafb134769

View File

@ -4520,7 +4520,8 @@ GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow*
* GLFW will pass those events on to the application callbacks before * GLFW will pass those events on to the application callbacks before
* returning. * returning.
* *
* Event processing is not required for joystick input to work. * Event processing is not required to receive joystick input. Joystick state
* is polled when a joystick input or gamepad input function is called.
* *
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
* GLFW_PLATFORM_ERROR. * GLFW_PLATFORM_ERROR.
@ -4565,7 +4566,8 @@ GLFWAPI void glfwPollEvents(void);
* GLFW will pass those events on to the application callbacks before * GLFW will pass those events on to the application callbacks before
* returning. * returning.
* *
* Event processing is not required for joystick input to work. * Event processing is not required to receive joystick input. Joystick state
* is polled when a joystick input or gamepad input function is called.
* *
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
* GLFW_PLATFORM_ERROR. * GLFW_PLATFORM_ERROR.
@ -4612,7 +4614,8 @@ GLFWAPI void glfwWaitEvents(void);
* GLFW will pass those events on to the application callbacks before * GLFW will pass those events on to the application callbacks before
* returning. * returning.
* *
* Event processing is not required for joystick input to work. * Event processing is not required to receive joystick input. Joystick state
* is polled when a joystick input or gamepad input function is called.
* *
* @param[in] timeout The maximum amount of time, in seconds, to wait. * @param[in] timeout The maximum amount of time, in seconds, to wait.
* *