Expand description
Low-level access to the layout algorithms themselves. For a higher-level API, see the TaffyTree struct.
§Layout functions
The layout functions all take an &mut impl LayoutPartialTree parameter, which represents a single container node and it’s direct children.
| Function | Purpose |
|---|---|
[compute_flexbox_layout] | Layout a Flexbox container and it’s direct children |
compute_grid_layout | Layout a CSS Grid container and it’s direct children |
[compute_block_layout] | Layout a Block container and it’s direct children |
compute_leaf_layout | Applies common properties like padding/border/aspect-ratio to a node before deferring to a passed closure to determine it’s size. Can be applied to nodes like text or image nodes. |
compute_root_layout | Layout the root node of a tree (regardless of it’s layout mode). This function is typically called once to begin a layout run. |
compute_hidden_layout | Mark a node as hidden during layout (like Display::None) |
compute_cached_layout | Attempts to find a cached layout for the specified node and layout inputs. Uses the provided closure to compute the layout (and then stores the result in the cache) if no cached layout is found. |
§Other functions
| Function | Requires | Purpose |
|---|---|---|
round_layout | RoundTree | Round a tree of float-valued layouts to integer pixels |
print_tree | PrintTree | Print a debug representation of a node tree and it’s computed layout |
Modules§
- common 🔒
- Generic code that is shared between multiple layout algorithms
- detailed_
info - A module for unified re-exports of detailed layout info structs, used by low level API
- grid 🔒
- This module is a partial implementation of the CSS Grid Level 1 specification https://www.w3.org/TR/css-grid-1
- leaf 🔒
- Computes size using styles and measure functions
Functions§
- compute_
cached_ layout - Attempts to find a cached layout for the specified node and layout inputs.
- compute_
grid_ layout - Grid layout algorithm This consists of a few phases:
- compute_
hidden_ layout - Creates a layout for this node and its children, recursively. Each hidden node has zero size and is placed at the origin
- compute_
leaf_ layout - Compute the size of a leaf node (node with no children)
- compute_
root_ layout - Compute layout for the root node in the tree
- round_
layout - Rounds the calculated layout to exact pixel values