← 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/aretexturesresident.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/aretexturesresident.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 aretextur
 
9
.ds Xs 9130 5 aretexturesresident.gl
 
10
.TH GLARETEXTURESRESIDENT 3G
 
11
.SH NAME
 
12
.B "glAreTexturesResident
 
13
\- determine if textures are loaded in texture memory
 
14
 
 
15
.SH C SPECIFICATION
 
16
GLboolean \f3glAreTexturesResident\fP(
 
17
GLsizei \fIn\fP,
 
18
.nf
 
19
.ta \w'\f3GLboolean \fPglAreTexturesResident( 'u
 
20
        const GLuint \fI*textures\fP,
 
21
        GLboolean \fI*residences\fP )
 
22
.fi
 
23
 
 
24
.SH PARAMETERS
 
25
.TP \w'\fIresidences\fP\ \ 'u 
 
26
\f2n\fP
 
27
Specifies the number of textures to be queried.
 
28
.TP
 
29
\f2textures\fP
 
30
Specifies an array containing the names of the textures to be queried.
 
31
.TP
 
32
\f2residences\fP
 
33
Specifies an array in which the texture residence status is returned.
 
34
The residence status of a texture named by an element of \f2textures\fP is
 
35
returned in the corresponding element of \f2residences\fP.
 
36
.SH DESCRIPTION
 
37
GL establishes
 
38
a ``working set'' of textures that are resident in texture memory.
 
39
These textures can be bound to a texture target much more efficiently
 
40
than textures that are not resident.
 
41
.P
 
42
\%\f3glAreTexturesResident\fP queries the texture residence status of the \f2n\fP textures named by
 
43
the elements of \f2textures\fP.
 
44
If all the named textures are resident,
 
45
\%\f3glAreTexturesResident\fP returns \%\f3GL_TRUE\fP,
 
46
and the contents of \f2residences\fP are undisturbed.
 
47
If not all the named textures are resident, \%\f3glAreTexturesResident\fP returns \%\f3GL_FALSE\fP,
 
48
and detailed status is returned in the \f2n\fP elements of \f2residences\fP.
 
49
If an element of \f2residences\fP is \%\f3GL_TRUE\fP, then the texture named by
 
50
the corresponding element of \f2textures\fP is resident.
 
51
.P
 
52
The residence status of a single bound texture may also be queried
 
53
by calling 
 
54
\%\f3glGetTexParameter\fP with the \f2target\fP argument set to the
 
55
target to which the texture is bound, and the \f2pname\fP argument
 
56
set to \%\f3GL_TEXTURE_RESIDENT\fP.
 
57
This is the only way that the residence status of a default texture can be
 
58
queried.
 
59
.SH NOTES
 
60
\%\f3glAreTexturesResident\fP is available only if the GL version is 1.1 or greater.
 
61
.P
 
62
\%\f3glAreTexturesResident\fP returns the residency status of the textures at the time of
 
63
invocation. It does not guarantee that the textures will remain
 
64
resident at any other time. 
 
65
.P
 
66
If textures reside in virtual memory (there is no texture memory), they
 
67
are considered always resident. 
 
68
.P
 
69
Some implementations may not load a texture until the first use of
 
70
that texture.
 
71
.SH ERRORS
 
72
\%\f3GL_INVALID_VALUE\fP is generated if \f2n\fP is negative.
 
73
.P
 
74
\%\f3GL_INVALID_VALUE\fP is generated if any element in \f2textures\fP
 
75
is 0 or does not name a texture. In that case, the function returns
 
76
\%\f3GL_FALSE\fP and the contents of \f2residences\fP is indeterminate. 
 
77
.P
 
78
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glAreTexturesResident\fP is executed
 
79
between the execution of \%\f3glBegin\fP and the corresponding
 
80
execution of \%\f3glEnd\fP.
 
81
.SH ASSOCIATED GETS
 
82
\%\f3glGetTexParameter\fP with parameter name \%\f3GL_TEXTURE_RESIDENT\fP
 
83
retrieves the residence status of a currently bound texture.
 
84
.SH SEE ALSO
 
85
\%\f3glBindTexture(3G)\fP,
 
86
\%\f3glGetTexParameter(3G)\fP,
 
87
\%\f3glPrioritizeTextures(3G)\fP,
 
88
\%\f3glTexImage1D(3G)\fP,
 
89
\%\f3glTexImage2D(3G)\fP,
 
90
\%\f3glTexImage3D(3G)\fP,
 
91
\%\f3glTexParameter(3G)\fP