From cb15669585dd01ad3acfa3e3e902dbb41a7fcb89 Mon Sep 17 00:00:00 2001 From: ws909 <37029098+ws909@users.noreply.github.com> Date: Thu, 9 Mar 2023 17:41:33 +0100 Subject: [PATCH] Fix window_icon subsection in window.dox --- docs/window.dox | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/window.dox b/docs/window.dox index 560c7fa3..e62a6eab 100644 --- a/docs/window.dox +++ b/docs/window.dox @@ -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. +@code +glfwSetWindowIcon(window, 0, NULL); +@endcode + 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. -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, 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); @endcode -@code -glfwSetWindowIcon(window, 0, NULL); -@endcode - - @subsection window_monitor Window monitor Full screen windows are associated with a specific monitor. You can get the