MAN page from PCLinuxOS libxv1-devel-1.0.1-3.pclo2005.mde.i586.rpm

XvGetPortAttribute

Section: Misc. Reference Manual Pages (3x)
Updated: libXv 1.0.1
Index

Name

XvGetPortAttribute - return current port attribute value

Syntax

#include <X11/extensions/Xvlib.h>

XvGetPortAttribute(dpy, port, attribute, p_value)

Display *dpy;
XvPortID port;
Atom attribute;
int *p_value;

Arguments

dpy: Specifies the display screen on which theX Server is to accept requests from X clients. If thedisplay option is not specified, X uses the display screenspecified by your DISPLAY environment variable. The displayoption has the format hostname:number. Using two colons(::) instead of one (:) indicates that DECnet is to be usedfor transport.
port: Specifies the port, associated with the given display, forwhich the attribute values are to be returned.
attribute: An atom that identifies the attribute to be queried by thisrequest. Control atoms are obtained using the XInternAtomrequest with a string from the following table.
p_value: Pointer to the location where the attribute value is written onreturn.

Description

XvGetPortAttribute(3x) returns the current value of the requestedport attribute in the integer pointed to by p_value. The attribute is identified using an Atom that equates to the attribute name. The XInternAtom request can be used with one of the stringsbelow to return a matching Atom.

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

Returned Values

[Success]: Returned if XvGetPortAttribute(3x) completed successfully.
[XvBadExtension]: Returned if the Xv extension is unavailable.
[XvBadAlloc]: Returned if XvGetPortAttribute(3x) failed to allocate memory to processthe request.

Diagnostics

[XvBadPort]: Generated if the requested port does not exist.
[BadMatch]: Generated if the requested attribute atom does not specify an attribute supported by the adaptor.

This document was created byman2html,using the manual pages.