← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/XvGetVideo.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/XvGetVideo.man
 
1
.TH XvGetVideo __libmansuffix__  __vendorversion__
 
2
.\" $XFree86: xc/doc/man/Xv/XvGetVideo.man,v 1.4 1999/03/02 11:49:14 dawes Exp $
 
3
.SH Name
 
4
XvGetVideo \- capture video from a drawable
 
5
.\"
 
6
.SH Syntax
 
7
.B include "Xvlib.h"
 
8
.sp 1l
 
9
.B XvGetVideo(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh)
 
10
.sp 1l
 
11
.B register 
 
12
.I Display 
 
13
.I *dpy;
 
14
.br
 
15
.B XvPortID 
 
16
.I port;
 
17
.br
 
18
.B Drawable 
 
19
.I d;
 
20
.br
 
21
.B GC 
 
22
.I gc;
 
23
.br
 
24
.B int 
 
25
.I vx, 
 
26
.I vy, 
 
27
.I dx, 
 
28
.I dy;
 
29
.br
 
30
unsigned int 
 
31
.I vw, 
 
32
.I vh;
 
33
.br
 
34
unsigned int 
 
35
.I dw, 
 
36
.I dh;
 
37
.sp 1l
 
38
.\"
 
39
.SH Arguments
 
40
.\"
 
41
.IP \fIdpy\fR 15
 
42
Specifies the connection to the X server.
 
43
.IP \fIport\fR 15
 
44
Defines the port to which video output is sent.
 
45
.IP \fId\fR 15
 
46
Defines the drawable (window) from which video output is to be obtained.
 
47
.IP \fIgc\fR 15
 
48
Defines the graphical context.  GC components are: 
 
49
.I subwindow-mode, 
 
50
.I clip-x-origin, 
 
51
.I clip-y-origin,
 
52
and 
 
53
.I clip-mask.
 
54
.IP \fIvx,vy,vw,vh\fR 15
 
55
Define the location and size of the video region is to be written.  \fIvx\fP 
 
56
and \fIvy\fP define the 
 
57
.I x and
 
58
.I y
 
59
coordinates of the upper-left corner of the video region; 
 
60
.I vw and
 
61
.I vh
 
62
define the width and height, in pixels, of the video region.
 
63
.IP \fIdx,dy,dw,dh\fR 15
 
64
Define the location of the source drawable from which the
 
65
video image is to be taken.  
 
66
.I dx and
 
67
.I dy 
 
68
define the 
 
69
.I x and
 
70
.I y 
 
71
coordinates of the upper-left corner of the drawable region; 
 
72
.I dw and 
 
73
.I dh 
 
74
define the width and height, in pixels, of the drawable region.
 
75
.br
 
76
.SH Description
 
77
.PN XvGetVideo
 
78
outputs video from a drawable.  The position
 
79
and size of the destination rectangle is specified by 
 
80
.I vx,
 
81
.I vy, 
 
82
.I vw, 
 
83
and 
 
84
.I vh.  
 
85
The position and size of the source rectangle is specified by 
 
86
.I dx, 
 
87
.I dy, 
 
88
.I dw, 
 
89
and 
 
90
.I dh.
 
91
.PP
 
92
Drawable data is clipped to the bounds of the drawable, scaled to the
 
93
requested video region size (or the closest size supported) and
 
94
clipped to the bounds of the video encoding.  The contents of any region
 
95
not updated with drawable data is undefined.
 
96
.PP
 
97
If video is successfully initiated, an XvVideoNotify event with
 
98
detail XvStarted is generated for the drawable.  If the port is
 
99
already in use, its video is preempted, and if the new drawable is
 
100
different than the old, an XvVideoNotify event with detail XvPreempted
 
101
is generated for the old drawable.  If the port is grabbed by another
 
102
client, this request is ignored, and an XvVideoNotify event with detail
 
103
XvBusy is generated for the drawable.
 
104
.\"
 
105
.br
 
106
.SH Returned Values
 
107
.IP [Success] 8
 
108
Returned if XvGetVideo(__libmansuffix__) completed successfully.
 
109
.IP [XvBadExtension] 8
 
110
Returned if the Xv extension is unavailable.
 
111
.IP [XvBadAlloc] 8
 
112
Returned if XvGetVideo(__libmansuffix__) failed to allocate memory to process
 
113
the request.
 
114
.SH Diagnostics
 
115
.IP [XvBadPort] 8
 
116
Generated if the requested port does not exist.
 
117
.IP [BadGC] 8
 
118
Generated if the requested graphics context does not exist.
 
119
.IP [BadDrawable] 8
 
120
Generated if the requested drawable does not exist.
 
121
.IP [BadAlloc] 8
 
122
Generated if there were insufficient resources to process the request.
 
123
.SH See Also
 
124
.br
 
125
.\"
 
126
XvGetStill(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotify(__libmansuffix__)
 
127
.br