← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/GL/gl/gettexparameter.3gl

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/GL/gl/gettexparameter.3gl
 
1
'\" e
 
2
'\"! eqn | mmdoc
 
3
'\"macro stdmacro
 
4
.ds Vn Version 1.2
 
5
.ds Dt 24 September 1999
 
6
.ds Re Release 1.2.1
 
7
.ds Dp Jan 14 18:30
 
8
.ds Dm 01 gettexpar
 
9
.ds Xs 10274 6 gettexparameter.gl
 
10
.TH GLGETTEXPARAMETER 3G
 
11
.SH NAME
 
12
.B "glGetTexParameterfv, glGetTexParameteriv
 
13
\- return texture parameter values
 
14
 
 
15
.SH C SPECIFICATION
 
16
void \f3glGetTexParameterfv\fP(
 
17
GLenum \fItarget\fP,
 
18
.nf
 
19
.ta \w'\f3void \fPglGetTexParameterfv( 'u
 
20
        GLenum \fIpname\fP,
 
21
        GLfloat \fI*params\fP )
 
22
.fi
 
23
void \f3glGetTexParameteriv\fP(
 
24
GLenum \fItarget\fP,
 
25
.nf
 
26
.ta \w'\f3void \fPglGetTexParameteriv( 'u
 
27
        GLenum \fIpname\fP,
 
28
        GLint \fI*params\fP )
 
29
.fi
 
30
 
 
31
.EQ
 
32
delim $$
 
33
.EN
 
34
.SH PARAMETERS
 
35
.TP \w'\f2target\fP\ \ 'u 
 
36
\f2target\fP
 
37
Specifies the symbolic name of the target texture.
 
38
\%\f3GL_TEXTURE_1D\fP,\%\f3GL_TEXTURE_2D\fP, and \%\f3GL_TEXTURE_3D\fP  are accepted.
 
39
.TP
 
40
\f2pname\fP
 
41
Specifies the symbolic name of a texture parameter.
 
42
\%\f3GL_TEXTURE_MAG_FILTER\fP,
 
43
\%\f3GL_TEXTURE_MIN_FILTER\fP,
 
44
\%\f3GL_TEXTURE_MIN_LOD\fP,
 
45
\%\f3GL_TEXTURE_MAX_LOD\fP,
 
46
\%\f3GL_TEXTURE_BASE_LEVEL\fP,
 
47
\%\f3GL_TEXTURE_MAX_LEVEL\fP,
 
48
\%\f3GL_TEXTURE_WRAP_S\fP,
 
49
\%\f3GL_TEXTURE_WRAP_T\fP,
 
50
\%\f3GL_TEXTURE_WRAP_R\fP,
 
51
\%\f3GL_TEXTURE_BORDER_COLOR\fP,
 
52
\%\f3GL_TEXTURE_PRIORITY\fP, and
 
53
\%\f3GL_TEXTURE_RESIDENT\fP are accepted.
 
54
.TP
 
55
\f2params\fP
 
56
Returns the texture parameters.
 
57
.SH DESCRIPTION
 
58
\%\f3glGetTexParameter\fP returns in \f2params\fP the value or values of the texture parameter
 
59
specified as \f2pname\fP.
 
60
\f2target\fP defines the target texture,
 
61
either \%\f3GL_TEXTURE_1D\fP, \%\f3GL_TEXTURE_2D\fP, or \%\f3GL_TEXTURE_3D\fP
 
62
to specify one-, two-, or three-dimensional texturing.
 
63
\f2pname\fP accepts the same symbols as \%\f3glTexParameter\fP,
 
64
with the same interpretations:
 
65
.TP 35
 
66
\%\f3GL_TEXTURE_MAG_FILTER\fP
 
67
Returns the single-valued texture magnification filter,
 
68
a symbolic constant. The initial value is \%\f3GL_LINEAR\fP.
 
69
.TP
 
70
\%\f3GL_TEXTURE_MIN_FILTER\fP
 
71
Returns the single-valued texture minification filter,
 
72
a symbolic constant. The initial value is \%\f3GL_NEAREST_MIPMAP_LINEAR\fP.
 
73
.TP
 
74
\%\f3GL_TEXTURE_MIN_LOD\fP
 
75
Returns the single-valued texture minimum level-of-detail value.  The
 
76
initial value is $-1000$.
 
77
.TP
 
78
\%\f3GL_TEXTURE_MAX_LOD\fP
 
79
Returns the single-valued texture maximum level-of-detail value. The
 
80
initial value is 1000.
 
81
.TP
 
82
\%\f3GL_TEXTURE_BASE_LEVEL\fP
 
83
Returns the single-valued base texture mipmap level.  The initial value is 0.
 
84
.TP
 
85
\%\f3GL_TEXTURE_MAX_LEVEL\fP
 
86
Returns the single-valued maximum texture mipmap array level.  The initial
 
87
value is 1000.
 
88
.TP
 
89
\%\f3GL_TEXTURE_WRAP_S\fP
 
90
Returns the single-valued wrapping function for texture coordinate $s$,
 
91
a symbolic constant. The initial value is \%\f3GL_REPEAT\fP.
 
92
.TP
 
93
\%\f3GL_TEXTURE_WRAP_T\fP
 
94
Returns the single-valued wrapping function for texture coordinate $t$,
 
95
a symbolic constant. The initial value is \%\f3GL_REPEAT\fP.
 
96
.TP
 
97
\%\f3GL_TEXTURE_WRAP_R\fP
 
98
Returns the single-valued wrapping function for texture coordinate $r$,
 
99
a symbolic constant. The initial value is \%\f3GL_REPEAT\fP.
 
100
.BP
 
101
.TP
 
102
\%\f3GL_TEXTURE_BORDER_COLOR\fP
 
103
Returns four integer or floating-point numbers that comprise the RGBA color
 
104
of the texture border.
 
105
Floating-point values are returned in the range [0, 1].
 
106
Integer values are returned as a linear mapping of the internal floating-point 
 
107
representation such that 1.0 maps to the most positive representable
 
108
integer and \-1.0 maps to the most negative representable
 
109
integer. The initial value is (0, 0, 0, 0). 
 
110
.TP
 
111
\%\f3GL_TEXTURE_PRIORITY\fP
 
112
Returns the residence priority of the target texture (or the named
 
113
texture bound to it). The initial value is 1. 
 
114
See \%\f3glPrioritizeTextures\fP.
 
115
.TP
 
116
\%\f3GL_TEXTURE_RESIDENT\fP
 
117
Returns the residence status of the target texture.
 
118
If the value returned in \f2params\fP is \%\f3GL_TRUE\fP, the texture is
 
119
resident in texture memory.
 
120
See \%\f3glAreTexturesResident\fP.
 
121
.SH NOTES
 
122
\%\f3GL_TEXTURE_PRIORITY\fP and \%\f3GL_TEXTURE_RESIDENT\fP are
 
123
available only if the GL version is 1.1 or greater.
 
124
.P
 
125
\%\f3GL_TEXTURE_3D\fP, 
 
126
\%\f3GL_TEXTURE_MIN_LOD\fP, \%\f3GL_TEXTURE_MAX_LOD\fP, \%\f3GL_TEXTURE_BASE_LEVEL\fP,
 
127
\%\f3GL_TEXTURE_MAX_LEVEL\fP, and \%\f3GL_TEXTURE_WRAP_R\fP are available only
 
128
if the GL version is 1.2 or greater.
 
129
.P
 
130
If an error is generated,
 
131
no change is made to the contents of \f2params\fP.
 
132
.SH ERRORS
 
133
\%\f3GL_INVALID_ENUM\fP is generated if \f2target\fP or \f2pname\fP is not an
 
134
accepted value.
 
135
.P
 
136
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetTexParameter\fP
 
137
is executed between the execution of \%\f3glBegin\fP
 
138
and the corresponding execution of \%\f3glEnd\fP.
 
139
.SH SEE ALSO
 
140
\%\f3glAreTexturesResident(3G)\fP,
 
141
\%\f3glPrioritizeTextures(3G)\fP,
 
142
\%\f3glTexParameter(3G)\fP