PEXMatchRenderingTargets - Return Information about Supported Rendering Targets (5.1)


Synopsis

 
   Status PEXMatchRenderingTargets(
             Display *display,
             Drawable drawable,
             int depth,
             int type,
             Visual *visual,
             unsigned long max_targets,
             unsigned long *count_return,
             PEXRenderingTarget **targets_return
)
 

Arguments

display
A pointer to a display structure returned by a successful XOpenDisplay call.

drawable
The drawable indicates which screen the application is interested in.

depth
The depth of interest.

type
The drawable type of interest (PEXAnyDrawable, PEXWindowDrawable, PEXPixmapDrawable or PEXBufferDrawable).

visual
The visual of interest.

max_targets
The maximum number of targets to return.

count_return
Returns the actual number of targets in the return array.

targets_return
Returns an array of rendering target information.

Returns

Zero if unsuccessful; non-zero otherwise.

Description

Invoke PEXMatchRenderingTargets to get information about which drawable types the implementation supports.

Specify with the drawable argument only the screen about which you want information. This function does not apply any of the other drawable attributes.

Specify with the depth argument the depth about which you want information. If you want information on all supported depths, then specify a value of zero.

Specify with the type argument the type of drawable about which you want information. The type field of the PEXRenderingTarget data structure has these same values with the exception of PEXAnyDrawable.

Specify with the visual argument the visual about which you want information. If you want information on all of the supported visuals, then specify a null pointer.

Indicate with the max_targets argument the number of targets that this function should return. If this number is less than the number of matching targets, then it is implementation-dependent which of the matching targets this function returns. If you want this function to return all matching targets, then specify a value of zero.

PEXlib allocates memory for the returned target values. Invoke the XFree function to deallocate the memory.

Errors

BadDrawable
The specified drawable resource identifier is invalid.

BadValue
The specified visual is invalid or the type argument is not one of the defined types.

See Also

For an overview, see PEXlib Access and Information Functions.