+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
- "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
-<refentry id="glGetDebugMessageLog">\r
- <refmeta>\r
- <refmetainfo>\r
- <copyright>\r
- <year>2012</year>\r
- <holder>Khronos Group</holder>\r
- </copyright>\r
- </refmetainfo>\r
- <refentrytitle>glGetDebugMessageLog</refentrytitle>\r
- <manvolnum>3G</manvolnum>\r
- </refmeta>\r
- <refnamediv>\r
- <refname>glGetDebugMessageLog</refname>\r
- <refpurpose>retrieve messages from the debug message log</refpurpose>\r
- </refnamediv>\r
- <refsynopsisdiv><title>C Specification</title>\r
- <funcsynopsis>\r
- <funcprototype>\r
- <funcdef>GLuint <function>glGetDebugMessageLog</function></funcdef>\r
- <paramdef>GLuint <parameter>count</parameter></paramdef>\r
- <paramdef>GLsizei <parameter>bufSize</parameter></paramdef>\r
- <paramdef>GLenum *<parameter>sources</parameter></paramdef>\r
- <paramdef>Glenum *<parameter>types</parameter></paramdef>\r
- <paramdef>GLuint *<parameter>ids</parameter></paramdef>\r
- <paramdef>GLenum *<parameter>severities</parameter></paramdef>\r
- <paramdef>GLsizei *<parameter>lengths</parameter></paramdef>\r
- <paramdef>GLchar *<parameter>messageLog</parameter></paramdef>\r
- </funcprototype>\r
- </funcsynopsis>\r
- </refsynopsisdiv>\r
- <refsect1 id="parameters"><title>Parameters</title>\r
- <variablelist>\r
- <varlistentry>\r
- <term><parameter>count</parameter></term>\r
- <listitem>\r
- <para>\r
- The number of debug messages to retrieve from the log.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>bufSize</parameter></term>\r
- <listitem>\r
- <para>\r
- The size of the buffer whose address is given by <parameter>messageLog</parameter>.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>sources</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of variables to receive the sources of the retrieved messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>types</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of variables to receive the types of the retrieved messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>ids</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of unsigned integers to receive the ids of the retrieved messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>severities</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of variables to receive the severites of the retrieved messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>lengths</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of variables to receive the lengths of the received messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>messageLog</parameter></term>\r
- <listitem>\r
- <para>\r
- The address of an array of characters that will receive the messages.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
- </refsect1>\r
- <refsect1 id="description"><title>Description</title>\r
- <para>\r
- <function>glGetDebugMessageLog</function> retrieves messages from the debug message log. A maximum of\r
- <parameter>count</parameter> messages are retrieved from the log. If <parameter>sources</parameter>\r
- is not NULL then the source of each message is written into up to <parameter>count</parameter> elements\r
- of the array. If <parameter>types</parameter>\r
- is not NULL then the type of each message is written into up to <parameter>count</parameter> elements\r
- of the array. If <parameter>id</parameter>\r
- is not NULL then the identifier of each message is written into up to <parameter>count</parameter> elements\r
- of the array. If <parameter>severities</parameter>\r
- is not NULL then the severity of each message is written into up to <parameter>count</parameter> elements\r
- of the array. If <parameter>lengths</parameter>\r
- is not NULL then the length of each message is written into up to <parameter>count</parameter> elements\r
- of the array.\r
- </para>\r
- <para>\r
- <parameter>messageLog</parameter> specifies the address of a character array into which the debug messages\r
- will be written. Each message will be concatenated onto the array starting at the first element of <parameter>messageLog</parameter>.\r
- <parameter>bufSize</parameter> specifies the size of the array <parameter>messageLog</parameter>. If a message will not\r
- fit into the remaining space in <parameter>messageLog</parameter> then the function terminates and returns the number\r
- of messages written so far, which may be zero.\r
- </para>\r
- <para>\r
- If <function>glGetDebugMessageLog</function> returns zero then no messages are present in the debug log, or there\r
- was not enough space in <parameter>messageLog</parameter> to retrieve the first message in the queue. If <parameter>messageLog</parameter>\r
- is NULL then no messages are written and the value of <parameter>bufSize</parameter> is ignored.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="notes"><title>Notes</title>\r
- <para>\r
- Although debug messages may be enabled in a non-debug context, the quantity and detail of such messages may be substantially\r
- inferior to those in a debug context. In particular, a valid implementation of the debug message queue in a non-debug context\r
- may produce no messages at all.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="errors"><title>Errors</title>\r
- <para>\r
- <constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> or <parameter>bufSize</parameter> is negative.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="associatedgets"><title>Associated Gets</title>\r
- <para>\r
- <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEBUG_LOGGED_MESSAGES</constant>\r
- </para>\r
- <para>\r
- <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEBUG_NEXT_LOGGED_MESSAGE_LENGTH</constant>\r
- </para>\r
- <para>\r
- <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_MESSAGE_LENGTH</constant>\r
- </para>\r
- <para>\r
- <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_DEBUG_LOGGED_MESSAGES</constant>\r
- </para>\r
- </refsect1>\r
- <refsect1 id="seealso"><title>See Also</title>\r
- <para>\r
- <citerefentry><refentrytitle>glDebugMessageInsert</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glDebugMessageCallback</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>glDebugMessageControl</refentrytitle></citerefentry>.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="Copyright"><title>Copyright</title>\r
- <para>\r
- Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
- This material may be distributed subject to the terms and conditions set forth in \r
- the Open Publication License, v 1.0, 8 June 1999.\r
- <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
- </para>\r
- </refsect1>\r
-</refentry>\r
HCoop / clinton / guile-figl.git / blobdiff