2009-10-31 12:54:56 -06:00
|
|
|
'\" t
|
|
|
|
|
.TH XvSetPortAttribute __libmansuffix__ __vendorversion__ "libXv Functions"
|
|
|
|
|
.SH NAME
|
|
|
|
|
XvSetPortAttribute \- sets an attribute of a video port
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SYNOPSIS
|
2008-05-24 07:46:47 -06:00
|
|
|
.B #include <X11/extensions/Xvlib.h>
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
2009-10-31 12:54:56 -06:00
|
|
|
.BI "int XvSetPortAttribute(Display *" dpy ", XvPortID " port ","
|
|
|
|
|
.BI " Atom " attribute ", int " value ");"
|
2008-05-24 07:46:47 -06:00
|
|
|
.fi
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH ARGUMENTS
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
|
|
|
|
.IP \fIdpy\fR 15
|
|
|
|
|
Specifies the connection to the X server.
|
|
|
|
|
.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.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.BR XvSetPortAttribute (__libmansuffix__)
|
|
|
|
|
permits a client to set the port attribute
|
2006-11-25 11:01:46 -07:00
|
|
|
to specified values. This request supports the following values:
|
|
|
|
|
.PP
|
2009-10-31 12:54:56 -06:00
|
|
|
.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
|
2006-11-25 11:01:46 -07:00
|
|
|
.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
|
2009-10-31 12:54:56 -06:00
|
|
|
supported are assumed. Use
|
|
|
|
|
.BR XvGetPortAttribute (__libmansuffix__)
|
2006-11-25 11:01:46 -07:00
|
|
|
to query the resulting levels.
|
|
|
|
|
.PP
|
2009-10-31 12:54:56 -06:00
|
|
|
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
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [Success] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvSetPortAttribute (__libmansuffix__)
|
|
|
|
|
completed successfully.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [XvBadExtension] 8
|
|
|
|
|
Returned if the Xv extension is unavailable.
|
|
|
|
|
.IP [XvBadAlloc] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvSelectVideoNotify (__libmansuffix__)
|
|
|
|
|
failed to allocate memory to process the request.
|
|
|
|
|
.SH DIAGNOSTICS
|
2006-11-25 11:01:46 -07:00
|
|
|
.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
|
2009-10-31 12:54:56 -06:00
|
|
|
Generated if the requested attribute atom does not specify an attribute
|
2006-11-25 11:01:46 -07:00
|
|
|
supported by the adaptor.
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SEE ALSO
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.BR XvGetPortAttribute (__libmansuffix__),
|
|
|
|
|
.BR XvQueryPortAttributes (__libmansuffix__),
|
|
|
|
|
.BR XvSelectPortNotify (__libmansuffix__),
|
|
|
|
|
.BR XvPortNotify (__libmansuffix__)
|
