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

« back to all changes in this revision

Viewing changes to man/XvQueryBestSize.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:
 
1
.TH XvQueryBestSize __libmansuffix__ __vendorversion__
 
2
.\" $XFree86: xc/doc/man/Xv/XvQueryBestSize.man,v 1.4 1999/03/02 11:49:16 dawes Exp $
 
3
.SH Name
 
4
XvQueryBestSize \- determine the optimum drawable region size
 
5
.\"
 
6
.SH Syntax
 
7
.B #include <X11/extensions/Xvlib.h>
 
8
.sp 1l
 
9
\fBXvQueryBestSize\fP(\fIdpy, port, motion, vw, vh, dw, dh, p_dw, p_dh\fR)
 
10
.sp 1l
 
11
.B Display \fI*dpy\fR;
 
12
.br 
 
13
.B XvPortID \fIport\fR; 
 
14
.br
 
15
.B Bool \fImotion\fR;
 
16
.br
 
17
.B unsigned 
 
18
.B int \fIvw, vh\fR;
 
19
.br
 
20
\fBunsigned int \fIdw, dh;\fR 
 
21
.br 
 
22
\fBunsigned int \fI*p_dw, *p_dh;\fR
 
23
.\"
 
24
.SH Arguments
 
25
.\"
 
26
.IP \fIdpy\fR 15
 
27
Specifies the connection to the X server.
 
28
.IP \fIport\fR 15
 
29
Defines the port associated with the display and adaptor for which 
 
30
the optimum size is to be calculated.
 
31
.IP \fImotion\fR 15
 
32
Specifies \fITrue\fP if the destination size needs to support
 
33
full motion, and \fIFalse\fP if the destination size need only
 
34
support still images.
 
35
.IP \fIvw,vh\fR 15
 
36
Specifies the size of the source video region desired.
 
37
.IP \fIdw,dh\fR 15
 
38
Specifies the size of the destination drawable region desired.
 
39
.IP \fIp_dw,p_dh\fR 15
 
40
Pointers to where the closest destination sizes supported by the server are
 
41
returned.
 
42
.\"
 
43
.SH Description
 
44
.\"
 
45
Some ports may be able to scale incoming or outgoing video.  
 
46
XvQueryBestSize(__libmansuffix__) returns the size of the closest destination
 
47
region that is supported by the adaptor.  The returned size is
 
48
guaranteed to be smaller than the requested size if a smaller 
 
49
size is supported.
 
50
.\"
 
51
.SH Returned Values
 
52
.IP [Success] 8
 
53
Returned if XvQueryBestSize(__libmansuffix__) completed successfully.
 
54
.IP [XvBadExtension] 8
 
55
Returned if the Xv extension is unavailable.
 
56
.IP [XvBadAlloc] 8
 
57
Returned if XvQueryBestSize(__libmansuffix__) failed to allocate memory to process
 
58
the request.
 
59
.SH Diagnostics
 
60
.IP [XvBadPort] 8
 
61
Generated if the requested port does not exist.
 
62
.br