1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE book PUBLIC
"-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4 <refentry id=
"glDebugMessageInsert">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>glDebugMessageInsert
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glDebugMessageInsert
</refname>
17 <refpurpose>inject an application-supplied message into the debug message queue
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glDebugMessageInsert
</function></funcdef>
23 <paramdef>GLenum
<parameter>source
</parameter></paramdef>
24 <paramdef>GLenum
<parameter>type
</parameter></paramdef>
25 <paramdef>GLuint
<parameter>id
</parameter></paramdef>
26 <paramdef>GLenum
<parameter>severity
</parameter></paramdef>
27 <paramdef>GLsizei
<parameter>length
</parameter></paramdef>
28 <paramdef>const char *
<parameter>message
</parameter></paramdef>
32 <refsect1 id=
"parameters"><title>Parameters
</title>
35 <term><parameter>source
</parameter></term>
38 The source of the debug message to insert.
43 <term><parameter>type
</parameter></term>
46 The type of the debug message insert.
51 <term><parameter>id
</parameter></term>
54 The user-supplied identifier of the message to insert.
59 <term><parameter>severity
</parameter></term>
62 The severity of the debug messages to insert.
67 <term><parameter>length
</parameter></term>
70 The length string contained in the character array whose address is given by
<parameter>message
</parameter>.
75 <term><parameter>message
</parameter></term>
78 The address of a character array containing the message to insert.
84 <refsect1 id=
"description"><title>Description
</title>
86 <function>glDebugMessageInsert
</function> inserts a user-supplied message into the
87 debug output queue.
<parameter>source
</parameter> specifies the source that will be
88 used to classify the message and must be
<constant>GL_DEBUG_SOURCE_APPLICATION
</constant>
89 or
<constant>GL_DEBUG_SOURCE_THIRD_PARTY
</constant>. All other sources are reserved for
90 use by the GL implementation.
<parameter>type
</parameter> indicates the type of the message
91 to be inserted and may be one of
<constant>GL_DEBUG_TYPE_ERROR
</constant>,
<constant>GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR
</constant>,
92 <constant>GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR
</constant>,
<constant>GL_DEBUG_TYPE_PORTABILITY
</constant>,
93 <constant>GL_DEBUG_TYPE_PERFORMANCE
</constant>,
<constant>GL_DEBUG_TYPE_MARKER
</constant>,
<constant>GL_DEBUG_TYPE_PUSH_GROUP
</constant>,
<constant>GL_DEBUG_TYPE_POP_GROUP
</constant>, or
<constant>GL_DEBUG_TYPE_OTHER
</constant>.
94 <parameter>severity
</parameter> indicates the severity of the message and may be
<constant>GL_DEBUG_SEVERITY_LOW
</constant>,
95 <constant>GL_DEBUG_SEVERITY_MEDIUM
</constant>,
<constant>GL_DEBUG_SEVERITY_HIGH
</constant> or
<constant>GL_DEBUG_SEVERITY_NOTIFICATION
</constant>.
96 <parameter>id
</parameter> is available for application defined use and may be any value. This value
97 will be recorded and used to identify the message.
100 <parameter>length
</parameter> contains a count of the characters in the character array
101 whose address is given in
<parameter>message
</parameter>. If
<parameter>length
</parameter>
102 is negative then
<parameter>message
</parameter> is treated as a null-terminated string.
103 The length of the message, whether specified explicitly or implicitly, must be less than
104 or equal to the implementation defined constant
<constant>GL_MAX_DEBUG_MESSAGE_LENGTH
</constant>.
107 <refsect1 id=
"notes"><title>Notes
</title>
109 <constant>GL_DEBUG_TYPE_MARKER
</constant>,
<constant>GL_DEBUG_TYPE_PUSH_GROUP
</constant>,
<constant>GL_DEBUG_TYPE_POP_GROUP
</constant>, and
<constant>GL_DEBUG_SEVERITY_NOTIFICATION
</constant>
110 are available only if the GL version is
4.3 or higher.
113 <refsect1 id=
"errors"><title>Errors
</title>
115 <constant>GL_INVALID_ENUM
</constant> is generated if any of
<parameter>source
</parameter>,
<parameter>type
</parameter>
116 or
<parameter>severity
</parameter> is not one of the accepted interface types.
119 <constant>GL_INVALID_VALUE
</constant> is generated if the length of the message is greater than the
120 value of
<constant>GL_MAX_DEBUG_MESSAGE_LENGTH
</constant>.
123 <refsect1 id=
"seealso"><title>See Also
</title>
125 <citerefentry><refentrytitle>glDebugMessageControl
</refentrytitle></citerefentry>,
126 <citerefentry><refentrytitle>glDebugMessageCallback
</refentrytitle></citerefentry>,
127 <citerefentry><refentrytitle>glGetDebugMessageLog
</refentrytitle></citerefentry>.
130 <refsect1 id=
"Copyright"><title>Copyright
</title>
132 Copyright
<trademark class=
"copyright"></trademark> 2012 Khronos Group.
133 This material may be distributed subject to the terms and conditions set forth in
134 the Open Publication License, v
1.0,
8 June
1999.
135 <ulink url=
"http://opencontent.org/openpub/">http://opencontent.org/openpub/
</ulink>.