diagnostic.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_GLF_DIAGNOSTIC_H
#define PXR_IMAGING_GLF_DIAGNOSTIC_H
 
 
#include "pxr/pxr.h"
#include "pxr/imaging/glf/api.h"
#include "pxr/imaging/garch/glApi.h"
#include "pxr/base/tf/diagnostic.h"
 
#include <string>
#include <cstdint>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
#define GLF_POST_PENDING_GL_ERRORS() \
        GlfPostPendingGLErrors(__ARCH_PRETTY_FUNCTION__, __LINE__)
 
GLF_API
void GlfPostPendingGLErrors(std::string const & where = std::string(), int line = 0);
 
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 const * GlfDebugEnumToString(GLenum debugEnum);
 
#define GLF_GROUP_FUNCTION() \
    GlfDebugGroup __glf_group_function(__ARCH_PRETTY_FUNCTION__)
 
#define GLF_GROUP_SCOPE(str) \
    GlfDebugGroup __glf_group_scope(str)
 
class GlfDebugGroup {
    public:
    GLF_API
    GlfDebugGroup(char const *message);
    
    GLF_API
    ~GlfDebugGroup();
 
    GlfDebugGroup() = delete;
    GlfDebugGroup(GlfDebugGroup const&) = delete;
    GlfDebugGroup& operator =(GlfDebugGroup const&) = delete;
};
 
GLF_API
void GlfDebugLabelBuffer(GLuint id, char const *label);
 
GLF_API
void GlfDebugLabelShader(GLuint id, char const *label);
 
GLF_API
void GlfDebugLabelProgram(GLuint id, char const *label);
 
class GlfGLQueryObject {
public:
    GLF_API
    GlfGLQueryObject();
    GLF_API
    ~GlfGLQueryObject();
 
    GLF_API
    void Begin(GLenum target);
 
    GLF_API
    void BeginSamplesPassed();
 
    GLF_API
    void BeginPrimitivesGenerated();
 
    GLF_API
    void BeginTimeElapsed();
 
    GLF_API
    void End();
 
    GLF_API
    int64_t GetResult();
 
    GLF_API
    int64_t GetResultNoWait();
 
    GlfGLQueryObject(GlfGLQueryObject const&) = delete;
    GlfGLQueryObject& operator =(GlfGLQueryObject const&) = delete;
private:
    GLuint _id;
    GLenum _target;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif