summaryrefslogtreecommitdiff
path: root/man/XvGetStill.man
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2009-10-02 08:55:52 -0700
committerAlan Coopersmith <alan.coopersmith@sun.com>2009-10-03 01:32:22 -0700
commit7303af622984579e600893934a3958c0654d57bf (patch)
treefd3956f647d2a525cc4f122ab1121c5fec80766c /man/XvGetStill.man
parentea79759a6940855dab10472a876e784fb8494eee (diff)
Man page cleanups and formatting fixes
- Convert man page section headings to traditional style/names Make them all caps, and use 'synopsis' instead of 'syntax' - Strip trailing whitespace from man pages - Add return types to function prototypes - Fix unbalanced quoting and other formatting issues - Use .BR for formatting man page references - Add "libXv Functions" to man page header Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
Diffstat (limited to 'man/XvGetStill.man')
-rw-r--r--man/XvGetStill.man105
1 files changed, 59 insertions, 46 deletions
diff --git a/man/XvGetStill.man b/man/XvGetStill.man
index 19997ed..7c3f92d 100644
--- a/man/XvGetStill.man
+++ b/man/XvGetStill.man
@@ -1,82 +1,93 @@
-.TH XvGetStill __libmansuffix__ __vendorversion__
-.SH Name
+.TH XvGetStill __libmansuffix__ __vendorversion__ "libXv Functions"
+.SH NAME
XvGetStill \- capture a single frame of video from a drawable
.\"
-.SH Syntax
+.SH SYNOPSIS
.B #include <X11/extensions/Xvlib.h>
.sp
.nf
-.BI "XvGetStill(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 XvGetStill(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.
.IP \fIport\fR 15
-Defines the port to which the still is output'd.
+Defines the port to which the still is output.
.IP \fId\fR 15
Defines the drawable from which the still is to be captured.
Pixmaps are currently not supported.
.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 destination video region
-into which the still is to be written. \fIvx\fP and \fIvy\fP define the
-.I x and
+Define the location and size of the destination video region
+into which the still 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 and size of the source drawable from which the
-still image is to be captured.
-.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
+still image is to be captured.
+.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.
.\"
-.SH Description
+.SH DESCRIPTION
.\"
-.PN XvGetStill
-captures a single frame of video from a drawable. The
-position and size of the destination (video) rectangle is specified by \fIvx,
-vy, vw\fR, and \fIvh\fR. The position and size of the
-source (drawable) rectangle is
-specified by \fIdx, dy, dw\fR, and \fIdh\fR.
+.PN XvGetStill
+captures a single frame of video from a drawable. The
+position and size of the destination (video) rectangle is specified by
+.IR vx ,
+.IR vy ,
+.IR vw ,
+and
+.IR vh .
+The position and size of the source (drawable) 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
clipped to the bounds of the video encoding. The contents of any region
not updated with drawable data is undefined.
.PP
-./" If the still is successfully captured an XvVideoNotify event with
-./" detail XvStill is generated for the drawable.
-./" [mhs]: Not in this universe
+.\" If the still is successfully captured an XvVideoNotify event with
+.\" detail XvStill is generated for the drawable.
+.\" [mhs]: Not in this universe
If the port is grabbed
by another client, this request is ignored, and an XvVideoNotify event
with detail XvBusy is generated for the drawable.
-.SH Returned Values
+.SH RETURN VALUES
.IP [Success] 8
-Returned if XvGetStill(__libmansuffix__) completed successfully.
+Returned if
+.BR XvGetStill (__libmansuffix__)
+completed successfully.
.IP [XvBadExtension] 8
Returned if the Xv extension is unavailable.
.IP [XvBadAlloc] 8
-Returned if XvGetStill(__libmansuffix__) failed to allocate memory to process
-the request.
-.SH Diagnostics
+Returned if
+.BR XvGetStill (__libmansuffix__)
+failed to allocate memory to process the request.
+.SH DIAGNOSTICS
.IP [XvBadPort] 8
Generated if the requested port does not exist.
.IP [BadDrawable] 8
@@ -86,8 +97,10 @@ Generated if the requested graphics context does not exist.
.IP [BadAlloc] 8
Generated if there were insufficient resources to process the request.
.\"
-.SH See Also
+.SH SEE ALSO
.\"
-XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotify(__libmansuffix__)
-.br
+.BR XvPutStill (__libmansuffix__),
+.BR XvGetVideo (__libmansuffix__),
+.BR XvPutVideo (__libmansuffix__),
+.BR XvVideoNotify (__libmansuffix__)