rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / gl_FragCoord.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="gl_FragCoord">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>gl_FragCoord</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>gl_FragCoord</refname>\r
        <refpurpose>contains the window-relative coordinates of the current fragment</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <function>in vec4 gl_FragCoord;</function>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            Available only in the fragment language, <function>gl_FragCoord</function> is an input variable that contains the\r
            window relative coordinate (x, y, z, 1/w) values for the fragment. If multi-sampling,\r
            this value can be for any location within the pixel, or one of the fragment samples.\r
            This value is the result of fixed functionality that interpolates primitives after vertex\r
            processing to generate fragments. The z component is the depth value that would be used for the\r
            fragment's depth if no shader contained any writes to <citerefentry><refentrytitle>gl_FragDepth</refentrytitle></citerefentry>.\r
        </para>\r
        <para>\r
            <function>gl_FragCoord</function> may be redeclared with the additional layout qualifier identifiers\r
            <function>origin_upper_left</function> or <function>pixel_center_integer</function>. By\r
            default, <function>gl_FragCoord</function> assumes a lower-left origin for window coordinates\r
            and assumes pixel centers are located at half-pixel centers. For example, the (x, y) location\r
            (0.5, 0.5) is returned for the lower-left-most pixel in a window. The origin of\r
            <function>gl_FragCoord</function> may be changed by redeclaring <function>gl_FragCoord</function>\r
            with the <function>origin_upper_left</function> identifier. The values returned can also be\r
            shifted by half a pixel in both x and y by <function>pixel_center_integer</function> so it\r
            appears the pixels are centered at whole number pixel offsets. This moves the (x, y) value returned by\r
            <function>gl_FragCoord</function> of (0.5, 0.5) by default to (0.0, 0.0) with\r
            <function>pixel_center_integer</function>.\r
        </para>\r
        <para>\r
            If <function>gl_FragCoord</function> is redeclared in any fragment shader in a program, it must be redeclared\r
            in all fragment shaders in that program that have static use of <function>gl_FragCoord</function>. Redeclaring\r
            <function>gl_FragCoord</function> with any accepted qualifier affects only <function>gl_FragCoord.x</function>\r
            and <function>gl_FragCoord.y</function>. It has no affect on rasterization, transformation or any other part\r
            of the OpenGL pipline or language features.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            #VARTABLECOLS#\r
                <thead>\r
                    #VARTABLEHEADER#\r
                    <row>\r
                        <entry>gl_ClipDistance</entry>#newin11#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>gl_FragCoord</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