Procházet zdrojové kódy

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.
Camilla Löwy před 5 roky
rodič
revize
f5f060e6bf
1 změnil soubory, kde provedl 10 přidání a 5 odebrání
  1. 10 5
      docs/intro.dox

+ 10 - 5
docs/intro.dox

@@ -91,14 +91,17 @@ Setting these hints requires no platform specific headers or functions.
 @anchor GLFW_JOYSTICK_HAT_BUTTONS
 @anchor GLFW_JOYSTICK_HAT_BUTTONS
 __GLFW_JOYSTICK_HAT_BUTTONS__ specifies whether to also expose joystick hats as
 __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
 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
 @anchor GLFW_ANGLE_PLATFORM_TYPE_hint
 __GLFW_ANGLE_PLATFORM_TYPE__ specifies the platform type (rendering backend) to
 __GLFW_ANGLE_PLATFORM_TYPE__ specifies the platform type (rendering backend) to
 request when using OpenGL ES and EGL via
 request when using OpenGL ES and EGL via
 [ANGLE](https://chromium.googlesource.com/angle/angle/).  If the requested
 [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
 @par
 The ANGLE platform type is specified via the `EGL_ANGLE_platform_angle`
 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
 @anchor GLFW_COCOA_CHDIR_RESOURCES_hint
 __GLFW_COCOA_CHDIR_RESOURCES__ specifies whether to set the current directory to
 __GLFW_COCOA_CHDIR_RESOURCES__ specifies whether to set the current directory to
 the application to the `Contents/Resources` subdirectory of the application's
 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
 @anchor GLFW_COCOA_MENUBAR_hint
 __GLFW_COCOA_MENUBAR__ specifies whether to create the menu bar and dock icon
 __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
 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
 @subsubsection init_hints_values Supported and default values