glAreTexturesResident(3gl)

1GLARETEXTURESRESIDENT(3G)                            GLARETEXTURESRESIDENT(3G)
2
3
4

NAME

6       glAreTexturesResident  -  determine  if  textures are loaded in texture
7       memory
8
9

C SPECIFICATION

11       GLboolean glAreTexturesResident( GLsizei n,
12                                        const GLuint *textures,
13                                        GLboolean *residences )
14
15

PARAMETERS

17       n           Specifies the number of textures to be queried.
18
19       textures    Specifies an array containing the names of the textures  to
20                   be queried.
21
22       residences  Specifies an array in which the texture residence status is
23                   returned.  The residence status of a texture  named  by  an
24                   element  of  textures is returned in the corresponding ele‐
25                   ment of residences.
26

DESCRIPTION

28       GL establishes a ``working set'' of textures that are resident in  tex‐
29       ture memory.  These textures can be bound to a texture target much more
30       efficiently than textures that are not resident.
31
32       glAreTexturesResident queries the texture residence  status  of  the  n
33       textures  named by the elements of textures.  If all the named textures
34       are resident, glAreTexturesResident returns GL_TRUE, and  the  contents
35       of residences are undisturbed.  If not all the named textures are resi‐
36       dent, glAreTexturesResident returns GL_FALSE, and  detailed  status  is
37       returned  in the n elements of residences.  If an element of residences
38       is GL_TRUE, then the texture named by the corresponding element of tex‐
39       tures is resident.
40
41       The  residence  status of a single bound texture may also be queried by
42       calling glGetTexParameter with the target argument set to the target to
43       which   the   texture   is   bound,  and  the  pname  argument  set  to
44       GL_TEXTURE_RESIDENT.  This is the only way that the residence status of
45       a default texture can be queried.
46

NOTES

48       glAreTexturesResident  is  available  only  if the GL version is 1.1 or
49       greater.
50
51       glAreTexturesResident returns the residency status of the  textures  at
52       the  time  of  invocation. It does not guarantee that the textures will
53       remain resident at any other time.
54
55       If textures reside in virtual memory (there is no texture memory), they
56       are considered always resident.
57
58       Some implementations may not load a texture until the first use of that
59       texture.
60

ERRORS

62       GL_INVALID_VALUE is generated if n is negative.
63
64       GL_INVALID_VALUE is generated if any element in textures is 0  or  does
65       not name a texture. In that case, the function returns GL_FALSE and the
66       contents of residences is indeterminate.
67
68       GL_INVALID_OPERATION is generated if glAreTexturesResident is  executed
69       between  the  execution  of  glBegin and the corresponding execution of
70       glEnd.
71

ASSOCIATED GETS

73       glGetTexParameter with parameter name GL_TEXTURE_RESIDENT retrieves the
74       residence status of a currently bound texture.
75