// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a // Creative Commons Attribution 4.0 International License; see // http://creativecommons.org/licenses/by/4.0/ Vulkan API Reference Pages ========================== include::../specversion.txt[] :doctype: book :numbered!: :toc2: :max-width: 200 :numbered: :doctype: book :data-uri: :asciimath: :toclevels: 4 include::khronoscopyright.txt[] Table of Contents ----------------- * <> * <> * <> * <> * <> * <> * <> * <> [[protos,Vulkan Commands]] Vulkan Commands --------------- :leveloffset: 2 include::vkAllocateCommandBuffers.txt[] include::vkAllocateDescriptorSets.txt[] include::vkAllocateMemory.txt[] include::vkBeginCommandBuffer.txt[] include::vkBindBufferMemory.txt[] include::vkBindImageMemory.txt[] include::vkCmdBeginQuery.txt[] include::vkCmdBeginRenderPass.txt[] include::vkCmdBindDescriptorSets.txt[] include::vkCmdBindIndexBuffer.txt[] include::vkCmdBindPipeline.txt[] include::vkCmdBindVertexBuffers.txt[] include::vkCmdBlitImage.txt[] include::vkCmdClearAttachments.txt[] include::vkCmdClearColorImage.txt[] include::vkCmdClearDepthStencilImage.txt[] include::vkCmdCopyBuffer.txt[] include::vkCmdCopyBufferToImage.txt[] include::vkCmdCopyImage.txt[] include::vkCmdCopyImageToBuffer.txt[] include::vkCmdCopyQueryPoolResults.txt[] include::vkCmdDispatch.txt[] include::vkCmdDispatchIndirect.txt[] include::vkCmdDraw.txt[] include::vkCmdDrawIndexed.txt[] include::vkCmdDrawIndexedIndirect.txt[] include::vkCmdDrawIndirect.txt[] include::vkCmdEndQuery.txt[] include::vkCmdEndRenderPass.txt[] include::vkCmdExecuteCommands.txt[] include::vkCmdFillBuffer.txt[] include::vkCmdNextSubpass.txt[] include::vkCmdPipelineBarrier.txt[] include::vkCmdPushConstants.txt[] include::vkCmdResetEvent.txt[] include::vkCmdResetQueryPool.txt[] include::vkCmdResolveImage.txt[] include::vkCmdSetBlendConstants.txt[] include::vkCmdSetDepthBias.txt[] include::vkCmdSetDepthBounds.txt[] include::vkCmdSetEvent.txt[] include::vkCmdSetLineWidth.txt[] include::vkCmdSetScissor.txt[] include::vkCmdSetStencilCompareMask.txt[] include::vkCmdSetStencilReference.txt[] include::vkCmdSetStencilWriteMask.txt[] include::vkCmdSetViewport.txt[] include::vkCmdUpdateBuffer.txt[] include::vkCmdWaitEvents.txt[] include::vkCmdWriteTimestamp.txt[] include::vkCreateBuffer.txt[] include::vkCreateBufferView.txt[] include::vkCreateCommandPool.txt[] include::vkCreateComputePipelines.txt[] include::vkCreateDescriptorPool.txt[] include::vkCreateDescriptorSetLayout.txt[] include::vkCreateDevice.txt[] include::vkCreateEvent.txt[] include::vkCreateFence.txt[] include::vkCreateFramebuffer.txt[] include::vkCreateGraphicsPipelines.txt[] include::vkCreateImage.txt[] include::vkCreateImageView.txt[] include::vkCreateInstance.txt[] include::vkCreatePipelineCache.txt[] include::vkCreatePipelineLayout.txt[] include::vkCreateQueryPool.txt[] include::vkCreateRenderPass.txt[] include::vkCreateSampler.txt[] include::vkCreateSemaphore.txt[] include::vkCreateShaderModule.txt[] include::vkDestroyBuffer.txt[] include::vkDestroyBufferView.txt[] include::vkDestroyCommandPool.txt[] include::vkDestroyDescriptorPool.txt[] include::vkDestroyDescriptorSetLayout.txt[] include::vkDestroyDevice.txt[] include::vkDestroyEvent.txt[] include::vkDestroyFence.txt[] include::vkDestroyFramebuffer.txt[] include::vkDestroyImage.txt[] include::vkDestroyImageView.txt[] include::vkDestroyInstance.txt[] include::vkDestroyPipeline.txt[] include::vkDestroyPipelineCache.txt[] include::vkDestroyPipelineLayout.txt[] include::vkDestroyQueryPool.txt[] include::vkDestroyRenderPass.txt[] include::vkDestroySampler.txt[] include::vkDestroySemaphore.txt[] include::vkDestroyShaderModule.txt[] include::vkDeviceWaitIdle.txt[] include::vkEndCommandBuffer.txt[] include::vkEnumerateDeviceExtensionProperties.txt[] include::vkEnumerateDeviceLayerProperties.txt[] include::vkEnumerateInstanceExtensionProperties.txt[] include::vkEnumerateInstanceLayerProperties.txt[] include::vkEnumeratePhysicalDevices.txt[] include::vkFlushMappedMemoryRanges.txt[] include::vkFreeCommandBuffers.txt[] include::vkFreeDescriptorSets.txt[] include::vkFreeMemory.txt[] include::vkGetBufferMemoryRequirements.txt[] include::vkGetDeviceMemoryCommitment.txt[] include::vkGetDeviceProcAddr.txt[] include::vkGetDeviceQueue.txt[] include::vkGetEventStatus.txt[] include::vkGetFenceStatus.txt[] include::vkGetImageMemoryRequirements.txt[] include::vkGetImageSparseMemoryRequirements.txt[] include::vkGetImageSubresourceLayout.txt[] include::vkGetInstanceProcAddr.txt[] include::vkGetPhysicalDeviceFeatures.txt[] include::vkGetPhysicalDeviceFormatProperties.txt[] include::vkGetPhysicalDeviceImageFormatProperties.txt[] include::vkGetPhysicalDeviceMemoryProperties.txt[] include::vkGetPhysicalDeviceProperties.txt[] include::vkGetPhysicalDeviceQueueFamilyProperties.txt[] include::vkGetPhysicalDeviceSparseImageFormatProperties.txt[] include::vkGetPipelineCacheData.txt[] include::vkGetQueryPoolResults.txt[] include::vkGetRenderAreaGranularity.txt[] include::vkInvalidateMappedMemoryRanges.txt[] include::vkMapMemory.txt[] include::vkMergePipelineCaches.txt[] include::vkQueueBindSparse.txt[] include::vkQueueSubmit.txt[] include::vkQueueWaitIdle.txt[] include::vkResetCommandBuffer.txt[] include::vkResetCommandPool.txt[] include::vkResetDescriptorPool.txt[] include::vkResetEvent.txt[] include::vkResetFences.txt[] include::vkSetEvent.txt[] include::vkUnmapMemory.txt[] include::vkUpdateDescriptorSets.txt[] include::vkWaitForFences.txt[] :leveloffset: 0 [[handles,Object Handles]] Object Handles -------------- :leveloffset: 2 include::VkBuffer.txt[] include::VkBufferView.txt[] include::VkCommandBuffer.txt[] include::VkCommandPool.txt[] include::VkDescriptorPool.txt[] include::VkDescriptorSet.txt[] include::VkDescriptorSetLayout.txt[] include::VkDevice.txt[] include::VkDeviceMemory.txt[] include::VkEvent.txt[] include::VkFence.txt[] include::VkFramebuffer.txt[] include::VkImage.txt[] include::VkImageView.txt[] include::VkInstance.txt[] include::VkPhysicalDevice.txt[] include::VkPipeline.txt[] include::VkPipelineCache.txt[] include::VkPipelineLayout.txt[] include::VkQueryPool.txt[] include::VkQueue.txt[] include::VkRenderPass.txt[] include::VkSampler.txt[] include::VkSemaphore.txt[] include::VkShaderModule.txt[] :leveloffset: 0 [[structs,Structures]] Structures ---------- :leveloffset: 2 include::VkAllocationCallbacks.txt[] include::VkApplicationInfo.txt[] include::VkAttachmentDescription.txt[] include::VkAttachmentReference.txt[] include::VkBindSparseInfo.txt[] include::VkBufferCopy.txt[] include::VkBufferCreateInfo.txt[] include::VkBufferImageCopy.txt[] include::VkBufferMemoryBarrier.txt[] include::VkBufferViewCreateInfo.txt[] include::VkClearAttachment.txt[] include::VkClearColorValue.txt[] include::VkClearDepthStencilValue.txt[] include::VkClearRect.txt[] include::VkClearValue.txt[] include::VkCommandBufferAllocateInfo.txt[] include::VkCommandBufferBeginInfo.txt[] include::VkCommandBufferInheritanceInfo.txt[] include::VkCommandPoolCreateInfo.txt[] include::VkComponentMapping.txt[] include::VkComputePipelineCreateInfo.txt[] include::VkCopyDescriptorSet.txt[] include::VkDescriptorBufferInfo.txt[] include::VkDescriptorImageInfo.txt[] include::VkDescriptorPoolCreateInfo.txt[] include::VkDescriptorPoolSize.txt[] include::VkDescriptorSetAllocateInfo.txt[] include::VkDescriptorSetLayoutBinding.txt[] include::VkDescriptorSetLayoutCreateInfo.txt[] include::VkDeviceCreateInfo.txt[] include::VkDeviceQueueCreateInfo.txt[] include::VkDispatchIndirectCommand.txt[] include::VkDrawIndexedIndirectCommand.txt[] include::VkDrawIndirectCommand.txt[] include::VkEventCreateInfo.txt[] include::VkExtensionProperties.txt[] include::VkExtent2D.txt[] include::VkExtent3D.txt[] include::VkFenceCreateInfo.txt[] include::VkFormatProperties.txt[] include::VkFramebufferCreateInfo.txt[] include::VkGraphicsPipelineCreateInfo.txt[] include::VkImageBlit.txt[] include::VkImageCopy.txt[] include::VkImageCreateInfo.txt[] include::VkImageFormatProperties.txt[] include::VkImageMemoryBarrier.txt[] include::VkImageResolve.txt[] include::VkImageSubresource.txt[] include::VkImageSubresourceLayers.txt[] include::VkImageSubresourceRange.txt[] include::VkImageViewCreateInfo.txt[] include::VkInstanceCreateInfo.txt[] include::VkLayerProperties.txt[] include::VkMappedMemoryRange.txt[] include::VkMemoryAllocateInfo.txt[] include::VkMemoryBarrier.txt[] include::VkMemoryHeap.txt[] include::VkMemoryRequirements.txt[] include::VkMemoryType.txt[] include::VkOffset2D.txt[] include::VkOffset3D.txt[] include::VkPhysicalDeviceFeatures.txt[] include::VkPhysicalDeviceLimits.txt[] include::VkPhysicalDeviceMemoryProperties.txt[] include::VkPhysicalDeviceProperties.txt[] include::VkPhysicalDeviceSparseProperties.txt[] include::VkPipelineCacheCreateInfo.txt[] include::VkPipelineColorBlendAttachmentState.txt[] include::VkPipelineColorBlendStateCreateInfo.txt[] include::VkPipelineDepthStencilStateCreateInfo.txt[] include::VkPipelineDynamicStateCreateInfo.txt[] include::VkPipelineInputAssemblyStateCreateInfo.txt[] include::VkPipelineLayoutCreateInfo.txt[] include::VkPipelineMultisampleStateCreateInfo.txt[] include::VkPipelineRasterizationStateCreateInfo.txt[] include::VkPipelineShaderStageCreateInfo.txt[] include::VkPipelineTessellationStateCreateInfo.txt[] include::VkPipelineVertexInputStateCreateInfo.txt[] include::VkPipelineViewportStateCreateInfo.txt[] include::VkPushConstantRange.txt[] include::VkQueryPoolCreateInfo.txt[] include::VkQueueFamilyProperties.txt[] include::VkRect2D.txt[] include::VkRenderPassBeginInfo.txt[] include::VkRenderPassCreateInfo.txt[] include::VkSamplerCreateInfo.txt[] include::VkSemaphoreCreateInfo.txt[] include::VkShaderModuleCreateInfo.txt[] include::VkSparseBufferMemoryBindInfo.txt[] include::VkSparseImageFormatProperties.txt[] include::VkSparseImageMemoryBind.txt[] include::VkSparseImageMemoryBindInfo.txt[] include::VkSparseImageMemoryRequirements.txt[] include::VkSparseImageOpaqueMemoryBindInfo.txt[] include::VkSparseMemoryBind.txt[] include::VkSpecializationInfo.txt[] include::VkSpecializationMapEntry.txt[] include::VkStencilOpState.txt[] include::VkSubmitInfo.txt[] include::VkSubpassDependency.txt[] include::VkSubpassDescription.txt[] include::VkSubresourceLayout.txt[] include::VkVertexInputAttributeDescription.txt[] include::VkVertexInputBindingDescription.txt[] include::VkViewport.txt[] include::VkWriteDescriptorSet.txt[] :leveloffset: 0 [[enums,Enumerations]] Enumerations ------------ :leveloffset: 2 include::VkAccessFlagBits.txt[] include::VkAttachmentDescriptionFlagBits.txt[] include::VkAttachmentLoadOp.txt[] include::VkAttachmentStoreOp.txt[] include::VkBlendFactor.txt[] include::VkBlendOp.txt[] include::VkBorderColor.txt[] include::VkBufferCreateFlagBits.txt[] include::VkBufferUsageFlagBits.txt[] include::VkColorComponentFlagBits.txt[] include::VkCommandBufferLevel.txt[] include::VkCommandBufferResetFlagBits.txt[] include::VkCommandBufferUsageFlagBits.txt[] include::VkCommandPoolCreateFlagBits.txt[] include::VkCommandPoolResetFlagBits.txt[] include::VkCompareOp.txt[] include::VkComponentSwizzle.txt[] include::VkCullModeFlagBits.txt[] include::VkDependencyFlagBits.txt[] include::VkDescriptorPoolCreateFlagBits.txt[] include::VkDescriptorType.txt[] include::VkDynamicState.txt[] include::VkFenceCreateFlagBits.txt[] include::VkFilter.txt[] include::VkFormat.txt[] include::VkFormatFeatureFlagBits.txt[] include::VkFrontFace.txt[] include::VkImageAspectFlagBits.txt[] include::VkImageCreateFlagBits.txt[] include::VkImageLayout.txt[] include::VkImageTiling.txt[] include::VkImageType.txt[] include::VkImageUsageFlagBits.txt[] include::VkImageViewType.txt[] include::VkIndexType.txt[] include::VkInternalAllocationType.txt[] include::VkLogicOp.txt[] include::VkMemoryHeapFlagBits.txt[] include::VkMemoryPropertyFlagBits.txt[] include::VkPhysicalDeviceType.txt[] include::VkPipelineBindPoint.txt[] include::VkPipelineCacheHeaderVersion.txt[] include::VkPipelineCreateFlagBits.txt[] include::VkPipelineStageFlagBits.txt[] include::VkPolygonMode.txt[] include::VkPrimitiveTopology.txt[] include::VkQueryControlFlagBits.txt[] include::VkQueryPipelineStatisticFlagBits.txt[] include::VkQueryResultFlagBits.txt[] include::VkQueryType.txt[] include::VkQueueFlagBits.txt[] include::VkResult.txt[] include::VkSampleCountFlagBits.txt[] include::VkSamplerAddressMode.txt[] include::VkSamplerMipmapMode.txt[] include::VkShaderStageFlagBits.txt[] include::VkSharingMode.txt[] include::VkSparseImageFormatFlagBits.txt[] include::VkSparseMemoryBindFlagBits.txt[] include::VkStencilFaceFlagBits.txt[] include::VkStencilOp.txt[] include::VkStructureType.txt[] include::VkSubpassContents.txt[] include::VkSystemAllocationScope.txt[] include::VkVertexInputRate.txt[] :leveloffset: 0 [[flags,Flags]] Flags ----- :leveloffset: 2 include::VkAccessFlags.txt[] include::VkAttachmentDescriptionFlags.txt[] include::VkBufferCreateFlags.txt[] include::VkBufferUsageFlags.txt[] include::VkBufferViewCreateFlags.txt[] include::VkColorComponentFlags.txt[] include::VkCommandBufferResetFlags.txt[] include::VkCommandBufferUsageFlags.txt[] include::VkCommandPoolCreateFlags.txt[] include::VkCommandPoolResetFlags.txt[] include::VkCullModeFlags.txt[] include::VkDependencyFlags.txt[] include::VkDescriptorPoolCreateFlags.txt[] include::VkDescriptorPoolResetFlags.txt[] include::VkDescriptorSetLayoutCreateFlags.txt[] include::VkDeviceCreateFlags.txt[] include::VkDeviceQueueCreateFlags.txt[] include::VkEventCreateFlags.txt[] include::VkFenceCreateFlags.txt[] include::VkFormatFeatureFlags.txt[] include::VkFramebufferCreateFlags.txt[] include::VkImageAspectFlags.txt[] include::VkImageCreateFlags.txt[] include::VkImageUsageFlags.txt[] include::VkImageViewCreateFlags.txt[] include::VkInstanceCreateFlags.txt[] include::VkMemoryHeapFlags.txt[] include::VkMemoryMapFlags.txt[] include::VkMemoryPropertyFlags.txt[] include::VkPipelineCacheCreateFlags.txt[] include::VkPipelineColorBlendStateCreateFlags.txt[] include::VkPipelineCreateFlags.txt[] include::VkPipelineDepthStencilStateCreateFlags.txt[] include::VkPipelineDynamicStateCreateFlags.txt[] include::VkPipelineInputAssemblyStateCreateFlags.txt[] include::VkPipelineLayoutCreateFlags.txt[] include::VkPipelineMultisampleStateCreateFlags.txt[] include::VkPipelineRasterizationStateCreateFlags.txt[] include::VkPipelineShaderStageCreateFlags.txt[] include::VkPipelineStageFlags.txt[] include::VkPipelineTessellationStateCreateFlags.txt[] include::VkPipelineVertexInputStateCreateFlags.txt[] include::VkPipelineViewportStateCreateFlags.txt[] include::VkQueryControlFlags.txt[] include::VkQueryPipelineStatisticFlags.txt[] include::VkQueryPoolCreateFlags.txt[] include::VkQueryResultFlags.txt[] include::VkQueueFlags.txt[] include::VkRenderPassCreateFlags.txt[] include::VkSampleCountFlags.txt[] include::VkSamplerCreateFlags.txt[] include::VkSemaphoreCreateFlags.txt[] include::VkShaderModuleCreateFlags.txt[] include::VkShaderStageFlags.txt[] include::VkSparseImageFormatFlags.txt[] include::VkSparseMemoryBindFlags.txt[] include::VkStencilFaceFlags.txt[] include::VkSubpassDescriptionFlags.txt[] :leveloffset: 0 [[funcpointers,Function Pointer Types]] Function Pointer Types ---------------------- :leveloffset: 2 include::PFN_vkAllocationFunction.txt[] include::PFN_vkFreeFunction.txt[] include::PFN_vkInternalAllocationNotification.txt[] include::PFN_vkInternalFreeNotification.txt[] include::PFN_vkReallocationFunction.txt[] include::PFN_vkVoidFunction.txt[] :leveloffset: 0 [[basetypes,Vulkan Scalar types]] Vulkan Scalar types ------------------- :leveloffset: 2 include::VkBool32.txt[] include::VkDeviceSize.txt[] include::VkFlags.txt[] include::VkSampleMask.txt[] :leveloffset: 0 [[defines,C Macro Definitions]] C Macro Definitions ------------------- :leveloffset: 2 include::VK_API_VERSION.txt[] include::VK_API_VERSION_1_0.txt[] include::VK_DEFINE_HANDLE.txt[] include::VK_DEFINE_NON_DISPATCHABLE_HANDLE.txt[] include::VK_HEADER_VERSION.txt[] include::VK_MAKE_VERSION.txt[] include::VK_NULL_HANDLE.txt[] include::VK_VERSION_MAJOR.txt[] include::VK_VERSION_MINOR.txt[] include::VK_VERSION_PATCH.txt[] :leveloffset: 0