← Back to branch summary

~ubuntu-branches/debian/squeeze/libxv/squeeze

« back to all changes in this revision

Viewing changes to man/XvGetPortAttribute.man

  • Committer: Bazaar Package Importer
  • Author(s): David Nusinow
  • Date: 2006-09-25 20:17:05 UTC
  • Revision ID: james.westby@ubuntu.com-20060925201705-o5vqinq0rqdc7obb
Tags: upstream-1.0.2
Import upstream version 1.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/XvGetPortAttribute.man
 
1
.TH XvGetPortAttribute __libmansuffix__ __vendorversion__
 
2
.\" $XFree86: xc/doc/man/Xv/XvGetPortAttribute.man,v 1.6 2001/01/27 18:20:35 dawes Exp $
 
3
.SH Name
 
4
XvGetPortAttribute \- return current port attribute value
 
5
.\"
 
6
.SH Syntax
 
7
.B #include <X11/extensions/Xvlib.h>
 
8
.sp 1l
 
9
.B XvGetPortAttribute(\fIdpy, port, attribute, p_value\fR)
 
10
.sp 1l
 
11
\fBDisplay \fI*dpy\fR;
 
12
.br
 
13
\fBXvPortID \fIport\fR;
 
14
.br
 
15
\fBAtom \fIattribute\fR;
 
16
.br
 
17
\fBint \fI*p_value\fR;
 
18
.sp 1l
 
19
.\"
 
20
.SH Arguments
 
21
.\"
 
22
.IP \fIdpy\fR 8
 
23
Specifies the connection to the X server.
 
24
.IP \fIport\fR 8
 
25
Specifies the port, associated with the given display, for
 
26
which the attribute values are to be returned. 
 
27
.IP \fIattribute\fR 8
 
28
An atom that identifies the attribute to be queried by this
 
29
request.  Control atoms are obtained using the XInternAtom
 
30
request with a string from the following table.
 
31
.IP \fIp_value\fR 8
 
32
Pointer to the location where the attribute value is written on
 
33
return.
 
34
.\"
 
35
.SH Description
 
36
.\"
 
37
.PP
 
38
XvGetPortAttribute(__libmansuffix__) returns the current value of the requested
 
39
port attribute in the integer pointed to by \fIp_value\fR.  
 
40
The attribute is identified using an Atom that equates to the attribute name.  
 
41
The XInternAtom request can be used with one of the strings
 
42
below to return a matching Atom.
 
43
.bp
 
44
.PP
 
45
.\" .TS
 
46
.\" tab(@);
 
47
.\" lfHB lfHB lfHB
 
48
.\" lfR  lfR  lfR .
 
49
.\" _
 
50
.\" .PP
 
51
.\" .sp 4p
 
52
.\" Attribute String@Type@Default
 
53
.\" .sp 6p
 
54
.\" _
 
55
.\" .sp 6p
 
56
.\" "XV_ENCODING"@XvEncodingID@Server dependent
 
57
.\" "XV_HUE"@[-1000...1000]@0
 
58
.\" "XV_SATURATION"@[-1000...1000]@0
 
59
.\" "XV_BRIGHTNESS"@[-1000...1000]@0
 
60
.\" "XV_CONTRAST"@[-1000...1000]@0
 
61
.\" .sp 6p
 
62
.\" .TE
 
63
.nf
 
64
Attribute String        Type             Default
 
65
 
 
66
"XV_ENCODING"           XvEncodingID     Server dependent
 
67
"XV_HUE"                [-1000...1000]   0
 
68
"XV_SATURATION"         [-1000...1000]   0
 
69
"XV_BRIGHTNESS"         [-1000...1000]   0
 
70
"XV_CONTRAST"           [-1000...1000]   0
 
71
.fi
 
72
.SH Returned Values
 
73
.IP [Success] 8
 
74
Returned if XvGetPortAttribute(__libmansuffix__) completed successfully.
 
75
.IP [XvBadExtension] 8
 
76
Returned if the Xv extension is unavailable.
 
77
.IP [XvBadAlloc] 8
 
78
Returned if XvGetPortAttribute(__libmansuffix__) failed to allocate memory to process
 
79
the request.
 
80
.SH Diagnostics
 
81
.IP [XvBadPort] 8
 
82
Generated if the requested port does not exist.
 
83
.IP [BadMatch] 8
 
84
Generated if the requested attribute atom does not specify an attribute 
 
85
supported by the adaptor.
 
86
.SH See Also
 
87
.\"
 
88
XvSetPortAttribute(__libmansuffix__), XvPortNotify(__libmansuffix__)
 
89
.br
 
90