MAN page from Mandriva 2010 libxv1-devel-1.0.4-3mdv2010.0.i586.rpm

XvQueryAdaptors

Section: C Library Functions (3)
Updated: libXv 1.0.4
Index

Name

XvQueryAdaptors - return adaptor information for a screen

Syntax

#include <X11/extensions/Xvlib.h>

XvQueryAdaptors(Display *dpy, Window window,                unsigned int *p_num_adaptors,                XvAdaptorInfo **pp_adaptor_info);

Arguments

dpy: Specifies the connection to the X server.
window: Specifies a window of the screen for which the adaptor information is desired.
p_num_adaptors: A pointer to where the number of adaptors for the specified screen is returned.
pp_adaptor_info: A pointer to where the list of returned adaptor information isreturned.

Description

XvQueryAdaptors(3) returns an video adaptor information forthe screen of the specified drawable. The XvAdaptorInfo structurehas the following organization:

     typedef struct {
       XvPortID base_id;
       unsigned long num_ports;
       char type;
       char *name;
       unsigned long num_formats;
       XvFormat *formats;
       unsigned long num_adaptors;
     } XvAdaptorInfo;

base_id: The resource ID of the first adaptor port.
num_ports: The number of ports supported by the adaptor.
type: A bit mask with the value XvInputMask asserted if the adaptor supports videoinput, and value XvOutputMask asserted if the adaptor supports video output.
name: A vendor specific name that identifies the adaptor.
num_formats: The number of depth/visual id formats supported by the adaptor.
formats: A pointer to an array of XvFormat structures.

The XvFormat structure has the following organization:

     typedef struct {
       char depth;
       unsigned long visual_id;
     } XvFormat;

depth: A drawable depth supported by the adaptor.
visual_id: A visual-id supported for the given depth by the adaptor.

Returned Values

[Success]: Returned if XvQueryAdaptors(3) completed successfully.
[XvBadExtension]: Returned if the Xv extension is unavailable.
[XvBadAlloc]: Returned if XvQueryAdaptors(3) failed to allocate memory to processthe request.

Diagnostics

[Drawable]: Returned if the requested drawable does not exist.

This document was created byman2html,using the manual pages.