upstream-man-pages/man4/glDebugMessageInsert.xml

   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">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glDebugMessageInsert</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glDebugMessageInsert</refname>
  17         <refpurpose>inject an application-supplied message into the debug message queue</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  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>
  29             </funcprototype>
  30         </funcsynopsis>
  31     </refsynopsisdiv>
  32     <refsect1 id="parameters"><title>Parameters</title>
  33         <variablelist>
  34         <varlistentry>
  35             <term><parameter>source</parameter></term>
  36             <listitem>
  37                 <para>
  38                     The source of the debug message to insert.
  39                 </para>
  40             </listitem>
  41         </varlistentry>
  42         <varlistentry>
  43             <term><parameter>type</parameter></term>
  44             <listitem>
  45                 <para>
  46                     The type of the debug message insert.
  47                 </para>
  48             </listitem>
  49         </varlistentry>
  50         <varlistentry>
  51             <term><parameter>id</parameter></term>
  52             <listitem>
  53                 <para>
  54                     The user-supplied identifier of the message to insert.
  55                 </para>
  56             </listitem>
  57         </varlistentry>
  58         <varlistentry>
  59             <term><parameter>severity</parameter></term>
  60             <listitem>
  61                 <para>
  62                     The severity of the debug messages to insert.
  63                 </para>
  64             </listitem>
  65         </varlistentry>
  66         <varlistentry>
  67             <term><parameter>length</parameter></term>
  68             <listitem>
  69                 <para>
  70                     The length string contained in the character array whose address is given by <parameter>message</parameter>.
  71                 </para>
  72             </listitem>
  73         </varlistentry>
  74         <varlistentry>
  75             <term><parameter>message</parameter></term>
  76             <listitem>
  77                 <para>
  78                     The address of a character array containing the message to insert.
  79                 </para>
  80             </listitem>
  81         </varlistentry>
  82         </variablelist>
  83     </refsect1>
  84     <refsect1 id="description"><title>Description</title>
  85         <para>
  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>, 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>, or <constant>GL_DEBUG_SEVERITY_HIGH</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.
  98         </para>
  99         <para>
 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>.
 105         </para>
 106     </refsect1>
 107     <refsect1 id="errors"><title>Errors</title>
 108         <para>
 109             <constant>GL_INVALID_ENUM</constant> is generated if any of <parameter>source</parameter>, <parameter>type</parameter>
 110             or <parameter>severity</parameter> is not one of the accepted interface types.
 111         </para>
 112         <para>
 113             <constant>GL_INVALID_VALUE</constant> is generated if the length of the message is greater than the
 114             value of <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>.
 115         </para>
 116     </refsect1>
 117     <refsect1 id="seealso"><title>See Also</title>
 118         <para>
 119             <citerefentry><refentrytitle>glDebugMessageControl</refentrytitle></citerefentry>,
 120             <citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,
 121             <citerefentry><refentrytitle>glGetDebugMessageLog</refentrytitle></citerefentry>.
 122         </para>
 123     </refsect1>
 124     <refsect1 id="Copyright"><title>Copyright</title>
 125         <para>
 126             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 127             This material may be distributed subject to the terms and conditions set forth in
 128             the Open Publication License, v 1.0, 8 June 1999.
 129             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 130         </para>
 131     </refsect1>
 132 </refentry>