Class Builtin.MasterStack : LayoutGenerator

A LayoutGenerator that has one master area to one side and a stack of windows next to it.

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.

master_factor

master_factor: number = 0.5

The proportion of the output taken up by the master window(s).

This is a float that will be clamped between 0.1 and 0.9.

master_side

master_side: "left" | "right" | "top" | "bottom" = "left"

The side the master window(s) will be on.

master_count

master_count: integer = 1

How many windows the master side will have.

Functions

method layout

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

Parameters

args: LayoutArgs

Returns

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