MAN page from Mandriva 2009 libxv1-devel-1.0.4-2mdv2009.1.i586.rpm

XvGetPortAttribute

Section: C Library Functions (3)
Updated: libXv 1.0.4
Index

Name

XvGetPortAttribute - return current port attribute value

Syntax

#include <X11/extensions/Xvlib.h>

XvGetPortAttribute(Display *dpy, XvPortID port,                   Atom attribute, int p_value);

Arguments

dpy: Specifies the connection to the X server.
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(3) 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(3) completed successfully.
[XvBadExtension]: Returned if the Xv extension is unavailable.
[XvBadAlloc]: Returned if XvGetPortAttribute(3) 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.