Update from pinnacle-comp/pinnacle@500ba85

Author: pinnacle-comp

main/classes/pinnacle.layout.LayoutNode.md

@@ -45,9 +45,9 @@ The gaps the node applies around its children nodes.
 
 The proportion the node takes up relative to its siblings.
 
-### children
+### children <Badge type="danger" text="nullable" />
 
-`children`: <code><a href="/lua-reference/main/classes/pinnacle.layout.LayoutNode">pinnacle.layout.LayoutNode</a>[]</code>
+`children?`: <code><a href="/lua-reference/main/classes/pinnacle.layout.LayoutNode">pinnacle.layout.LayoutNode</a>[]</code>
 
 Child layout nodes.
 

main/classes/pinnacle.layout.LayoutResponse.md

@@ -0,0 +1,27 @@
+---
+outline: [2, 3]
+---
+
+# Class `pinnacle.layout.LayoutResponse`
+
+
+A response to a layout request.
+
+## Fields
+
+### root_node
+
+`root_node`: <code><a href="/lua-reference/main/classes/pinnacle.layout.LayoutNode">pinnacle.layout.LayoutNode</a></code>
+
+The root node of the layout tree.
+
+### tree_id
+
+`tree_id`: <code>integer</code>
+
+A non-negative identifier.
+
+Trees that are considered "the same", like trees for a certain tag and layout,
+should have the same identifier to allow Pinnacle to remember tile sizing.
+
+

main/classes/pinnacle.layout.builtin.Cycle.md

@@ -84,3 +84,21 @@ Gets the current layout generator for the given tag.
 
 
 
+
+### <Badge type="method" text="method" /> current_tree_id
+
+<div class="language-lua"><pre><code>function pinnacle.layout.builtin.Cycle:current_tree_id()
+    -> integer</code></pre></div>
+
+Gets a (most-likely) unique identifier for the current layout tree.
+This is guaranteed to be greater than zero.
+
+
+
+
+#### Returns
+
+1. <code>integer</code>
+
+
+

main/classes/pinnacle.layout.md

@@ -23,35 +23,45 @@ Builtin layout generators.
 
 ### <Badge type="function" text="function" /> manage
 
-<div class="language-lua"><pre><code>function pinnacle.layout.manage(on_layout: fun(args: <a href="/lua-reference/main/classes/pinnacle.layout.LayoutArgs">pinnacle.layout.LayoutArgs</a>): <a href="/lua-reference/main/classes/pinnacle.layout.LayoutNode">pinnacle.layout.LayoutNode</a>)
+<div class="language-lua"><pre><code>function pinnacle.layout.manage(on_layout: fun(args: <a href="/lua-reference/main/classes/pinnacle.layout.LayoutArgs">pinnacle.layout.LayoutArgs</a>): <a href="/lua-reference/main/classes/pinnacle.layout.LayoutResponse">pinnacle.layout.LayoutResponse</a>)
     -> <a href="/lua-reference/main/classes/pinnacle.layout.LayoutRequester">pinnacle.layout.LayoutRequester</a></code></pre></div>
 
 Begins managing layout requests from the compositor.
 
-You must call this function to get windows to lay out.
+You must call this function to get windows to tile.
 The provided function will be run with the arguments of the layout request.
-It must return a `LayoutNode` that represents the root of a layout tree.
+It must return a `LayoutResponse` containing a `LayoutNode` that represents
+the root of a layout tree, along with an identifier.
 
 #### Example
 
 ```lua
 local layout_requester = Layout.manage(function(args)
     local first_tag = args.tags[1]
     if not first_tag then
+        ---@type pinnacle.layout.LayoutResponse
         return {
-            children = {},
+            root_node = {},
+            tree_id = 0,
         }
     end
     layout_cycler.current_tag = first_tag
-    return layout_cycler:layout(args.window_count)
+    local root_node = layout_cycler:layout(args.window_count)
+    local tree_id = layout_cycler:current_tree_id()
+
+    ---@type pinnacle.layout.LayoutResponse
+    return {
+        root_node = root_node,
+        tree_id = tree_id,
+    }
 end)
 ```
 
 
 
 #### Parameters
 
-`on_layout`: <code>fun(args: <a href="/lua-reference/main/classes/pinnacle.layout.LayoutArgs">pinnacle.layout.LayoutArgs</a>): <a href="/lua-reference/main/classes/pinnacle.layout.LayoutNode">pinnacle.layout.LayoutNode</a></code> - A function that receives layout arguments and builds and returns a layout tree.
+`on_layout`: <code>fun(args: <a href="/lua-reference/main/classes/pinnacle.layout.LayoutArgs">pinnacle.layout.LayoutArgs</a>): <a href="/lua-reference/main/classes/pinnacle.layout.LayoutResponse">pinnacle.layout.LayoutResponse</a></code> - A function that receives layout arguments and builds and returns a layout response.
 
 
 

main/classes/pinnacle.window.WindowHandle.md

@@ -76,6 +76,42 @@ end
 
 
 
+### <Badge type="method" text="method" /> resize_tile
+
+<div class="language-lua"><pre><code>function pinnacle.window.WindowHandle:resize_tile(dimensions: { left?: integer, right?: integer, top?: integer, bottom?: integer })</code></pre></div>
+
+If this window is tiled, resizes its tile by shifting the left, right,
+top, and bottom edges by the provided pixel amounts.
+
+Positive amounts shift edges right/down, while negative amounts
+shift edges left/up.
+
+If this resizes the tile in a direction that it can no longer resize
+towards (e.g. it's at the edge of the screen), it will resize in the opposite
+direction.
+
+#### Example
+```lua
+-- Grow the focused tiled window 10 pixels leftward
+Window.get_focused():resize_tile({ left = -10 })
+
+-- Shrink the focused tiled window 10 pixels inward from the right
+Window.get_focused():resize_tile({ right = -10 })
+
+-- Grow the focused tiled window 20 pixels centered vertically
+Window.get_focused():resize_tile({ top = -10, bottom = 10 })
+```
+
+
+#### Parameters
+
+`dimensions`: <code>{ left?: integer, right?: integer, top?: integer, bottom?: integer }</code>
+
+
+
+
+
+
 ### <Badge type="method" text="method" /> set_fullscreen
 
 <div class="language-lua"><pre><code>function pinnacle.window.WindowHandle:set_fullscreen(fullscreen: boolean)</code></pre></div>