summaryrefslogtreecommitdiff
path: root/man/XvSetPortAttribute.man
diff options
context:
space:
mode:
Diffstat (limited to 'man/XvSetPortAttribute.man')
-rw-r--r--man/XvSetPortAttribute.man101
1 files changed, 51 insertions, 50 deletions
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__)