Update documentation and changes

CuarzoSoftware · Aug 6, 2024 · a58b3ae · a58b3ae
1 parent 77a0452
commit a58b3ae
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 17 deletions.
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,29 @@
+Louvre (2.5.0-1)
+
+  # New Protocols
+
+  * Idle Notify (see `LIdleListener` for details).
+  * Idle Inhibit (see `LSeat::idleInhibitorSurfaces()` for details).
+
+  # Packaging
+
+  * Added Fedora package in the downloads section. Credits to @Conan-Kudo.
+
+  # Examples
+
+  * New louvre-views Shortcuts: Credits to @mishoo:
+    * `Super + L/R Click`: Starts interactive move/resize for top-level windows.
+    * `Super + Shift + PageUp`: Toggle maximize.
+    * `Super + Shift + PageDown`: Minimize.
+
+  # Bug Fixes
+
+  * Prevent `weston-terminal` from launching when switching to TTY 1. Credits to @mishoo.
+  * Allow VT switching using the right CTRL key. Credits to @mishoo.
+
+ -- Eduardo Hopperdietzel <[email protected]>  Tue, 06 Aug 2024 13:59:30 -0400
+
+
 Louvre (2.4.1-1)
 
   # Bug Fixes & Security

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
     <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Louvre is released under the MIT license." />
   </a>
   <a href="https://github.com/CuarzoSoftware/Louvre">
-    <img src="https://img.shields.io/badge/version-2.4.1-brightgreen" alt="Current Louvre version." />
+    <img src="https://img.shields.io/badge/version-2.5.0-brightgreen" alt="Current Louvre version." />
   </a>
 </p>
 
@@ -57,6 +57,8 @@ Fortunately, Louvre simplifies this intricate process by handling all the comple
 * Fractional Scale
 * Tearing Control
 * Session Lock
+* Idle Notify
+* Idle Inhibit
 * Content Type Hint
 * Wlr Gamma Control
 * Wlr Layer Shell
@@ -155,7 +157,6 @@ Similarly as with CPU consumption, we can observe that Louvre uses fewer GPU res
 
 * Wlr Output Management
 * XDG activation Protocol
-* Idle Notify Protocol
 * Cursor Shape Protocol
 * DRM Overlay Planes Control
 * DRM Synchronization Object

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.4.1
+2.5.0
diff --git a/doxygen/md/Downloads.md b/doxygen/md/Downloads.md
@@ -5,6 +5,7 @@
 Pre-built binaries are provided for the following distributions. Please be aware that their versions may not always match the latest Louvre release.
 
 * **Arch** : [louvre](https://aur.archlinux.org/packages/louvre) - *Thanks to [@TrialnError](https://aur.archlinux.org/account/TrialnError)*.
+* **Fedora** : [louvre](https://copr.fedorainfracloud.org/coprs/ngompa/louvre/) - *Thanks to [Neal Gompa](https://github.com/Conan-Kudo)*.
 * **NixOS** : [louvre](https://search.nixos.org/packages?channel=unstable&show=louvre&from=0&size=50&sort=relevance&type=packages&query=louvre) - *Thanks to [Marco Rebhan](https://github.com/2xsaiko)*.
 
 ## Manual Building

diff --git a/doxygen/md/Examples.md b/doxygen/md/Examples.md
@@ -28,11 +28,14 @@ The dock icons featured in the screenshot were sourced from <a href="https://mac
 * `Ctrl + Alt + [F1,...,F10]` : Switches to another TTY.
 * `Ctrl + Alt + [Left/Right arrow keys]` : Navigates to the left or right workspace. If supported, you can use three or more fingers on your touchpad.
 * `Alt + [mouse over maximize button]` : While hovering the cursor over a server-side decorated toplevel window, press `Alt` to maximize the window instead of setting it to fullscreen mode.
+* `Super + Shift + PageUp`: Toggle maximize.
+* `Super + Shift + PageDown`: Minimize.
 * `Super + Shift + V` : Toggles the current output VSync.
 * `Super + Shift + T` : Changes the current output transform.
 * `Super + Shift + W` : Launches Wofi in run mode.
 * `Super + Shift + [Up/Down arrow keys]` : Increments or decrements the current output scale factor by 0.25.
 * `Super + Shift + L + [Up/Down arrow keys]` : Modifies the priority of a focused LLayerShell surface.
+* `Super + L/R Click` : Starts interactive move/resize for toplevel windows.
 
 ### Wallpaper
 

diff --git a/doxygen/md/tutorial/tmp.md b/doxygen/md/tutorial/tmp.md
@@ -32,4 +32,5 @@ Here are some links to the C++ API documentation to help you navigate it:
 - [Session Lock Manager](@ref lsessionlockmanager_detailed) and [role.](@ref lsessionlockrole_detailed)
 - [Toplevel](@ref ltoplevelrole_detailed) and [Popup](@ref ldnd_detailed) surfaces.
 - [Wlr Layer Shell](@ref llayerrole_detailed) and [Exclusive Zones.](@ref lexclusivezone_detailed)
-- [Foreign Toplevel Window Management.](@ref lforeigntoplevelcontroller_detailed)
+- [Foreign Toplevel Window Management.](@ref lforeigntoplevelcontroller_detailed)
+- [Idle Listeners and Inhibitors.](@ref lidlelistener_detailed)
diff --git a/src/lib/core/LIdleListener.h b/src/lib/core/LIdleListener.h
@@ -6,9 +6,11 @@
 /**
  * @brief Idle state listener
  *
+ * @anchor lidlelistener_detailed
+ *
  * Clients using the [Idle Notify](https://wayland.app/protocols/ext-idle-notify-v1) protocol create an
- * instance of this class to be notified when the user has been idle for a set amount of time. Clients
- * like [swayidle](https://man.archlinux.org/man/swayidle) use this information to trigger screen lockers,
+ * instance of this class to be notified when the user has been idle for a set amount of time. For example,
+ * [swayidle](https://man.archlinux.org/man/swayidle) uses this information to trigger screen lockers,
  * screen savers, etc.
  *
  * @note All idle listeners can be accessed from LSeat::idleListeners().

diff --git a/src/lib/core/LOutput.h b/src/lib/core/LOutput.h
@@ -325,13 +325,13 @@ class Louvre::LOutput : public LFactoryObject
     LFramebuffer *framebuffer() const noexcept;
 
     /**
-     * @brief Gets the framebuffer transformation.
+     * @brief Gets the framebuffer transform.
      *
-     * This method returns the current framebuffer transformation applied with setTransform().
+     * This method returns the current framebuffer transform applied with setTransform().
      *
      * The default value is @ref LTransform::Normal.
      *
-     * @return The framebuffer transformation.
+     * @return The framebuffer transforma.
      */
     LTransform transform() const noexcept;
 
@@ -352,14 +352,14 @@ class Louvre::LOutput : public LFactoryObject
      *
      * @image html https://lh3.googleusercontent.com/2ousoWwxnVGvFX5bT6ual2G8UUbhUOJ21mK1UQmthPNM-7XfracRlL5GCYBQTzt4Os28eKO_FzC6BS-rasiNngvTMI9lEdET0ItKrI2wK_9IwSDaF-hNGkTMI6gVlL0m4ENDJYbckw
      *
-     * @return The current buffer index. Alternates between [0], [0, 1] or [0, 1, 2] depending on the graphic backend configuration.
+     * @return The current buffer index. Alternates between [0, 1] or [0, 1, 2] depending on the graphic backend configuration.
      */
     Int32 currentBuffer() const noexcept;
 
     /**
      * @brief Returns the count of available buffers.
      *
-     * This method returns the number of buffers used by the output. It can be 1, 2 or 3 depending on the graphic backend configuration.
+     * This method returns the number of buffers used by the output. It can be 2 or 3 depending on the graphic backend configuration.
      */
     UInt32 buffersCount() const noexcept;
 

diff --git a/src/lib/core/LScreenshotRequest.h b/src/lib/core/LScreenshotRequest.h
@@ -14,7 +14,7 @@
  * This means that for screencasting, clients make a new LScreenshotRequest for each paintGL event.\n
  * If a request is accepted within a paintGL event, Louvre later copies the rendered frame to the client's buffer.
  *
- * @note All requests are initially denied unless accept(true) is called.
+ * @note All requests are initially denied unless accept(true) is called and no custom buffer is set for direct scanout (see LOutput::setCustomScanoutBuffer()).
  *
  * Within a paintGL event, the LOutput::screenshotRequests() vector contains the requests made for the current frame being rendered, which
  * can be more than one if multiple clients are requesting to capture it.

diff --git a/src/lib/core/LSeat.h b/src/lib/core/LSeat.h
@@ -61,16 +61,14 @@ class Louvre::LSeat : public LFactoryObject
     const std::vector<LInputDevice *> &inputDevices() const noexcept;
 
     /**
-     * @brief Surfaces that inhibit the idle state.
+     * @brief Surfaces requesting to inhibit the idle state.
      *
      * @see LIdleListener for more details.
      */
     const std::vector<LSurface *> &idleInhibitorSurfaces() const noexcept;
 
     /**
-     * @brief List of idle listeners.
-     *
-     * Provides access to idle listeners used by clients to detect when the user has been idle for a specified amount of time.
+     * @brief Listeners used by clients to detect when the user has been idle for a specified amount of time.
      *
      * @see LIdleListener for more details.
      */
@@ -313,7 +311,7 @@ class Louvre::LSeat : public LFactoryObject
      * The default implementation returns `true` if at least one of the surfaces
      * listed in `idleInhibitorSurfaces()` is mapped and visible on at least one output.
      *
-     * @note Since the method of displaying surfaces is specific to each compositor,
+     * @note Since the way of displaying surfaces is specific to each compositor,
      *       no additional checks are performed to determine if the surface is obscured
      *       by opaque areas. You may override this method to include such checks if needed.
      *