From 132bcacf288754a5696061327edbb9df016bd29a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 13 Jun 2020 11:17:25 +0200 Subject: [PATCH] Vk: add HandleFlags, similar to GL::ObjectFlags. --- src/Magnum/Vk/CMakeLists.txt | 2 + src/Magnum/Vk/Handle.cpp | 52 ++++++++++++++++++++++ src/Magnum/Vk/Handle.h | 73 +++++++++++++++++++++++++++++++ src/Magnum/Vk/Test/CMakeLists.txt | 1 + src/Magnum/Vk/Test/HandleTest.cpp | 60 +++++++++++++++++++++++++ src/Magnum/Vk/Vk.h | 2 + 6 files changed, 190 insertions(+) create mode 100644 src/Magnum/Vk/Handle.cpp create mode 100644 src/Magnum/Vk/Handle.h create mode 100644 src/Magnum/Vk/Test/HandleTest.cpp diff --git a/src/Magnum/Vk/CMakeLists.txt b/src/Magnum/Vk/CMakeLists.txt index 1ab5af633..c61905bf8 100644 --- a/src/Magnum/Vk/CMakeLists.txt +++ b/src/Magnum/Vk/CMakeLists.txt @@ -28,6 +28,7 @@ find_package(Vulkan REQUIRED) set(MagnumVk_SRCS Extensions.cpp + Handle.cpp Result.cpp Version.cpp) @@ -41,6 +42,7 @@ set(MagnumVk_HEADERS Enums.h Extensions.h ExtensionProperties.h + Handle.h Instance.h Integration.h LayerProperties.h diff --git a/src/Magnum/Vk/Handle.cpp b/src/Magnum/Vk/Handle.cpp new file mode 100644 index 000000000..e9638482a --- /dev/null +++ b/src/Magnum/Vk/Handle.cpp @@ -0,0 +1,52 @@ +/* + This file is part of Magnum. + + Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, + 2020 Vladimír Vondruš + + 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 "Handle.h" + +#include +#include + +namespace Magnum { namespace Vk { + +Debug& operator<<(Debug& debug, const HandleFlag value) { + debug << "Vk::HandleFlag" << Debug::nospace; + + switch(value) { + /* LCOV_EXCL_START */ + #define _c(value) case Vk::HandleFlag::value: return debug << "::" << Debug::nospace << #value; + _c(DestroyOnDestruction) + #undef _c + /* LCOV_EXCL_STOP */ + } + + return debug << "(" << Debug::nospace << reinterpret_cast(UnsignedByte(value)) << Debug::nospace << ")"; +} + +Debug& operator<<(Debug& debug, const HandleFlags value) { + return Containers::enumSetDebugOutput(debug, value, "Vk::HandleFlags{}", { + HandleFlag::DestroyOnDestruction}); +} + +}} diff --git a/src/Magnum/Vk/Handle.h b/src/Magnum/Vk/Handle.h new file mode 100644 index 000000000..50225273e --- /dev/null +++ b/src/Magnum/Vk/Handle.h @@ -0,0 +1,73 @@ +#ifndef Magnum_Vk_Handle_h +#define Magnum_Vk_Handle_h +/* + This file is part of Magnum. + + Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, + 2020 Vladimír Vondruš + + 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 Enum @ref Magnum::Vk::HandleFlag, enum set @ref Magnum::Vk::HandleFlags + * @m_since_latest + */ + +#include + +#include "Magnum/Magnum.h" +#include "Magnum/Vk/visibility.h" + +namespace Magnum { namespace Vk { + +/** +@brief Handle wrapping flag +@m_since_latest + +@see @ref HandleFlags +*/ +enum class HandleFlag: UnsignedByte { + /** Destroy the handle on destruction. */ + DestroyOnDestruction = 1 << 0 +}; + +/** +@brief Handle wrapping flags +@m_since_latest +*/ +typedef Containers::EnumSet HandleFlags; + +CORRADE_ENUMSET_OPERATORS(HandleFlags) + +/** +@debugoperatorenum{HandleFlag} +@m_since_latest +*/ +MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, HandleFlag value); + +/** +@debugoperatorenum{HandleFlags} +@m_since_latest +*/ +MAGNUM_VK_EXPORT Debug& operator<<(Debug& debug, HandleFlags value); + +}} + +#endif diff --git a/src/Magnum/Vk/Test/CMakeLists.txt b/src/Magnum/Vk/Test/CMakeLists.txt index bc3891281..c41e2585e 100644 --- a/src/Magnum/Vk/Test/CMakeLists.txt +++ b/src/Magnum/Vk/Test/CMakeLists.txt @@ -27,6 +27,7 @@ corrade_add_test(VkEnumsTest EnumsTest.cpp LIBRARIES MagnumVkTestLib) corrade_add_test(VkExtensionsTest ExtensionsTest.cpp LIBRARIES MagnumVk) corrade_add_test(VkExtensionPropertiesTest ExtensionPropertiesTest.cpp LIBRARIES MagnumVk) +corrade_add_test(VkHandleTest HandleTest.cpp LIBRARIES MagnumVk) corrade_add_test(VkIntegrationTest IntegrationTest.cpp LIBRARIES MagnumVk) corrade_add_test(VkLayerPropertiesTest LayerPropertiesTest.cpp LIBRARIES MagnumVk) corrade_add_test(VkResultTest ResultTest.cpp LIBRARIES MagnumVk) diff --git a/src/Magnum/Vk/Test/HandleTest.cpp b/src/Magnum/Vk/Test/HandleTest.cpp new file mode 100644 index 000000000..0df0980c9 --- /dev/null +++ b/src/Magnum/Vk/Test/HandleTest.cpp @@ -0,0 +1,60 @@ +/* + This file is part of Magnum. + + Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, + 2020 Vladimír Vondruš + + 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 +#include +#include + +#include "Magnum/Vk/Handle.h" + +namespace Magnum { namespace Vk { namespace Test { namespace { + +struct HandleTest: TestSuite::Tester { + explicit HandleTest(); + + void debugHandleFlag(); + void debugHandleFlags(); +}; + +HandleTest::HandleTest() { + addTests({&HandleTest::debugHandleFlag, + &HandleTest::debugHandleFlags}); +} + +void HandleTest::debugHandleFlag() { + std::ostringstream out; + Debug{&out} << HandleFlag::DestroyOnDestruction << HandleFlag(0xf0); + CORRADE_COMPARE(out.str(), "Vk::HandleFlag::DestroyOnDestruction Vk::HandleFlag(0xf0)\n"); +} + +void HandleTest::debugHandleFlags() { + std::ostringstream out; + Debug{&out} << (HandleFlag::DestroyOnDestruction|HandleFlag(0xf0)) << HandleFlags{}; + CORRADE_COMPARE(out.str(), "Vk::HandleFlag::DestroyOnDestruction|Vk::HandleFlag(0xf0) Vk::HandleFlags{}\n"); +} + +}}}} + +CORRADE_TEST_MAIN(Magnum::Vk::Test::HandleTest) diff --git a/src/Magnum/Vk/Vk.h b/src/Magnum/Vk/Vk.h index 7ebd6d838..023968525 100644 --- a/src/Magnum/Vk/Vk.h +++ b/src/Magnum/Vk/Vk.h @@ -36,6 +36,8 @@ namespace Magnum { namespace Vk { #ifndef DOXYGEN_GENERATING_OUTPUT class Extension; class ExtensionProperties; +enum class HandleFlag: UnsignedByte; +typedef Containers::EnumSet HandleFlags; class InstanceExtension; class InstanceExtensionProperties; class LayerProperties;