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

« back to all changes in this revision

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