MirBSD manpage: glAreTexturesResident(3)


GLARETEXTURESRESIDENTUNIX Programmer's MGLARETEXTURESRESIDENT(3G)

NAME

     glAreTexturesResident - determine if textures are loaded in
     texture memory

C SPECIFICATION

     GLboolean glAreTexturesResident( GLsizei n,
                                      const GLuint *textures,
                                      GLboolean *residences )

PARAMETERS

     n           Specifies the number of textures to be queried.

     textures    Specifies an array containing the names of the
                 textures to be queried.

     residences  Specifies an array in which the texture
                 residence status is returned. The residence
                 status of a texture named by an element of tex-
                 tures is returned in the corresponding element
                 of residences.

DESCRIPTION

     GL establishes a ``working set'' of textures that are
     resident in texture memory. These textures can be bound to a
     texture target much more efficiently than textures that are
     not resident.

     glAreTexturesResident queries the texture residence status
     of the n textures named by the elements of textures. If all
     the named textures are resident, glAreTexturesResident
     returns GL_TRUE, and the contents of residences are undis-
     turbed. If not all the named textures are resident,
     glAreTexturesResident returns GL_FALSE, and detailed status
     is returned in the n elements of residences. If an element
     of residences is GL_TRUE, then the texture named by the
     corresponding element of textures is resident.

     The residence status of a single bound texture may also be
     queried by calling glGetTexParameter with the target argu-
     ment set to the target to which the texture is bound, and
     the pname argument set to GL_TEXTURE_RESIDENT. This is the
     only way that the residence status of a default texture can
     be queried.

NOTES

     glAreTexturesResident is available only if the GL version is
     1.1 or greater.

     glAreTexturesResident returns the residency status of the
     textures at the time of invocation. It does not guarantee

MirBSD #10-current     Printed 2021-12-07                       1

GLARETEXTURESRESIDENTUNIX Programmer's MGLARETEXTURESRESIDENT(3G)

     that the textures will remain resident at any other time.

     If textures reside in virtual memory (there is no texture
     memory), they are considered always resident.

     Some implementations may not load a texture until the first
     use of that texture.

ERRORS

     GL_INVALID_VALUE is generated if n is negative.

     GL_INVALID_VALUE is generated if any element in textures is
     0 or does not name a texture. In that case, the function
     returns GL_FALSE and the contents of residences is indeter-
     minate.

     GL_INVALID_OPERATION is generated if glAreTexturesResident
     is executed between the execution of glBegin and the
     corresponding execution of glEnd.

ASSOCIATED GETS

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

SEE ALSO

     glBindTexture(3G), glGetTexParameter(3G),
     glPrioritizeTextures(3G), glTexImage1D(3G),
     glTexImage2D(3G), glTexImage3D(3G), glTexParameter(3G)

MirBSD #10-current     Printed 2021-12-07                       2

Generated on 2021-12-07 11:07:08 by $MirOS: src/scripts/roff2htm,v 1.103 2021/01/23 20:24:35 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2021 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.