summaryrefslogtreecommitdiff
path: root/man/XvSetPortAttribute.man
diff options
context:
space:
mode:
authorKaleb Keithley <kaleb@freedesktop.org>2003-11-14 16:48:49 +0000
committerKaleb Keithley <kaleb@freedesktop.org>2003-11-14 16:48:49 +0000
commit355f676a4ff26d8fcdfdbe64e791e60bc579e339 (patch)
tree7a1490729f7fad1929023e3408a5545a6470d68c /man/XvSetPortAttribute.man
downloadxorg-lib-libXv-355f676a4ff26d8fcdfdbe64e791e60bc579e339.tar.gz
Initial revisionXORG-STABLE
Diffstat (limited to 'man/XvSetPortAttribute.man')
-rw-r--r--man/XvSetPortAttribute.man100
1 files changed, 100 insertions, 0 deletions
diff --git a/man/XvSetPortAttribute.man b/man/XvSetPortAttribute.man
new file mode 100644
index 0000000..f61d682
--- /dev/null
+++ b/man/XvSetPortAttribute.man
@@ -0,0 +1,100 @@
+.TH XvSetPortAttribute 3X __vendorversion__
+.\" $XFree86: xc/doc/man/Xv/XvSetPortAttribute.man,v 1.7 2001/08/17 13:27:50 dawes Exp $
+.SH Name
+XvSetPortAttribute \- sets an attribute of a video port
+.\"
+.SH Syntax
+\fB#include <X11/extensions/Xvlib.h>\fR
+.sp 1l
+\fBXvSetPortAttribute(\fIdpy, port, attribute, value\fR)
+.sp 1l
+\fBDisplay \fI*dpy\fR;
+.br
+\fBXvPortID \fIport\fR;
+.br
+\fBAtom \fIattribute\fR;
+.br
+\fBint \fIvalue\fR;
+.SH Arguments
+.\"
+.IP \fIdpy\fR 15
+Specifies the display screen on which the
+Xv Server is to accept requests from Xv clients. If the
+display option is not specified, Xv uses the display screen
+specified by your DISPLAY environment variable. The display
+option has the format hostname:number. Using two colons
+(::) instead of one (:) indicates that DECnet is to be used
+for transport.
+.IP \fIport\fR 15
+Specifies the port for which the attribute is to be used.
+.IP \fIattribute\fR 15
+Identifies the port attribute to be set by this request.
+Can be one of the table entries under the column "String," below.
+.IP \fIvalue\fR 15
+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(3X) 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
+.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(3X)
+to query the resulting levels.
+.PP
+When an XvSetPortAttribute(3X) request is processed, a
+PortControlNotify(3X) event is generated for all clients
+that have requested for port changes using XvSelectPortNotify(3X).
+.SH Returned Values
+.IP [Success] 8
+Returned if XvSetPortAttribute(3X) completed successfully.
+.IP [XvBadExtension] 8
+Returned if the Xv extension is unavailable.
+.IP [XvBadAlloc] 8
+Returned if XvSelectVideoNotify(3X) 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
+supported by the adaptor.
+.SH See Also
+.\"
+XvGetPortAttribute(3X), XvSelectPortNotify(3X), XvPortNotify(3X)
+.br