|
|
|
|
#
|
|
|
|
|
# This file is part of Magnum.
|
|
|
|
|
#
|
|
|
|
|
# Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
|
|
|
|
|
# 2020 Vladimír Vondruš <mosra@centrum.cz>
|
|
|
|
|
# Copyright © 2016 Jonathan Hale <squareys@googlemail.com>
|
|
|
|
|
#
|
|
|
|
|
# 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.
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
find_package(Vulkan REQUIRED)
|
|
|
|
|
|
|
|
|
|
set(MagnumVk_SRCS
|
|
|
|
|
CommandBuffer.cpp
|
|
|
|
|
CommandPool.cpp
|
|
|
|
|
Extensions.cpp
|
|
|
|
|
Handle.cpp
|
|
|
|
|
Instance.cpp
|
|
|
|
|
Result.cpp
|
|
|
|
|
Shader.cpp
|
|
|
|
|
Version.cpp
|
|
|
|
|
|
|
|
|
|
Implementation/Arguments.cpp
|
|
|
|
|
Implementation/DeviceState.cpp
|
|
|
|
|
Implementation/InstanceState.cpp)
|
|
|
|
|
|
|
|
|
|
set(MagnumVk_GracefulAssert_SRCS
|
|
|
|
|
Buffer.cpp
|
|
|
|
|
Device.cpp
|
|
|
|
|
DeviceProperties.cpp
|
|
|
|
|
DeviceFeatures.cpp
|
|
|
|
|
Enums.cpp
|
|
|
|
|
ExtensionProperties.cpp
|
Vk: initial APIs for binding a memory to an image.
You won't believe it, but it took me over a month of sitting on the
shitter until this design idea materialized out of [..] air. The whole
story, in order:
- Vulkan doesn't allow one VkDeviceMemory to be mapped more than once.
This is rather sad, because since Vulkan best practices suggest to
allocate a large block and suballocate from that, the engine needs
an extra layer that "emulates" mapping the suballocations for the
users but behind the scenes it inevitably has to map the whole
VkDeviceMemory anyway and keep it mapped for as long as any of the
sub-mappings is active.
- Because if it would map just a certain suballocation and then the
user would want to map another suballocation, it would have to
discard the original mapping and create a new one spanning both
suballocations and that has a risk of suddenly being in a different
VM block, making all pointers to the previous mapping invalid.
- The Vulkan Memory Allocator implements this approach of mapping the
whole thing and because of all the bookkeeping it doesn't give a
direct access to the underlying VkDeviceMemory, making it rather
hard to integrate.
Here I realized that:
- Most allocations won't need to be mapped ever, so the hiding and
obfuscation done by VMA isn't needed for those --- and we want
interoperability with 3rd party code, so preventing access to
VkDeviceMemory is out of question.
- There's KHR_dedicated_allocation, which (probably?) wasn't around
when VMA was originally designed. The extension was created because
a dedicated allocation actually *does* make sense in certain
cases and on certain architectures. Providing a way to make those
thus shouldn't be something "temporary, until a real allocator
exists" but rather a well-designed API that's there to stay.
- Except for iGPUs, the usual way to populate a GPU buffer would be to
first copy the data to some host-accessible scratch buffer and then
do a GPU-side copy of that buffer to a device-local memory. The
scratch buffer is very likely to have a vastly different
suballocation scheme than GPU buffers (grow & discard everything
once it's all uploaded, for example) so again trying to put the two
under the same allocator umbrella doesn't make sense.
Thus:
- To avoid implementing a full-blown allocator right from the start,
we'll first provide convenience APIs only for dedicated allocations
-- making it possible to transfer memory ownership to an
Image/Buffer so it can be treated the same way as in GL, and later
having the Image/Buffer constructor implicitly allocate a dedicated
VkDeviceMemory.
- This default allocation will be subsequently equipped with
KHR_dedicated_allocation bits.
- Thanks to the extensible/layered nature of the design, the user is
still capable of being completely in control of allocations,
managing VkDeviceMemory sub-allocations by hand.
Finally, once allocator APIs are figured out, the default Buffer/Image
behavior gets switched from a dedicated allocation to using an
allocator, and dedicated allocation will be only used if the
KHR_dedicated_allocation bit is requested.
6 years ago
|
|
|
Image.cpp
|
|
|
|
|
ImageView.cpp
|
|
|
|
|
LayerProperties.cpp
|
|
|
|
|
Memory.cpp
|
|
|
|
|
RenderPass.cpp)
|
|
|
|
|
|
|
|
|
|
set(MagnumVk_HEADERS
|
|
|
|
|
Assert.h
|
|
|
|
|
Buffer.h
|
|
|
|
|
BufferCreateInfo.h
|
|
|
|
|
CommandBuffer.h
|
|
|
|
|
CommandPool.h
|
|
|
|
|
CommandPoolCreateInfo.h
|
|
|
|
|
Device.h
|
|
|
|
|
DeviceCreateInfo.h
|
|
|
|
|
DeviceFeatures.h
|
|
|
|
|
DeviceProperties.h
|
|
|
|
|
Enums.h
|
|
|
|
|
Extensions.h
|
|
|
|
|
ExtensionProperties.h
|
|
|
|
|
Handle.h
|
|
|
|
|
Image.h
|
|
|
|
|
ImageCreateInfo.h
|
|
|
|
|
ImageView.h
|
|
|
|
|
ImageViewCreateInfo.h
|
|
|
|
|
Instance.h
|
|
|
|
|
InstanceCreateInfo.h
|
|
|
|
|
Integration.h
|
|
|
|
|
LayerProperties.h
|
|
|
|
|
Memory.h
|
|
|
|
|
MemoryAllocateInfo.h
|
|
|
|
|
Queue.h
|
|
|
|
|
RenderPass.h
|
|
|
|
|
RenderPassCreateInfo.h
|
|
|
|
|
Result.h
|
|
|
|
|
Shader.h
|
|
|
|
|
ShaderCreateInfo.h
|
|
|
|
|
TypeTraits.h
|
|
|
|
|
Version.h
|
|
|
|
|
Vk.h
|
|
|
|
|
Vulkan.h
|
|
|
|
|
|
|
|
|
|
visibility.h)
|
|
|
|
|
|
|
|
|
|
set(MagnumVk_PRIVATE_HEADERS
|
|
|
|
|
Implementation/Arguments.h
|
|
|
|
|
Implementation/DeviceFeatures.h
|
|
|
|
|
Implementation/DeviceState.h
|
|
|
|
|
Implementation/InstanceState.h
|
|
|
|
|
|
|
|
|
|
Implementation/compressedPixelFormatMapping.hpp
|
|
|
|
|
Implementation/deviceFeatureMapping.hpp
|
|
|
|
|
Implementation/pixelFormatMapping.hpp
|
|
|
|
|
Implementation/structureHelpers.h
|
|
|
|
|
Implementation/vertexFormatMapping.hpp)
|
|
|
|
|
|
|
|
|
|
# Objects shared between main and test library
|
|
|
|
|
add_library(MagnumVkObjects OBJECT
|
|
|
|
|
${MagnumVk_SRCS}
|
|
|
|
|
${MagnumVk_HEADERS}
|
|
|
|
|
${MagnumVk_PRIVATE_HEADERS})
|
|
|
|
|
target_include_directories(MagnumVkObjects PUBLIC
|
|
|
|
|
$<TARGET_PROPERTY:Magnum,INTERFACE_INCLUDE_DIRECTORIES>)
|
|
|
|
|
if(NOT BUILD_STATIC)
|
|
|
|
|
target_compile_definitions(MagnumVkObjects PRIVATE "MagnumVkObjects_EXPORTS" "FlextVk_EXPORTS")
|
|
|
|
|
endif()
|
|
|
|
|
if(NOT BUILD_STATIC OR BUILD_STATIC_PIC)
|
|
|
|
|
set_target_properties(MagnumVkObjects PROPERTIES POSITION_INDEPENDENT_CODE ON)
|
|
|
|
|
endif()
|
|
|
|
|
set_target_properties(MagnumVkObjects PROPERTIES FOLDER "Magnum/Vk")
|
|
|
|
|
|
|
|
|
|
# Vk library
|
|
|
|
|
add_library(MagnumVk ${SHARED_OR_STATIC}
|
|
|
|
|
$<TARGET_OBJECTS:MagnumVkObjects>
|
|
|
|
|
$<TARGET_OBJECTS:MagnumFlextVkObjects>
|
|
|
|
|
${MagnumVk_GracefulAssert_SRCS})
|
|
|
|
|
set_target_properties(MagnumVk PROPERTIES
|
|
|
|
|
DEBUG_POSTFIX "-d"
|
|
|
|
|
FOLDER "Magnum/Vk")
|
|
|
|
|
if(NOT BUILD_STATIC)
|
|
|
|
|
target_compile_definitions(MagnumVk PRIVATE "FlextVk_EXPORTS")
|
|
|
|
|
set_target_properties(MagnumVk PROPERTIES VERSION ${MAGNUM_LIBRARY_VERSION} SOVERSION ${MAGNUM_LIBRARY_SOVERSION})
|
|
|
|
|
elseif(BUILD_STATIC_PIC)
|
|
|
|
|
set_target_properties(MagnumVk PROPERTIES POSITION_INDEPENDENT_CODE ON)
|
|
|
|
|
endif()
|
|
|
|
|
target_include_directories(MagnumVk PUBLIC
|
|
|
|
|
${PROJECT_SOURCE_DIR}/src
|
|
|
|
|
${PROJECT_BINARY_DIR}/src)
|
|
|
|
|
target_link_libraries(MagnumVk PUBLIC
|
|
|
|
|
Magnum
|
|
|
|
|
Vulkan::Vulkan)
|
|
|
|
|
|
|
|
|
|
install(TARGETS MagnumVk
|
|
|
|
|
RUNTIME DESTINATION ${MAGNUM_BINARY_INSTALL_DIR}
|
|
|
|
|
LIBRARY DESTINATION ${MAGNUM_LIBRARY_INSTALL_DIR}
|
|
|
|
|
ARCHIVE DESTINATION ${MAGNUM_LIBRARY_INSTALL_DIR})
|
|
|
|
|
install(FILES ${MagnumVk_HEADERS} DESTINATION ${MAGNUM_INCLUDE_INSTALL_DIR}/Vk)
|
|
|
|
|
|
|
|
|
|
if(WITH_VK_INFO)
|
|
|
|
|
add_executable(magnum-vk-info vk-info.cpp)
|
|
|
|
|
target_link_libraries(magnum-vk-info PRIVATE MagnumVk)
|
|
|
|
|
set_target_properties(magnum-vk-info PROPERTIES FOLDER "Magnum/Vk")
|
|
|
|
|
|
|
|
|
|
install(TARGETS magnum-vk-info DESTINATION ${MAGNUM_BINARY_INSTALL_DIR})
|
|
|
|
|
|
|
|
|
|
# Magnum Vk Info target alias for superprojects
|
|
|
|
|
add_executable(Magnum::vk-info ALIAS magnum-vk-info)
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(WITH_VULKANTESTER)
|
|
|
|
|
if(NOT TARGET_VK)
|
|
|
|
|
message(SEND_ERROR "VulkanTester is available only if TARGET_VK is enabled")
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
find_package(Corrade REQUIRED TestSuite)
|
|
|
|
|
|
|
|
|
|
set(MagnumVulkanTester_SRCS VulkanTester.cpp)
|
|
|
|
|
set(MagnumVulkanTester_HEADERS VulkanTester.h)
|
|
|
|
|
|
|
|
|
|
# Unlike with OpenGLTester, we shouldn't need a separate library that links
|
|
|
|
|
# exclusively to MagnumVkTestLib as there is no global state that could
|
|
|
|
|
# cause problems on Windows.
|
|
|
|
|
add_library(MagnumVulkanTester STATIC
|
|
|
|
|
${MagnumVulkanTester_SRCS}
|
|
|
|
|
${MagnumVulkanTester_HEADERS})
|
|
|
|
|
set_target_properties(MagnumVulkanTester PROPERTIES
|
|
|
|
|
DEBUG_POSTFIX "-d"
|
|
|
|
|
FOLDER "Magnum/Vk")
|
|
|
|
|
target_link_libraries(MagnumVulkanTester PUBLIC MagnumVk Corrade::TestSuite)
|
|
|
|
|
|
|
|
|
|
install(FILES ${MagnumVulkanTester_HEADERS} DESTINATION ${MAGNUM_INCLUDE_INSTALL_DIR}/Vk)
|
|
|
|
|
install(TARGETS MagnumVulkanTester
|
|
|
|
|
RUNTIME DESTINATION ${MAGNUM_BINARY_INSTALL_DIR}
|
|
|
|
|
LIBRARY DESTINATION ${MAGNUM_LIBRARY_INSTALL_DIR}
|
|
|
|
|
ARCHIVE DESTINATION ${MAGNUM_LIBRARY_INSTALL_DIR})
|
|
|
|
|
|
|
|
|
|
# Magnum VulkanTester target alias for superprojects
|
|
|
|
|
add_library(Magnum::VulkanTester ALIAS MagnumVulkanTester)
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
if(BUILD_TESTS)
|
|
|
|
|
# Library with graceful assert for testing
|
|
|
|
|
add_library(MagnumVkTestLib ${SHARED_OR_STATIC}
|
|
|
|
|
$<TARGET_OBJECTS:MagnumVkObjects>
|
|
|
|
|
$<TARGET_OBJECTS:MagnumFlextVkObjects>
|
|
|
|
|
${MagnumVk_GracefulAssert_SRCS})
|
|
|
|
|
set_target_properties(MagnumVkTestLib PROPERTIES
|
|
|
|
|
DEBUG_POSTFIX "-d"
|
|
|
|
|
FOLDER "Magnum/Vk")
|
|
|
|
|
target_compile_definitions(MagnumVkTestLib PRIVATE
|
|
|
|
|
"CORRADE_GRACEFUL_ASSERT" "MagnumVk_EXPORTS" "FlextVk_EXPORTS")
|
|
|
|
|
if(BUILD_STATIC_PIC)
|
|
|
|
|
set_target_properties(MagnumVkTestLib PROPERTIES POSITION_INDEPENDENT_CODE ON)
|
|
|
|
|
endif()
|
|
|
|
|
target_link_libraries(MagnumVkTestLib PUBLIC
|
|
|
|
|
Magnum
|
|
|
|
|
Vulkan::Vulkan)
|
|
|
|
|
|
|
|
|
|
add_subdirectory(Test)
|
|
|
|
|
endif()
|
|
|
|
|
|
|
|
|
|
# Magnum Vk library target alias for superprojects
|
|
|
|
|
add_library(Magnum::Vk ALIAS MagnumVk)
|