<?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>glDebugMessageInsert - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glDebugMessageInsert"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDebugMessageInsert — inject an application-supplied message into the debug message queue</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDebugMessageInsert</b>(</code></td><td>GLenum  </td><td><var class="pdparam">source</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">severity</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>const char * </td><td><var class="pdparam">message</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>source</code></em></span></dt><dd><p>
                    The source of the debug message to insert.
                </p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
                    The type of the debug message insert.
                </p></dd><dt><span class="term"><em class="parameter"><code>id</code></em></span></dt><dd><p>
                    The user-supplied identifier of the message to insert.
                </p></dd><dt><span class="term"><em class="parameter"><code>severity</code></em></span></dt><dd><p>
                    The severity of the debug messages to insert.
                </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
                    The length string contained in the character array whose address is given by <em class="parameter"><code>message</code></em>.
                </p></dd><dt><span class="term"><em class="parameter"><code>message</code></em></span></dt><dd><p>
                    The address of a character array containing the message to insert.
                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
            <code class="function">glDebugMessageInsert</code> inserts a user-supplied message into the
            debug output queue. <em class="parameter"><code>source</code></em> specifies the source that will be
            used to classify the message and must be <code class="constant">GL_DEBUG_SOURCE_APPLICATION</code>
            or <code class="constant">GL_DEBUG_SOURCE_THIRD_PARTY</code>. All other sources are reserved for
            use by the GL implementation. <em class="parameter"><code>type</code></em> indicates the type of the message
            to be inserted and 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>, or <code class="constant">GL_DEBUG_TYPE_OTHER</code>.
            <em class="parameter"><code>severity</code></em> indicates the severity of the message and may be <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>.
            <em class="parameter"><code>id</code></em> is available for application defined use and may be any value. This value
            will be recorded and used to identify the message.
        </p><p>
            <em class="parameter"><code>length</code></em> contains a count of the characters in the character array
            whose address is given in <em class="parameter"><code>message</code></em>. If <em class="parameter"><code>length</code></em>
            is negative then <em class="parameter"><code>message</code></em> is treated as a null-terminated string.
            The length of the message, whether specified explicitly or implicitly, must be less than
            or equal to the implementation defined constant <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><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_VALUE</code> is generated if the length of the message is greater than the
            value of <code class="constant">GL_MAX_DEBUG_MESSAGE_LENGTH</code>.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
            <a href="glDebugMessageControl.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageControl</span></span></a>,
            <a href="glDebugMessageCallback.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageCallback</span></span></a>,
            <a href="glGetDebugMessageLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetDebugMessageLog</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>© 2012 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>
