Zengtudor/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2025-11-03 22:04:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work

Browse Source 
Gamma will never be supported on Wayland.

Closes #1134.
This commit is contained in:
Emmanuel Gil Peyrot 2017-11-17 12:17:43 +00:00 committed by Camilla Löwy
parent 68809869f9
commit 9c513346ad
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
include/GLFW/glfw3.h
View File

@ -2089,8 +2089,8 @@ GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
* GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
*
* @remark @wayland Gamma handling is currently unavailable, this function will
* always emit @ref GLFW_PLATFORM_ERROR.
* @remark @wayland Gamma handling is a priviledged protocol, this function
* will thus never be implemented and emits @ref GLFW_PLATFORM_ERROR.
*
* @thread_safety This function must only be called from the main thread.
*
@ -2113,8 +2113,9 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
* @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
* GLFW_PLATFORM_ERROR.
*
* @remark @wayland Gamma handling is currently unavailable, this function will
* always return `NULL` and emit @ref GLFW_PLATFORM_ERROR.
* @remark @wayland Gamma handling is a priviledged protocol, this function
* will thus never be implemented and emits @ref GLFW_PLATFORM_ERROR while
* returning `NULL`.
*
* @pointer_lifetime The returned structure and its arrays are allocated and
* freed by GLFW. You should not free them yourself. They are valid until the
@ -2156,8 +2157,8 @@ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
*
* @remark @win32 The gamma ramp size must be 256.
*
* @remark @wayland Gamma handling is currently unavailable, this function will
* always emit @ref GLFW_PLATFORM_ERROR.
* @remark @wayland Gamma handling is a priviledged protocol, this function
* will thus never be implemented and emits @ref GLFW_PLATFORM_ERROR.
*
* @pointer_lifetime The specified gamma ramp is copied before this function
* returns.