.\" @(#)PEXEscape-PEXSunEscIdFlushRenderer.3 1.3 95/03/24 SMI;
.so man3/pex.macs
.TH PEXEscape-PEXSunEscIdFlushRenderer 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXEscape-PEXSunEscIdFlushRenderer - PEX Flush Renderer Escape
.SH SYNTAX
.HP
void PEXEscape\^(\^Display *\fIdisplay\fP\^, unsigned long \fIescape_id\fP\^, int \fIlength\fP\^, char *\fIescape_data\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIescape_id\fP 1i
The escape identifier.
.IP \fIlength\fP 1i
The length, in bytes, of data for the escape request.
.IP \fIescape_data\fP 1i
A pointer to data for the escape request.
.SH RETURNS
None
.SH DESCRIPTION
.\" indexing
.IX PEXEscape-PEXSunEscIdFlushRenderer
.IX "Escapes" "PEXEscape-PEXSunEscIdFlushRenderer"
.LP
To use the Sun FlushRenderer escape, the
.I escape_id
parameter should be set to
.B PEXSunEscIdFlushRenderer,
the
.I escape_data
parameter should be set to point to structure type
.I pexSunEscFlushRendererData,
and the
.I length
parameter should be set to the total length of
.I escape_data.
.LP
This escape forces all pending output commands to be either drawn or discarded.
.LP
If flush is
.SB True,
all pending output is rendered onto the drawable associated with the renderer,
or if the renderer state is
.I Picking,
all pending output is processed.
If flush is
.SB False,
all pending output is discarded.
.LP
If the renderer state is Idle, this escape has no effect.
.SH DATA STRUCTURES
.nf
typedef struct {
.br
	CARD32	rdr B32;
	CARD8		flush;
	CARD8		unused[3];
.br
} pexSunEscFlushRendererData;
.fi
.SH SEE ALSO
.LP
.nf
.BR PEXEscape (3)
.fi