2009-10-31 12:54:56 -06:00
|
|
|
'\" t
|
|
|
|
|
.TH XvGetPortAttribute __libmansuffix__ __vendorversion__ "libXv Functions"
|
|
|
|
|
.SH NAME
|
2006-11-25 11:01:46 -07:00
|
|
|
XvGetPortAttribute \- return current port attribute value
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SYNOPSIS
|
2006-11-25 11:01:46 -07:00
|
|
|
.B #include <X11/extensions/Xvlib.h>
|
2008-05-24 07:46:47 -06:00
|
|
|
.sp
|
|
|
|
|
.nf
|
2009-10-31 12:54:56 -06:00
|
|
|
.BI "int XvGetPortAttribute(Display *" dpy ", XvPortID " port ","
|
|
|
|
|
.BI " Atom " attribute ", int " p_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
|
|
|
.\"
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIdpy\fR 12
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the connection to the X server.
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIport\fR 12
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the port, associated with the given display, for
|
2009-10-31 12:54:56 -06:00
|
|
|
which the attribute values are to be returned.
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIattribute\fR 12
|
2006-11-25 11:01:46 -07:00
|
|
|
An atom that identifies the attribute to be queried by this
|
|
|
|
|
request. Control atoms are obtained using the XInternAtom
|
|
|
|
|
request with a string from the following table.
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIp_value\fR 12
|
2006-11-25 11:01:46 -07:00
|
|
|
Pointer to the location where the attribute value is written on
|
|
|
|
|
return.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH DESCRIPTION
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
|
|
|
|
.PP
|
2009-10-31 12:54:56 -06:00
|
|
|
.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.
|
2006-11-25 11:01:46 -07:00
|
|
|
The XInternAtom request can be used with one of the strings
|
|
|
|
|
below to return a matching Atom.
|
|
|
|
|
.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
|
|
|
|
|
.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 XvGetPortAttribute (__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 XvGetPortAttribute (__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 [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 XvSetPortAttribute (__libmansuffix__),
|
|
|
|
|
.BR XvPortNotify (__libmansuffix__)
|
