1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
xmlns="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glAreTexturesResident</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glAlphaFunc.3G.xml" title="glAlphaFunc"/><link rel="next" href="glArrayElement.3G.xml" title="glArrayElement"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glAreTexturesResident</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glAlphaFunc.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glArrayElement.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glAreTexturesResident.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glAreTexturesResident.3G-name"/><h2>Name</h2><p>glAreTexturesResident — determine if textures are loaded in texture memory</p></div><div class="refsynopsisdiv"><a name="glAreTexturesResident.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>GLboolean<tt>glAreTexturesResident</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLsizei<i><tt>n</tt></i>, constGLuint*<i><tt>textures</tt></i>, GLboolean*<i><tt>residences</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glAreTexturesResident.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glAreTexturesResident</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>textures</tt></i>[]) →<i><tt>residences</tt></i>[]</code></td></tr></table></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>n</tt></i></span></dt><dd>
Specifies the number of textures to be queried.
</dd><dt><span class="term"><i><tt>textures</tt></i></span></dt><dd>
Specifies an array containing the names of the textures to be queried.
</dd><dt><span class="term"><i><tt>residences</tt></i></span></dt><dd>
Specifies an array in which the texture residence status is returned. The residence status of a texture
named by an element of <i><tt>textures</tt></i> is returned in the corresponding element of
<i><tt>residences</tt></i>.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-description"/><h2>Description</h2><p>
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.
</p><p>
<tt>glAreTexturesResident</tt> queries the texture residence status of the <i><tt>n</tt></i>
textures named by the elements of <i><tt>textures</tt></i>. If all the named textures are resident,
<tt>glAreTexturesResident</tt> returns <tt>GL_TRUE</tt>, and the contents of
<i><tt>residences</tt></i> are undisturbed. If not all the named textures are resident,
<tt>glAreTexturesResident</tt> returns <tt>GL_FALSE</tt>, and detailed status is returned in
the <i><tt>n</tt></i> elements of <i><tt>residences</tt></i>. If an element of
<i><tt>residences</tt></i> is <tt>GL_TRUE</tt>, then the texture named by the corresponding element
of <i><tt>textures</tt></i> is resident.
</p><p>
The residence status of a single bound texture may also be queried by calling <tt>glGetTexParameter</tt> with the <i><tt>target</tt></i> argument set to the target to
which the texture is bound, and the <i><tt>pname</tt></i> argument set to
<tt>GL_TEXTURE_RESIDENT</tt>. This is the only way that the residence status of a default texture can be
queried.
</p></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-notes"/><h2>Notes</h2><p>
<tt>glAreTexturesResident</tt> is available only if the GL version is 1.1 or greater.
</p><p>
<tt>glAreTexturesResident</tt> returns the residency status of the textures at the time of invocation. It
does not guarantee that the textures will remain resident at any other time.
</p><p>
If textures reside in virtual memory (there is no texture memory), they are considered always resident.
</p><p>
Some implementations may not load a texture until the first use of that texture.
</p></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-errors"/><h2>Errors</h2><p>
<tt>GL_INVALID_VALUE</tt> is generated if <i><tt>n</tt></i> is negative.
</p><p>
<tt>GL_INVALID_VALUE</tt> is generated if any element in <i><tt>textures</tt></i> is 0 or does not
name a texture. In that case, the function returns <tt>GL_FALSE</tt> and the contents of
<i><tt>residences</tt></i> is indeterminate.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glAreTexturesResident</tt> is executed
between the execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
</p></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-associated_gets"/><h2>Associated Gets</h2><p>
<tt>glGetTexParameter</tt> with parameter name <tt>GL_TEXTURE_RESIDENT</tt>
retrieves the residence status of a currently bound texture.
</p></div><div class="refsect1" lang="en"><a name="glAreTexturesResident.3G-see_also"/><h2>See Also</h2><p>
<span class="simplelist"><a href="glBindTexture.3G.xml">glBindTexture</a>, <a href="glGetTexParameter.3G.xml">glGetTexParameter</a>, <a href="glPrioritizeTextures.3G.xml">glPrioritizeTextures</a>, <a href="glTexImage1D.3G.xml">glTexImage1D</a>, <a href="glTexImage2D.3G.xml">glTexImage2D</a>, <a href="glTexImage3D.3G.xml">glTexImage3D</a>, <a href="glTexParameter.3G.xml">glTexParameter</a></span>
</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glAlphaFunc.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glArrayElement.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glAlphaFunc</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glArrayElement</td></tr></table></div></body></html>
|
