[clinton/guile-figl.git] / upstream-doc / manglsl / textureQueryLod.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="textureQueryLod">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>textureQueryLod</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>textureQueryLod</refname>\r
        <refpurpose>compute the level-of-detail that would be used to sample from a texture</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
                <paramdef>float <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec2 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsamplerCube <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
                <paramdef>float <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler2DDArray <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec2 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsamplerCubeArray <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler1DShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>float <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler2DShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec2 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsamplerCubeShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler1DArrayShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>float <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsampler2DArrayShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec2 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
                <paramdef>gsamplerCubeArrayShadow <parameter>sampler</parameter></paramdef>\r
                <paramdef>vec3 <parameter>P</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>sampler</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the sampler to which the texture whose level-of-detail will be queried is bound.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>P</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the texture coordinates at which the level-of-detail will be queried.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <emphasis>Available only in the fragment shader</emphasis>,\r
            <function>textureQueryLod</function> computes the level-of-detail that would be used to sample from\r
            a texture. The mipmap array(s) that would be accessed is returned in the <emphasis>x</emphasis> component\r
            of the return value. The computed level-of-detail relative to the base level is returned in the\r
            <emphasis>y</emphasis> component of the return value.\r
        </para>\r
        <para>\r
            If called on an incomplete texture, the result of the operation is undefined.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            #VARTABLECOLS#\r
                <thead>\r
                    #FUNCTABLEHEADER#\r
                    <row>\r
                        <entry>textureQueryLod</entry>#newin40#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>\r
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
	4	<refentry id="textureQueryLod">\r
	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2011</year>\r
	9	<holder>Khronos Group</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>textureQueryLod</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>textureQueryLod</refname>\r
	17	<refpurpose>compute the level-of-detail that would be used to sample from a texture</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>Declaration</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	23	<paramdef>gsampler1D <parameter>sampler</parameter></paramdef>\r
	24	<paramdef>float <parameter>P</parameter></paramdef>\r
	25	</funcprototype>\r
	26	<funcprototype>\r
	27	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	28	<paramdef>gsampler2D <parameter>sampler</parameter></paramdef>\r
	29	<paramdef>vec2 <parameter>P</parameter></paramdef>\r
	30	</funcprototype>\r
	31	<funcprototype>\r
	32	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	33	<paramdef>gsampler3D <parameter>sampler</parameter></paramdef>\r
	34	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
	35	</funcprototype>\r
	36	<funcprototype>\r
	37	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	38	<paramdef>gsamplerCube <parameter>sampler</parameter></paramdef>\r
	39	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
	40	</funcprototype>\r
	41	<funcprototype>\r
	42	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	43	<paramdef>gsampler1DArray <parameter>sampler</parameter></paramdef>\r
	44	<paramdef>float <parameter>P</parameter></paramdef>\r
	45	</funcprototype>\r
	46	<funcprototype>\r
	47	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	48	<paramdef>gsampler2DDArray <parameter>sampler</parameter></paramdef>\r
	49	<paramdef>vec2 <parameter>P</parameter></paramdef>\r
	50	</funcprototype>\r
	51	<funcprototype>\r
	52	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	53	<paramdef>gsamplerCubeArray <parameter>sampler</parameter></paramdef>\r
	54	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
	55	</funcprototype>\r
	56	<funcprototype>\r
	57	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	58	<paramdef>gsampler1DShadow <parameter>sampler</parameter></paramdef>\r
	59	<paramdef>float <parameter>P</parameter></paramdef>\r
	60	</funcprototype>\r
	61	<funcprototype>\r
	62	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
	63	<paramdef>gsampler2DShadow <parameter>sampler</parameter></paramdef>\r
	64	<paramdef>vec2 <parameter>P</parameter></paramdef>\r
65	</funcprototype>\r
66	<funcprototype>\r
67	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
68	<paramdef>gsamplerCubeShadow <parameter>sampler</parameter></paramdef>\r
69	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
70	</funcprototype>\r
71	<funcprototype>\r
72	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
73	<paramdef>gsampler1DArrayShadow <parameter>sampler</parameter></paramdef>\r
74	<paramdef>float <parameter>P</parameter></paramdef>\r
75	</funcprototype>\r
76	<funcprototype>\r
77	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
78	<paramdef>gsampler2DArrayShadow <parameter>sampler</parameter></paramdef>\r
79	<paramdef>vec2 <parameter>P</parameter></paramdef>\r
80	</funcprototype>\r
81	<funcprototype>\r
82	<funcdef>vec2 <function>textureQueryLod</function></funcdef>\r
83	<paramdef>gsamplerCubeArrayShadow <parameter>sampler</parameter></paramdef>\r
84	<paramdef>vec3 <parameter>P</parameter></paramdef>\r
85	</funcprototype>\r
86	</funcsynopsis>\r
87	</refsynopsisdiv>\r
88	<refsect1 id="parameters"><title>Parameters</title>\r
89	<variablelist>\r
90	<varlistentry>\r
91	<term><parameter>sampler</parameter></term>\r
92	<listitem>\r
93	<para>\r
94	Specifies the sampler to which the texture whose level-of-detail will be queried is bound.\r
95	</para>\r
96	</listitem>\r
97	</varlistentry>\r
98	<varlistentry>\r
99	<term><parameter>P</parameter></term>\r
100	<listitem>\r
101	<para>\r
102	Specifies the texture coordinates at which the level-of-detail will be queried.\r
103	</para>\r
104	</listitem>\r
105	</varlistentry>\r
106	</variablelist>\r
107	</refsect1>\r
108	<refsect1 id="description"><title>Description</title>\r
109	<para>\r
110	<emphasis>Available only in the fragment shader</emphasis>,\r
111	<function>textureQueryLod</function> computes the level-of-detail that would be used to sample from\r
112	a texture. The mipmap array(s) that would be accessed is returned in the <emphasis>x</emphasis> component\r
113	of the return value. The computed level-of-detail relative to the base level is returned in the\r
114	<emphasis>y</emphasis> component of the return value.\r
115	</para>\r
116	<para>\r
117	If called on an incomplete texture, the result of the operation is undefined.\r
118	</para>\r
119	</refsect1>\r
120	<refsect1 id="versions"><title>Version Support</title>\r
121	<informaltable frame="topbot">\r
122	#VARTABLECOLS#\r
123	<thead>\r
124	#FUNCTABLEHEADER#\r
125	<row>\r
126	<entry>textureQueryLod</entry>#newin40#\r
127	</row>\r
128	</thead>\r
129	</tgroup>\r
130	</informaltable>\r
131	</refsect1>\r
132	<refsect1 id="seealso"><title>See Also</title>\r
133	<para>\r
134	<citerefentry><refentrytitle>texelFetch</refentrytitle></citerefentry>,\r
135	<citerefentry><refentrytitle>texelFetchOffset</refentrytitle></citerefentry>,\r
136	<citerefentry><refentrytitle>texture</refentrytitle></citerefentry>,\r
137	<citerefentry><refentrytitle>textureGather</refentrytitle></citerefentry>,\r
138	<citerefentry><refentrytitle>textureGatherOffset</refentrytitle></citerefentry>,\r
139	<citerefentry><refentrytitle>textureGatherOffsets</refentrytitle></citerefentry>,\r
140	<citerefentry><refentrytitle>textureGrad</refentrytitle></citerefentry>,\r
141	<citerefentry><refentrytitle>textureGradOffset</refentrytitle></citerefentry>,\r
142	<citerefentry><refentrytitle>textureLod</refentrytitle></citerefentry>,\r
143	<citerefentry><refentrytitle>textureLodOffset</refentrytitle></citerefentry>,\r
144	<citerefentry><refentrytitle>textureOffset</refentrytitle></citerefentry>,\r
145	<citerefentry><refentrytitle>textureProj</refentrytitle></citerefentry>,\r
146	<citerefentry><refentrytitle>textureProjGrad</refentrytitle></citerefentry>,\r
147	<citerefentry><refentrytitle>textureProjGradOffset</refentrytitle></citerefentry>,\r
148	<citerefentry><refentrytitle>textureProjLod</refentrytitle></citerefentry>,\r
149	<citerefentry><refentrytitle>textureProjLodOffset</refentrytitle></citerefentry>,\r
150	<citerefentry><refentrytitle>textureProjOffset</refentrytitle></citerefentry>,\r
151	<citerefentry><refentrytitle>textureSize</refentrytitle></citerefentry>\r
152	</para>\r
153	</refsect1>\r
154	<refsect1 id="Copyright"><title>Copyright</title>\r
155	<para>\r
156	Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
157	This material may be distributed subject to the terms and conditions set forth in \r
158	the Open Publication License, v 1.0, 8 June 1999.\r
159	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
160	</para>\r
161	</refsect1>\r
162	</refentry>\r