Class Builtin.Spiral : LayoutGenerator

A LayoutGenerator that lays out windows in a spiral.

This is similar to the dwindle layout but in a spiral instead of towards the borrom right corner.

Fields

gaps

gaps: integer | { inner: integer, outer: integer } = 8

Gaps between windows, in pixels.

This can be an integer or the table { inner: integer, outer: integer }. If it is an integer, all gaps will be that amount of pixels wide. If it is a table, outer denotes the amount of pixels around the edge of the output area that will become a gap, and inner denotes the amount of pixels around each window that will become a gap.

This means that, for example, inner = 2 will cause the gap width between windows to be 4; 2 around each window.

split_factors

split_factors: table<integer, number>

The proportions that each split will split at.

The first split will use the factor at [1], the second at [2], and so on.

Functions

method layout

function Builtin.Spiral:layout(args: LayoutArgs)
    -> { x: integer, y: integer, width: integer, height: integer }[]

Parameters

args: LayoutArgs

Returns

1. { x: integer, y: integer, width: integer, height: integer }[]