aboutsummaryrefslogtreecommitdiffstats
path: root/layout/doc.go
diff options
context:
space:
mode:
authorSam Anthony <sam@samanthony.xyz>2026-02-10 09:30:42 -0500
committerSam Anthony <sam@samanthony.xyz>2026-02-10 09:30:42 -0500
commit3ce04a4d3dc8d174b520d85804e5c8dce8c5d08f (patch)
tree8ae271f0f151e1870b25574a88218f2040841247 /layout/doc.go
parentfa47463d8fa0dbd1b12ef227c15fa573e45244cd (diff)
downloadgui-3ce04a4d3dc8d174b520d85804e5c8dce8c5d08f.zip
add layout resize functions
Diffstat (limited to 'layout/doc.go')
-rw-r--r--layout/doc.go15
1 files changed, 15 insertions, 0 deletions
diff --git a/layout/doc.go b/layout/doc.go
new file mode 100644
index 0000000..bae4673
--- /dev/null
+++ b/layout/doc.go
@@ -0,0 +1,15 @@
+/*
+Package layout provides means of partitioning screen space.
+
+A layout exists in a parent Env, and has one or more child Envs. It
+acts as a multiplexer for the children. The parent Env may be a window,
+another layout, or whatever... Several layers of layouts can be composed.
+
+A layout allocates screen area to its children by intercepting Resize
+events from the parent Env. Upon reception by the layout, a Resize event
+is transformed for each child, and forwarded to them.
+
+Draw calls from the children are intercepted and translated onto their
+respective areas before being forwarded to the parent Env.
+*/
+package layout