Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glDebugMessageInsert">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2012</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glDebugMessageInsert</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glDebugMessageInsert</refname>\r | |
17 | <refpurpose>inject an application-supplied message into the debug message queue</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glDebugMessageInsert</function></funcdef>\r | |
23 | <paramdef>GLenum <parameter>source</parameter></paramdef>\r | |
24 | <paramdef>GLenum <parameter>type</parameter></paramdef>\r | |
25 | <paramdef>GLuint <parameter>id</parameter></paramdef>\r | |
26 | <paramdef>GLenum <parameter>severity</parameter></paramdef>\r | |
27 | <paramdef>GLsizei <parameter>length</parameter></paramdef>\r | |
28 | <paramdef>const char *<parameter>message</parameter></paramdef>\r | |
29 | </funcprototype>\r | |
30 | </funcsynopsis>\r | |
31 | </refsynopsisdiv>\r | |
32 | <refsect1 id="parameters"><title>Parameters</title>\r | |
33 | <variablelist>\r | |
34 | <varlistentry>\r | |
35 | <term><parameter>source</parameter></term>\r | |
36 | <listitem>\r | |
37 | <para>\r | |
38 | The source of the debug message to insert.\r | |
39 | </para>\r | |
40 | </listitem>\r | |
41 | </varlistentry>\r | |
42 | <varlistentry>\r | |
43 | <term><parameter>type</parameter></term>\r | |
44 | <listitem>\r | |
45 | <para>\r | |
46 | The type of the debug message insert.\r | |
47 | </para>\r | |
48 | </listitem>\r | |
49 | </varlistentry>\r | |
50 | <varlistentry>\r | |
51 | <term><parameter>id</parameter></term>\r | |
52 | <listitem>\r | |
53 | <para>\r | |
54 | The user-supplied identifier of the message to insert.\r | |
55 | </para>\r | |
56 | </listitem>\r | |
57 | </varlistentry>\r | |
58 | <varlistentry>\r | |
59 | <term><parameter>severity</parameter></term>\r | |
60 | <listitem>\r | |
61 | <para>\r | |
62 | The severity of the debug messages to insert.\r | |
63 | </para>\r | |
64 | </listitem>\r | |
65 | </varlistentry>\r | |
66 | <varlistentry>\r | |
67 | <term><parameter>length</parameter></term>\r | |
68 | <listitem>\r | |
69 | <para>\r | |
70 | The length string contained in the character array whose address is given by <parameter>message</parameter>.\r | |
71 | </para>\r | |
72 | </listitem>\r | |
73 | </varlistentry>\r | |
74 | <varlistentry>\r | |
75 | <term><parameter>message</parameter></term>\r | |
76 | <listitem>\r | |
77 | <para>\r | |
78 | The address of a character array containing the message to insert.\r | |
79 | </para>\r | |
80 | </listitem>\r | |
81 | </varlistentry>\r | |
82 | </variablelist>\r | |
83 | </refsect1>\r | |
84 | <refsect1 id="description"><title>Description</title>\r | |
85 | <para>\r | |
86 | <function>glDebugMessageInsert</function> inserts a user-supplied message into the\r | |
87 | debug output queue. <parameter>source</parameter> specifies the source that will be\r | |
88 | used to classify the message and must be <constant>GL_DEBUG_SOURCE_APPLICATION</constant>\r | |
89 | or <constant>GL_DEBUG_SOURCE_THIRD_PARTY</constant>. All other sources are reserved for\r | |
90 | use by the GL implementation. <parameter>type</parameter> indicates the type of the message\r | |
91 | to be inserted and may be one of <constant>GL_DEBUG_TYPE_ERROR</constant>, <constant>GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR</constant>,\r | |
92 | <constant>GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR</constant>, <constant>GL_DEBUG_TYPE_PORTABILITY</constant>,\r | |
c7b31271 | 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>.\r |
7faf1d71 | 94 | <parameter>severity</parameter> indicates the severity of the message and may be <constant>GL_DEBUG_SEVERITY_LOW</constant>,\r |
c7b31271 | 95 | <constant>GL_DEBUG_SEVERITY_MEDIUM</constant>, <constant>GL_DEBUG_SEVERITY_HIGH</constant> or <constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant>.\r |
7faf1d71 AW |
96 | <parameter>id</parameter> is available for application defined use and may be any value. This value\r |
97 | will be recorded and used to identify the message.\r | |
98 | </para>\r | |
99 | <para>\r | |
100 | <parameter>length</parameter> contains a count of the characters in the character array\r | |
101 | whose address is given in <parameter>message</parameter>. If <parameter>length</parameter>\r | |
102 | is negative then <parameter>message</parameter> is treated as a null-terminated string.\r | |
103 | The length of the message, whether specified explicitly or implicitly, must be less than\r | |
104 | or equal to the implementation defined constant <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.\r | |
105 | </para>\r | |
106 | </refsect1>\r | |
c7b31271 DH |
107 | <refsect1 id="notes"><title>Notes</title>\r |
108 | <para>\r | |
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>\r | |
110 | are available only if the GL version is 4.3 or higher.\r | |
111 | </para>\r | |
112 | </refsect1>\r | |
7faf1d71 AW |
113 | <refsect1 id="errors"><title>Errors</title>\r |
114 | <para>\r | |
115 | <constant>GL_INVALID_ENUM</constant> is generated if any of <parameter>source</parameter>, <parameter>type</parameter>\r | |
116 | or <parameter>severity</parameter> is not one of the accepted interface types.\r | |
117 | </para>\r | |
118 | <para>\r | |
119 | <constant>GL_INVALID_VALUE</constant> is generated if the length of the message is greater than the\r | |
120 | value of <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.\r | |
121 | </para>\r | |
122 | </refsect1>\r | |
123 | <refsect1 id="seealso"><title>See Also</title>\r | |
124 | <para>\r | |
125 | <citerefentry><refentrytitle>glDebugMessageControl</refentrytitle></citerefentry>,\r | |
126 | <citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,\r | |
127 | <citerefentry><refentrytitle>glGetDebugMessageLog</refentrytitle></citerefentry>.\r | |
128 | </para>\r | |
129 | </refsect1>\r | |
130 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
131 | <para>\r | |
132 | Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r | |
133 | This material may be distributed subject to the terms and conditions set forth in \r | |
134 | the Open Publication License, v 1.0, 8 June 1999.\r | |
135 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
136 | </para>\r | |
137 | </refsect1>\r | |
138 | </refentry>\r |