← Back to branch summary

~ubuntu-branches/debian/squeeze/libxv/squeeze

« back to all changes in this revision

Viewing changes to man/XvQueryAdaptors.man

  • Committer: Bazaar Package Importer
  • Author(s): David Nusinow
  • Date: 2006-09-25 20:17:05 UTC
  • Revision ID: james.westby@ubuntu.com-20060925201705-o5vqinq0rqdc7obb
Tags: upstream-1.0.2
Import upstream version 1.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/XvQueryAdaptors.man
 
1
.TH XvQueryAdaptors __libmansuffix__  __vendorversion__
 
2
.\" $XFree86: xc/doc/man/Xv/XvQueryAdaptors.man,v 1.5 2001/01/27 18:20:36 dawes Exp $
 
3
.SH Name
 
4
XvQueryAdaptors \- return adaptor information for a screen
 
5
.\"
 
6
.SH Syntax
 
7
.B #include <X11/extensions/Xvlib.h>
 
8
.br
 
9
.sp 1l
 
10
.B XvQueryAdaptors(\fIdpy, win, p_num_adaptors, pp_adaptor_info\fR)
 
11
.sp 1l 
 
12
\fBDisplay \fI*dpy;\fR
 
13
.br
 
14
\fBDrawable \fI draw;\fR
 
15
.br
 
16
\fBint \fI*p_num_adaptors\fR;
 
17
.br
 
18
\fBXvAdaptorInfo \fI**pp_adaptor_info\fR;
 
19
.br
 
20
.\"
 
21
.SH Arguments
 
22
.\"
 
23
.IP \fIdpy\fR 8
 
24
Specifies the connection to the X server.
 
25
.IP \fIdraw\fR 8
 
26
Specifies a drawable of the screen for which the adaptor 
 
27
information is desired.
 
28
.IP \fIp_num_adaptors\fR 8
 
29
A pointer to where the number of adaptors for the specified screen 
 
30
is returned.
 
31
.IP \fIpp_adaptor_info\fR 8
 
32
A pointer to where the list of returned adaptor information is
 
33
returned.
 
34
.\"
 
35
.SH Description
 
36
.\"
 
37
XvQueryAdaptors(__libmansuffix__) returns an video adaptor information for
 
38
the screen of the specified drawable.  The XvAdaptorInfo structure
 
39
has the following organization:
 
40
.EX
 
41
 
 
42
     typedef struct {
 
43
       XvPortID base_id;
 
44
       unsigned long num_ports;
 
45
       char type;
 
46
       char *name;
 
47
       unsigned long num_formats;
 
48
       XvFormat *formats;
 
49
       unsigned long num_adaptors;
 
50
     } XvAdaptorInfo;
 
51
 
 
52
.EE
 
53
.IP \fIbase_id\fR 8
 
54
The resource ID of the first adaptor port.
 
55
.IP \fInum_ports\fR 8
 
56
The number of ports supported by the adaptor.
 
57
.IP \fItype\fR 8
 
58
A bit mask with the value XvInputMask asserted if the adaptor supports video
 
59
input, and value XvOutputMask asserted if the adaptor supports video output.
 
60
.IP \fIname\fR 8
 
61
A vendor specific name that identifies the adaptor.
 
62
.IP \fInum_formats\fR 8
 
63
The number of depth/visual id formats supported by the adaptor.
 
64
.IP \fIformats\fR 8
 
65
A pointer to an array of XvFormat structures.
 
66
.PP
 
67
The XvFormat structure has the following organization:
 
68
.EX
 
69
 
 
70
     typedef struct {
 
71
       char depth;
 
72
       unsigned long visual_id;
 
73
     } XvFormat;
 
74
 
 
75
.EE
 
76
.IP \fIdepth\fR 8
 
77
A drawable depth supported by the adaptor.
 
78
.IP \fIvisual_id\fR 8
 
79
A visual-id supported for the given depth by the adaptor.
 
80
.\"
 
81
.SH Returned Values
 
82
.IP [Success] 8
 
83
Returned if XvQueryAdaptors(__libmansuffix__) completed successfully.
 
84
.IP [XvBadExtension] 8
 
85
Returned if the Xv extension is unavailable.
 
86
.IP [XvBadAlloc] 8
 
87
Returned if XvQueryAdaptors(__libmansuffix__) failed to allocate memory to process
 
88
the request.
 
89
.SH Diagnostics
 
90
.IP [Drawable] 8
 
91
Returned if the requested drawable does not exist.
 
92
.SH See Also
 
93
XvFreeAdaptorInfo(__libmansuffix__)
 
94
.\"