<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>gl_ClipDistance - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gl_ClipDistance"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gl_ClipDistance — provides a forward-compatible mechanism for vertex clipping</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><p>
            <code class="function">gl_ClipDistance</code> is a member of the <code class="function">gl_PerVertex</code>
            named block:
        </p><div class="funcsynopsis"><pre class="programlisting">    out gl_PerVertex {
        vec4 gl_Position;
        float gl_PointSize;
        float gl_ClipDistance[];
    };</pre></div><p>
            In the fragment language, it is intrinsically declared as:
        </p><div class="funcsynopsis"><code class="function">in float gl_ClipDistance[];</code></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
            The <code class="function">gl_ClipDistance</code> variable provides a forward compatible
            mechanism for controlling user clipping. The element <code class="function">gl_ClipDistance[<span class="emphasis"><em>i</em></span>]</code>
            specifies a clip distance for each user clip plane <span class="emphasis"><em>i</em></span>. A distance of 0.0 means that
            the vertex is on the plane, a positive distance means that the vertex is insider the clip plane, and a negative
            distance means that the point is outside the clip plane. The clip distances will be linearly interpolated across
            the primitive and the portion of the primitive with interpolated distances less than 0.0 will be clipped.
        </p><p>
            The <code class="function">gl_ClipDistance</code> array is initially predeclared as unsized and must be
            sized by the shader either by redeclaring it with an explicit size, or by indexing it
            with only integral constant expressions. The array must be sized to include all
            clip planes that are enabled via the OpenGL API; if the size does not include all enabled planes,
            results are undefined. The size may be at most <code class="function">gl_MaxClipDistances</code>. The number
            of variing components consumed by <code class="function">gl_ClipDistance</code> will match the size of the
            array, no matter how many planes are enabled. The shader must also set all values in <code class="function">gl_ClipDistance</code>
            that have been enabled via the OpenGL API, or results are undefined. Values written into
            <code class="function">gl_ClipDistance</code> planes that are not enabled have no effect.
        </p><p>
            In the vertex, tessellation evaluation and geoemtry languages, a single
            global instance of the <code class="function">gl_PerVertex</code> named block is available and
            its <code class="function">gl_ClipDistance</code> member is an output that receives the
            clip distances for the current vertex. It may be written at any time during shader execution.
            The value written to <code class="function">gl_ClipDistance</code> will be used by primitive assembly,
            clipping, culling and other fixed functionality operations, if present, that operate on
            primitives after vertex processing has occurred.
        </p><p>
            In the tessellation control language, the <code class="function">gl_PerVertex</code> named block
            is used to construct an array, <code class="function">gl_out[]</code>, whose <code class="function">gl_ClipDistance</code>
            members hold clip distances for each of the control points, which become available as inputs to the subsequent
            tessellation evaluation shader.
        </p><p>
            The value of <code class="function">gl_ClipDistance</code> (or the <code class="function">gl_ClipDistance</code> member of the <code class="function">gl_out[]</code>
            array, in the case of the tessellation control shader)
            is undefined after the vertex, tessellation control, and tessellation evaluation
            shading stages if the corresponding shader executable does
            not write to gl_ClipDistance. It is also undefined after the geometry processing stage if the geometry shader executable calls
            <a href="EmitVertex.xml"><span class="citerefentry"><span class="refentrytitle">EmitVertex</span></span></a> without having
            written <code class="function">gl_ClipDistance</code> since the last call to <a href="EmitVertex.xml"><span class="citerefentry"><span class="refentrytitle">EmitVertex</span></span></a>
            (or hasn't written it at all).
        </p><p>
            In the tessellation control, tessellation evaluation and geoemetry languages,
            the <code class="function">gl_PerVertex</code> named block is used to construct an array, <code class="function">gl_in[]</code>
            of per-vertex or per-control point inputs whose content represents the corresponding
            outputs written by the previous stage. Only elements of the <code class="function">gl_ClipDistance</code>
            array that correspond to enabled clip planes have defined values.
         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Variable</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">gl_ClipDistance</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div><p>Versions 1.30 to 1.40 - vertex shader only.</p><p>Versions 1.50 to 3.30 - vertex and geometry shaders only.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
            <a href="gl_PointSize.xml"><span class="citerefentry"><span class="refentrytitle">gl_PointSize</span></span></a>
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2011 Khronos Group. 
            This material may be distributed subject to the terms and conditions set forth in 
            the Open Publication License, v 1.0, 8 June 1999.
            <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p></div></div></body></html>
