mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-10 00:51:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work.

Browse Source
This commit is contained in:
Camilla Berglund 2013-04-11 01:07:07 +02:00
parent 159f9b9526
commit fa0cbd9a44
2 changed files with 185 additions and 185 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/window.dox
View File

@ -65,7 +65,7 @@ buffers.
The `GLFW_STEREO` hint specifies whether to use stereoscopic rendering. The `GLFW_STEREO` hint specifies whether to use stereoscopic rendering.
The `GLFW_SAMPLES` hint specifies the desired number of samples to use for The `GLFW_SAMPLES` hint specifies the desired number of samples to use for
multisampling. multisampling. Zero disables multisampling.
The `GLFW_SRGB_CAPABLE` hint specifies whether the framebuffer should be The `GLFW_SRGB_CAPABLE` hint specifies whether the framebuffer should be
sRGB capable. sRGB capable.
@ -90,8 +90,7 @@ While there is no way to ask the driver for a context of the highest supported
version, most drivers provide this when you ask GLFW for a version version, most drivers provide this when you ask GLFW for a version
1.0 context. 1.0 context.
For OpenGL ES, these hints are hard constraints, as there is no backward For OpenGL ES, these hints are hard constraints.
compatibility between OpenGL ES versions.
If an OpenGL context is requested, the `GLFW_OPENGL_FORWARD_COMPAT` hint If an OpenGL context is requested, the `GLFW_OPENGL_FORWARD_COMPAT` hint
specifies whether the OpenGL context should be forward-compatible, i.e. one specifies whether the OpenGL context should be forward-compatible, i.e. one
@ -119,9 +118,9 @@ a robustness strategy.
@subsection window_hints_wnd Window related hints @subsection window_hints_wnd Window related hints
The `GLFW_RESIZABLE` hint specifies whether the window will be resizable by The `GLFW_RESIZABLE` hint specifies whether the window will be resizable *by the
the user. The window will still be resizable using the @ref user*. The window will still be resizable using the @ref glfwSetWindowSize
glfwSetWindowSize function. This hint is ignored for fullscreen windows. function. This hint is ignored for fullscreen windows.
The `GLFW_VISIBLE` hint specifies whether the window will be initially The `GLFW_VISIBLE` hint specifies whether the window will be initially
visible. This hint is ignored for fullscreen windows. visible. This hint is ignored for fullscreen windows.

9
include/GL/glfw3.h
View File

@ -1121,16 +1121,17 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* *
* This function creates a window and its associated context. Most of the * This function creates a window and its associated context. Most of the
* options controlling how the window and its context should be created are * options controlling how the window and its context should be created are
* specified via the @ref glfwWindowHint function. * specified through @ref glfwWindowHint.
* *
* Successful creation does not change which context is current. Before you * Successful creation does not change which context is current. Before you
* can use the newly created context, you need to make it current using @ref * can use the newly created context, you need to make it current using @ref
* glfwMakeContextCurrent. * glfwMakeContextCurrent.
* *
* Note that the created window and context may differ from what you requested, * Note that the created window and context may differ from what you requested,
* as not all parameters and hints are hard constraints. This includes the * as not all parameters and hints are
* size of the window, especially for full screen windows. To retrieve the * [hard constraints](@ref window_hints_hard). This includes the size of the
* actual properties of the window and context, use queries like @ref * window, especially for full screen windows. To retrieve the actual
* properties of the window and context, use queries like @ref
* glfwGetWindowParam and @ref glfwGetWindowSize. * glfwGetWindowParam and @ref glfwGetWindowSize.
* *
* @param[in] width The desired width, in screen coordinates, of the window. * @param[in] width The desired width, in screen coordinates, of the window.