glDebugMessageControl.xhtml

    <div class="refentry" id="glDebugMessageControl">
      <div class="titlepage"></div>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glDebugMessageControl — control the reporting of debug messages in a debug context</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glDebugMessageControl</strong>(</code>
              </td>
              <td>GLenum <var class="pdparam">source</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum <var class="pdparam">type</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLenum <var class="pdparam">severity</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei <var class="pdparam">count</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>const GLuint *<var class="pdparam">ids</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLboolean <var class="pdparam">enabled</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>source</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The source of debug messages to enable or disable.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>type</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The type of debug messages to enable or disable.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>severity</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The severity of debug messages to enable or disable.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>count</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The length of the array <em class="parameter"><code>ids</code></em>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>ids</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    The address of an array of unsigned integers contianing the ids of the messages to enable or disable.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>enabled</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    A Boolean flag determining whether the selected messages should be enabled or disabled.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">glDebugMessageControl</code> controls the reporting of debug messages generated by a debug
            context. The parameters <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em> and <em class="parameter"><code>severity</code></em>
            form a filter to select messages from the pool of potential messages generated by the GL.
        </p>
        <p>
            <em class="parameter"><code>source</code></em> may be <code class="constant">GL_DEBUG_SOURCE_API</code>, <code class="constant">GL_DEBUG_SOURCE_WINDOW_SYSTEM</code>,
            <code class="constant">GL_DEBUG_SOURCE_SHADER_COMPILER</code>, <code class="constant">GL_DEBUG_SOURCE_THIRD_PARTY</code>,
            <code class="constant">GL_DEBUG_SOURCE_APPLICATION</code>, <code class="constant">GL_DEBUG_SOURCE_OTHER</code> to select messages generated by
            usage of the GL API, the window system, the shader compiler, third party tools or libraries, explicitly by the application
            or by some other source, respectively. It may also take the value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>source</code></em>
            is not <code class="constant">GL_DONT_CARE</code> then only messages whose source matches <em class="parameter"><code>source</code></em> will be referenced.
        </p>
        <p>
            <em class="parameter"><code>type</code></em> may be one of <code class="constant">GL_DEBUG_TYPE_ERROR</code>, <code class="constant">GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR</code>,
            <code class="constant">GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR</code>, <code class="constant">GL_DEBUG_TYPE_PORTABILITY</code>,
            <code class="constant">GL_DEBUG_TYPE_PERFORMANCE</code>, <code class="constant">GL_DEBUG_TYPE_MARKER</code>, <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>,
            <code class="constant">GL_DEBUG_TYPE_POP_GROUP</code>, or <code class="constant">GL_DEBUG_TYPE_OTHER</code> to indicate the type of messages describing
            GL errors, attempted use of deprecated features, triggering of undefined behavior, portability issues, performance notifications, markers,
            group push and pop events, and other
            types of messages, respectively. It may also take the value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>type</code></em> is not <code class="constant">GL_DONT_CARE</code>
            then only messages whose type matches <em class="parameter"><code>type</code></em> will be referenced.
        </p>
        <p>
            <em class="parameter"><code>severity</code></em> may be one of <code class="constant">GL_DEBUG_SEVERITY_LOW</code>, <code class="constant">GL_DEBUG_SEVERITY_MEDIUM</code>,
            or <code class="constant">GL_DEBUG_SEVERITY_HIGH</code> to select messages of low, medium or high severity messages or to
            <code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code> for notifications. It may also take the
            value <code class="constant">GL_DONT_CARE</code>. If <em class="parameter"><code>severity</code></em> is not <code class="constant">GL_DONT_CARE</code> then only
            messages whose severity matches <em class="parameter"><code>severity</code></em> will be referenced.
        </p>
        <p>
            <em class="parameter"><code>ids</code></em> contains a list of <em class="parameter"><code>count</code></em> message identifiers to select specific messages from the pool
            of available messages. If <em class="parameter"><code>count</code></em> is zero then the value of <em class="parameter"><code>ids</code></em> is ignored. Otherwise,
            only messages appearing in this list are selected. In this case, <em class="parameter"><code>source</code></em> and <em class="parameter"><code>type</code></em>
            may not be <code class="constant">GL_DONT_CARE</code> and <em class="parameter"><code>severity</code></em> must be <code class="constant">GL_DONT_CARE</code>.
        </p>
        <p>
            If <em class="parameter"><code>enabled</code></em> is <code class="constant">GL_TRUE</code> then messages that match the filter formed by
            <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em>, <em class="parameter"><code>severity</code></em> and <em class="parameter"><code>ids</code></em>
            are enabled. Otherwise, those messages are disabled.
        </p>
      </div>
      <div class="refsect1" id="notes">
        <h2>Notes</h2>
        <p>
            Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially
            inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context
            may produce no messages at all.
        </p>
        <p>
            <code class="constant">GL_DEBUG_TYPE_MARKER</code>, <code class="constant">GL_DEBUG_TYPE_PUSH_GROUP</code>, <code class="constant">GL_DEBUG_TYPE_POP_GROUP</code>, and <code class="constant">GL_DEBUG_SEVERITY_NOTIFICATION</code>
            are available only if the GL version is 4.3 or higher.
        </p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p>
            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>count</code></em> is negative.
        </p>
        <p>
            <code class="constant">GL_INVALID_ENUM</code> is generated if any of <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em>
            or <em class="parameter"><code>severity</code></em> is not one of the accepted interface types.
        </p>
        <p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>count</code></em> is non-zero
            and either <em class="parameter"><code>source</code></em> or <em class="parameter"><code>type</code></em> is <code class="constant">GL_DONT_CARE</code>
            or if <em class="parameter"><code>severity</code></em> is not <code class="constant">GL_DONT_CARE</code>.
        </p>
      </div>
      {$pipelinestall}{$examples}
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">

            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
                <span class="bold"><strong>OpenGL Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function / Feature Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.2</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.3</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.0</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.1</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.2</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.3</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.4</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.5</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">
                  <code class="function">glDebugMessageControl</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="glDebugMessageInsert"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>,
            <a class="citerefentry" href="glDebugMessageCallback"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>,
            <a class="citerefentry" href="glGetDebugMessageLog"><span class="citerefentry"><span class="refentrytitle">glGetDebugMessageLog</span></span></a>.
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright © 2013-2014 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 class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>