Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glDebugMessageCallback - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glDebugMessageCallback"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDebugMessageCallback — specify a callback to receive debugging messages from the GL</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDebugMessageCallback</b>(</code></td><td>DEBUGPROC </td><td><var class="pdparam">callback</var>, </td></tr><tr><td> </td><td>void * </td><td><var class="pdparam">userParam</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>callback</code></em></span></dt><dd><p> | |
5 | The address of a callback function that will be called when a debug message is generated. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>userParam</code></em></span></dt><dd><p> | |
7 | A user supplied pointer that will be passed on each invocation of <em class="parameter"><code>callback</code></em>. | |
8 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
9 | <code class="function">glDebugMessageInsert</code> sets the current debug output callback function to | |
10 | the function whose address is given in <em class="parameter"><code>callback</code></em>. The callback function | |
11 | should have the following prototype (in C), or be otherwise compatible with such a prototype: | |
12 | </p><pre class="programlisting"> typedef void (APIENTRY *DEBUGPROC)(GLenum source, | |
13 | GLenum type, | |
14 | GLuint id, | |
15 | GLenum severity, | |
16 | GLsizei length, | |
17 | const GLchar* message, | |
18 | void* userParam);</pre><p> | |
19 | This function is defined to have the same calling convention as the GL API functions. In | |
20 | most cases this is defined as <code class="code">APIENTRY</code>, although it will vary depending | |
21 | on platform, language and compiler. | |
22 | </p><p> | |
23 | Each time a debug message is generated the debug callback function will be invoked | |
24 | with <em class="parameter"><code>source</code></em>, <em class="parameter"><code>type</code></em>, <em class="parameter"><code>id</code></em>, and | |
25 | <em class="parameter"><code>severity</code></em> associated with the message, and <em class="parameter"><code>length</code></em> set to | |
26 | the length of debug message whose character string is in the array pointed to by <em class="parameter"><code>message</code></em> | |
27 | <em class="parameter"><code>userParam</code></em> will be set to the value passed in the | |
28 | <em class="parameter"><code>userParam</code></em> parameter to the most recent call to <code class="function">glDebugMessageInsert</code>. | |
29 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
30 | When the GL is in use remotely, the server may not be able to call functions in the client's address space. | |
31 | In such cases, the callback function may not be invoked and the user should retrieve debug messages from | |
32 | the context's debug message log by calling <a href="glGetDebugMessageLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetDebugMessageLog</span></span></a>. | |
33 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
34 | <a href="glDebugMessageControl.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageControl</span></span></a>, | |
35 | <a href="glDebugMessageInsert.xml"><span class="citerefentry"><span class="refentrytitle">glDebugMessageInsert</span></span></a>, | |
36 | <a href="glGetDebugMessageLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetDebugMessageLog</span></span></a>. | |
37 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
38 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
39 | This material may be distributed subject to the terms and conditions set forth in | |
40 | the Open Publication License, v 1.0, 8 June 1999. | |
41 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
42 | </p></div></div></body></html> |