mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-25 22:14:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix window_icon subsection in window.dox

Browse Source
This commit is contained in:
ws909 2023-03-09 17:41:33 +01:00
parent 364774dbc7
commit cb15669585
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/window.dox
View File

@ -902,10 +902,14 @@ sequential rows, starting from the top-left corner.
To revert to the default window icon, pass in an empty image array. To revert to the default window icon, pass in an empty image array.
@code
glfwSetWindowIcon(window, 0, NULL);
@endcode
On Windows and X11, the window's title bar and taskbar icons are set with this method. On Windows and X11, the window's title bar and taskbar icons are set with this method.
On MacOS, a `NULL` window handle may be passed to set the application's Dock icon. On MacOS, a `NULL` window handle may be passed to set the application's Dock icon.
Some platforms support querying an optimal size for its icons. Some platforms support querying for an optimal size for its icons.
You can ask for this size by passing a `NULL` window handle, a count of zero, You can ask for this size by passing a `NULL` window handle, a count of zero,
and a valid pointer to an image with its `pixels` field set to `NULL`: and a valid pointer to an image with its `pixels` field set to `NULL`:
@ -919,11 +923,6 @@ glfwSetWindowIcon(window, 1, &image);
free(image.pixels); free(image.pixels);
@endcode @endcode
@code
glfwSetWindowIcon(window, 0, NULL);
@endcode
@subsection window_monitor Window monitor @subsection window_monitor Window monitor
Full screen windows are associated with a specific monitor. You can get the Full screen windows are associated with a specific monitor. You can get the