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.
8479 Commits
21 Branches
19 Tags
70 MiB
Tree: fa31077789
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fa31077789'
${ noResults }
magnum/doc/vulkan-mapping.dox

655 lines
38 KiB
Raw Normal View History Unescape

Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
/*
This file is part of Magnum.
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
2020 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.
*/
namespace Magnum { namespace Vk {
doc: list all current Vulkan structures in the mapping tables.
6 years ago
/** @page vulkan-mapping Command and structure mapping
@brief List of Vulkan commands and structures corresponding to particular Magnum APIs.
@m_since_latest
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@tableofcontents
@m_footernavigation
Legend:
- @m_class{m-label m-flat m-success} **X.Y** --- given feature is new in
Vulkan version X.Y
- @m_class{m-label m-flat m-success} **ABC, X.Y** --- given feature is
exposed though an ABC extension and then promoted to Vulkan version X.Y;
both the extension and the core entrypoints are available
- @m_class{m-label m-flat m-warning} **ABC** --- given feature is
exposed though an ABC extension
- @m_class{m-label m-danger} **deprecated** --- given feature is deprecated
in newer versions of Vulkan and replaced by different functionality
@section vulkan-mapping-functions Functions
@subsection vulkan-mapping-functions-a A
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
Vk: command buffer allocation.
6 years ago
@fn_vk{AllocateCommandBuffers}, \n @fn_vk{FreeCommandBuffers} | @ref CommandPool::allocate(), @ref CommandBuffer destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{AllocateDescriptorSets}, \n @fn_vk{FreeDescriptorSets} | |
Vk: initial memory allocation.
6 years ago
@fn_vk{AllocateMemory}, \n @fn_vk{FreeMemory} | @ref Memory constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@subsection vulkan-mapping-functions-b B
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{BeginCommandBuffer}, \n \fn_vk{EndCommandBuffer} | |
Vk: Shader wrapper. This was easy ... except for the fun with taking ownership of the binary. And it led to me inventing CORRADE_INTERNAL_ASSERT_EXPRESSION().
6 years ago
@fn_vk{BindBufferMemory}, \n @fn_vk{BindBufferMemory2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref Buffer::bindMemory()
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
@fn_vk{BindImageMemory}, \n @fn_vk{BindImageMemory2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref Image::bindMemory()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@subsection vulkan-mapping-functions-c C
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{CmdBeginQuery}, \n @fn_vk{CmdEndQuery} | |
@fn_vk{CmdBeginDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{CmdEndebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CmdBeginRenderPass}, \n @fn_vk{CmdBeginRenderPass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{CmdEndRenderpass}, \n @fn_vk{CmdEndRenderpass2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{CmdBindDescriptorSets} | |
@fn_vk{CmdBindIndexBuffer} | |
@fn_vk{CmdBindPipeline} | |
@fn_vk{CmdBindVertexBuffers} | |
@fn_vk{CmdBlitImage} | |
@fn_vk{CmdClearAttachments} | |
@fn_vk{CmdClearColorImage} | |
@fn_vk{CmdClearDepthStencilImage} | |
@fn_vk{CmdCopyBuffer} | |
@fn_vk{CmdCopyBufferToImage} | |
@fn_vk{CmdCopyImage} | |
@fn_vk{CmdCopyImageToBuffer} | |
@fn_vk{CmdCopyQueryPoolResults} | |
@fn_vk{CmdDebugMarkerBeginEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{CmdDebugMarkerEndEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CmdDebugMarkerInsertEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CmdDispatch} | |
@fn_vk{CmdDispatchBase} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{CmdDispatchIndirect} | |
@fn_vk{CmdDraw} | |
@fn_vk{CmdDrawIndexed} | |
@fn_vk{CmdDrawIndexedIndirect} | |
@fn_vk{CmdDrawIndexedIndirectCount} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{CmdDrawIndirect} | |
@fn_vk{CmdDrawIndirectCount} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{CmdExecuteCommands} | |
@fn_vk{CmdFillBuffer} | |
@fn_vk{CmdInsertDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CmdNextSubpass}, \n @fn_vk{CmdNextSubpass2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{CmdPipelineBarrier} | |
@fn_vk{CmdPushConstants} | |
@fn_vk{CmdResetEvent} | |
@fn_vk{CmdResetQueryPool} | |
@fn_vk{CmdResolveImage} | |
@fn_vk{CmdSetBlendConstants} | |
@fn_vk{CmdSetDepthBias} | |
@fn_vk{CmdSetDeviceMask} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{CmdSetDepthBounds} | |
@fn_vk{CmdSetEvent} | |
@fn_vk{CmdSetLineWidth} | |
@fn_vk{CmdSetScissor} | |
@fn_vk{CmdSetStencilCompareMask} | |
@fn_vk{CmdSetStencilReference} | |
@fn_vk{CmdSetStencilWriteMask} | |
@fn_vk{CmdSetViewport} | |
@fn_vk{CmdUpdateBuffer} | |
@fn_vk{CmdWaitEvents} | |
@fn_vk{CmdWriteTimestamp} | |
Vk: initial Buffer wrapper. Basically the same as with Image, but easier.
6 years ago
@fn_vk{CreateBuffer}, \n @fn_vk{DestroyBuffer} | @ref Buffer constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{CreateBufferView}, \n @fn_vk{DestroyBufferView} | |
Vk: command pool creation.
6 years ago
@fn_vk{CreateCommandPool}, \n @fn_vk{DestroyCommandPool} | @ref CommandPool constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{CreateComputePipelines}, \n @fn_vk{DestroyComputePipelines} | |
@fn_vk{CreateDebugReportCallbackEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{DestroyDebugReportCallbackEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CreateDebugUtilsMessengerEXT} @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{DestroyDebugUtilsMessengerEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{CreateDescriptorPool}, \n @fn_vk{DestroyDescriptorPool} | |
@fn_vk{CreateDescriptorSetLayout}, \n @fn_vk{DestroyDescriptorSetLayout} | |
@fn_vk{CreateDescriptorUpdateTemplate} @m_class{m-label m-flat m-success} **KHR, 1.1**, \n @fn_vk{DestroyDescriptorUpdateTemplate} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
Vk: device creation.
6 years ago
@fn_vk{CreateDevice}, \n @fn_vk{DestroyDevice} | @ref Device constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{CreateEvent}, \n @fn_vk{DestroyEvent} | |
@fn_vk{CreateFence}, \n @fn_vk{DestroyFence} | |
@fn_vk{CreateFramebuffer}, \n @fn_vk{DestroyFramebuffer} | |
Vk: add an Image wrapper. Not exactly sure about the usage, so no docs yet. Will come once memory allocation is complete.
6 years ago
@fn_vk{CreateImage}, \n @fn_vk{DestroyImage} | @ref Image constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{CreateImageView}, \n @fn_vk{DestroyImageView} | |
Vk: instance creation.
6 years ago
@fn_vk{CreateInstance}, \n @fn_vk{DestroyInstance} | @ref Instance constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{CreatePipeline}, \n @fn_vk{DestroyPipeline} | |
@fn_vk{CreatePipelineCache}, \n @fn_vk{DestroyPipelineCache} | |
@fn_vk{CreatePipelineLayout}, \n @fn_vk{DestroyPipelineLayout} | |
@fn_vk{CreateQueryPool}, \n @fn_vk{DestroyQueryPool} | |
@fn_vk{CreateRenderPass}, \n @fn_vk{CreateRenderPass2} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{DestroyRenderPass} | |
@fn_vk{CreateSampler}, \n @fn_vk{DestroySampler} | |
@fn_vk{CreateSamplerYcbcrConversion} @m_class{m-label m-flat m-success} **KHR, 1.1** , \n @fn_vk{DestroySamplerYcbcrConversion} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{CreateSemaphore}, \n @fn_vk{DestroySemaphore} | |
Vk: Shader wrapper. This was easy ... except for the fun with taking ownership of the binary. And it led to me inventing CORRADE_INTERNAL_ASSERT_EXPRESSION().
6 years ago
@fn_vk{CreateShaderModule}, \n @fn_vk{DestroyShaderModule} | @ref Shader constructor and destructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@subsection vulkan-mapping-functions-d D
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{DeviceWaitIdle} | |
@fn_vk{DebugMarkerSetObjectNameEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{DebugMarkerSetObjectTagEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{DebugReportMessageEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@subsection vulkan-mapping-functions-e E
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{EnumerateDeviceLayerProperties} @m_class{m-label m-danger} **deprecated in 1.0.13** | not exposed, [spec commit](https://github.com/KhronosGroup/Vulkan-Docs/commit/2656f459333b3a1dc63619a9ebd83490eea22e93)
Vk: device extension enumeration.
6 years ago
@fn_vk{EnumerateDeviceExtensionProperties} | @ref DeviceProperties::enumerateExtensionProperties()
Vk: enumerating instance extension properties. Device extension properties will reuse a large part of this API.
6 years ago
@fn_vk{EnumerateInstanceExtensionProperties} | @ref enumerateInstanceExtensionProperties()
Vk: enumerating layer properties. Instance layers, with the same interface designed to be reused for device-level layers.
6 years ago
@fn_vk{EnumerateInstanceLayerProperties} | @ref enumerateLayerProperties()
Vk: retrieving instance version.
6 years ago
@fn_vk{EnumerateInstanceVersion} @m_class{m-label m-flat m-success} **1.1** | @ref enumerateInstanceVersion()
Vk: initial device enumeration.
6 years ago
@fn_vk{EnumeratePhysicalDevices} | @ref enumerateDevices()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{EnumeratePhysicalDeviceGroups} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@subsection vulkan-mapping-functions-f F
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{FlushMappedMemoryRanges} | |
@subsection vulkan-mapping-functions-g G
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{GetBufferDeviceAddress} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{GetBufferOpaqueCaptureAddress} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{GetDeviceMemoryOpaqueCaptureAddress} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
Vk: querying buffer memory requirements.
6 years ago
@fn_vk{GetBufferMemoryRequirements}, \n @fn_vk{GetBufferMemoryRequirements2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref Buffer::memoryRequirements()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{GetDescriptorSetLayoutSupport} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetDeviceGroupPeerMemoryFeatures} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetDeviceMemoryCommitment} | |
Vk: device creation.
6 years ago
@fn_vk{GetDeviceProcAddr} | @ref Device constructor
Vk: a non-error-prone way to retrieve queues after device creation. I wonder why this couldn't be done this way in the Vulkan API directly.
6 years ago
@fn_vk{GetDeviceQueue}, \n @fn_vk{GetDeviceQueue2} @m_class{m-label m-flat m-success} **1.1** | @ref Device constructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{GetEventStatus} | |
@fn_vk{GetFenceStatus} | |
Vk: querying image memory requirements.
6 years ago
@fn_vk{GetImageMemoryRequirements}, \n @fn_vk{GetImageMemoryRequirements2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref Image::memoryRequirements()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{GetImageSparseMemoryRequirements}, \n @fn_vk{GetImageSparseMemoryRequirements2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetImageSubresourceLayout} | |
Vk: instance creation.
6 years ago
@fn_vk{GetInstanceProcAddr} | @ref Instance constructor
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{GetPhysicalDeviceExternalBufferProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPhysicalDeviceExternalFenceProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPhysicalDeviceExternalSemaphoreProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPhysicalDeviceFeatures}, \n @fn_vk{GetPhysicalDeviceFeatures2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPhysicalDeviceFormatProperties}, \n @fn_vk{GetPhysicalDeviceFormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPhysicalDeviceImageFormatProperties}, \n @fn_vk{GetPhysicalDeviceImageFormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
Vk: querying device memory heaps and types. Memory type flags are put into a new, separate Memory.h header as those will be needed more often than the (ever-growing) DeviceProperties -- from Image and Buffer constructors, in particular.
6 years ago
@fn_vk{GetPhysicalDeviceMemoryProperties}, \n @fn_vk{GetPhysicalDeviceMemoryProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties::memoryProperties()
Vk: initial device enumeration.
6 years ago
@fn_vk{GetPhysicalDeviceProperties}, \n @fn_vk{GetPhysicalDeviceProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties
Vk: querying device queue family properties.
6 years ago
@fn_vk{GetPhysicalDeviceQueueFamilyProperties}, \n @fn_vk{GetPhysicalDeviceQueueFamilyProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties::queueFamilyProperties()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{GetPhysicalDeviceSparseImageFormatProperties}, \n @fn_vk{GetPhysicalDeviceSparseImageFormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@fn_vk{GetPipelineCacheData} | |
@fn_vk{GetQueryPoolResults} | |
@fn_vk{GetRenderAreaGranularity} | |
@fn_vk{GetSemaphoreCounterValue} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@subsection vulkan-mapping-functions-i I
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{InvalidateMappedMemoryRanges} | |
@subsection vulkan-mapping-functions-m M
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
doc: forgot to list this Vulkan API. ... and Doxygen is shitty once again, totally ignoring the doc block on a forward declaration. FFS.
5 years ago
@fn_vk{MapMemory}, \n @fn_vk{UnmapMemory} | @ref Memory::map(), @ref MemoryMapDeleter
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{MergePipelineCaches} | |
@subsection vulkan-mapping-functions-q Q
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{QueueBeginDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT**, \n @fn_vk{QueueEndDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{QueueBindSparse} | |
@fn_vk{QueueInsertDebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{QueueSubmit} | |
@fn_vk{QueueWaitIdle} | |
@subsection vulkan-mapping-functions-r R
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
Vk: command pool and buffer reset.
6 years ago
@fn_vk{ResetCommandBuffer} | @ref CommandBuffer::reset()
@fn_vk{ResetCommandPool} | @ref CommandPool::reset()
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
@fn_vk{ResetDescriptorPool} | |
@fn_vk{ResetFences} | |
@fn_vk{ResetQueryPool} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@subsection vulkan-mapping-functions-s S
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{SetDebugUtilsObjectNameEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{SetDebugUtilsObjectTagEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@fn_vk{SetEvent}, \n @fn_vk{ResetEvent} | |
@fn_vk{SignalSemaphore} @m_class{m-label m-flat m-success} **KHR, 1.2**, \n @fn_vk{WaitSemaphores} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@fn_vk{SubmitDebugUtilsMessageEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@subsection vulkan-mapping-functions-t T
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{TrimCommandPool} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@subsection vulkan-mapping-functions-u U
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{UpdateDescriptorSets} | |
@fn_vk{UpdateDescriptorSetWithTemplate} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@subsection vulkan-mapping-functions-w W
@m_class{m-fullwidth}
Vulkan function | Matching API
--------------------------------------- | ------------
@fn_vk{WaitForFences} | |
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@section vulkan-mapping-structures Structures
Vk: instance creation.
6 years ago
@subsection vulkan-mapping-structures-a A
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{AllocationCallbacks} | intentionally @ref vulkan-wrapping-host-allocation "not exposed"
Vk: instance creation.
6 years ago
@type_vk{ApplicationInfo} | @ref InstanceCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{AttachmentDescription}, \n @type_vk{AttachmentDescription2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{AttachmentDescriptionStencilLayout} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{AttachmentReference}, \n @type_vk{AttachmentReference2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{AttachmentReferenceStencilLayout} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
Vk: instance creation.
6 years ago
Vk: initial Buffer wrapper. Basically the same as with Image, but easier.
6 years ago
@subsection vulkan-mapping-structures-b B
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{BindBufferMemoryDeviceGroupInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{BindBufferMemoryInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{BindImageMemoryDeviceGroupInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{BindImageMemoryInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{BindImagePlaneMemoryInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{BaseInStructure} | |
@type_vk{BaseOutStructure} | |
@type_vk{BindSparseInfo} | |
@type_vk{BufferCopy} | |
Vk: initial Buffer wrapper. Basically the same as with Image, but easier.
6 years ago
@type_vk{BufferCreateInfo} | @ref BufferCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{BufferDeviceAddressInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{BufferImageCopy} | |
@type_vk{BufferMemoryBarrier} | |
@type_vk{BufferMemoryRequirementsInfo}, \n @type_vk{BufferMemoryRequirementsInfo2} @m_class{m-label m-flat m-success} **KHR, 1.1** | not exposed, internal to @ref Buffer::memoryRequirements()
@type_vk{BufferOpaqueCaptureAddressCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{BufferViewCreateInfo} | |
Vk: initial Buffer wrapper. Basically the same as with Image, but easier.
6 years ago
Vk: command pool creation.
6 years ago
@subsection vulkan-mapping-structures-c C
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{ClearAttachment} | |
@type_vk{ClearColorValue} | convertible from/to @ref Magnum::Vector3 "Vector3", @ref Magnum::Color3 "Color3", @ref Magnum::Vector4 "Vector4", @ref Magnum::Color4 "Color4", @ref Magnum::Vector4i "Vector4i", @ref Magnum::Vector4ui "Vector4ui" using @ref Magnum/Vk/Integration.h
@type_vk{ClearDepthStencilValue} | |
@type_vk{ClearValue} | |
@type_vk{ClearRect} | convertible from/to @ref Range3Di using @ref Magnum/Vk/Integration.h
Vk: command buffer allocation.
6 years ago
@type_vk{CommandBufferAllocateInfo} | not exposed, internal to @ref CommandPool::allocate()
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{CommandBufferBeginInfo} | |
@type_vk{CommandBufferInheritanceInfo} | |
Vk: command pool creation.
6 years ago
@type_vk{CommandPoolCreateInfo} | @ref CommandPoolCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{ComponentMapping} | |
@type_vk{ComputePipelineCreateInfo} | |
@type_vk{ConformanceVersion} | |
@type_vk{CopyDescriptorSet} | |
Vk: command pool creation.
6 years ago
Vk: device creation.
6 years ago
@subsection vulkan-mapping-structures-d D
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{DebugMarkerMarkerInfoEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugMarkerObjectNameInfoEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugMarkerObjectTagInfoEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugReportCallbackCreateInfoEXT} @m_class{m-label m-danger} **deprecated** @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugUtilsLabelEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugUtilsMessengerCallbackDataEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugUtilsMessengerCreateInfoEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugUtilsObjectNameInfoEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DebugUtilsObjectTagInfoEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{DescriptorBufferInfo} | |
@type_vk{DescriptorImageInfo} | |
@type_vk{DescriptorPoolCreateInfo} | |
@type_vk{DescriptorPoolSize} | |
@type_vk{DescriptorSetAllocateInfo} | |
@type_vk{DescriptorSetLayoutBinding} | |
@type_vk{DescriptorSetLayoutBindingFlagsCreateInfo} | |
@type_vk{DescriptorSetLayoutCreateInfo} | |
@type_vk{DescriptorSetLayoutBindingFlagsCreateInfo} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{DescriptorSetLayoutSupport} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DescriptorSetVariableDescriptorCountAllocateInfo} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{DescriptorSetVariableDescriptorCountLayoutSupport} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{DescriptorUpdateTemplateEntry} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DescriptorUpdateTemplateCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
Vk: device creation.
6 years ago
@type_vk{DeviceCreateInfo} | @ref DeviceCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{DeviceGroupBindSparseInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DeviceGroupCommandBufferBeginInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DeviceGroupDeviceCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DeviceGroupRenderPassBeginInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DeviceGroupSubmitInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{DeviceMemoryOpaqueCaptureAddressInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
Vk: Doxygen continues to be a massively underwhelming disappointment. Nope, it's 2020 and there's still no way to link to &-qualified functions. Feature that is in C++ since 2011.
6 years ago
@type_vk{DeviceQueueCreateInfo} | not exposed, but you can pass a custom instance to @ref DeviceCreateInfo::addQueues()
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{DeviceQueueInfo2} | not exposed, internal to @ref Device constructor
@type_vk{DispatchIndirectCommand} | |
@type_vk{DrawIndirectCommand} | |
@type_vk{DrawIndexedIndirectCommand} | |
@subsection vulkan-mapping-structures-e E
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{EventCreateInfo} | |
@type_vk{ExportFenceCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExportMemoryAllocateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExportSemaphoreCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExtensionProperties} | @ref ExtensionProperties
@type_vk{Extent2D} | convertible from/to @ref Magnum::Vector2i "Vector2i" using @ref Magnum/Vk/Integration.h
@type_vk{Extent3D} | convertible from/to @ref Magnum::Vector3i "Vector3i" using @ref Magnum/Vk/Integration.h
@type_vk{ExternalBufferProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalFenceProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalImageFormatProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalSemaphoreProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalMemoryBufferCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalMemoryImageCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ExternalMemoryProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@subsection vulkan-mapping-structures-f F
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{FenceCreateInfo} | |
@type_vk{FormatProperties}, \n @type_vk{FormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{FramebufferAttachmentsCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{FramebufferAttachmentImageInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{FramebufferCreateInfo} | |
@subsection vulkan-mapping-structures-g G
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{GraphicsPipelineCreateInfo} | |
Vk: device creation.
6 years ago
Vk: instance creation.
6 years ago
@subsection vulkan-mapping-structures-i I
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{ImageBlit} | |
@type_vk{ImageCopy} | |
Vk: add an Image wrapper. Not exactly sure about the usage, so no docs yet. Will come once memory allocation is complete.
6 years ago
@type_vk{ImageCreateInfo} | @ref ImageCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{ImageFormatListCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{ImageFormatProperties}, \n @type_vk{ImageFormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ImageSubresourceRange} | |
@type_vk{ImageMemoryBarrier} | |
@type_vk{ImageMemoryRequirementsInfo}, \n @type_vk{ImageMemoryRequirementsInfo2} @m_class{m-label m-flat m-success} **KHR, 1.1** | not exposed, internal to @ref Image::memoryRequirements()
@type_vk{ImagePlaneMemoryRequirementsInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ImageResolve} | |
@type_vk{ImageSparseMemoryRequirementsInfo2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{ImageStencilUsageCreateInfo} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{ImageViewCreateInfo} | |
@type_vk{ImageViewUsageCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{InputAttachmentAspectReference} | |
Vk: instance creation.
6 years ago
@type_vk{InstanceCreateInfo} | @ref InstanceCreateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@subsection vulkan-mapping-structures-l L
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{LayerProperties} | @ref LayerProperties
Vk: initial memory allocation.
6 years ago
@subsection vulkan-mapping-structures-m M
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{MappedMemoryRange} | |
Vk: initial memory allocation.
6 years ago
@type_vk{MemoryAllocateInfo} | @ref MemoryAllocateInfo
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{MemoryAllocateFlagsInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{MemoryBarrier} | |
@type_vk{MemoryDedicatedAllocateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{MemoryDedicatedRequirements} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{MemoryHeap} | @ref DeviceProperties::memoryHeapSize(), \n @ref DeviceProperties::memoryHeapFlags()
@type_vk{MemoryOpaqueCaptureAddressAllocateInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{MemoryRequirements}, \n @type_vk{MemoryRequirements2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref MemoryRequirements
@type_vk{MemoryType} | @ref DeviceProperties::memoryFlags(), \n @ref DeviceProperties::memoryHeapIndex()
@subsection vulkan-mapping-structures-o O
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{Offset2D} | convertible from/to @ref Magnum::Vector2i "Vector2i" using @ref Magnum/Vk/Integration.h
@type_vk{Offset3D} | convertible from/to @ref Magnum::Vector3i "Vector3i" using @ref Magnum/Vk/Integration.h
@subsection vulkan-mapping-structures-p P
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{PhysicalDevice8bitStorageFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDevice16bitStorageFeatures} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceBufferDeviceAddressFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceDepthStencilResolveProperties} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceDescriptorIndexingFeatures} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{PhysicalDeviceDescriptorIndexingProperties} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{PhysicalDeviceDriverProperties} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceExternalBufferInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceExternalFenceInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceExternalImageFormatInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceExternalSemaphoreInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceFeatures}, \n @type_vk{PhysicalDeviceFeatures2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceFloat16Int8Features} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceFloatControlsProperties} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceGroupProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceHostQueryResetFeatures} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{PhysicalDeviceIDProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceImageFormatInfo2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceImagelessFramebufferFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceIndexTypeUint8FeaturesEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{PhysicalDeviceTextureCompressionASTCHDRFeaturesEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{PhysicalDeviceLimits} | |
@type_vk{PhysicalDeviceMaintenance3Properties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceMemoryProperties}, \n @type_vk{PhysicalDeviceMemoryProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties
@type_vk{PhysicalDeviceMultiviewFeatures} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceMultiviewProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDevicePointClippingProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceProperties}, \n @type_vk{PhysicalDeviceProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties
@type_vk{PhysicalDeviceProtectedMemoryFeatures} @m_class{m-label m-flat m-success} **1.1** | |
@type_vk{PhysicalDeviceProtectedMemoryProperties} @m_class{m-label m-flat m-success} **1.1** | |
@type_vk{PhysicalDeviceSamplerFilterMinmaxProperties} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{PhysicalDeviceSamplerYcbcrConversionFeatures} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceSeparateDepthStencilLayoutsFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceScalarBlockLayoutFeatures} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{PhysicalDeviceShaderAtomicInt64Features} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceShaderDrawParametersFeatures} @m_class{m-label m-flat m-success} **1.1** | |
@type_vk{PhysicalDeviceShaderFloat16Int8Features} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceShaderSubgroupExtendedTypesFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceSparseImageFormatInfo2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceSparseProperties} | |
@type_vk{PhysicalDeviceSubgroupProperties} @m_class{m-label m-flat m-success} **1.1** | |
@type_vk{PhysicalDeviceTimelineSemaphoreFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceTimelineSemaphoreProperties} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceUniformBufferStandardLayoutFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PhysicalDeviceVariablePointersFeatures} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PhysicalDeviceVulkan11Features} @m_class{m-label m-flat m-success} **1.2** | ignored for compatibility reasons
@type_vk{PhysicalDeviceVulkan11Properties} @m_class{m-label m-flat m-success} **1.2** | ignored for compatibility reasons
@type_vk{PhysicalDeviceVulkan12Features} @m_class{m-label m-flat m-success} **1.2** | ignored for compatibility reasons
@type_vk{PhysicalDeviceVulkan12Properties} @m_class{m-label m-flat m-success} **1.2** | ignored for compatibility reasons
@type_vk{PhysicalDeviceVulkanMemoryModelFeatures} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{PipelineCacheCreateInfo} | |
@type_vk{PipelineColorBlendAttachmentState} | |
@type_vk{PipelineColorBlendStateCreateInfo} | |
@type_vk{PipelineDepthStencilStateCreateInfo} | |
@type_vk{PipelineDynamicStateCreateInfo} | |
@type_vk{PipelineInputAssemblyStateCreateInfo} | |
@type_vk{PipelineLayoutCreateInfo} | |
@type_vk{PipelineMultisampleStateCreateInfo} | |
@type_vk{PipelineRasterizationStateCreateInfo} | |
@type_vk{PipelineShaderStageCreateInfo} | |
@type_vk{PipelineTessellationStateCreateInfo} | |
@type_vk{PipelineTessellationDomainOriginStateCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{PipelineVertexInputStateCreateInfo} | |
@type_vk{PipelineViewportStateCreateInfo} | |
@type_vk{ProtectedSubmitInfo} | |
@type_vk{PushConstantRange} | |
@subsection vulkan-mapping-structures-q Q
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{QueryPoolCreateInfo} | |
@type_vk{QueueFamilyProperties}, \n @type_vk{QueueFamilyProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | @ref DeviceProperties::queueFamilyProperties(), \n @ref DeviceProperties::queueFamilyCount(), \n @ref DeviceProperties::queueFamilySize(), \n @ref DeviceProperties::queueFamilyFlags()
@subsection vulkan-mapping-structures-r R
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{Rect2D} | convertible from/to @ref Range2Di using @ref Magnum/Vk/Integration.h
@type_vk{RenderPassBeginInfo} | |
@type_vk{RenderPassAttachmentBeginInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{RenderPassCreateInfo}, \n @type_vk{RenderPassCreateInfo2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{RenderPassMultiviewCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{RenderPassInputAttachmentAspectCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
Vk: initial memory allocation.
6 years ago
Vk: Shader wrapper. This was easy ... except for the fun with taking ownership of the binary. And it led to me inventing CORRADE_INTERNAL_ASSERT_EXPRESSION().
6 years ago
@subsection vulkan-mapping-structures-s S
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
doc: list all current Vulkan structures in the mapping tables.
6 years ago
@type_vk{SamplerCreateInfo} | |
@type_vk{SamplerReductionModeCreateInfo} @m_class{m-label m-flat m-success} **EXT, 1.2** | |
@type_vk{SamplerYcbcrConversionCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{SamplerYcbcrConversionImageFormatProperties} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{SamplerYcbcrConversionInfo} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{SemaphoreCreateInfo} | |
@type_vk{SemaphoreSignalInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SemaphoreTypeCreateInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SemaphoreWaitInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{ShaderModuleCreateInfo} | @ref ShaderCreateInfo
@type_vk{SparseBufferMemoryBindInfo} | |
@type_vk{SparseImageFormatProperties}, \n @type_vk{SparseImageFormatProperties2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{SparseImageOpaqueMemoryBindInfo} | |
@type_vk{SparseImageMemoryBindInfo} | |
@type_vk{SparseImageMemoryBind} | |
@type_vk{SparseImageMemoryRequirements}, \n @type_vk{SparseImageMemoryRequirements2} @m_class{m-label m-flat m-success} **KHR, 1.1** | |
@type_vk{SparseMemoryBind} | |
@type_vk{SpecializationInfo} | |
@type_vk{SpecializationMapEntry} | |
@type_vk{StencilOpState} | |
@type_vk{SubmitInfo} | |
@type_vk{SubpassBeginInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SubpassEndInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SubpassDependency}, \n @type_vk{SubpassDependency2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SubpassDescription}, \n @type_vk{SubpassDescription2} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SubpassDescriptionDepthStencilResolve} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@type_vk{SubresourceLayout} | |
@subsection vulkan-mapping-structures-t T
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{TimelineSemaphoreSubmitInfo} @m_class{m-label m-flat m-success} **KHR, 1.2** | |
@subsection vulkan-mapping-structures-v V
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{ValidationFeaturesEXT} @m_class{m-label m-flat m-warning} **EXT** | |
@type_vk{VertexInputBindingDescription} | |
@type_vk{VertexInputAttributeDescription} | |
@type_vk{Viewport} | convertible from/to @ref Range3D using @ref Magnum/Vk/Integration.h
@subsection vulkan-mapping-structures-w W
@m_class{m-fullwidth}
Vulkan structure | Matching API
--------------------------------------- | ------------
@type_vk{WriteDescriptorSet} | |
Vk: Shader wrapper. This was easy ... except for the fun with taking ownership of the binary. And it led to me inventing CORRADE_INTERNAL_ASSERT_EXPRESSION().
6 years ago
Vk: expose all extensions for version 1.2. Also provide compile-time info with them, a runtime list and everything else similar to what's done for GL.
6 years ago
*/
}}