mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
415 lines
14 KiB
415 lines
14 KiB
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
|
2020, 2021 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
|
to deal in the Software without restriction, including without limitation |
|
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
and/or sell copies of the Software, and to permit persons to whom the |
|
Software is furnished to do so, subject to the following conditions: |
|
|
|
The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software. |
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
|
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
|
DEALINGS IN THE SOFTWARE. |
|
*/ |
|
|
|
#include "DebugOutput.h" |
|
|
|
#ifndef MAGNUM_TARGET_WEBGL |
|
#include <Corrade/Utility/Assert.h> |
|
#include <Corrade/Utility/Debug.h> |
|
#include <Corrade/Utility/DebugStl.h> |
|
|
|
#include "Magnum/GL/Context.h" |
|
#include "Magnum/GL/Extensions.h" |
|
#include "Magnum/GL/Implementation/State.h" |
|
#include "Magnum/GL/Implementation/DebugState.h" |
|
|
|
namespace Magnum { namespace GL { |
|
|
|
namespace Implementation { |
|
|
|
void defaultDebugCallback(const DebugOutput::Source source, const DebugOutput::Type type, const UnsignedInt id, const DebugOutput::Severity severity, const std::string& string, std::ostream* out) { |
|
Debug output{out}; |
|
output << "Debug output:"; |
|
|
|
switch(severity) { |
|
case DebugOutput::Severity::High: |
|
output << "high severity"; break; |
|
|
|
case DebugOutput::Severity::Medium: |
|
output << "medium severity"; break; |
|
|
|
case DebugOutput::Severity::Low: |
|
output << "low severity"; break; |
|
|
|
case DebugOutput::Severity::Notification: ; |
|
} |
|
|
|
switch(source) { |
|
case DebugOutput::Source::Api: |
|
output << "API"; break; |
|
case DebugOutput::Source::WindowSystem: |
|
output << "window system"; break; |
|
case DebugOutput::Source::ShaderCompiler: |
|
output << "shader compiler"; break; |
|
case DebugOutput::Source::ThirdParty: |
|
output << "third party"; break; |
|
case DebugOutput::Source::Application: |
|
output << "application"; break; |
|
|
|
case DebugOutput::Source::Other: ; |
|
} |
|
|
|
switch(type) { |
|
case DebugOutput::Type::Error: |
|
output << "error"; break; |
|
case DebugOutput::Type::DeprecatedBehavior: |
|
output << "deprecated behavior note"; break; |
|
case DebugOutput::Type::UndefinedBehavior: |
|
output << "undefined behavior note"; break; |
|
case DebugOutput::Type::Portability: |
|
output << "portability note"; break; |
|
case DebugOutput::Type::Performance: |
|
output << "performance note"; break; |
|
case DebugOutput::Type::Marker: |
|
output << "marker"; break; |
|
case DebugOutput::Type::PushGroup: |
|
output << "debug group enter"; break; |
|
case DebugOutput::Type::PopGroup: |
|
output << "debug group leave"; break; |
|
|
|
case DebugOutput::Type::Other: ; |
|
} |
|
|
|
output << "(" << Debug::nospace << id << Debug::nospace << "):" << string; |
|
} |
|
|
|
} |
|
|
|
namespace { |
|
|
|
void |
|
#ifdef CORRADE_TARGET_WINDOWS |
|
APIENTRY |
|
#endif |
|
callbackWrapper(GLenum source, GLenum type, GLuint id, GLenum severity, GLsizei length, const GLchar* message, const void* userParam) { |
|
const auto& callback = *static_cast<const Implementation::DebugState::MessageCallback*>(userParam); |
|
callback.callback(DebugOutput::Source(source), DebugOutput::Type(type), id, DebugOutput::Severity(severity), std::string{message, std::size_t(length)}, callback.userParam); |
|
} |
|
|
|
} |
|
|
|
Int DebugOutput::maxLoggedMessages() { |
|
if(!Context::current().isExtensionSupported<Extensions::KHR::debug>()) |
|
return 0; |
|
|
|
GLint& value = Context::current().state().debug.maxLoggedMessages; |
|
|
|
if(value == 0) { |
|
#ifndef MAGNUM_TARGET_GLES2 |
|
glGetIntegerv(GL_MAX_DEBUG_LOGGED_MESSAGES, &value); |
|
#else |
|
glGetIntegerv(GL_MAX_DEBUG_LOGGED_MESSAGES_KHR, &value); |
|
#endif |
|
} |
|
|
|
return value; |
|
} |
|
|
|
Int DebugOutput::maxMessageLength() { |
|
if(!Context::current().isExtensionSupported<Extensions::KHR::debug>()) |
|
return 0; |
|
|
|
GLint& value = Context::current().state().debug.maxMessageLength; |
|
|
|
if(value == 0) { |
|
#ifndef MAGNUM_TARGET_GLES2 |
|
glGetIntegerv(GL_MAX_DEBUG_MESSAGE_LENGTH, &value); |
|
#else |
|
glGetIntegerv(GL_MAX_DEBUG_MESSAGE_LENGTH_KHR, &value); |
|
#endif |
|
} |
|
|
|
return value; |
|
} |
|
|
|
void DebugOutput::setCallback(const Callback callback, const void* userParam) { |
|
Context::current().state().debug.callbackImplementation(callback, userParam); |
|
} |
|
|
|
void DebugOutput::setDefaultCallback() { |
|
setCallback([](DebugOutput::Source source, DebugOutput::Type type, UnsignedInt id, DebugOutput::Severity severity, const std::string& string, const void*) { |
|
Implementation::defaultDebugCallback(source, type, id, severity, string, Debug::output()); |
|
}); |
|
} |
|
|
|
void DebugOutput::setEnabledInternal(const GLenum source, const GLenum type, const GLenum severity, const std::initializer_list<UnsignedInt> ids, const bool enabled) { |
|
Context::current().state().debug.controlImplementation(source, type, severity, ids, enabled); |
|
} |
|
|
|
void DebugOutput::controlImplementationNoOp(GLenum, GLenum, GLenum, std::initializer_list<UnsignedInt>, bool) {} |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
void DebugOutput::controlImplementationKhrDesktopES32(const GLenum source, const GLenum type, const GLenum severity, const std::initializer_list<UnsignedInt> ids, const bool enabled) { |
|
glDebugMessageControl(source, type, severity, ids.size(), ids.begin(), enabled); |
|
} |
|
#endif |
|
|
|
#ifdef MAGNUM_TARGET_GLES |
|
void DebugOutput::controlImplementationKhrES(const GLenum source, const GLenum type, const GLenum severity, const std::initializer_list<UnsignedInt> ids, const bool enabled) { |
|
glDebugMessageControlKHR(source, type, severity, ids.size(), ids.begin(), enabled); |
|
} |
|
#endif |
|
|
|
void DebugOutput::callbackImplementationNoOp(Callback, const void*) {} |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
void DebugOutput::callbackImplementationKhrDesktopES32(const Callback callback, const void* userParam) { |
|
/* Replace the callback */ |
|
const Callback original = Context::current().state().debug.messageCallback.callback; |
|
Context::current().state().debug.messageCallback.callback = callback; |
|
Context::current().state().debug.messageCallback.userParam = userParam; |
|
|
|
/* Adding callback */ |
|
if(!original && callback) |
|
glDebugMessageCallback(callbackWrapper, &Context::current().state().debug.messageCallback); |
|
|
|
/* Deleting callback */ |
|
else if(original && !callback) |
|
glDebugMessageCallback(nullptr, nullptr); |
|
} |
|
#endif |
|
|
|
#ifdef MAGNUM_TARGET_GLES |
|
void DebugOutput::callbackImplementationKhrES(const Callback callback, const void* userParam) { |
|
/* Replace the callback */ |
|
const Callback original = Context::current().state().debug.messageCallback.callback; |
|
Context::current().state().debug.messageCallback.callback = callback; |
|
Context::current().state().debug.messageCallback.userParam = userParam; |
|
|
|
/* Adding callback */ |
|
if(!original && callback) |
|
glDebugMessageCallbackKHR(callbackWrapper, &Context::current().state().debug.messageCallback); |
|
|
|
/* Deleting callback */ |
|
else if(original && !callback) |
|
glDebugMessageCallbackKHR(nullptr, nullptr); |
|
} |
|
#endif |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
Debug& operator<<(Debug& debug, const DebugOutput::Source value) { |
|
debug << "GL::DebugOutput::Source" << Debug::nospace; |
|
|
|
switch(value) { |
|
/* LCOV_EXCL_START */ |
|
#define _c(value) case DebugOutput::Source::value: return debug << "::" #value; |
|
_c(Api) |
|
_c(WindowSystem) |
|
_c(ShaderCompiler) |
|
_c(ThirdParty) |
|
_c(Application) |
|
_c(Other) |
|
#undef _c |
|
/* LCOV_EXCL_STOP */ |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
|
|
Debug& operator<<(Debug& debug, const DebugOutput::Type value) { |
|
debug << "GL::DebugOutput::Type" << Debug::nospace; |
|
|
|
switch(value) { |
|
/* LCOV_EXCL_START */ |
|
#define _c(value) case DebugOutput::Type::value: return debug << "::" #value; |
|
_c(Error) |
|
_c(DeprecatedBehavior) |
|
_c(UndefinedBehavior) |
|
_c(Portability) |
|
_c(Performance) |
|
_c(Marker) |
|
_c(PushGroup) |
|
_c(PopGroup) |
|
_c(Other) |
|
#undef _c |
|
/* LCOV_EXCL_STOP */ |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
|
|
Debug& operator<<(Debug& debug, const DebugOutput::Severity value) { |
|
debug << "GL::DebugOutput::Severity" << Debug::nospace; |
|
|
|
switch(value) { |
|
#define _c(value) case DebugOutput::Severity::value: return debug << "::" #value; |
|
_c(High) |
|
_c(Medium) |
|
_c(Low) |
|
_c(Notification) |
|
#undef _c |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
#endif |
|
|
|
void DebugMessage::insertInternal(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) { |
|
Context::current().state().debug.messageInsertImplementation(source, type, id, severity, string); |
|
} |
|
|
|
void DebugMessage::insertImplementationNoOp(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char>) {} |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
void DebugMessage::insertImplementationKhrDesktopES32(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) { |
|
glDebugMessageInsert(GLenum(source), GLenum(type), id, GLenum(severity), string.size(), string.data()); |
|
} |
|
#endif |
|
|
|
#ifdef MAGNUM_TARGET_GLES |
|
void DebugMessage::insertImplementationKhrES(const Source source, const Type type, const UnsignedInt id, const DebugOutput::Severity severity, const Containers::ArrayView<const char> string) { |
|
glDebugMessageInsertKHR(GLenum(source), GLenum(type), id, GLenum(severity), string.size(), string.data()); |
|
} |
|
#endif |
|
|
|
void DebugMessage::insertImplementationExt(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char> string) { |
|
glInsertEventMarkerEXT(string.size(), string.data()); |
|
} |
|
|
|
#ifndef MAGNUM_TARGET_GLES |
|
void DebugMessage::insertImplementationGremedy(Source, Type, UnsignedInt, DebugOutput::Severity, const Containers::ArrayView<const char> string) { |
|
glStringMarkerGREMEDY(string.size(), string.data()); |
|
} |
|
#endif |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
Debug& operator<<(Debug& debug, const DebugMessage::Source value) { |
|
debug << "GL::DebugMessage::Source" << Debug::nospace; |
|
|
|
switch(value) { |
|
/* LCOV_EXCL_START */ |
|
#define _c(value) case DebugMessage::Source::value: return debug << "::" #value; |
|
_c(ThirdParty) |
|
_c(Application) |
|
#undef _c |
|
/* LCOV_EXCL_STOP */ |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
|
|
Debug& operator<<(Debug& debug, const DebugMessage::Type value) { |
|
debug << "GL::DebugMessage::Type" << Debug::nospace; |
|
|
|
switch(value) { |
|
#define _c(value) case DebugMessage::Type::value: return debug << "::" #value; |
|
_c(Error) |
|
_c(DeprecatedBehavior) |
|
_c(UndefinedBehavior) |
|
_c(Portability) |
|
_c(Performance) |
|
_c(Other) |
|
_c(Marker) |
|
#undef _c |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
#endif |
|
|
|
Int DebugGroup::maxStackDepth() { |
|
if(!Context::current().isExtensionSupported<Extensions::KHR::debug>()) |
|
return 0; |
|
|
|
GLint& value = Context::current().state().debug.maxStackDepth; |
|
|
|
if(value == 0) { |
|
#ifndef MAGNUM_TARGET_GLES2 |
|
glGetIntegerv(GL_MAX_DEBUG_GROUP_STACK_DEPTH, &value); |
|
#else |
|
glGetIntegerv(GL_MAX_DEBUG_GROUP_STACK_DEPTH_KHR, &value); |
|
#endif |
|
} |
|
|
|
return value; |
|
} |
|
|
|
void DebugGroup::pushInternal(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) { |
|
CORRADE_ASSERT(!_active, "GL::DebugGroup::push(): group is already active", ); |
|
Context::current().state().debug.pushGroupImplementation(source, id, message); |
|
_active = true; |
|
} |
|
|
|
void DebugGroup::pop() { |
|
CORRADE_ASSERT(_active, "GL::DebugGroup::pop(): group is not active", ); |
|
Context::current().state().debug.popGroupImplementation(); |
|
_active = false; |
|
} |
|
|
|
void DebugGroup::pushImplementationNoOp(Source, UnsignedInt, Containers::ArrayView<const char>) {} |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
void DebugGroup::pushImplementationKhrDesktopES32(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) { |
|
glPushDebugGroup(GLenum(source), id, message.size(), message.data()); |
|
} |
|
#endif |
|
|
|
#ifdef MAGNUM_TARGET_GLES |
|
void DebugGroup::pushImplementationKhrES(const Source source, const UnsignedInt id, const Containers::ArrayView<const char> message) { |
|
glPushDebugGroupKHR(GLenum(source), id, message.size(), message.data()); |
|
} |
|
#endif |
|
|
|
void DebugGroup::pushImplementationExt(Source, UnsignedInt, const Containers::ArrayView<const char> message) { |
|
glPushGroupMarkerEXT(message.size(), message.data()); |
|
} |
|
|
|
void DebugGroup::popImplementationNoOp() {} |
|
|
|
#ifndef MAGNUM_TARGET_GLES2 |
|
void DebugGroup::popImplementationKhrDesktopES32() { |
|
glPopDebugGroup(); |
|
} |
|
#endif |
|
|
|
#ifdef MAGNUM_TARGET_GLES |
|
void DebugGroup::popImplementationKhrES() { |
|
glPopDebugGroupKHR(); |
|
} |
|
#endif |
|
|
|
void DebugGroup::popImplementationExt() { |
|
glPopGroupMarkerEXT(); |
|
} |
|
|
|
#ifndef DOXYGEN_GENERATING_OUTPUT |
|
Debug& operator<<(Debug& debug, const DebugGroup::Source value) { |
|
debug << "GL::DebugGroup::Source" << Debug::nospace; |
|
|
|
switch(value) { |
|
/* LCOV_EXCL_START */ |
|
#define _c(value) case DebugGroup::Source::value: return debug << "::" #value; |
|
_c(ThirdParty) |
|
_c(Application) |
|
#undef _c |
|
/* LCOV_EXCL_STOP */ |
|
} |
|
|
|
return debug << "(" << Debug::nospace << reinterpret_cast<void*>(GLenum(value)) << Debug::nospace << ")"; |
|
} |
|
#endif |
|
|
|
}} |
|
#endif
|
|
|