mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-21 03:40:21 +00:00
279452463a
* Update release number to 92. Public Issues: * Move and modify valid usage statements dealing with pname:aspectMask in flink:vkCmdClearColorImage, flink:vkCmdClearDepthStencilImage, and slink:VkClearAttachment, so they are in places where all necessary information is available (public issue 529). * Fix math markup in <<textures-texel-anisotropic-filtering, Texel Anisotropic Filtering>> (public pull request 840). * Fix misspellings (public pull request 845). Internal Issues: * Add installation instructions and a Makefile "`chunked`" target for chunked HTML generation (internal issue 1352). * Fix pipeline mesh diagram style; also fix a minor bug in the classic pipeline diagram where vertex/index buffers wrongly fed into the vertex shader (internal issue 1436). * Make asciidoctor ERROR output raise an error, and don't suppress executed command output from CI make invocation (internal issue 1454). * Minor typo fixes and clarifications for `VK_NV_raytracing`. * Cleanup extension-specific properties ** Remove duplicated documentation for pname:maxDiscardRectangles, pname:pointClippingBehavior, and pname:maxVertexAttribDivisor (they shouldn't be documented with the other members of slink:VkPhysicalDeviceLimits at all). ** Remove duplicate anchor for pname:maxVertexAttribDivisor ** Consistently document stext:VkPhysicalDevice<Extension>PropertiesKHR *** Always document pname:sType/pname:pNext (was inconsistent before) *** Always mention chaining to slink:VkPhysicalDeviceProperties2 (and not as slink:VkPhysicalDeviceProperties2KHR) *** Always include Valid Usage statements last * Update Makefile 'checklinks' target and associated scripts, and fix markup problems identified by checkLinks.py, so that we can rely on the checklinks script as part of Gitlab CI.
102 lines
4.6 KiB
Plaintext
102 lines
4.6 KiB
Plaintext
= Debugging
|
|
|
|
To aid developers in tracking down errors in the application's use of
|
|
Vulkan, particularly in combination with an external debugger or profiler,
|
|
_debugging extensions_ may be available.
|
|
|
|
[open,refpage='VkObjectType',desc='Specify an enumeration to track object handle types',type='enums']
|
|
--
|
|
|
|
The elink:VkObjectType enumeration defines values, each of which corresponds
|
|
to a specific Vulkan handle type.
|
|
These values can: be used to associate debug information with a particular
|
|
type of object through one or more extensions.
|
|
|
|
include::../api/enums/VkObjectType.txt[]
|
|
|
|
[[debugging-object-types]]
|
|
.VkObjectType and Vulkan Handle Relationship
|
|
[width="80%",cols="<35,<23",options="header"]
|
|
|====
|
|
| elink:VkObjectType | Vulkan Handle Type
|
|
| ename:VK_OBJECT_TYPE_UNKNOWN | Unknown/Undefined Handle
|
|
| ename:VK_OBJECT_TYPE_INSTANCE | slink:VkInstance
|
|
| ename:VK_OBJECT_TYPE_PHYSICAL_DEVICE | slink:VkPhysicalDevice
|
|
| ename:VK_OBJECT_TYPE_DEVICE | slink:VkDevice
|
|
| ename:VK_OBJECT_TYPE_QUEUE | slink:VkQueue
|
|
| ename:VK_OBJECT_TYPE_SEMAPHORE | slink:VkSemaphore
|
|
| ename:VK_OBJECT_TYPE_COMMAND_BUFFER | slink:VkCommandBuffer
|
|
| ename:VK_OBJECT_TYPE_FENCE | slink:VkFence
|
|
| ename:VK_OBJECT_TYPE_DEVICE_MEMORY | slink:VkDeviceMemory
|
|
| ename:VK_OBJECT_TYPE_BUFFER | slink:VkBuffer
|
|
| ename:VK_OBJECT_TYPE_IMAGE | slink:VkImage
|
|
| ename:VK_OBJECT_TYPE_EVENT | slink:VkEvent
|
|
| ename:VK_OBJECT_TYPE_QUERY_POOL | slink:VkQueryPool
|
|
| ename:VK_OBJECT_TYPE_BUFFER_VIEW | slink:VkBufferView
|
|
| ename:VK_OBJECT_TYPE_IMAGE_VIEW | slink:VkImageView
|
|
| ename:VK_OBJECT_TYPE_SHADER_MODULE | slink:VkShaderModule
|
|
| ename:VK_OBJECT_TYPE_PIPELINE_CACHE | slink:VkPipelineCache
|
|
| ename:VK_OBJECT_TYPE_PIPELINE_LAYOUT | slink:VkPipelineLayout
|
|
| ename:VK_OBJECT_TYPE_RENDER_PASS | slink:VkRenderPass
|
|
| ename:VK_OBJECT_TYPE_PIPELINE | slink:VkPipeline
|
|
| ename:VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT | slink:VkDescriptorSetLayout
|
|
| ename:VK_OBJECT_TYPE_SAMPLER | slink:VkSampler
|
|
| ename:VK_OBJECT_TYPE_DESCRIPTOR_POOL | slink:VkDescriptorPool
|
|
| ename:VK_OBJECT_TYPE_DESCRIPTOR_SET | slink:VkDescriptorSet
|
|
| ename:VK_OBJECT_TYPE_FRAMEBUFFER | slink:VkFramebuffer
|
|
| ename:VK_OBJECT_TYPE_COMMAND_POOL | slink:VkCommandPool
|
|
ifdef::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[]
|
|
| ename:VK_OBJECT_TYPE_SAMPLER_YCBCR_CONVERSION | slink:VkSamplerYcbcrConversion
|
|
endif::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[]
|
|
ifdef::VK_VERSION_1_1,VK_KHR_descriptor_update_template[]
|
|
| ename:VK_OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE | slink:VkDescriptorUpdateTemplate
|
|
endif::VK_VERSION_1_1,VK_KHR_descriptor_update_template[]
|
|
ifdef::VK_KHR_surface[]
|
|
| ename:VK_OBJECT_TYPE_SURFACE_KHR | slink:VkSurfaceKHR
|
|
endif::VK_KHR_surface[]
|
|
ifdef::VK_KHR_swapchain[]
|
|
| ename:VK_OBJECT_TYPE_SWAPCHAIN_KHR | slink:VkSwapchainKHR
|
|
endif::VK_KHR_swapchain[]
|
|
ifdef::VK_KHR_display[]
|
|
| ename:VK_OBJECT_TYPE_DISPLAY_KHR | slink:VkDisplayKHR
|
|
| ename:VK_OBJECT_TYPE_DISPLAY_MODE_KHR | slink:VkDisplayModeKHR
|
|
endif::VK_KHR_display[]
|
|
ifdef::VK_EXT_debug_report[]
|
|
| ename:VK_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT | slink:VkDebugReportCallbackEXT
|
|
endif::VK_EXT_debug_report[]
|
|
ifdef::VK_NVX_device_generated_commands[]
|
|
| ename:VK_OBJECT_TYPE_OBJECT_TABLE_NVX | slink:VkObjectTableNVX
|
|
| ename:VK_OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NVX | slink:VkIndirectCommandsLayoutNVX
|
|
endif::VK_NVX_device_generated_commands[]
|
|
ifdef::VK_EXT_debug_utils[]
|
|
| ename:VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT | slink:VkDebugUtilsMessengerEXT
|
|
endif::VK_EXT_debug_utils[]
|
|
ifdef::VK_EXT_validation_cache[]
|
|
| ename:VK_OBJECT_TYPE_VALIDATION_CACHE_EXT | slink:VkValidationCacheEXT
|
|
endif::VK_EXT_validation_cache[]
|
|
ifdef::VK_NV_ray_tracing[]
|
|
| ename:VK_OBJECT_TYPE_ACCELERATION_STRUCTURE_NV | slink:VkAccelerationStructureNV
|
|
endif::VK_NV_ray_tracing[]
|
|
|====
|
|
|
|
--
|
|
|
|
If this Specification was generated with any such extensions included, they
|
|
will be described in the remainder of this chapter.
|
|
|
|
ifdef::VK_EXT_debug_utils[]
|
|
include::VK_EXT_debug_utils.txt[]
|
|
endif::VK_EXT_debug_utils[]
|
|
|
|
ifdef::VK_EXT_debug_marker[]
|
|
include::VK_EXT_debug_marker.txt[]
|
|
endif::VK_EXT_debug_marker[]
|
|
|
|
ifdef::VK_EXT_debug_report[]
|
|
include::VK_EXT_debug_report.txt[]
|
|
endif::VK_EXT_debug_report[]
|
|
|
|
ifdef::VK_NV_device_diagnostic_checkpoints[]
|
|
include::VK_NV_device_diagnostic_checkpoints/device_diagnostic_checkpoints.txt[]
|
|
endif::VK_NV_device_diagnostic_checkpoints[]
|