From f5f060e6bfa95872281188301920eabfc8bfc740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Fri, 26 Jun 2020 17:39:57 +0200 Subject: [PATCH] Init hint documentation work The documentation for window hints had several features that had not been carried over to init hints. This also removes listing glfwInitHint for each hint, which was an artifact of the removal of glfwInitHintString. --- docs/intro.dox | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/intro.dox b/docs/intro.dox index abbe9d11..1d041ae6 100644 --- a/docs/intro.dox +++ b/docs/intro.dox @@ -91,14 +91,17 @@ Setting these hints requires no platform specific headers or functions. @anchor GLFW_JOYSTICK_HAT_BUTTONS __GLFW_JOYSTICK_HAT_BUTTONS__ specifies whether to also expose joystick hats as buttons, for compatibility with earlier versions of GLFW that did not have @ref -glfwGetJoystickHats. Set this with @ref glfwInitHint. +glfwGetJoystickHats. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. @anchor GLFW_ANGLE_PLATFORM_TYPE_hint __GLFW_ANGLE_PLATFORM_TYPE__ specifies the platform type (rendering backend) to request when using OpenGL ES and EGL via [ANGLE](https://chromium.googlesource.com/angle/angle/). If the requested -platform type is unavailable, ANGLE will use its default. Set this hint with -@ref glfwInitHint. +platform type is unavailable, ANGLE will use its default. Possible values are +one of `GLFW_ANGLE_PLATFORM_TYPE_NONE`, `GLFW_ANGLE_PLATFORM_TYPE_OPENGL`, +`GLFW_ANGLE_PLATFORM_TYPE_OPENGLES`, `GLFW_ANGLE_PLATFORM_TYPE_D3D9`, +`GLFW_ANGLE_PLATFORM_TYPE_D3D11`, `GLFW_ANGLE_PLATFORM_TYPE_VULKAN` and +`GLFW_ANGLE_PLATFORM_TYPE_METAL`. @par The ANGLE platform type is specified via the `EGL_ANGLE_platform_angle` @@ -111,12 +114,14 @@ extension. This extension is not used if this hint is @anchor GLFW_COCOA_CHDIR_RESOURCES_hint __GLFW_COCOA_CHDIR_RESOURCES__ specifies whether to set the current directory to the application to the `Contents/Resources` subdirectory of the application's -bundle, if present. Set this with @ref glfwInitHint. +bundle, if present. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This is +ignored on other platforms. @anchor GLFW_COCOA_MENUBAR_hint __GLFW_COCOA_MENUBAR__ specifies whether to create the menu bar and dock icon when GLFW is initialized. This applies whether the menu bar is created from -a nib or manually by GLFW. Set this with @ref glfwInitHint. +a nib or manually by GLFW. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. +This is ignored on other platforms. @subsubsection init_hints_values Supported and default values