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.
134 lines
6.7 KiB
134 lines
6.7 KiB
#ifndef Magnum_Vk_Assert_h |
|
#define Magnum_Vk_Assert_h |
|
/* |
|
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. |
|
*/ |
|
|
|
/** @file |
|
* @brief Macro @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(), @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR() |
|
* @m_since_latest |
|
*/ |
|
|
|
#include <Corrade/Containers/EnumSet.h> |
|
#include <Corrade/Utility/Assert.h> |
|
|
|
#include "Magnum/configure.h" |
|
|
|
#if !defined(CORRADE_NO_ASSERT) && (!defined(MAGNUM_VK_INTERNAL_ASSERT_SUCCESS) || !defined(MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR)) |
|
#ifndef CORRADE_STANDARD_ASSERT |
|
#include <cstdlib> |
|
#include <Corrade/Utility/Debug.h> |
|
|
|
#include "Magnum/Vk/Result.h" |
|
#elif !defined(NDEBUG) |
|
#include <cassert> |
|
#endif |
|
#endif |
|
|
|
/** |
|
@brief Assert that a Vulkan function call succeeds |
|
@m_since_latest |
|
|
|
Compared to using @ref CORRADE_INTERNAL_ASSERT_OUTPUT() to verify that |
|
@cpp call == VK_SUCCESS @ce, this macro also prints the result value. Otherwise |
|
the behavior is the same, including interactions with |
|
@ref CORRADE_STANDARD_ASSERT and @ref CORRADE_NO_ASSERT. Works with both plain |
|
Vulkan functions returning @type_vk{Result} and APIs returning |
|
@ref Magnum::Vk::Result "Vk::Result". |
|
|
|
You can override this implementation by placing your own |
|
@cpp #define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS @ce before including the |
|
@ref Magnum/Vk/Assert.h header. |
|
@see @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR() |
|
*/ |
|
#ifndef MAGNUM_VK_INTERNAL_ASSERT_SUCCESS |
|
#if defined(CORRADE_NO_ASSERT) || (defined(CORRADE_STANDARD_ASSERT) && defined(NDEBUG)) |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \ |
|
static_cast<void>(call) |
|
#elif defined(CORRADE_STANDARD_ASSERT) |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \ |
|
assert(Magnum::Vk::Result(call) == Magnum::Vk::Result::Success) |
|
#else |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \ |
|
do { \ |
|
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \ |
|
if(_CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) != Magnum::Vk::Result::Success) { \ |
|
Corrade::Utility::Error{Corrade::Utility::Error::defaultOutput()} << "Call " #call " failed with" << _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) << "at " __FILE__ ":" CORRADE_LINE_STRING; \ |
|
std::abort(); \ |
|
} \ |
|
} while(false) |
|
#endif |
|
#endif |
|
|
|
/** |
|
@brief Assert that a Vulkan function call succeeds or returns any of the specified results |
|
@m_since_latest |
|
|
|
A variant of @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS() that allows the call to |
|
return any of the specified results in addition to |
|
@ref Magnum::Vk::Result::Success "Result::Success". The variadic argument |
|
accepts any number of @ref Magnum::Vk::Result "Result" values, the macro then |
|
returns the actual result value. Example usage: |
|
|
|
@snippet MagnumVk.cpp MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR |
|
|
|
Similarly to @ref CORRADE_INTERNAL_ASSERT_EXPRESSION() this macro is usable in |
|
any expression such as @cpp if @ce and @cpp return @ce statements. You can |
|
override this implementation by placing your own |
|
@cpp #define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR @ce before |
|
including the @ref Magnum/Vk/Assert.h header. |
|
*/ |
|
#ifndef MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR |
|
#if defined(CORRADE_NO_ASSERT) || (defined(CORRADE_STANDARD_ASSERT) && defined(NDEBUG)) |
|
/* Defining it to just Magnum::Vk::Result(call) causes ugly warnings with |
|
asserts disabled, so it has to be a lambda even here :( */ |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \ |
|
[&]() { \ |
|
return Magnum::Vk::Result(call); \ |
|
}() |
|
#elif defined(CORRADE_STANDARD_ASSERT) |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \ |
|
[&]() { \ |
|
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \ |
|
for(const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResultCandidate, __LINE__): {Magnum::Vk::Result::Success, __VA_ARGS__}) { \ |
|
if(_CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) == _CORRADE_HELPER_PASTE(magnumVkResultCandidate, __LINE__)) \ |
|
return _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__); \ |
|
} \ |
|
assert(false); \ |
|
}() |
|
#else |
|
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \ |
|
[&]() { \ |
|
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \ |
|
for(const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResultCandidate, __LINE__): {Magnum::Vk::Result::Success, __VA_ARGS__}) { \ |
|
if(_CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) == _CORRADE_HELPER_PASTE(magnumVkResultCandidate, __LINE__)) \ |
|
return _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__); \ |
|
} \ |
|
Corrade::Utility::Error{Corrade::Utility::Error::defaultOutput()} << "Call " #call " failed with" << _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) << "at " __FILE__ ":" CORRADE_LINE_STRING; \ |
|
std::abort(); \ |
|
}() |
|
#endif |
|
#endif |
|
|
|
#endif
|
|
|