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.
9962 Commits
21 Branches
19 Tags
70 MiB
Tree: 51fe5c0c8e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '51fe5c0c8e'
${ noResults }
magnum/src/Magnum/Vk/Enums.h

159 lines
6.5 KiB
Raw Normal View History Unescape

Vk: no, this is not GL!
7 years ago
#ifndef Magnum_Vk_Enums_h
#define Magnum_Vk_Enums_h
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/*
This file is part of Magnum.
Updated copyright year.
6 years ago
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
Updated copyright year.
4 years ago
2020, 2021, 2022 Vladimír Vondruš <mosra@centrum.cz>
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 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.
*/
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
#ifdef MAGNUM_BUILD_DEPRECATED
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/** @file
* @brief Function @ref Magnum::Vk::hasVkPrimitiveTopology(), @ref Magnum::Vk::vkPrimitiveTopology(), @ref Magnum::Vk::hasVkIndexType(), @ref Magnum::Vk::vkIndexType(), @ref Magnum::Vk::hasVkFormat(), @ref Magnum::Vk::vkFormat(), @ref Magnum::Vk::vkFilter(), @ref Magnum::Vk::vkSamplerMipmapMode(), @ref Magnum::Vk::hasVkSamplerAddressMode(), @ref Magnum::Vk::vkSamplerAddressMode()
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
* @m_deprecated_since_latest All functionality in this header has been
* deprecated and moved elsewhere. Use headers corresponding to the
* suggested replacement APIs instead.
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
*/
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
#endif
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
#include "Magnum/configure.h"
#ifdef MAGNUM_BUILD_DEPRECATED
#include "Magnum/Array.h" /* That's fine, we're deprecated too */
Deprecate the weird Magnum::Array class. Its only use was for specifying N-dimensional SamplerWrapping because, compared to a Math::Vector, it had an implicit constructor from a single value (whereas the Vector has it explicit). I solved that by simply adding a few single-value overloads where it mattered. There, done. No need for this weird thing and confusion with Containers::Array anymore. All places that used it now use Math::VectorN<SamplerWrapping>, but the class is still included for backwards compatibility purposes, together with providing implicit conversion from and to a Vector.
5 years ago
#include "Magnum/Math/Vector3.h"
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
#include "Magnum/Vk/Vulkan.h"
#include "Magnum/Vk/visibility.h"
Vk: add a PixelFormat enum. I was slowly getting cancer from having to write the unreadably awful VK_FORMAT_R666G666B666A666_SRGB all the time. Besides that: - All pixel formats are documented to show what's guaranteed for them by the spec. Pretty useful I'd say. - The old hasVkFormat() and vkFormat() converters operating on a VkFormat are deprecated in favor of new hasPixelFormat() and pixelFormat() that use the PixelFormat enum. Similarly as done in the GL wrapper. - All APIs that took a VkFormat before take a PixelFormat now, together with having conveinience overloads for Magnum::PixelFormat and Magnum::CompressedPixelFormat. Again similarly as done in the GL wrapper, also the first step on being able to *directly* use data imported with the Trade library with Vulkan.
5 years ago
#include <Corrade/Utility/Macros.h>
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
#ifndef _MAGNUM_NO_DEPRECATED_VK_ENUMS
CORRADE_DEPRECATED_FILE("use headers corresponding to the suggested replacement APIs instead")
Deprecate the weird Magnum::Array class. Its only use was for specifying N-dimensional SamplerWrapping because, compared to a Math::Vector, it had an implicit constructor from a single value (whereas the Vector has it explicit). I solved that by simply adding a few single-value overloads where it mattered. There, done. No need for this weird thing and confusion with Containers::Array anymore. All places that used it now use Math::VectorN<SamplerWrapping>, but the class is still included for backwards compatibility purposes, together with providing implicit conversion from and to a Vector.
5 years ago
#endif
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
namespace Magnum { namespace Vk {
/**
Vk: add a wrapper for mesh layout setup. Next up is *the unthinkable*, a Vk::Mesh. After that I'll finally have enough APIs exposed to document everything including command buffer recording and submission.
5 years ago
* @brief @copybrief hasMeshPrimitive()
* @m_deprecated_since_latest Use @ref hasMeshPrimitive() instead.
*/
CORRADE_DEPRECATED("use hasMeshPrimitive() instead") MAGNUM_VK_EXPORT bool hasVkPrimitiveTopology(Magnum::MeshPrimitive primitive);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: add a wrapper for mesh layout setup. Next up is *the unthinkable*, a Vk::Mesh. After that I'll finally have enough APIs exposed to document everything including command buffer recording and submission.
5 years ago
* @brief @copybrief meshPrimitive()
* @m_deprecated_since_latest Use @ref meshPrimitive() instead.
*/
CORRADE_DEPRECATED("use meshPrimitive() instead") MAGNUM_VK_EXPORT VkPrimitiveTopology vkPrimitiveTopology(Magnum::MeshPrimitive primitive);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implemented a Mesh wrapper. Together with: * CommandBuffer::draw() * Support for indexed and non-indexed meshes * Support for setting primitive and stride dynamically I took one shortcut and vkCmdBindVertexBuffers() is currently called once for each binding. The interface is ready for this, but I'm not yet 100% sure how to test that it actually does batch the buffers, so it's left at the lazy implementation for now.
5 years ago
* @brief Check availability of a generic index type
* @m_deprecated_since_latest All generic index types are available in Vulkan.
*/
CORRADE_DEPRECATED("all generic index types are available in Vulkan") MAGNUM_VK_EXPORT bool hasVkIndexType(Magnum::MeshIndexType type);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implemented a Mesh wrapper. Together with: * CommandBuffer::draw() * Support for indexed and non-indexed meshes * Support for setting primitive and stride dynamically I took one shortcut and vkCmdBindVertexBuffers() is currently called once for each binding. The interface is ready for this, but I'm not yet 100% sure how to test that it actually does batch the buffers, so it's left at the lazy implementation for now.
5 years ago
* @brief @copybrief meshIndexType()
* @m_deprecated_since_latest Use @ref meshIndexType() instead.
*/
CORRADE_DEPRECATED("use meshIndexType() instead") MAGNUM_VK_EXPORT VkIndexType vkIndexType(Magnum::MeshIndexType type);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
Provide reliable mapping of VertexFormat to GL and Vulkan. GL was missing a check whether given format is available on a target (for example double types are not on ES), and for Vulkan we need something similar to pixel format mapping as well.
6 years ago
/**
Vk: add a VertexFormat enum. Similar to PixelFormat, to filter out values that make no sense as a vertex format (such as sRGB) and add others (such as doubles). And documenting which are guaranteed to be supported and which not. The hasVkFormat(Magnum::VertexFormat) and vkFormat(Magnum::VertexFormat) were also deprecated in favor of the new hasVertexFormat() / vertexFormat() APIs.
5 years ago
* @brief @copybrief hasVertexFormat()
* @m_deprecated_since_latest Use @ref hasVertexFormat() instead.
*/
CORRADE_DEPRECATED("use hasVertexFormat() instead") MAGNUM_VK_EXPORT bool hasVkFormat(Magnum::VertexFormat format);
Provide reliable mapping of VertexFormat to GL and Vulkan. GL was missing a check whether given format is available on a target (for example double types are not on ES), and for Vulkan we need something similar to pixel format mapping as well.
6 years ago
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: add a PixelFormat enum. I was slowly getting cancer from having to write the unreadably awful VK_FORMAT_R666G666B666A666_SRGB all the time. Besides that: - All pixel formats are documented to show what's guaranteed for them by the spec. Pretty useful I'd say. - The old hasVkFormat() and vkFormat() converters operating on a VkFormat are deprecated in favor of new hasPixelFormat() and pixelFormat() that use the PixelFormat enum. Similarly as done in the GL wrapper. - All APIs that took a VkFormat before take a PixelFormat now, together with having conveinience overloads for Magnum::PixelFormat and Magnum::CompressedPixelFormat. Again similarly as done in the GL wrapper, also the first step on being able to *directly* use data imported with the Trade library with Vulkan.
5 years ago
* @brief @copybrief hasPixelFormat(Magnum::PixelFormat)
* @m_deprecated_since_latest Use @ref hasPixelFormat(Magnum::PixelFormat)
* instead.
*/
CORRADE_DEPRECATED("use hasPixelFormat() instead") MAGNUM_VK_EXPORT bool hasVkFormat(Magnum::PixelFormat format);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: add a PixelFormat enum. I was slowly getting cancer from having to write the unreadably awful VK_FORMAT_R666G666B666A666_SRGB all the time. Besides that: - All pixel formats are documented to show what's guaranteed for them by the spec. Pretty useful I'd say. - The old hasVkFormat() and vkFormat() converters operating on a VkFormat are deprecated in favor of new hasPixelFormat() and pixelFormat() that use the PixelFormat enum. Similarly as done in the GL wrapper. - All APIs that took a VkFormat before take a PixelFormat now, together with having conveinience overloads for Magnum::PixelFormat and Magnum::CompressedPixelFormat. Again similarly as done in the GL wrapper, also the first step on being able to *directly* use data imported with the Trade library with Vulkan.
5 years ago
* @brief @copybrief hasPixelFormat(Magnum::CompressedPixelFormat)
* @m_deprecated_since_latest Use @ref hasPixelFormat(Magnum::CompressedPixelFormat)
* instead.
*/
CORRADE_DEPRECATED("use hasPixelFormat() instead") MAGNUM_VK_EXPORT bool hasVkFormat(Magnum::CompressedPixelFormat format);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
Provide reliable mapping of VertexFormat to GL and Vulkan. GL was missing a check whether given format is available on a target (for example double types are not on ES), and for Vulkan we need something similar to pixel format mapping as well.
6 years ago
/**
Vk: add a VertexFormat enum. Similar to PixelFormat, to filter out values that make no sense as a vertex format (such as sRGB) and add others (such as doubles). And documenting which are guaranteed to be supported and which not. The hasVkFormat(Magnum::VertexFormat) and vkFormat(Magnum::VertexFormat) were also deprecated in favor of the new hasVertexFormat() / vertexFormat() APIs.
5 years ago
* @brief @copybrief vertexFormat()
* @m_deprecated_since_latest Use @ref vertexFormat() instead.
*/
CORRADE_DEPRECATED("use vertexFormat() instead") MAGNUM_VK_EXPORT VkFormat vkFormat(Magnum::VertexFormat format);
Provide reliable mapping of VertexFormat to GL and Vulkan. GL was missing a check whether given format is available on a target (for example double types are not on ES), and for Vulkan we need something similar to pixel format mapping as well.
6 years ago
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: add a PixelFormat enum. I was slowly getting cancer from having to write the unreadably awful VK_FORMAT_R666G666B666A666_SRGB all the time. Besides that: - All pixel formats are documented to show what's guaranteed for them by the spec. Pretty useful I'd say. - The old hasVkFormat() and vkFormat() converters operating on a VkFormat are deprecated in favor of new hasPixelFormat() and pixelFormat() that use the PixelFormat enum. Similarly as done in the GL wrapper. - All APIs that took a VkFormat before take a PixelFormat now, together with having conveinience overloads for Magnum::PixelFormat and Magnum::CompressedPixelFormat. Again similarly as done in the GL wrapper, also the first step on being able to *directly* use data imported with the Trade library with Vulkan.
5 years ago
* @brief @copybrief pixelFormat(Magnum::PixelFormat)
* @m_deprecated_since_latest Use @ref pixelFormat(Magnum::PixelFormat)
* instead.
*/
CORRADE_DEPRECATED("use pixelFormat() instead") MAGNUM_VK_EXPORT VkFormat vkFormat(Magnum::PixelFormat format);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: add a PixelFormat enum. I was slowly getting cancer from having to write the unreadably awful VK_FORMAT_R666G666B666A666_SRGB all the time. Besides that: - All pixel formats are documented to show what's guaranteed for them by the spec. Pretty useful I'd say. - The old hasVkFormat() and vkFormat() converters operating on a VkFormat are deprecated in favor of new hasPixelFormat() and pixelFormat() that use the PixelFormat enum. Similarly as done in the GL wrapper. - All APIs that took a VkFormat before take a PixelFormat now, together with having conveinience overloads for Magnum::PixelFormat and Magnum::CompressedPixelFormat. Again similarly as done in the GL wrapper, also the first step on being able to *directly* use data imported with the Trade library with Vulkan.
5 years ago
* @brief @copybrief pixelFormat(Magnum::CompressedPixelFormat)
* @m_deprecated_since_latest Use @ref pixelFormat(Magnum::CompressedPixelFormat)
* instead.
*/
CORRADE_DEPRECATED("use pixelFormat() instead") MAGNUM_VK_EXPORT VkFormat vkFormat(Magnum::CompressedPixelFormat format);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
* @brief @copybrief samplerFilter()
* @m_deprecated_since_latest Use @ref samplerFilter() instead.
*/
CORRADE_DEPRECATED("use samplerFilter() instead") MAGNUM_VK_EXPORT VkFilter vkFilter(Magnum::SamplerFilter filter);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
* @brief @copybrief samplerMipmap()
* @m_deprecated_since_latest Use @ref samplerMipmap() instead.
*/
CORRADE_DEPRECATED("use samplerMipmap() instead") MAGNUM_VK_EXPORT VkSamplerMipmapMode vkSamplerMipmapMode(Magnum::SamplerMipmap mipmap);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
* @brief Check availability of a generic sampler wrapping mode
* @m_deprecated_since_latest All generic sampler wrapping modes are available
* in Vulkan.
*/
CORRADE_DEPRECATED("all generic sampler wrapping modes are available in Vulkan") MAGNUM_VK_EXPORT bool hasVkSamplerAddressMode(Magnum::SamplerWrapping wrapping);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
/**
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
* @brief @copybrief samplerWrapping()
* @m_deprecated_since_latest Use @ref samplerWrapping() instead.
*/
CORRADE_DEPRECATED("use samplerWrapping() instead") MAGNUM_VK_EXPORT VkSamplerAddressMode vkSamplerAddressMode(Magnum::SamplerWrapping wrapping);
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
/**
* @brief @copybrief samplerWrapping()
* @m_deprecated_since_latest Use @ref samplerWrapping() instead.
*/
template<std::size_t dimensions> CORRADE_DEPRECATED("use samplerWrapping() instead") Math::Vector<dimensions, VkSamplerAddressMode> vkSamplerAddressMode(const Math::Vector<dimensions, Magnum::SamplerWrapping>& wrapping) {
Deprecate the weird Magnum::Array class. Its only use was for specifying N-dimensional SamplerWrapping because, compared to a Math::Vector, it had an implicit constructor from a single value (whereas the Vector has it explicit). I solved that by simply adding a few single-value overloads where it mattered. There, done. No need for this weird thing and confusion with Containers::Array anymore. All places that used it now use Math::VectorN<SamplerWrapping>, but the class is still included for backwards compatibility purposes, together with providing implicit conversion from and to a Vector.
5 years ago
Math::Vector<dimensions, VkSamplerAddressMode> out{NoInit};
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
for(std::size_t i = 0; i != dimensions; ++i)
out[i] = vkSamplerAddressMode(wrapping[i]);
return out;
}
}}
Vk: implement a Sampler wrapper. Together with SamplerFilter, SamplerMipmap and SamplerWrapping enums convertible from the generic versions, which finally deprecate the last remaining vk*() conversion functions in Enums.h and thus the whole header as well. The EnumsTest executable is also no more, as the rest of it now resides inside SamplerTest.
5 years ago
#else
#error use headers corresponding to the suggested replacement APIs instead
#endif
Vk: functions for translating generic enums to Vulkan values. Because I don't yet have any source file that's assert-independent, the MagnumVkObjects library is commented out, as it is completely empty right now.
8 years ago
#endif