HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diagnostic.h File Reference
#include "pxr/pxr.h"
#include "pxr/imaging/glf/api.h"
#include "pxr/imaging/garch/gl.h"
#include "pxr/base/tf/diagnostic.h"
#include <string>
#include <cstdint>
+ Include dependency graph for diagnostic.h:

Go to the source code of this file.

Classes

class  GlfDebugGroup
 
class  GlfGLQueryObject
 

Macros

#define GLF_POST_PENDING_GL_ERRORS()   GlfPostPendingGLErrors(__ARCH_PRETTY_FUNCTION__)
 
#define GLF_GROUP_FUNCTION()   GlfDebugGroup __glf_group_function(__ARCH_PRETTY_FUNCTION__)
 Emit a GlfDebugGroup tracing the current function. More...
 
#define GLF_GROUP_SCOPE(str)   GlfDebugGroup __glf_group_scope(str)
 Emit a GlfDebugGroup tracing the current scope with the given string. More...
 

Functions

GLF_API void GlfPostPendingGLErrors (std::string const &where=std::string())
 Posts diagnostic errors for all GL errors in the current context. More...
 
GLF_API void GlfRegisterDefaultDebugOutputMessageCallback ()
 
GLF_API void GlfDefaultDebugOutputMessageCallback (GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, char const *message, GLvoid const *userParam)
 
GLF_API char constGlfDebugEnumToString (GLenum debugEnum)
 Returns a string representation of debug output enum values. More...
 
GLF_API void GlfDebugLabelBuffer (GLuint id, char const *label)
 Label a buffer object to improve tracing in the debug output. More...
 
GLF_API void GlfDebugLabelShader (GLuint id, char const *label)
 Label a shader object to improve tracing in the debug output. More...
 
GLF_API void GlfDebugLabelProgram (GLuint id, char const *label)
 Label a program object to improve tracing in the debug output. More...
 

Macro Definition Documentation

#define GLF_GROUP_FUNCTION ( )    GlfDebugGroup __glf_group_function(__ARCH_PRETTY_FUNCTION__)

Emit a GlfDebugGroup tracing the current function.

Definition at line 68 of file diagnostic.h.

#define GLF_GROUP_SCOPE (   str)    GlfDebugGroup __glf_group_scope(str)

Emit a GlfDebugGroup tracing the current scope with the given string.

Definition at line 72 of file diagnostic.h.

#define GLF_POST_PENDING_GL_ERRORS ( )    GlfPostPendingGLErrors(__ARCH_PRETTY_FUNCTION__)

Posts diagnostic errors for all GL errors in the current context. This macro tags the diagnostic errors with the name of the calling function.

Definition at line 43 of file diagnostic.h.

Function Documentation

GLF_API char const* GlfDebugEnumToString ( GLenum  debugEnum)

Returns a string representation of debug output enum values.

GLF_API void GlfDebugLabelBuffer ( GLuint  id,
char const label 
)

Label a buffer object to improve tracing in the debug output.

GLF_API void GlfDebugLabelProgram ( GLuint  id,
char const label 
)

Label a program object to improve tracing in the debug output.

GLF_API void GlfDebugLabelShader ( GLuint  id,
char const label 
)

Label a shader object to improve tracing in the debug output.

GLF_API void GlfDefaultDebugOutputMessageCallback ( GLenum  source,
GLenum  type,
GLuint  id,
GLenum  severity,
GLsizei  length,
char const message,
GLvoid const userParam 
)

A GL debug output message callback method which posts diagnostic errors for messages of type DEBUG_TYPE_ERROR and diagnostic warnings for other message types.

GLF_API void GlfPostPendingGLErrors ( std::string const where = std::string())

Posts diagnostic errors for all GL errors in the current context.

GLF_API void GlfRegisterDefaultDebugOutputMessageCallback ( )

Registers GlfDefaultDebugOutputMessageCallback as the debug message callback for the current GL context.