.\" @(#)PEXMatchRenderingTargets.3 1.5 95/03/24 SMI;
.so man3/pex.macs
.TH PEXMatchRenderingTargets 3 "May 1995" "Solaris PEXlib Reference Manual" ""
.SH NAME
PEXMatchRenderingTargets - Return Information about Supported Rendering Targets
.SH SYNTAX
.HP
Status PEXMatchRenderingTargets\^(\^Display *\fIdisplay\fP\^, Drawable \fIdrawable\fP\^, int \fIdepth\fP\^, int \fItype\fP\^, Visual *\fIvisual\fP\^, unsigned long \fImax_targets\fP\^, unsigned long *\fIcount_return\fP\^, PEXRenderingTarget **\fItargets_return\fP\^)
.SH PARAMETERS
.IP \fIdisplay\fP 1i
A pointer to a display structure returned by a successful
.B XOpenDisplay
call.
.IP \fIdrawable\fP 1i
The drawable indicates which screen the application is interested in.
.IP \fIdepth\fP 1i
The depth of interest.
.IP \fItype\fP 1i
The drawable type of interest (
.B PEXAnyDrawable,
.B PEXWindowDrawable,
.B PEXPixmapDrawable,
.B PEXBufferDrawable
).
.IP \fIvisual\fP 1i
The visual of interest.
.IP \fImax_targets\fP 1i
The maximum number of targets to return.
.IP \fIcount_return\fP 1i
Returns the actual number of targets in the return array.
.IP \fItargets_return\fP 1i
Returns an array of rendering target information.
.SH RETURNS
.LP
Zero if unsuccessful, non-zero otherwise.
.SH DESCRIPTION
.\" indexing
.IX PEXMatchRenderingTargets
.IX "Rendering" "PEXMatchRenderingTargets"
.LP
This function returns information about which drawable types the server
supports.
.LP
A drawable is specified only to indicate the screen for which the
returned information should apply.  None of the other drawable attributes are
used.
.LP
The depth value is specified to indicate the depth for which the returned
information should apply.  If the application wants information on all
supported depths, a value of zero should be specified.
.LP
The drawable type is specified to indicate the type of drawable for which
the returned information should apply.
The type field of the
.B PEXRenderingTarget
data structure will have these same values with the exception of
.B PEXAnyDrawable .
.LP
The
.I visual
is specified to indicate the
.I visual
for which the returned
information should apply.  If the application wants information on all
supported visuals, a null pointer should be specified.
.LP
PEXlib allocates memory for the returned target values.
.B XFree
should be called to deallocate the memory.
.SH DATA STRUCTURES
.LP
.nf
typedef struct {
	int	depth;
	int	type;	/* PEXWindowDrawable, PEXPixmapDrawable, PEXBufferDrawable */
	Visual	*visual;
.br
} PEXRenderingTarget;
.fi
.SH ERRORS
.TP
.SB BadDrawable
The specified drawable resource identifier is invalid.
.TP
.SB BadValue
The specified visual is invalid.