.\" @(#)PEXAccumulateState.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXAccumulateState 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXAccumulateState \- Accumulate Rendering Pipeline State
.SH SYNTAX
.\" .nr F1 \w'PEXElementRef     'u
.\" .nr F2 \w'renderer     'u
.\" .ta .25i +\n(F1u +\n(F2u
.LP
.\" .nf
.\" .IP \fBvoid\fP 5
.\" .B PEXAccumulateState (
.\" .B	Display	*display,
.\" .B	PEXRenderer	renderer,
.\" .B	unsigned long	count,
.\" .B	PEXElementRef	elements );
.\" .fi
.HP
void PEXAccumulateState\^(\^Display *\fIdisplay\fP\^, PEXRenderer \fIrenderer\fP\^, unsigned long \fIcount\fP\^, PEXElementRef *\fIelements\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIrenderer\fP 1i
The resource identifier of a renderer resource.
.IP \fIcount\fP 1i
The number of elements.
.IP \fIelements\fP 1i
A pointer to the structure element reference path.
.SH RETURNS
None
.SH DESCRIPTION
.\" indexing
.IX PEXAccumulateState
.IX "Accumulation" "PEXAccumulateState"
.LP
This function accumulates the state that would be in effect if a traversal
were done to the element specified in the path.  If the
.I renderer
state is
.B PEXIdle,
the request is ignored.
.LP
The accumulation of rendering pipeline state begins with the current pipeline
attributes.  A linear traversal down the specified path is then made and
the structure
.I elements
that lie along the specified path are examined in order.
Any element that contains an output command that would modify the pipeline
state (i.e. output attributes) is sent to the renderer for processing.  All
other output commands (i.e. output primitives and structure output commands)
are skipped.  The traversal is flat meaning that the current pipeline
attributes will not be saved when a structure in the path is executed.
However, the current path offset is incremented for each output command that
is encountered during the state accumulation.
.SH DATA STRUCTURES
.LP
.nf
typedef  XID	PEXRenderer;
typedef  XID	PEXStructure;
.sp
typedef struct {
	PEXStructure	structure;
	unsigned long	offset;
.br
} PEXElementRef;
.fi
.SH ERRORS
.TP
.SB BadPEXPath
The specified path is invalid.
.TP
.SB BadPEXRenderer
The specified renderer resource identifier is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXBeginRendering (3)
.BR PEXCreateStructure (3)
.BR PEXCreateRenderer (3)
.fi