.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "notcurses_pile" "3" "v3.0.0" "" ""
.hy
.SH NAME
.PP
notcurses_pile - operations on Notcurses piles
.SH SYNOPSIS
.PP
\f[B]struct ncplane* notcurses_top(struct notcurses*
\f[R]\f[I]n\f[R]\f[B]);\f[R]
.PP
\f[B]struct ncplane* notcurses_bottom(struct notcurses*
\f[R]\f[I]n\f[R]\f[B]);\f[R]
.PP
\f[B]struct ncplane* ncpile_top(struct ncplane*
\f[R]\f[I]n\f[R]\f[B]);\f[R]
.PP
\f[B]struct ncplane* ncpile_bottom(struct ncplane*
\f[R]\f[I]n\f[R]\f[B]);\f[R]
.SH DESCRIPTION
.PP
Notcurses does not export the \f[B]ncpile\f[R] type, nor any
functionality that uses it directly.
Piles are nonetheless an important concept in Notcurses.
Functions which operate on piles (e.g.
\f[B]ncpile_render(3)\f[R] are invoked with any \f[B]ncplane\f[R] within
that pile.
.PP
Piles are collections of \f[B]ncplane\f[R]s, independent from one
another for purposes of rendering and also thread-safety.
While only one pile can be rasterized (written to the display) at a
time, arbitrary concurrent actions can be safely performed on distinct
piles.
Piles do not compose: rasterizing a pile destroys any overlapping
material.
.PP
A pile is created in one of three ways:
.IP \[bu] 2
\f[B]ncpile_create(3)\f[R] is called,
.IP \[bu] 2
\f[B]ncvisual_blit(3)\f[R] is called with a \f[B]NULL\f[R] target plane
\f[B]\f[BI]n\f[B]\f[R], or
.IP \[bu] 2
\f[B]ncplane_reparent(3)\f[R] is called with \f[B]\f[BI]n\f[B]\f[R]
equal to \f[B]\f[BI]newparent\f[B]\f[R], and \f[B]\f[BI]n\f[B]\f[R] is
not already a root plane.
.PP
A pile is destroyed whenever its last \f[B]ncplane\f[R] is destroyed, or
reparented into some other pile.
.PP
The planes of a pile are totally ordered along the z-axis.
\f[B]ncpile_top\f[R] and \f[B]ncpile_bottom\f[R] return the topmost and
bottommost planes, respectively, of the pile containing their argument.
\f[B]notcurses_top\f[R] and \f[B]notcurses_bottom\f[R] do the same for
the standard pile.
.SH NOTES
.SH BUGS
.SH SEE ALSO
.PP
\f[B]notcurses(3)\f[R], \f[B]notcurses_plane(3)\f[R],
\f[B]notcurses_render(3)\f[R], \f[B]notcurses_visual(3)\f[R]
.SH AUTHORS
nick black <nickblack@linux.com>.