From 1285e07f1bdd61eed46f3078b669801b4cf9abe5 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Tue, 28 Oct 2014 16:58:54 +0100 Subject: [PATCH] Documentation work. --- docs/compile.dox | 2 +- docs/rift.dox | 26 ++++++++------------------ docs/window.dox | 3 +++ 3 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/compile.dox b/docs/compile.dox index a8072eff..2fc463a3 100644 --- a/docs/compile.dox +++ b/docs/compile.dox @@ -252,7 +252,7 @@ defines `_GLFW_USE_CONFIG_H`, which causes this header to be included by `internal.h`. Without this macro, GLFW will expect the necessary configuration macros to be defined on the command-line. -Three macros _must_ be defined when compiling GLFW: one for selecting the window +Three macros _must_ be defined when compiling GLFW: one selecting the window creation API, one selecting the context creation API and one client library. Exactly one of each kind must be defined for GLFW to compile and link. diff --git a/docs/rift.dox b/docs/rift.dox index 105c5b2e..d763d477 100644 --- a/docs/rift.dox +++ b/docs/rift.dox @@ -30,46 +30,36 @@ monitor it corresponds to. Doing this requires you to use the @subsubsection rift_extend_detect_win32 Detecting a Rift on Windows -To identify which monitor corresponds to the Rift, compare Win32 display device -names. The display device name of a GLFW monitor is returned by @ref -glfwGetWin32Monitor and the display device name of the detected Rift is stored -in the `DisplayDeviceName` member of `ovrHmdDesc`. +The native display device name of a GLFW monitor, as returned by @ref +glfwGetWin32Monitor, corresponds to the display device name of the detected Rift +as stored, in the `DisplayDeviceName` member of `ovrHmdDesc`. @code int i, count; -GLFWmonitor* monitor = NULL; GLFWmonitor** monitors = glfwGetMonitors(&count); for (i = 0; i < count; i++) { if (strcmp(glfwGetWin32Monitor(monitors[i]), hmd->DisplayDeviceName) == 0) - { - monitor = monitors[i]; - break; - } + return monitors[i]; } @endcode @subsubsection rift_extend_detect_osx Detecting a Rift on OS X -To identify which monitor corresponds to the Rift, compare OS X display IDs. -The display ID of a GLFW monitor is returned by @ref glfwGetCocoaMonitor and the -display ID of the detected Rift is stored in the `DisplayId` member of -`ovrHmdDesc`. +The native display ID of a GLFW monitor, as returned by @ref +glfwGetCocoaMonitor, corresponds to the display ID of the detected Rift, as +stored in the `DisplayId` member of `ovrHmdDesc`. @code int i, count; -GLFWmonitor* monitor = NULL; GLFWmonitor** monitors = glfwGetMonitors(&count); for (i = 0; i < count; i++) { if (glfwGetCocoaMonitor(monitors[i]) == hmd->DisplayId) - { - monitor = monitors[i]; - break; - } + return monitors[i]; } @endcode diff --git a/docs/window.dox b/docs/window.dox index 35031607..6b2b557f 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -75,6 +75,9 @@ Once you have a full screen window, you can change its resolution with @ref glfwSetWindowSize. The new video mode will be selected and set the same way as the video mode chosen by @ref glfwCreateWindow. + +@subsubsection window_windowed_full_screen "Windowed full screen" windows + By default, the original video mode of the monitor will be restored and the window iconified if it loses input focus, to allow the user to switch back to the desktop. This behavior can be disabled with the `GLFW_AUTO_ICONIFY` window