summaryrefslogtreecommitdiff
path: root/man/XvGetVideo.man
diff options
context:
space:
mode:
Diffstat (limited to 'man/XvGetVideo.man')
-rw-r--r--man/XvGetVideo.man103
1 files changed, 52 insertions, 51 deletions
diff --git a/man/XvGetVideo.man b/man/XvGetVideo.man
index 6439dad..be8c08e 100644
--- a/man/XvGetVideo.man
+++ b/man/XvGetVideo.man
@@ -1,16 +1,16 @@
-.TH XvGetVideo __libmansuffix__ __vendorversion__
-.SH Name
+.TH XvGetVideo __libmansuffix__ __vendorversion__ "libXv Functions"
+.SH NAME
XvGetVideo \- capture video from a drawable
.\"
-.SH Syntax
+.SH SYNOPSIS
.B #include <X11/extensions/Xvlib.h>
.sp
.nf
-.BI "XvGetVideo(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc ",
-.BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh ",
-.BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");"
+.BI "int XvGetVideo(Display *" dpy ", XvPortID " port ", Drawable " d ", GC " gc ","
+.BI " int " vx ", int " vy ", unsigned int " vw ", unsigned int " vh ","
+.BI " int " dx ", int " dy ", unsigned int " dw ", unsigned int " dh ");"
.fi
-.SH Arguments
+.SH ARGUMENTS
.\"
.IP \fIdpy\fR 15
Specifies the connection to the X server.
@@ -19,49 +19,48 @@ Defines the port to which video output is sent.
.IP \fId\fR 15
Defines the drawable (window) from which video output is to be obtained.
.IP \fIgc\fR 15
-Defines the graphical context. GC components are:
-.I subwindow-mode,
-.I clip-x-origin,
-.I clip-y-origin,
-and
-.I clip-mask.
+Defines the graphical context. GC components are:
+.IR subwindow-mode ,
+.IR clip-x-origin ,
+.IR clip-y-origin ,
+and
+.IR clip-mask .
.IP \fIvx,vy,vw,vh\fR 15
-Define the location and size of the video region is to be written. \fIvx\fP
-and \fIvy\fP define the
-.I x and
+Define the location and size of the video region is to be written. \fIvx\fP
+and \fIvy\fP define the
+.IR x and
.I y
-coordinates of the upper-left corner of the video region;
-.I vw and
+coordinates of the upper-left corner of the video region;
+.IR vw and
.I vh
define the width and height, in pixels, of the video region.
.IP \fIdx,dy,dw,dh\fR 15
Define the location of the source drawable from which the
-video image is to be taken.
-.I dx and
-.I dy
-define the
-.I x and
-.I y
-coordinates of the upper-left corner of the drawable region;
-.I dw and
-.I dh
+video image is to be taken.
+.IR dx and
+.I dy
+define the
+.IR x and
+.I y
+coordinates of the upper-left corner of the drawable region;
+.IR dw and
+.I dh
define the width and height, in pixels, of the drawable region.
-.br
-.SH Description
+.SH DESCRIPTION
.PN XvGetVideo
outputs video from a drawable. The position
-and size of the destination rectangle is specified by
-.I vx,
-.I vy,
-.I vw,
-and
-.I vh.
-The position and size of the source rectangle is specified by
-.I dx,
-.I dy,
-.I dw,
-and
-.I dh.
+and size of the destination rectangle is specified by
+.IR vx ,
+.IR vy ,
+.IR vw ,
+and
+.IR vh .
+The position and size of the source rectangle is specified by
+.IR dx ,
+.IR dy ,
+.IR dw ,
+and
+.IR dh .
.PP
Drawable data is clipped to the bounds of the drawable, scaled to the
requested video region size (or the closest size supported) and
@@ -76,16 +75,18 @@ is generated for the old drawable. If the port is grabbed by another
client, this request is ignored, and an XvVideoNotify event with detail
XvBusy is generated for the drawable.
.\"
-.br
-.SH Returned Values
+.SH RETURN VALUES
.IP [Success] 8
-Returned if XvGetVideo(__libmansuffix__) completed successfully.
+Returned if
+.BR XvGetVideo (__libmansuffix__)
+completed successfully.
.IP [XvBadExtension] 8
Returned if the Xv extension is unavailable.
.IP [XvBadAlloc] 8
-Returned if XvGetVideo(__libmansuffix__) failed to allocate memory to process
-the request.
-.SH Diagnostics
+Returned if
+.BR XvGetVideo (__libmansuffix__)
+failed to allocate memory to process the request.
+.SH DIAGNOSTICS
.IP [XvBadPort] 8
Generated if the requested port does not exist.
.IP [BadGC] 8
@@ -94,8 +95,8 @@ Generated if the requested graphics context does not exist.
Generated if the requested drawable does not exist.
.IP [BadAlloc] 8
Generated if there were insufficient resources to process the request.
-.SH See Also
-.br
+.SH SEE ALSO
.\"
-XvGetStill(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotify(__libmansuffix__)
-.br
+.BR XvGetStill (__libmansuffix__),
+.BR XvPutVideo (__libmansuffix__),
+.BR XvVideoNotify (__libmansuffix__)