ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
11082 Commits
21 Branches
19 Tags
70 MiB
Tree: 0f1ffe9dae
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0f1ffe9dae'
${ noResults }
magnum/src/Magnum/Vk/Assert.h

141 lines
7.1 KiB
Raw Normal View History Unescape

Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
#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,
It's October already?!
2 years ago
2020, 2021, 2022, 2023, 2024
Vladimír Vondruš <mosra@centrum.cz>
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
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
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
* @brief Macro @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(), @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR()
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
* @m_since_latest
*/
#include <Corrade/Containers/EnumSet.h>
#include <Corrade/Utility/Assert.h>
#include "Magnum/configure.h"
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
#if !defined(CORRADE_NO_ASSERT) && (!defined(MAGNUM_VK_INTERNAL_ASSERT_SUCCESS) || !defined(MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR))
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
#ifndef CORRADE_STANDARD_ASSERT
#include <cstdlib>
#include <Corrade/Utility/Debug.h>
#elif !defined(NDEBUG)
#include <cassert>
#endif
Fix build with CORRADE_STANDARD_ASSERT. And clean up the warnings. Like in Corrade it's Debug build only, for the Release build it's better to just use CORRADE_NO_ASSERT instead.
3 years ago
#include "Magnum/Vk/Result.h"
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
#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
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
@cpp #define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS @ce before including the
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
@ref Magnum/Vk/Assert.h header.
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
@see @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR()
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
*/
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#ifndef MAGNUM_VK_INTERNAL_ASSERT_SUCCESS
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
#if defined(CORRADE_NO_ASSERT) || (defined(CORRADE_STANDARD_ASSERT) && defined(NDEBUG))
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
static_cast<void>(call)
#elif defined(CORRADE_STANDARD_ASSERT)
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
assert(Magnum::Vk::Result(call) == Magnum::Vk::Result::Success)
#else
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS(call) \
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
do { \
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
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
/**
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
@brief Assert that a Vulkan function call succeeds or returns any of the specified results
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
@m_since_latest
A variant of @ref MAGNUM_VK_INTERNAL_ASSERT_SUCCESS() that allows the call to
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
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:
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
doc: drop the redundant Magnum prefix from snippet files. I accidentally did that at first, and then "for consistency" continued with that for a decade.
2 years ago
@snippet Vk.cpp MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
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
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
including the @ref Magnum/Vk/Assert.h header.
*/
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
#ifndef MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#if defined(CORRADE_NO_ASSERT) || (defined(CORRADE_STANDARD_ASSERT) && defined(NDEBUG))
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
/* Defining it to just Magnum::Vk::Result(call) causes ugly warnings with
asserts disabled, so it has to be a lambda even here :( */
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
[&]() { \
return Magnum::Vk::Result(call); \
}()
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#elif defined(CORRADE_STANDARD_ASSERT)
Vk: hello, MinGW, why are you so special again?!
5 years ago
/* MinGW GCC 8 for some reason needs the `return Magnum::Vk::Result();` at the
end, otherwise it complains about non-void function exiting with no return.
All other compilers understand the abort() as a noreturn function. */
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
[&]() { \
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
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); \
Vk: hello, MinGW, why are you so special again?!
5 years ago
return Magnum::Vk::Result(); \
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
}()
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
#else
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
#define MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(call, ...) \
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
[&]() { \
Vk: rename the *ASSERT_{RESULT => SUCCESS}(), add an incomplete variant. We'll need that to optimize some commands, such as device enumeration.
6 years ago
const Magnum::Vk::Result _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) = Magnum::Vk::Result(call); \
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
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__); \
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
} \
Vk: allow multiple values in MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Breaking this macro yet again, sorry -- now the result values are specified last and there can be any number of them, however they need to be all prefixed, as adding the prefix implicitly with the macro would be too much of a pain to implement, especially given the poor preprocessor capabilities of MSVC.
5 years ago
Corrade::Utility::Error{Corrade::Utility::Error::defaultOutput()} << "Call " #call " failed with" << _CORRADE_HELPER_PASTE(magnumVkResult, __LINE__) << "at " __FILE__ ":" CORRADE_LINE_STRING; \
std::abort(); \
Vk: hello, MinGW, why are you so special again?!
5 years ago
return Magnum::Vk::Result(); \
Vk: more useful MAGNUM_VK_INTERNAL_ASSERT_SUCCESS_OR(). Another breaking change here, sorry -- I don't expect anyone to be seriously using these ... yet :)
5 years ago
}()
Vk: move MAGNUM_VK_INTERNAL_ASSER_RESULT() to a dedicated header. Similarly to Corrade Assert.h, so it's possible to include this header without having to worry about irrelevant overhead when asserts are disabled. Also test it properly, as it should have been from the start.
6 years ago
#endif
#endif
#endif