.\" @(#)PEXExecuteStructure.3 1.4 95/03/24 SMI;
.so man3/pex.macs
.TH PEXExecuteStructure 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXExecuteStructure - Execute Structure
.SH SYNTAX
.HP
void PEXExecuteStructure\^(\^Display *\fIdisplay\fP\^, XID \fIresource_id\fP\^,
PEXOCRequestType \fIreq_type\fP\^, PEXStructure \fIstructure\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIresource_id\fP 1i
The resource identifier of the renderer or structure.
.IP \fIreq_type\fP 1i
The request type for the output command (
.B PEXOCRender,
.B PEXOCStore,
.B PEXOCRenderSingle
or
.B PEXOCStoreSingle
).
.IP \fIstructure\fP 1i
The resource identifier of the structure.
.SH RETURNS
None
.SH DESCRIPTION
.\" indexing
.IX PEXExecuteStructure
.LP
This function creates an
execute structure output command
which causes the specified
.I structure
to be executed during structure traversal.
Executing a
.I structure
consists of these steps:
.RS
.IP 1. 3
Save the current state of the rendering pipeline.
.IP 2.
Set the global transform to the current composite modeling transform.
.IP 3.
Set the local transform to the identity matrix.
.IP 4.
Process all structure elements in the called structure.
.IP 5.
Restore the state saved at step 1.
.RE
.LP
If
.I structure
does not exist at the time
.B PEXExecuteStructure
is processed, a
.SB BadPEXOutputCommand
error is produced.  The structure must first be created.
.SH ERRORS
.TP
.SB BadPEXOutputCommand
The output command contains an invalid value.
.TP
.SB BadPEXRenderer
The specified renderer resource identifier is invalid.
.TP
.SB BadPEXStructure
The specified structure resource identifier is invalid.
.SH SEE ALSO
.LP
.nf
.BR PEXCreateStructure (3)
.BR PEXBeginStructure (3)
.BR PEXEndStructure (3)
.fi