diff options
| -rw-r--r-- | man/Xv.man | 78 | ||||
| -rw-r--r-- | man/XvFreeAdaptorInfo.man | 32 | ||||
| -rw-r--r-- | man/XvFreeEncodingInfo.man | 31 | ||||
| -rw-r--r-- | man/XvGetPortAttribute.man | 92 | ||||
| -rw-r--r-- | man/XvGetStill.man | 105 | ||||
| -rw-r--r-- | man/XvGetVideo.man | 103 | ||||
| -rw-r--r-- | man/XvGrabPort.man | 47 | ||||
| -rw-r--r-- | man/XvPortNotify.man | 22 | ||||
| -rw-r--r-- | man/XvPutStill.man | 72 | ||||
| -rw-r--r-- | man/XvPutVideo.man | 80 | ||||
| -rw-r--r-- | man/XvQueryAdaptors.man | 40 | ||||
| -rw-r--r-- | man/XvQueryBestSize.man | 43 | ||||
| -rw-r--r-- | man/XvQueryEncodings.man | 47 | ||||
| -rw-r--r-- | man/XvQueryExtension.man | 45 | ||||
| -rw-r--r-- | man/XvSelectPortNotify.man | 46 | ||||
| -rw-r--r-- | man/XvSelectVideoNotify.man | 37 | ||||
| -rw-r--r-- | man/XvSetPortAttribute.man | 101 | ||||
| -rw-r--r-- | man/XvStopVideo.man | 45 | ||||
| -rw-r--r-- | man/XvUngrabPort.man | 37 | ||||
| -rw-r--r-- | man/XvVideoNotify.man | 32 |
20 files changed, 622 insertions, 513 deletions
@@ -1,12 +1,12 @@ -.TH Xv __libmansuffix__ __vendorversion__ +.TH Xv __libmansuffix__ __vendorversion__ "libXv Functions" .\" -.SH Name +.SH NAME Xv \- X Window System video extension -.SH Description +.SH DESCRIPTION The Xv extension provides support for video adaptors attached to an X display. It takes the approach that a display may have one or more video adaptors, each of which has one or more ports through which -independent video streams pass. +independent video streams pass. .PP An adaptor may be able to display video in a drawable, capture video from a drawable, or both. It translates between video encoding (NTSC, @@ -14,55 +14,77 @@ PAL, SECAM, etc...) and drawable format (depth and visual-id pair). An adaptor may support multiple video encodings and/or multiple drawable formats. .PP -Clients use Xv(__libmansuffix__) to gain access and manage sharing of a display's -video resources. Typically, a client will use XvQueryExtension(__libmansuffix__) to -determine the status of the extension, XvQueryAdaptors(__libmansuffix__) to get a -description of what video adaptors exist, and XvQueryEncodings(__libmansuffix__) to -get a description of what video encodings an adaptor supports. +Clients use +.BR Xv (__libmansuffix__) +to gain access and manage sharing of a display's +video resources. Typically, a client will use +.BR XvQueryExtension (__libmansuffix__) +to determine the status of the extension, +.BR XvQueryAdaptors (__libmansuffix__) +to get a description of what video adaptors exist, and +.BR XvQueryEncodings (__libmansuffix__) +to get a description of what video encodings an adaptor supports. .PP Once a client has determined what video resources are available, it is free to put video into a drawable or get video from a drawable, according the capabilities supported. Clients can select to receive events when video activity changes in a drawable and when port attributes have changed. -.SH Summary of Library Functions +.SH SUMMARY OF LIBRARY FUNCTIONS The following is a summary of Xv library functions: .sp 1l -XvGetPortAttribute(__libmansuffix__) \- return current port attribute value +.BR XvGetPortAttribute (__libmansuffix__) +\- return current port attribute value .sp 1l -XvGetStill(__libmansuffix__) \- capture a single frame of video from a drawable +.BR XvGetStill (__libmansuffix__) +\- capture a single frame of video from a drawable .sp 1l -XvGetVideo(__libmansuffix__) \- capture video from a drawable +.BR XvGetVideo (__libmansuffix__) +\- capture video from a drawable .sp 1l -XvGrabPort(__libmansuffix__) \- lock port for exclusive use by client +.BR XvGrabPort (__libmansuffix__) +\- lock port for exclusive use by client .sp 1l -XvPortNotify(__libmansuffix__) \- event generated when port attributes change +.BR XvPortNotify (__libmansuffix__) +\- event generated when port attributes change .sp 1l -XvPutStill(__libmansuffix__) \- write a single frame of video to a drawable +.BR XvPutStill (__libmansuffix__) +\- write a single frame of video to a drawable .sp 1l -XvPutVideo(__libmansuffix__) \- write video into a drawable +.BR XvPutVideo (__libmansuffix__) +\- write video into a drawable .sp 1l -XvQueryAdaptors(__libmansuffix__) \- return adaptor information for a screen +.BR XvQueryAdaptors (__libmansuffix__) +\- return adaptor information for a screen .sp 1l -XvQueryBestSize(__libmansuffix__) \- determine the optimum drawable region size +.BR XvQueryBestSize (__libmansuffix__) +\- determine the optimum drawable region size .sp 1l -XvQueryEncodings(__libmansuffix__) \- return list of encodings for an adaptor +.BR XvQueryEncodings (__libmansuffix__) +\- return list of encodings for an adaptor .sp 1l -XvQueryExtension(__libmansuffix__) \- return version and revision of extension +.BR XvQueryExtension (__libmansuffix__) +\- return version and revision of extension .sp 1l -XvSelectPortNotify(__libmansuffix__) \- enable or disable XvPortNotify events +.BR XvSelectPortNotify (__libmansuffix__) +\- enable or disable XvPortNotify events .sp 1l -XvSelectVideoNotify(__libmansuffix__) \- enable or disable XvVideoNotify events +.BR XvSelectVideoNotify (__libmansuffix__) +\- enable or disable XvVideoNotify events .sp 1l -XvSetPortAttribute(__libmansuffix__) \- set an attribute for a port +.BR XvSetPortAttribute (__libmansuffix__) +\- set an attribute for a port .sp 1l -XvStopVideo(__libmansuffix__) \- stop active video +.BR XvStopVideo (__libmansuffix__) +\- stop active video .sp 1l -XvUngrabPort(__libmansuffix__) \- release a grabbed port +.BR XvUngrabPort (__libmansuffix__) +\- release a grabbed port .sp 1l -XvVideoNotify(__libmansuffix__) \- event generated for video processing +.BR XvVideoNotify (__libmansuffix__) +\- event generated for video processing .sp 1l .PP Each of these functions is described in its own Xv man page. -.br + diff --git a/man/XvFreeAdaptorInfo.man b/man/XvFreeAdaptorInfo.man index 95fc3c7..b901cf3 100644 --- a/man/XvFreeAdaptorInfo.man +++ b/man/XvFreeAdaptorInfo.man @@ -1,21 +1,23 @@ -.TH XvFreeAdaptorInfo __libmansuffix__ __vendorversion__ -.SH Name -XvFreeAdaptorInfo \- free adaptor information +.TH XvFreeAdaptorInfo __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvFreeAdaptorInfo \- free adaptor information .\" -.SH Syntax -\fBXvFreeAdaptorInfo(XvAdaptorInfo *\fIp_adaptor_info\fR) -.SH Arguments +.SH SYNOPSIS +.BI "void XvFreeAdaptorInfo(XvAdaptorInfo *" p_adaptor_info ");" +.SH ARGUMENTS .\" .IP \fIp_adaptor_info\fR 8 -Pointer to where the adaptor information is located. +Pointer to where the adaptor information is located. .\" -.SH Description +.SH DESCRIPTION .\" -XvFreeAdaptorInfo(__libmansuffix__) frees adaptor information that -was returned by XvQueryAdaptors(__libmansuffix__). The data structure -used for adaptor information is defined in the -reference page for XvQueryAdaptors(__libmansuffix__). -.SH See Also +.BR XvFreeAdaptorInfo (__libmansuffix__) +frees adaptor information that was returned by +.BR XvQueryAdaptors (__libmansuffix__). +The data structure used for adaptor information is defined in the +reference page for +.BR XvQueryAdaptors (__libmansuffix__). +.SH SEE ALSO .\" -XvQueryAdaptors(__libmansuffix__), XvFreeEncodingInfo(__libmansuffix__) -.br +.BR XvQueryAdaptors (__libmansuffix__), +.BR XvFreeEncodingInfo (__libmansuffix__) diff --git a/man/XvFreeEncodingInfo.man b/man/XvFreeEncodingInfo.man index d26dff0..956460d 100644 --- a/man/XvFreeEncodingInfo.man +++ b/man/XvFreeEncodingInfo.man @@ -1,21 +1,22 @@ -.TH XvFreeEncodingInfo __libmansuffix__ __vendorversion__ -.SH Name -XvFreeEncodingInfo \- free encoding information +.TH XvFreeEncodingInfo __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvFreeEncodingInfo \- free encoding information .\" -.SH Syntax -\fBXvFreeEncodingInfo(XvEncodingInfo *\fIp_encoding_info\fR)" -.SH Arguments +.SH SYNOPSIS +.BI "void XvFreeEncodingInfo(XvEncodingInfo *" p_encoding_info ");" +.SH ARGUMENTS .\" .IP \fIp_encoding_info\fR 8 -Pointer to where the encoding information is located. +Pointer to where the encoding information is located. .\" -.SH Description +.SH DESCRIPTION .\" -XvFreeEncodingInfo(__libmansuffix__) frees encoding information that -was returned by XvQueryEncodings(__libmansuffix__). The data structure -used for encoding information is defined in the -reference page for XvQueryEncodings(__libmansuffix__). -.SH See Also +.BR XvFreeEncodingInfo (__libmansuffix__) +frees encoding information that was returned by +.BR XvQueryEncodings (__libmansuffix__). +The data structure used for encoding information is defined in the +reference page for +.BR XvQueryEncodings (__libmansuffix__). +.SH SEE ALSO .\" -XvQueryEncodings(__libmansuffix__) -.br +.BR XvQueryEncodings (__libmansuffix__) diff --git a/man/XvGetPortAttribute.man b/man/XvGetPortAttribute.man index 9e6fcb3..489db2d 100644 --- a/man/XvGetPortAttribute.man +++ b/man/XvGetPortAttribute.man @@ -1,21 +1,22 @@ -.TH XvGetPortAttribute __libmansuffix__ __vendorversion__ -.SH Name +'\" t +.TH XvGetPortAttribute __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvGetPortAttribute \- return current port attribute value .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvGetPortAttribute(Display *" dpy ", XvPortID " port ", -.BI " Atom " attribute ", int " p_value ");" +.BI "int XvGetPortAttribute(Display *" dpy ", XvPortID " port "," +.BI " Atom " attribute ", int " p_value ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 12 Specifies the connection to the X server. .IP \fIport\fR 12 Specifies the port, associated with the given display, for -which the attribute values are to be returned. +which the attribute values are to be returned. .IP \fIattribute\fR 12 An atom that identifies the attribute to be queried by this request. Control atoms are obtained using the XInternAtom @@ -24,59 +25,52 @@ request with a string from the following table. Pointer to the location where the attribute value is written on return. .\" -.SH Description +.SH DESCRIPTION .\" .PP -XvGetPortAttribute(__libmansuffix__) returns the current value of the requested -port attribute in the integer pointed to by \fIp_value\fR. -The attribute is identified using an Atom that equates to the attribute name. +.BR XvGetPortAttribute (__libmansuffix__) +returns the current value of the requested +port attribute in the integer pointed to by \fIp_value\fR. +The attribute is identified using an Atom that equates to the attribute name. The XInternAtom request can be used with one of the strings below to return a matching Atom. -.bp .PP -.\" .TS -.\" tab(@); -.\" lfHB lfHB lfHB -.\" lfR lfR lfR . -.\" _ -.\" .PP -.\" .sp 4p -.\" Attribute String@Type@Default -.\" .sp 6p -.\" _ -.\" .sp 6p -.\" "XV_ENCODING"@XvEncodingID@Server dependent -.\" "XV_HUE"@[-1000...1000]@0 -.\" "XV_SATURATION"@[-1000...1000]@0 -.\" "XV_BRIGHTNESS"@[-1000...1000]@0 -.\" "XV_CONTRAST"@[-1000...1000]@0 -.\" .sp 6p -.\" .TE -.nf -Attribute String Type Default - -"XV_ENCODING" XvEncodingID Server dependent -"XV_HUE" [-1000...1000] 0 -"XV_SATURATION" [-1000...1000] 0 -"XV_BRIGHTNESS" [-1000...1000] 0 -"XV_CONTRAST" [-1000...1000] 0 -.fi -.SH Returned Values +.TS +tab(@); +lfHB lfHB lfHB +lfR lfR lfR . +_ +.PP +.sp 4p +Attribute String@Type@Default +.sp 6p +_ +.sp 6p +"XV_ENCODING"@XvEncodingID@Server dependent +"XV_HUE"@[-1000...1000]@0 +"XV_SATURATION"@[-1000...1000]@0 +"XV_BRIGHTNESS"@[-1000...1000]@0 +"XV_CONTRAST"@[-1000...1000]@0 +.sp 6p +.TE +.SH RETURN VALUES .IP [Success] 8 -Returned if XvGetPortAttribute(__libmansuffix__) completed successfully. +Returned if +.BR XvGetPortAttribute (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvGetPortAttribute(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvGetPortAttribute (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .IP [BadMatch] 8 -Generated if the requested attribute atom does not specify an attribute +Generated if the requested attribute atom does not specify an attribute supported by the adaptor. -.SH See Also +.SH SEE ALSO .\" -XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__) -.br - +.BR XvSetPortAttribute (__libmansuffix__), +.BR XvPortNotify (__libmansuffix__) 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__) 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__) diff --git a/man/XvGrabPort.man b/man/XvGrabPort.man index 50e6539..0e052df 100644 --- a/man/XvGrabPort.man +++ b/man/XvGrabPort.man @@ -1,14 +1,14 @@ -.TH XvGrabPort __libmansuffix__ __vendorversion__ -.SH Name +.TH XvGrabPort __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvGrabPort \- lock port for exclusive use by client .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" +.BI "int XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -17,26 +17,33 @@ Defines the port to be grabbed. .IP \fItime\fR 8 Specifies the request timestamp. .\" -.SH Description +.SH DESCRIPTION .\" -XvGrabPort(__libmansuffix__) grabs a port. Once a client grabs a port, -only that client can make video requests -to that port. +.BR XvGrabPort (__libmansuffix__) +grabs a port. Once a client grabs a port, only that client can make video +requests to that port. .PP If the time is before the current port time, the XvGrabPort request is ignored and XvInvalidTime is returned. If the port is already grabbed by another client, XvAlreadyGrabbed is returned. Otherwise it returns a status of \fISuccess\fR. The port time is updated when the following -requests are processed: XvGrabPort(__libmansuffix__), XvUngrabPort(__libmansuffix__), -XvPutVideo(__libmansuffix__), XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvGetStill(__libmansuffix__). +requests are processed: +.BR XvGrabPort (__libmansuffix__), +.BR XvUngrabPort (__libmansuffix__), +.BR XvPutVideo (__libmansuffix__), +.BR XvPutStill (__libmansuffix__), +.BR XvGetVideo (__libmansuffix__), +.BR XvGetStill (__libmansuffix__). .PP If the port is actively processing video for another client, the video is preempted, and an XvVideoNotify event with detail XvPreempted is generated for its drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvGrabPort(__libmansuffix__) completed successfully. +Returned if +.BR XvGrabPort (__libmansuffix__) +completed successfully. .IP [XvInvalidTime] 8 Returned if requested time is older than the current port time. .IP [XvAlreadyGrabbed] 8 @@ -44,13 +51,15 @@ Returned if the port is already grabbed by another client. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvGrabPort(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvGrabPort (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 15 Generated if the requested port does not exist. .\" -.SH See Also +.SH SEE ALSO .\" -XvUngrabPort(__libmansuffix__) XvVideoNotify(__libmansuffix__) -.br +.BR XvUngrabPort (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) + diff --git a/man/XvPortNotify.man b/man/XvPortNotify.man index a31dd03..6fa3bb3 100644 --- a/man/XvPortNotify.man +++ b/man/XvPortNotify.man @@ -1,8 +1,8 @@ -.TH XvPortNotify __libmansuffix__ __vendorversion__ -.SH Name +.TH XvPortNotify __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvPortNotify \- event generated when port attributes change .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .br .sp 1l @@ -43,15 +43,15 @@ An atom specifying the attribute that changed. .IP \fIvalue\fR 15 The new value of the attribute. .\" -.SH Description +.SH DESCRIPTION .\" XvPortNotify events are generated when a port attribute is set using -the XvSetPortAttribute(__libmansuffix__) function. +the +.BR XvSetPortAttribute (__libmansuffix__) +function. .\" -.SH See Also -XvSetPortAttribute(__libmansuffix__), XvGetPortAttribute(__libmansuffix__), XvSelectPortNotify(__libmansuffix__) +.SH SEE ALSO +.BR XvSetPortAttribute (__libmansuffix__), +.BR XvGetPortAttribute (__libmansuffix__), +.BR XvSelectPortNotify (__libmansuffix__). .\" - - - - diff --git a/man/XvPutStill.man b/man/XvPutStill.man index e7552d4..fb22659 100644 --- a/man/XvPutStill.man +++ b/man/XvPutStill.man @@ -1,16 +1,16 @@ -.TH XvPutStill __libmansuffix__ __vendorversion__ -.SH Name +.TH XvPutStill __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvPutStill \- write a single frame of video to a drawable .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvPutStill(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 XvPutStill(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. @@ -20,30 +20,40 @@ Defines the port from which to get the still. Defines the drawable into which the still is to be written. 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 video region -to be written. \fIvx\fP and \fIvy\fP define the +to be written. \fIvx\fP and \fIvy\fP define the upper-left pixel of the region. \fIvw\fP and \fIvh\fP define the width and height, in pixels, of the region. .IP \fIdx,dy,dw,dh\fR 15 Define the location and size of the destination region into which the -still image is written. \fIdx\fP and \fIdy\fP define the upper-left +still image is written. \fIdx\fP and \fIdy\fP define the upper-left corner of the region. \fIdw\fP and \fIdh\fP define the width and height, in pixels, of the region. .\" -.SH Description +.SH DESCRIPTION .\" -XvPutStill(__libmansuffix__) writes a single frame of video to a drawable. -The position and size of the source (video) rectangle is specified by \fIvx, -vy, vw\fR, and \fIvh\fR. The position and size of the destination (drawable) -rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. +.BR XvPutStill (__libmansuffix__) +writes a single frame of video to a drawable. +The position and size of the source (video) rectangle is specified by +.IR vx , +.IR vy , +.IR vw , +and +.IR vh . +The position and size of the destination (drawable) rectangle is specified by +.IR dx , +.IR dy , +.IR dw , +and +.IR dh . .PP Video data is clipped to the bounds of the video encoding, scaled to the requested drawable region size (or the closest size supported) and @@ -54,15 +64,18 @@ an XvVideoNotify event with detail XvBusy is generated for the drawable. If the port is not receiving a valid video signal a VideoNotify event with detail XvHardError is generated for the drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvPutStill(__libmansuffix__) completed successfully. +Returned if +.BR XvPutStill (__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 @@ -71,7 +84,8 @@ Generated if the requested drawable does not exist. 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 .\" -XvPutVideo(__libmansuffix__), XvGetStill(__libmansuffix__), XvVideoNotify(__libmansuffix__) -.br +.BR XvPutVideo (__libmansuffix__), +.BR XvGetStill (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) diff --git a/man/XvPutVideo.man b/man/XvPutVideo.man index 35fcd5f..474baef 100644 --- a/man/XvPutVideo.man +++ b/man/XvPutVideo.man @@ -1,16 +1,16 @@ -.TH XvPutVideo __libmansuffix__ __vendorversion__ -.SH Name +.TH XvPutVideo __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvPutVideo \- write video into a drawable .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvPutVideo(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 XvPutVideo(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,37 +19,46 @@ Defines the port from which to get video. .IP \fId\fR 15 Defines the drawable (window) into which video is to be written. .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 size and location of the source (video) region -to be written. \fIvx\fP and \fIvy\fP define the +Define the size and location of the source (video) region +to be written. \fIvx\fP and \fIvy\fP define the upper-left pixel of the region. \fIvw\fP and \fIvh\fP define the width and height, in pixels, of the region. .IP \fIdx,dy,dw,dh\fR 15 -Define the location and size of the destination (drawable) region -into which the video image is written. -.I dx +Define the location and size of the destination (drawable) region +into which the video image is written. +.I dx and -.I dy +.I dy define the upper-left pixel of the region. -.I dw -and -.I dh +.I dw +and +.I dh define the width and height, in pixels, of the region. .\" -.SH Description +.SH DESCRIPTION .\" XvPutVideo writes video into a drawable. -The position and size of the source (video) -rectangle is specified by \fIvx, vy, vw\fR, and \fIvh\fR. -The position and size of the destination (drawable) -rectangle is specified by \fIdx, dy, dw\fR, and \fIdh\fR. +The position and size of the source (video) rectangle is specified by +.IR vx , +.IR vy , +.IR vw , +and +.IR vh . +The position and size of the destination (drawable) +rectangle is specified by +.IR dx , +.IR dy , +.IR dw , +and +.IR dh . .PP Video data is clipped to the bounds of the video encoding, scaled to the requested drawable region size (or the closest size supported) and @@ -65,14 +74,16 @@ generated for the drawable. If the port is not receiving a valid video signal or if the video signal is interrupted while video is active a VideoNotify event with detail XvHardError is generated for the drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvPutVideo(__libmansuffix__) completed successfully. +Returned if +.BR XvPutVideo (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 Returned if there were insufficient resources to process the request. -.SH Diagnostics +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .IP [BadDrawable] 8 @@ -82,7 +93,8 @@ 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__), XvVideoNotify(__libmansuffix__) -.br +.BR XvPutStill (__libmansuffix__), +.BR XvGetVideo (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) diff --git a/man/XvQueryAdaptors.man b/man/XvQueryAdaptors.man index 628d932..bb52ff5 100644 --- a/man/XvQueryAdaptors.man +++ b/man/XvQueryAdaptors.man @@ -1,32 +1,33 @@ -.TH XvQueryAdaptors __libmansuffix__ __vendorversion__ -.SH Name +.TH XvQueryAdaptors __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvQueryAdaptors \- return adaptor information for a screen .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvQueryAdaptors(Display *" dpy ", Window " window ", -.BI " unsigned int *" p_num_adaptors ", -.BI " XvAdaptorInfo **" pp_adaptor_info ");" +.BI "int XvQueryAdaptors(Display *" dpy ", Window " window "," +.BI " unsigned int *" p_num_adaptors "," +.BI " XvAdaptorInfo **" pp_adaptor_info ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. .IP \fIwindow\fR 8 -Specifies a window of the screen for which the adaptor +Specifies a window of the screen for which the adaptor information is desired. .IP \fIp_num_adaptors\fR 8 -A pointer to where the number of adaptors for the specified screen +A pointer to where the number of adaptors for the specified screen is returned. .IP \fIpp_adaptor_info\fR 8 A pointer to where the list of returned adaptor information is returned. .\" -.SH Description +.SH DESCRIPTION .\" -XvQueryAdaptors(__libmansuffix__) returns an video adaptor information for +.BR XvQueryAdaptors (__libmansuffix__) + returns an video adaptor information for the screen of the specified drawable. The XvAdaptorInfo structure has the following organization: .EX @@ -70,17 +71,20 @@ A drawable depth supported by the adaptor. .IP \fIvisual_id\fR 8 A visual-id supported for the given depth by the adaptor. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvQueryAdaptors(__libmansuffix__) completed successfully. +Returned if +.BR XvQueryAdaptors (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvQueryAdaptors(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvQueryAdaptors (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [Drawable] 8 Returned if the requested drawable does not exist. -.SH See Also -XvFreeAdaptorInfo(__libmansuffix__) +.SH SEE ALSO +.BR XvFreeAdaptorInfo (__libmansuffix__) .\" diff --git a/man/XvQueryBestSize.man b/man/XvQueryBestSize.man index 368fa39..5031170 100644 --- a/man/XvQueryBestSize.man +++ b/man/XvQueryBestSize.man @@ -1,22 +1,22 @@ -.TH XvQueryBestSize __libmansuffix__ __vendorversion__ -.SH Name +.TH XvQueryBestSize __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvQueryBestSize \- determine the optimum drawable region size .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvQueryBestSize(Display *" dpy ", XvPort " port ", Bool " motion ", -.BI " unsigned int " vw ", unsigned int " vh ", -.BI " unsigned int " dw ", unsigned int " dh ", -.BI " unsigned int *" p_dw ", unsigned int *" p_dh ");" +.BI "int XvQueryBestSize(Display *" dpy ", XvPort " port ", Bool " motion "," +.BI " unsigned int " vw ", unsigned int " vh "," +.BI " unsigned int " dw ", unsigned int " dh "," +.BI " unsigned int *" p_dw ", unsigned int *" p_dh ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. .IP \fIport\fR 15 -Defines the port associated with the display and adaptor for which +Defines the port associated with the display and adaptor for which the optimum size is to be calculated. .IP \fImotion\fR 15 Specifies \fITrue\fP if the destination size needs to support @@ -30,23 +30,26 @@ Specifies the size of the destination drawable region desired. Pointers to where the closest destination sizes supported by the server are returned. .\" -.SH Description +.SH DESCRIPTION .\" -Some ports may be able to scale incoming or outgoing video. -XvQueryBestSize(__libmansuffix__) returns the size of the closest destination -region that is supported by the adaptor. The returned size is -guaranteed to be smaller than the requested size if a smaller -size is supported. +Some ports may be able to scale incoming or outgoing video. +.BR XvQueryBestSize (__libmansuffix__) +returns the size of the closest destination region that is supported +by the adaptor. The returned size is guaranteed to be smaller than +the requested size if a smaller size is supported. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvQueryBestSize(__libmansuffix__) completed successfully. +Returned if +.BR XvQueryBestSize (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvQueryBestSize(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvQueryBestSize (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .br diff --git a/man/XvQueryEncodings.man b/man/XvQueryEncodings.man index d9e4d50..34e55d0 100644 --- a/man/XvQueryEncodings.man +++ b/man/XvQueryEncodings.man @@ -1,16 +1,16 @@ -.TH XvQueryEncodings __libmansuffix__ __vendorversion__ -.SH Name +.TH XvQueryEncodings __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvQueryEncodings \- return list of encodings for an adaptor .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvQueryEncodings(Display *" dpy ", XvPortID " port ", -.BI " unsigned int *" p_num_encodings ", -.BI " XvEncodingInfo **" pp_encoding_info ");" +.BI "int XvQueryEncodings(Display *" dpy ", XvPortID " port "," +.BI " unsigned int *" p_num_encodings "," +.BI " XvEncodingInfo **" pp_encoding_info ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -21,8 +21,7 @@ list of encodings. A pointer to where the number of encodings supported by the adaptor is written. .IP \fIpp_encoding_info\fR 8 -A pointer to where the list of returned -encoding information is returned. +A pointer to where the list of returned encoding information is returned. XvEncodingInfo has the following structure: .EX @@ -41,7 +40,7 @@ Specifies the encoding-id of the encoding. The encoding-id is used to identify an encoding when a port's encoding attribute is changed. .IP \fIname\fR 8 A pointer to a formatted string that identifies the encoding. The string -has the format "\fItiming-signaltype\fR". For example "ntsc-composite". +has the format "\fItiming\fR-\fIsignaltype\fR". For example "ntsc-composite". .IP \fIwidth,height\fR 8 The width and height, in pixels, of the decoded video image. .IP \fIrate\fR 8 @@ -57,27 +56,31 @@ It has the following structure: } XvRational; .EE -The \fInumerator\fP and \fIdenominator\fP fields specify the +The \fInumerator\fP and \fIdenominator\fP fields specify the appropriate parts of a fractional number. .\" -.SH Description -XvQueryEncodings(__libmansuffix__) returns encoding information about an adaptor. Each -encoding is described by the XvEncodingInfo structure described above. The +.SH DESCRIPTION +.BR XvQueryEncodings (__libmansuffix__) +returns encoding information about an adaptor. Each +encoding is described by the XvEncodingInfo structure described above. The encodings are identified by an encoding-id, which can be used to set or get the encoding attribute of a port. -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvQueryEncodings(__libmansuffix__) completed successfully. +Returned if +.BR XvQueryEncodings (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvQueryEncodings(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvQueryEncodings (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .\" -.SH See Also +.SH SEE ALSO .\" -XvFreeEncodingInfo(__libmansuffix__) -.br +.BR XvFreeEncodingInfo (__libmansuffix__) + diff --git a/man/XvQueryExtension.man b/man/XvQueryExtension.man index b238a79..4cce6dc 100644 --- a/man/XvQueryExtension.man +++ b/man/XvQueryExtension.man @@ -1,18 +1,18 @@ -.TH XvQueryExtension __libmansuffix__ __vendorversion__ -.SH Name +.TH XvQueryExtension __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvQueryExtension \- return version and release of extension .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvQueryExtension(Display *" dpy ", unsigned int *" p_version ", -.BI " unsigned int *" p_revision ", -.BI " unsigned int *" p_request_base ", -.BI " unsigned int *" p_event_base ", -.BI " unsigned int *" p_error_base ");" +.BI "int XvQueryExtension(Display *" dpy ", unsigned int *" p_version "," +.BI " unsigned int *" p_revision "," +.BI " unsigned int *" p_request_base "," +.BI " unsigned int *" p_event_base "," +.BI " unsigned int *" p_error_base ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. @@ -29,21 +29,24 @@ Pointer to where the extension event base is returned .IP \fIp_error_base\fR 15 Pointer to where the extension error base is returned .\" -.SH Description +.SH DESCRIPTION .\" .PP -XvQueryExtension(__libmansuffix__) returns the version and release -numbers for the Xv video extension currently loaded -on the system. The extension major request number, event base, and error -base are also returned. +.BR XvQueryExtension (__libmansuffix__) +returns the version and release numbers for the Xv video extension +currently loaded on the system. The extension major request number, +event base, and error base are also returned. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvQueryExtension(__libmansuffix__) completed successfully. +Returned if +.BR XvQueryExtension (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 -Returned if the Xv video extension is not available for -the named display. +Returned if the Xv video extension is not available for the named display. .IP [XvBadAlloc] 8 -Returned if XvQueryExtension(__libmansuffix__) failed to allocate memory to process -the request. -.br +Returned if +.BR XvQueryExtension (__libmansuffix__) +failed to allocate memory to process the request. +.SH SEE ALSO +.BR Xv (__libmansuffix__) diff --git a/man/XvSelectPortNotify.man b/man/XvSelectPortNotify.man index 745d828..f31fa24 100644 --- a/man/XvSelectPortNotify.man +++ b/man/XvSelectPortNotify.man @@ -1,41 +1,49 @@ -.TH XvSelectPortNotify __libmansuffix__ __vendorversion__ -.SH Name -XvSelectPortNotify \- enable or disable XvPortNotify(__libmansuffix__) events +.TH XvSelectPortNotify __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvSelectPortNotify \- enable or disable XvPortNotify events .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");" +.BI "int XvSelectPortNotify(Display *" dpy ", XvPortID " port ", Bool " onoff ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. .IP \fIport\fR 8 Specifies the port for which PortNotify events are to be generated -when its attributes are changed using XvSetPortAttribute(__libmansuffix__). +when its attributes are changed using +.BR XvSetPortAttribute (__libmansuffix__) +. .IP \fIonoff\fR 8 Specifies whether notification is to be enabled or disabled. .\" -.SH Description +.SH DESCRIPTION .\" -XvSelectPortNotify(__libmansuffix__) enables or disables PortNotify event -delivery to the requesting client. XvPortNotify(__libmansuffix__) events are -generated when port attributes are changed using XvSetPortAttribute(__libmansuffix__). +.BR XvSelectPortNotify (__libmansuffix__) +enables or disables PortNotify event delivery to the requesting client. +.BR XvPortNotify (__libmansuffix__) +events are generated when port attributes are changed using +.BR XvSetPortAttribute (__libmansuffix__). .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvSelectPortNotify(__libmansuffix__) completed successfully. +Returned if +.BR XvSelectPortNotify (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvSelectPortNotify(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvSelectPortNotify (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. -.SH See Also +.SH SEE ALSO .\" -XvSetPortNotify(__libmansuffix__), XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__) -.br +.BR XvSetPortNotify (__libmansuffix__), +.BR XvSetPortAttribute (__libmansuffix__), +.BR XvPortNotify (__libmansuffix__) diff --git a/man/XvSelectVideoNotify.man b/man/XvSelectVideoNotify.man index f9cbab5..096d006 100644 --- a/man/XvSelectVideoNotify.man +++ b/man/XvSelectVideoNotify.man @@ -1,14 +1,14 @@ -.TH XvSelectVideoNotify __libmansuffix__ __vendorversion__ -.SH Name +.TH XvSelectVideoNotify __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvSelectVideoNotify \- enable or disable VideoNotify events .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvSelectVideoNotify(Display *" dpy ", Drawable " drawable ", Bool " onoff ");" +.BI "int XvSelectVideoNotify(Display *" dpy ", Drawable " drawable ", Bool " onoff ");" .fi -.SH Arguments +.SH ARGUMENTS .IP \fIdpy\fR 15 Specifies the connection to the X server. .IP \fIdrawable\fR 15 @@ -16,22 +16,27 @@ Defines the drawable in which video activity is to be reported. .IP \fIonoff\fR 15 Selects whether video notification is enabled or disabled. .\" -.SH Description -XvSelectVideoNotify(__libmansuffix__) enables or disables events to be reported for -video activity in a drawable. +.SH DESCRIPTION +.BR XvSelectVideoNotify (__libmansuffix__) +enables or disables +.BR XvVideoNotify (__libmansuffix__) +events to be reported for video activity in a drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvSelectVideoNotify(__libmansuffix__) completed successfully. +Returned if +.BR XvSelectVideoNotify (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvSelectVideoNotify(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvSelectVideoNotify (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [BadDrawable] 8 Generated if the requested drawable does not exist. -.SH See Also +.SH SEE ALSO .\" -XvVideoNotify -.br +.BR XvVideoNotify (__libmansuffix__) + diff --git a/man/XvSetPortAttribute.man b/man/XvSetPortAttribute.man index cf255c5..74e1f4d 100644 --- a/man/XvSetPortAttribute.man +++ b/man/XvSetPortAttribute.man @@ -1,15 +1,16 @@ -.TH XvSetPortAttribute __libmansuffix__ __vendorversion__ -.SH Name -XvSetPortAttribute \- sets an attribute of a video port +'\" t +.TH XvSetPortAttribute __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvSetPortAttribute \- sets an attribute of a video port .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvSetPortAttribute(Display *" dpy ", XvPortID " port ", -.BI " Atom " attribute ", int " value ");" +.BI "int XvSetPortAttribute(Display *" dpy ", XvPortID " port "," +.BI " Atom " attribute ", int " value ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 15 Specifies the connection to the X server. @@ -22,67 +23,67 @@ Can be one of the table entries under the column "String," below. Identifies the value to which \fIattribute\fP is to be set. Can be one of the table entries under the column "Type," below. .\" -.SH Description -XvSetPortAttribute(__libmansuffix__) permits a client to set the port attribute +.SH DESCRIPTION +.BR XvSetPortAttribute (__libmansuffix__) + permits a client to set the port attribute to specified values. This request supports the following values: -.bp .PP -.\" .TS -.\" tab(@); -.\" lfHB lfHB lfHB -.\" lfR lfR lfR . -.\" _ -.\" .PP -.\" .sp 4p -.\" Attribute String@Type@Default -.\" .sp 6p -.\" _ -.\" .sp 6p -.\" "XV_ENCODING"@XvEncodingID@Server dependent -.\" "XV_HUE"@[-1000...1000]@0 -.\" "XV_SATURATION"@[-1000...1000]@0 -.\" "XV_BRIGHTNESS"@[-1000...1000]@0 -.\" "XV_CONTRAST"@[-1000...1000]@0 -.\" .sp 6p -.\" .TE -.nf -Attribute String Type Default - -"XV_ENCODING" XvEncodingID Server dependent -"XV_HUE" [-1000...1000] 0 -"XV_SATURATION" [-1000...1000] 0 -"XV_BRIGHTNESS" [-1000...1000] 0 -"XV_CONTRAST" [-1000...1000] 0 -.fi +.TS +tab(@); +lfHB lfHB lfHB +lfR lfR lfR . +_ +.PP +.sp 4p +Attribute String@Type@Default +.sp 6p +_ +.sp 6p +"XV_ENCODING"@XvEncodingID@Server dependent +"XV_HUE"@[-1000...1000]@0 +"XV_SATURATION"@[-1000...1000]@0 +"XV_BRIGHTNESS"@[-1000...1000]@0 +"XV_CONTRAST"@[-1000...1000]@0 +.sp 6p +.TE .PP The supplied encoding must be one of the encodings listed for the adaptor, otherwise an Encoding error results. .PP If the adaptor does not support the exact hue, saturation, brightness, and contrast levels supplied, the closest levels -supported are assumed. Use XvGetPortAttribute(__libmansuffix__) +supported are assumed. Use +.BR XvGetPortAttribute (__libmansuffix__) to query the resulting levels. .PP -When an XvSetPortAttribute(__libmansuffix__) request is processed, a -PortControlNotify(__libmansuffix__) event is generated for all clients -that have requested for port changes using XvSelectPortNotify(__libmansuffix__). -.SH Returned Values +When an +.BR XvSetPortAttribute (__libmansuffix__) +request is processed, a +.BR XvPortNotify (__libmansuffix__) +event is generated for all clients that have requested notification of +port changes using +.BR XvSelectPortNotify (__libmansuffix__). +.SH RETURN VALUES .IP [Success] 8 -Returned if XvSetPortAttribute(__libmansuffix__) completed successfully. +Returned if +.BR XvSetPortAttribute (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvSelectVideoNotify(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvSelectVideoNotify (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. .IP [XvBadEncoding] 8 Generated if an encoding is specified that does not exist. .IP [BadMatch] 8 -Generated if the requested attribute atom does not specify an attribute +Generated if the requested attribute atom does not specify an attribute supported by the adaptor. -.SH See Also +.SH SEE ALSO .\" -XvGetPortAttribute(__libmansuffix__), XvSelectPortNotify(__libmansuffix__), XvPortNotify(__libmansuffix__) -.br +.BR XvGetPortAttribute (__libmansuffix__), +.BR XvSelectPortNotify (__libmansuffix__), +.BR XvPortNotify (__libmansuffix__) diff --git a/man/XvStopVideo.man b/man/XvStopVideo.man index 0c472b0..3904521 100644 --- a/man/XvStopVideo.man +++ b/man/XvStopVideo.man @@ -1,14 +1,14 @@ -.TH XvStopVideo __libmansuffix__ __vendorversion__ -.SH Name -XvStopVideo \- stop active video +.TH XvStopVideo __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME +XvStopVideo \- stop active video .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvGetStill(Display *" dpy ", XvPortID " port ", Drawable " draw ");" +.BI "int XvStopVideo(Display *" dpy ", XvPortID " port ", Drawable " draw ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -16,28 +16,33 @@ Specifies the connection to the X server. Specifies the port for which video is to be stopped. .IP \fIdraw\fR 8 Specifies the drawable associated with the named port. -.SH Description +.SH DESCRIPTION .\" -XvStopVideo(__libmansuffix__) stops active video for the specified port and -drawable. If the port is not processing video, or if it is processing -video in a different drawable, the request is ignored. When video is -stopped a XvVideoNotify(__libmansuffix__) event with detail XvStopped is generated -for the associated drawable. +.BR XvStopVideo (__libmansuffix__) +stops active video for the specified port and drawable. If the port +is not processing video, or if it is processing video in a different +drawable, the request is ignored. When video is stopped a +.BR XvVideoNotify (__libmansuffix__) +event with detail XvStopped is generated for the associated drawable. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvStopVideo(__libmansuffix__) completed successfully. +Returned if +.BR XvStopVideo (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvStopVideo(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvStopVideo (__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 Generated if the requested drawable does not exist. .\" -.SH See Also -XvGetVideo(__libmansuffix__), XvPutVideo(__libmansuffix__), XvVideoNotifyEvent(__libmansuffix__) -.br +.SH SEE ALSO +.BR XvGetVideo (__libmansuffix__), +.BR XvPutVideo (__libmansuffix__), +.BR XvVideoNotify (__libmansuffix__) diff --git a/man/XvUngrabPort.man b/man/XvUngrabPort.man index 6a88842..6538ff4 100644 --- a/man/XvUngrabPort.man +++ b/man/XvUngrabPort.man @@ -1,14 +1,14 @@ -.TH XvUngrabPort __libmansuffix__ __vendorversion__ -.SH Name +.TH XvUngrabPort __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvUngrabPort \- release port grabbed for video operation .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .sp .nf -.BI "XvUngrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" +.BI "int XvUngrabPort(Display *" dpy ", XvPortID " port ", Time " time ");" .fi -.SH Arguments +.SH ARGUMENTS .\" .IP \fIdpy\fR 8 Specifies the connection to the X server. @@ -18,23 +18,26 @@ previously grabbed, the request is ignored. .IP \fItime\fR 8 Specifies the request timestamp. .\" -.SH Description -XvUngrabPort(__libmansuffix__) releases a grabbed port. If \fItime\fR specifies a -time before the last XvGrabPort(__libmansuffix__) was executed, the -request is ignored. +.SH DESCRIPTION +.BR XvUngrabPort (__libmansuffix__) + releases a grabbed port. If \fItime\fR specifies a time before the last +.BR XvGrabPort (__libmansuffix__) +was executed, the request is ignored. .\" -.SH Returned Values +.SH RETURN VALUES .IP [Success] 8 -Returned if XvUngrabPort(__libmansuffix__) completed successfully. +Returned if +.BR XvUngrabPort (__libmansuffix__) +completed successfully. .IP [XvBadExtension] 8 Returned if the Xv extension is unavailable. .IP [XvBadAlloc] 8 -Returned if XvUngrabPort(__libmansuffix__) failed to allocate memory to process -the request. -.SH Diagnostics +Returned if +.BR XvUngrabPort (__libmansuffix__) +failed to allocate memory to process the request. +.SH DIAGNOSTICS .IP [XvBadPort] 8 Generated if the requested port does not exist. -.SH See Also +.SH SEE ALSO .\" -XvGrabPort(__libmansuffix__) -.br +.BR XvGrabPort (__libmansuffix__) diff --git a/man/XvVideoNotify.man b/man/XvVideoNotify.man index 5739320..8d0a24b 100644 --- a/man/XvVideoNotify.man +++ b/man/XvVideoNotify.man @@ -1,8 +1,8 @@ -.TH XvVideoNotify __libmansuffix__ __vendorversion__ -.SH Name +.TH XvVideoNotify __libmansuffix__ __vendorversion__ "libXv Functions" +.SH NAME XvVideoNotify \- event generated for video processing .\" -.SH Syntax +.SH SYNOPSIS .B #include <X11/extensions/Xvlib.h> .br .sp 1l @@ -29,7 +29,8 @@ XvVideoNotify \- event generated for video processing .EE .\" .IP \fItype\fR 8 -Specifies the type of event: XvVideoNotify(__libmansuffix__). +Specifies the type of event: +.BR XvVideoNotify . .IP \fIserial\fR 8 Number of the last request processed by the server. .IP \fIsend_event\fR 8 @@ -39,19 +40,24 @@ A pointer to the display the event was read from. .IP \fIdrawable\fR 8 The drawable for which the event was generated. .IP \fIreason\fR 8 -The reason the event was generated: \fBXvStarted\fR, \fBXvStopped\fR, +The reason the event was generated: \fBXvStarted\fR, \fBXvStopped\fR, \fBXvPreempted\fR, \fBXvBusy\fR, \fBXvHardError\fR. .IP \fIport_id\fR 8 The port processing the video for which the event was generated. .\" -.SH Description +.SH DESCRIPTION .\" -XvVideoNotify(__libmansuffix__) events are generated when video -is started, stopped, preempted by another video -request, ignored because the port is grabbed by another client, or interrupted -because of a hard transmission or reception error. +.B XvVideoNotify +events are generated when video is started, stopped, preempted by +another video request, ignored because the port is grabbed by another +client, or interrupted because of a hard transmission or reception +error. .\" -.SH See Also -XvPutVideo(__libmansuffix__), XvPutStill(__libmansuffix__), XvGetVideo(__libmansuffix__), XvGetStill(__libmansuffix__), -XvStopVideo(__libmansuffix__), XvSelectVideoNotify(__libmansuffix__) +.SH SEE ALSO +.BR XvPutVideo (__libmansuffix__), +.BR XvPutStill (__libmansuffix__), +.BR XvGetVideo (__libmansuffix__), +.BR XvGetStill (__libmansuffix__), +.BR XvStopVideo (__libmansuffix__), +.BR XvSelectVideoNotify (__libmansuffix__) .\" |