[RCORE] Update comments on fullscreen and boderless window to describ…

…e what they do (#4280) * Update raylib_api.* by CI * update fullscreen and borderless comments to better describe what they do. * Update raylib_api.* by CI --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
raysan5 · Aug 24, 2024 · 0aba21f · 0aba21f
1 parent 4c9282b
commit 0aba21f
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/parser/output/raylib_api.json b/parser/output/raylib_api.json
@@ -3215,12 +3215,12 @@
     },
     {
       "name": "ToggleFullscreen",
-      "description": "Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)",
+      "description": "Toggle window state: fullscreen/windowed [resizes monitor to match window resolution] (only PLATFORM_DESKTOP)",
       "returnType": "void"
     },
     {
       "name": "ToggleBorderlessWindowed",
-      "description": "Toggle window state: borderless windowed (only PLATFORM_DESKTOP)",
+      "description": "Toggle window state: borderless windowed [resizes window to match monitor resolution] (only PLATFORM_DESKTOP)",
       "returnType": "void"
     },
     {

diff --git a/parser/output/raylib_api.lua b/parser/output/raylib_api.lua
@@ -3158,12 +3158,12 @@ return {
     },
     {
       name = "ToggleFullscreen",
-      description = "Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)",
+      description = "Toggle window state: fullscreen/windowed [resizes monitor to match window resolution] (only PLATFORM_DESKTOP)",
       returnType = "void"
     },
     {
       name = "ToggleBorderlessWindowed",
-      description = "Toggle window state: borderless windowed (only PLATFORM_DESKTOP)",
+      description = "Toggle window state: borderless windowed [resizes window to match monitor resolution] (only PLATFORM_DESKTOP)",
       returnType = "void"
     },
     {

diff --git a/parser/output/raylib_api.txt b/parser/output/raylib_api.txt
@@ -1056,12 +1056,12 @@ Function 013: ClearWindowState() (1 input parameters)
 Function 014: ToggleFullscreen() (0 input parameters)
   Name: ToggleFullscreen
   Return type: void
-  Description: Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)
+  Description: Toggle window state: fullscreen/windowed [resizes monitor to match window resolution] (only PLATFORM_DESKTOP)
   No input parameters
 Function 015: ToggleBorderlessWindowed() (0 input parameters)
   Name: ToggleBorderlessWindowed
   Return type: void
-  Description: Toggle window state: borderless windowed (only PLATFORM_DESKTOP)
+  Description: Toggle window state: borderless windowed [resizes window to match monitor resolution] (only PLATFORM_DESKTOP)
   No input parameters
 Function 016: MaximizeWindow() (0 input parameters)
   Name: MaximizeWindow

diff --git a/parser/output/raylib_api.xml b/parser/output/raylib_api.xml
@@ -703,9 +703,9 @@
         <Function name="ClearWindowState" retType="void" paramCount="1" desc="Clear window configuration state flags">
             <Param type="unsigned int" name="flags" desc="" />
         </Function>
-        <Function name="ToggleFullscreen" retType="void" paramCount="0" desc="Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)">
+        <Function name="ToggleFullscreen" retType="void" paramCount="0" desc="Toggle window state: fullscreen/windowed [resizes monitor to match window resolution] (only PLATFORM_DESKTOP)">
         </Function>
-        <Function name="ToggleBorderlessWindowed" retType="void" paramCount="0" desc="Toggle window state: borderless windowed (only PLATFORM_DESKTOP)">
+        <Function name="ToggleBorderlessWindowed" retType="void" paramCount="0" desc="Toggle window state: borderless windowed [resizes window to match monitor resolution] (only PLATFORM_DESKTOP)">
         </Function>
         <Function name="MaximizeWindow" retType="void" paramCount="0" desc="Set window state: maximized, if resizable (only PLATFORM_DESKTOP)">
         </Function>

diff --git a/src/raylib.h b/src/raylib.h
@@ -968,8 +968,8 @@ RLAPI bool IsWindowResized(void);                                 // Check if wi
 RLAPI bool IsWindowState(unsigned int flag);                      // Check if one specific window flag is enabled
 RLAPI void SetWindowState(unsigned int flags);                    // Set window configuration state using flags (only PLATFORM_DESKTOP)
 RLAPI void ClearWindowState(unsigned int flags);                  // Clear window configuration state flags
-RLAPI void ToggleFullscreen(void);                                // Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)
-RLAPI void ToggleBorderlessWindowed(void);                        // Toggle window state: borderless windowed (only PLATFORM_DESKTOP)
+RLAPI void ToggleFullscreen(void);                                // Toggle window state: fullscreen/windowed [resizes monitor to match window resolution] (only PLATFORM_DESKTOP)
+RLAPI void ToggleBorderlessWindowed(void);                        // Toggle window state: borderless windowed [resizes window to match monitor resolution] (only PLATFORM_DESKTOP)
 RLAPI void MaximizeWindow(void);                                  // Set window state: maximized, if resizable (only PLATFORM_DESKTOP)
 RLAPI void MinimizeWindow(void);                                  // Set window state: minimized, if resizable (only PLATFORM_DESKTOP)
 RLAPI void RestoreWindow(void);                                   // Set window state: not minimized/maximized (only PLATFORM_DESKTOP)