mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-25 19:15:36 +00:00
168 lines
9.3 KiB
XML
168 lines
9.3 KiB
XML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
||
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
||
|
|
<refentry id="glDebugMessageControl">
|
||
|
|
<refmeta>
|
||
|
|
<refmetainfo>
|
||
|
|
<copyright>
|
||
|
|
<year>2012</year>
|
||
|
|
<holder>Khronos Group</holder>
|
||
|
|
</copyright>
|
||
|
|
</refmetainfo>
|
||
|
|
<refentrytitle>glDebugMessageControl</refentrytitle>
|
||
|
|
<manvolnum>3G</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>glDebugMessageControl</refname>
|
||
|
|
<refpurpose>control the reporting of debug messages in a debug context</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>void <function>glDebugMessageControl</function></funcdef>
|
||
|
|
<paramdef>GLenum <parameter>source</parameter></paramdef>
|
||
|
|
<paramdef>GLenum <parameter>type</parameter></paramdef>
|
||
|
|
<paramdef>GLenum <parameter>severity</parameter></paramdef>
|
||
|
|
<paramdef>GLsizei <parameter>count</parameter></paramdef>
|
||
|
|
<paramdef>const GLuint *<parameter>ids</parameter></paramdef>
|
||
|
|
<paramdef>GLboolean <parameter>enabled</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>source</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The source of debug messages to enable or disable.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>type</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The type of debug messages to enable or disable.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>severity</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The severity of debug messages to enable or disable.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>count</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The length of the array <parameter>ids</parameter>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>ids</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
The address of an array of unsigned integers contianing the ids of the messages to enable or disable.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>enabled</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
A Boolean flag determining whether the selected messages should be enabled or disabled.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="description"><title>Description</title>
|
||
|
|
<para>
|
||
|
|
<function>glDebugMessageControl</function> controls the reporting of debug messages generated by a debug
|
||
|
|
context. The parameters <parameter>source</parameter>, <parameter>type</parameter> and <parameter>severity</parameter>
|
||
|
|
form a filter to select messages from the pool of potential messages generated by the GL.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<parameter>source</parameter> may be <constant>GL_DEBUG_SOURCE_API</constant>, <constant>GL_DEBUG_SOURCE_WINDOW_SYSTEM_</constant>,
|
||
|
|
<constant>GL_DEBUG_SOURCE_SHADER_COMPILER</constant>, <constant>GL_DEBUG_SOURCE_THIRD_PARTY</constant>,
|
||
|
|
<constant>GL_DEBUG_SOURCE_APPLICATION</constant>, <constant>GL_DEBUG_SOURCE_OTHER</constant> 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 <constant>GL_DONT_CARE</constant>. If <parameter>source</parameter>
|
||
|
|
is not <constant>GL_DONT_CARE</constant> then only messages whose source matches <parameter>source</parameter> will be referenced.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<parameter>type</parameter> may be one of <constant>GL_DEBUG_TYPE_ERROR</constant>, <constant>GL_DEBUG_TYPE_DEPRECATED_BEHAVIOR</constant>,
|
||
|
|
<constant>GL_DEBUG_TYPE_UNDEFINED_BEHAVIOR</constant>, <constant>GL_DEBUG_TYPE_PORTABILITY</constant>,
|
||
|
|
<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> 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 <constant>GL_DONT_CARE</constant>. If <parameter>type</parameter> is not <constant>GL_DONT_CARE</constant>
|
||
|
|
then only messages whose type matches <parameter>type</parameter> will be referenced.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<parameter>severity</parameter> may be one of <constant>GL_DEBUG_SEVERITY_LOW</constant>, <constant>GL_DEBUG_SEVERITY_MEDIUM</constant>,
|
||
|
|
or <constant>GL_DEBUG_SEVERITY_HIGH</constant> to select messages of low, medium or high severity messages or to
|
||
|
|
<constant>GL_DEBUG_SEVERITY_NOTIFICATION</constant> for notifications. It may also take the
|
||
|
|
value <constant>GL_DONT_CARE</constant>. If <parameter>severity</parameter> is not <constant>GL_DONT_CARE</constant> then only
|
||
|
|
messages whose severity matches <parameter>severity</parameter> will be referenced.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<parameter>ids</parameter> contains a list of <parameter>count</parameter> message identifiers to select specific messages from the pool
|
||
|
|
of available messages. If <parameter>count</parameter> is zero then the value of <parameter>ids</parameter> is ignored. Otherwise,
|
||
|
|
only messages appearing in this list are selected. In this case, <parameter>source</parameter> and <parameter>type</parameter>
|
||
|
|
may not be <constant>GL_DONT_CARE</constant> and <parameter>severity</parameter> must be <constant>GL_DONT_CARE</constant>.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
If <parameter>enabled</parameter> is <constant>GL_TRUE</constant> then messages that match the filter formed by
|
||
|
|
<parameter>source</parameter>, <parameter>type</parameter>, <parameter>severity</parameter> and <parameter>ids</parameter>
|
||
|
|
are enabled. Otherwise, those messages are disabled.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="notes"><title>Notes</title>
|
||
|
|
<para>
|
||
|
|
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.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<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>
|
||
|
|
are available only if the GL version is 4.3 or higher.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="errors"><title>Errors</title>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_ENUM</constant> is generated if any of <parameter>source</parameter>, <parameter>type</parameter>
|
||
|
|
or <parameter>severity</parameter> is not one of the accepted interface types.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>count</parameter> is non-zero
|
||
|
|
and either <parameter>source</parameter> or <parameter>type</parameter> is <constant>GL_DONT_CARE</constant>
|
||
|
|
or if <parameter>severity</parameter> is not <constant>GL_DONT_CARE</constant>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="seealso"><title>See Also</title>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glDebugMessageInsert</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glGetDebugMessageLog</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
||
|
|
<para>
|
||
|
|
Copyright <trademark class="copyright"></trademark> 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.
|
||
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|