Package org.lwjgl.vulkan

Class VK10

java.lang.Object

org.lwjgl.vulkan.VK10

Direct Known Subclasses:

VK11

public class VK10
extends java.lang.Object

The core Vulkan 1.0 functionality.

Field Summary

Fields

Modifier and Type	Field	Description
static int	VK_ACCESS_COLOR_ATTACHMENT_READ_BIT VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT VK_ACCESS_HOST_READ_BIT VK_ACCESS_HOST_WRITE_BIT VK_ACCESS_INDEX_READ_BIT VK_ACCESS_INDIRECT_COMMAND_READ_BIT VK_ACCESS_INPUT_ATTACHMENT_READ_BIT VK_ACCESS_MEMORY_READ_BIT VK_ACCESS_MEMORY_WRITE_BIT VK_ACCESS_SHADER_READ_BIT VK_ACCESS_SHADER_WRITE_BIT VK_ACCESS_TRANSFER_READ_BIT VK_ACCESS_TRANSFER_WRITE_BIT VK_ACCESS_UNIFORM_READ_BIT VK_ACCESS_VERTEX_ATTRIBUTE_READ_BIT	VkAccessFlagBits - Bitmask specifying memory access types that will participate in a memory dependency
static int	VK_API_VERSION_1_0	The API version number for Vulkan 1.0.
static int	VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT	VkAttachmentDescriptionFlagBits - Bitmask specifying additional properties of an attachment
static int	VK_ATTACHMENT_LOAD_OP_CLEAR VK_ATTACHMENT_LOAD_OP_DONT_CARE VK_ATTACHMENT_LOAD_OP_LOAD	VkAttachmentLoadOp - Specify how contents of an attachment are treated at the beginning of a subpass
static int	VK_ATTACHMENT_STORE_OP_DONT_CARE VK_ATTACHMENT_STORE_OP_STORE	VkAttachmentStoreOp - Specify how contents of an attachment are treated at the end of a subpass
static int	VK_ATTACHMENT_UNUSED	API Constants
static int	VK_BLEND_FACTOR_CONSTANT_ALPHA VK_BLEND_FACTOR_CONSTANT_COLOR VK_BLEND_FACTOR_DST_ALPHA VK_BLEND_FACTOR_DST_COLOR VK_BLEND_FACTOR_ONE VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR VK_BLEND_FACTOR_ONE_MINUS_DST_ALPHA VK_BLEND_FACTOR_ONE_MINUS_DST_COLOR VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA VK_BLEND_FACTOR_ONE_MINUS_SRC_COLOR VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR VK_BLEND_FACTOR_SRC_ALPHA VK_BLEND_FACTOR_SRC_ALPHA_SATURATE VK_BLEND_FACTOR_SRC_COLOR VK_BLEND_FACTOR_SRC1_ALPHA VK_BLEND_FACTOR_SRC1_COLOR VK_BLEND_FACTOR_ZERO	VkBlendFactor - Framebuffer blending factors
static int	VK_BLEND_OP_ADD VK_BLEND_OP_MAX VK_BLEND_OP_MIN VK_BLEND_OP_REVERSE_SUBTRACT VK_BLEND_OP_SUBTRACT	VkBlendOp - Framebuffer blending operations
static int	VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK VK_BORDER_COLOR_INT_OPAQUE_BLACK VK_BORDER_COLOR_INT_OPAQUE_WHITE VK_BORDER_COLOR_INT_TRANSPARENT_BLACK	VkBorderColor - Specify border color used for texture lookups
static int	VK_BUFFER_CREATE_SPARSE_ALIASED_BIT VK_BUFFER_CREATE_SPARSE_BINDING_BIT VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT	VkBufferCreateFlagBits - Bitmask specifying additional parameters of a buffer
static int	VK_BUFFER_USAGE_INDEX_BUFFER_BIT VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT VK_BUFFER_USAGE_STORAGE_BUFFER_BIT VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT VK_BUFFER_USAGE_TRANSFER_DST_BIT VK_BUFFER_USAGE_TRANSFER_SRC_BIT VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT VK_BUFFER_USAGE_VERTEX_BUFFER_BIT	VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer
static int	VK_COLOR_COMPONENT_A_BIT VK_COLOR_COMPONENT_B_BIT VK_COLOR_COMPONENT_G_BIT VK_COLOR_COMPONENT_R_BIT	VkColorComponentFlagBits - Bitmask controlling which components are written to the framebuffer
static int	VK_COMMAND_BUFFER_LEVEL_PRIMARY VK_COMMAND_BUFFER_LEVEL_SECONDARY	VkCommandBufferLevel - Enumerant specifying a command buffer level
static int	VK_COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT	VkCommandBufferResetFlagBits - Bitmask controlling behavior of a command buffer reset
static int	VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT	VkCommandBufferUsageFlagBits - Bitmask specifying usage behavior for command buffer
static int	VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT VK_COMMAND_POOL_CREATE_TRANSIENT_BIT	VkCommandPoolCreateFlagBits - Bitmask specifying usage behavior for a command pool
static int	VK_COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT	VkCommandPoolResetFlagBits - Bitmask controlling behavior of a command pool reset
static int	VK_COMPARE_OP_ALWAYS VK_COMPARE_OP_EQUAL VK_COMPARE_OP_GREATER VK_COMPARE_OP_GREATER_OR_EQUAL VK_COMPARE_OP_LESS VK_COMPARE_OP_LESS_OR_EQUAL VK_COMPARE_OP_NEVER VK_COMPARE_OP_NOT_EQUAL	VkCompareOp - Stencil comparison function
static int	VK_COMPONENT_SWIZZLE_A VK_COMPONENT_SWIZZLE_B VK_COMPONENT_SWIZZLE_G VK_COMPONENT_SWIZZLE_IDENTITY VK_COMPONENT_SWIZZLE_ONE VK_COMPONENT_SWIZZLE_R VK_COMPONENT_SWIZZLE_ZERO	VkComponentSwizzle - Specify how a component is swizzled
static int	VK_CULL_MODE_BACK_BIT VK_CULL_MODE_FRONT_AND_BACK VK_CULL_MODE_FRONT_BIT VK_CULL_MODE_NONE	VkCullModeFlagBits - Bitmask controlling triangle culling
static int	VK_DEPENDENCY_BY_REGION_BIT	VkDependencyFlagBits - Bitmask specifying how execution and memory dependencies are formed
static int	VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT	VkDescriptorPoolCreateFlagBits - Bitmask specifying certain supported operations on a descriptor pool
static int	VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE VK_DESCRIPTOR_TYPE_SAMPLER VK_DESCRIPTOR_TYPE_STORAGE_BUFFER VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC VK_DESCRIPTOR_TYPE_STORAGE_IMAGE VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER	VkDescriptorType - Specifies the type of a descriptor in a descriptor set
static int	VK_DYNAMIC_STATE_BLEND_CONSTANTS VK_DYNAMIC_STATE_DEPTH_BIAS VK_DYNAMIC_STATE_DEPTH_BOUNDS VK_DYNAMIC_STATE_LINE_WIDTH VK_DYNAMIC_STATE_SCISSOR VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK VK_DYNAMIC_STATE_STENCIL_REFERENCE VK_DYNAMIC_STATE_STENCIL_WRITE_MASK VK_DYNAMIC_STATE_VIEWPORT	VkDynamicState - Indicate which dynamic state is taken from dynamic state commands
static int	VK_ERROR_DEVICE_LOST VK_ERROR_EXTENSION_NOT_PRESENT VK_ERROR_FEATURE_NOT_PRESENT VK_ERROR_FORMAT_NOT_SUPPORTED VK_ERROR_FRAGMENTED_POOL VK_ERROR_INCOMPATIBLE_DRIVER VK_ERROR_INITIALIZATION_FAILED VK_ERROR_LAYER_NOT_PRESENT VK_ERROR_MEMORY_MAP_FAILED VK_ERROR_OUT_OF_DEVICE_MEMORY VK_ERROR_OUT_OF_HOST_MEMORY VK_ERROR_TOO_MANY_OBJECTS VK_EVENT_RESET VK_EVENT_SET	VkResult - Vulkan command return codes
static int	VK_FALSE	API Constants
static int	VK_FENCE_CREATE_SIGNALED_BIT	VkFenceCreateFlagBits - Bitmask specifying initial state and behavior of a fence
static int	VK_FILTER_LINEAR VK_FILTER_NEAREST	VkFilter - Specify filters used for texture lookups
static int	VK_FORMAT_A1R5G5B5_UNORM_PACK16 VK_FORMAT_A2B10G10R10_SINT_PACK32 VK_FORMAT_A2B10G10R10_SNORM_PACK32 VK_FORMAT_A2B10G10R10_SSCALED_PACK32 VK_FORMAT_A2B10G10R10_UINT_PACK32 VK_FORMAT_A2B10G10R10_UNORM_PACK32 VK_FORMAT_A2B10G10R10_USCALED_PACK32 VK_FORMAT_A2R10G10B10_SINT_PACK32 VK_FORMAT_A2R10G10B10_SNORM_PACK32 VK_FORMAT_A2R10G10B10_SSCALED_PACK32 VK_FORMAT_A2R10G10B10_UINT_PACK32 VK_FORMAT_A2R10G10B10_UNORM_PACK32 VK_FORMAT_A2R10G10B10_USCALED_PACK32 VK_FORMAT_A8B8G8R8_SINT_PACK32 VK_FORMAT_A8B8G8R8_SNORM_PACK32 VK_FORMAT_A8B8G8R8_SRGB_PACK32 VK_FORMAT_A8B8G8R8_SSCALED_PACK32 VK_FORMAT_A8B8G8R8_UINT_PACK32 VK_FORMAT_A8B8G8R8_UNORM_PACK32 VK_FORMAT_A8B8G8R8_USCALED_PACK32 VK_FORMAT_ASTC_10x10_SRGB_BLOCK VK_FORMAT_ASTC_10x10_UNORM_BLOCK VK_FORMAT_ASTC_10x5_SRGB_BLOCK VK_FORMAT_ASTC_10x5_UNORM_BLOCK VK_FORMAT_ASTC_10x6_SRGB_BLOCK VK_FORMAT_ASTC_10x6_UNORM_BLOCK VK_FORMAT_ASTC_10x8_SRGB_BLOCK VK_FORMAT_ASTC_10x8_UNORM_BLOCK VK_FORMAT_ASTC_12x10_SRGB_BLOCK VK_FORMAT_ASTC_12x10_UNORM_BLOCK VK_FORMAT_ASTC_12x12_SRGB_BLOCK VK_FORMAT_ASTC_12x12_UNORM_BLOCK VK_FORMAT_ASTC_4x4_SRGB_BLOCK VK_FORMAT_ASTC_4x4_UNORM_BLOCK VK_FORMAT_ASTC_5x4_SRGB_BLOCK VK_FORMAT_ASTC_5x4_UNORM_BLOCK VK_FORMAT_ASTC_5x5_SRGB_BLOCK VK_FORMAT_ASTC_5x5_UNORM_BLOCK VK_FORMAT_ASTC_6x5_SRGB_BLOCK VK_FORMAT_ASTC_6x5_UNORM_BLOCK VK_FORMAT_ASTC_6x6_SRGB_BLOCK VK_FORMAT_ASTC_6x6_UNORM_BLOCK VK_FORMAT_ASTC_8x5_SRGB_BLOCK VK_FORMAT_ASTC_8x5_UNORM_BLOCK VK_FORMAT_ASTC_8x6_SRGB_BLOCK VK_FORMAT_ASTC_8x6_UNORM_BLOCK VK_FORMAT_ASTC_8x8_SRGB_BLOCK VK_FORMAT_ASTC_8x8_UNORM_BLOCK VK_FORMAT_B10G11R11_UFLOAT_PACK32 VK_FORMAT_B4G4R4A4_UNORM_PACK16 VK_FORMAT_B5G5R5A1_UNORM_PACK16 VK_FORMAT_B5G6R5_UNORM_PACK16 VK_FORMAT_B8G8R8_SINT VK_FORMAT_B8G8R8_SNORM VK_FORMAT_B8G8R8_SRGB VK_FORMAT_B8G8R8_SSCALED VK_FORMAT_B8G8R8_UINT VK_FORMAT_B8G8R8_UNORM VK_FORMAT_B8G8R8_USCALED VK_FORMAT_B8G8R8A8_SINT VK_FORMAT_B8G8R8A8_SNORM VK_FORMAT_B8G8R8A8_SRGB VK_FORMAT_B8G8R8A8_SSCALED VK_FORMAT_B8G8R8A8_UINT VK_FORMAT_B8G8R8A8_UNORM VK_FORMAT_B8G8R8A8_USCALED VK_FORMAT_BC1_RGB_SRGB_BLOCK VK_FORMAT_BC1_RGB_UNORM_BLOCK VK_FORMAT_BC1_RGBA_SRGB_BLOCK VK_FORMAT_BC1_RGBA_UNORM_BLOCK VK_FORMAT_BC2_SRGB_BLOCK VK_FORMAT_BC2_UNORM_BLOCK VK_FORMAT_BC3_SRGB_BLOCK VK_FORMAT_BC3_UNORM_BLOCK VK_FORMAT_BC4_SNORM_BLOCK VK_FORMAT_BC4_UNORM_BLOCK VK_FORMAT_BC5_SNORM_BLOCK VK_FORMAT_BC5_UNORM_BLOCK VK_FORMAT_BC6H_SFLOAT_BLOCK VK_FORMAT_BC6H_UFLOAT_BLOCK VK_FORMAT_BC7_SRGB_BLOCK VK_FORMAT_BC7_UNORM_BLOCK VK_FORMAT_D16_UNORM VK_FORMAT_D16_UNORM_S8_UINT VK_FORMAT_D24_UNORM_S8_UINT VK_FORMAT_D32_SFLOAT VK_FORMAT_D32_SFLOAT_S8_UINT VK_FORMAT_E5B9G9R9_UFLOAT_PACK32 VK_FORMAT_EAC_R11_SNORM_BLOCK VK_FORMAT_EAC_R11_UNORM_BLOCK VK_FORMAT_EAC_R11G11_SNORM_BLOCK VK_FORMAT_EAC_R11G11_UNORM_BLOCK VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK	VkFormat - Available image formats
static int	VK_FORMAT_FEATURE_BLIT_DST_BIT VK_FORMAT_FEATURE_BLIT_SRC_BIT VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT	VkFormatFeatureFlagBits - Bitmask specifying features supported by a buffer
static int	VK_FORMAT_R16_SFLOAT VK_FORMAT_R16_SINT VK_FORMAT_R16_SNORM VK_FORMAT_R16_SSCALED VK_FORMAT_R16_UINT VK_FORMAT_R16_UNORM VK_FORMAT_R16_USCALED VK_FORMAT_R16G16_SFLOAT VK_FORMAT_R16G16_SINT VK_FORMAT_R16G16_SNORM VK_FORMAT_R16G16_SSCALED VK_FORMAT_R16G16_UINT VK_FORMAT_R16G16_UNORM VK_FORMAT_R16G16_USCALED VK_FORMAT_R16G16B16_SFLOAT VK_FORMAT_R16G16B16_SINT VK_FORMAT_R16G16B16_SNORM VK_FORMAT_R16G16B16_SSCALED VK_FORMAT_R16G16B16_UINT VK_FORMAT_R16G16B16_UNORM VK_FORMAT_R16G16B16_USCALED VK_FORMAT_R16G16B16A16_SFLOAT VK_FORMAT_R16G16B16A16_SINT VK_FORMAT_R16G16B16A16_SNORM VK_FORMAT_R16G16B16A16_SSCALED VK_FORMAT_R16G16B16A16_UINT VK_FORMAT_R16G16B16A16_UNORM VK_FORMAT_R16G16B16A16_USCALED VK_FORMAT_R32_SFLOAT VK_FORMAT_R32_SINT VK_FORMAT_R32_UINT VK_FORMAT_R32G32_SFLOAT VK_FORMAT_R32G32_SINT VK_FORMAT_R32G32_UINT VK_FORMAT_R32G32B32_SFLOAT VK_FORMAT_R32G32B32_SINT VK_FORMAT_R32G32B32_UINT VK_FORMAT_R32G32B32A32_SFLOAT VK_FORMAT_R32G32B32A32_SINT VK_FORMAT_R32G32B32A32_UINT VK_FORMAT_R4G4_UNORM_PACK8 VK_FORMAT_R4G4B4A4_UNORM_PACK16 VK_FORMAT_R5G5B5A1_UNORM_PACK16 VK_FORMAT_R5G6B5_UNORM_PACK16 VK_FORMAT_R64_SFLOAT VK_FORMAT_R64_SINT VK_FORMAT_R64_UINT VK_FORMAT_R64G64_SFLOAT VK_FORMAT_R64G64_SINT VK_FORMAT_R64G64_UINT VK_FORMAT_R64G64B64_SFLOAT VK_FORMAT_R64G64B64_SINT VK_FORMAT_R64G64B64_UINT VK_FORMAT_R64G64B64A64_SFLOAT VK_FORMAT_R64G64B64A64_SINT VK_FORMAT_R64G64B64A64_UINT VK_FORMAT_R8_SINT VK_FORMAT_R8_SNORM VK_FORMAT_R8_SRGB VK_FORMAT_R8_SSCALED VK_FORMAT_R8_UINT VK_FORMAT_R8_UNORM VK_FORMAT_R8_USCALED VK_FORMAT_R8G8_SINT VK_FORMAT_R8G8_SNORM VK_FORMAT_R8G8_SRGB VK_FORMAT_R8G8_SSCALED VK_FORMAT_R8G8_UINT VK_FORMAT_R8G8_UNORM VK_FORMAT_R8G8_USCALED VK_FORMAT_R8G8B8_SINT VK_FORMAT_R8G8B8_SNORM VK_FORMAT_R8G8B8_SRGB VK_FORMAT_R8G8B8_SSCALED VK_FORMAT_R8G8B8_UINT VK_FORMAT_R8G8B8_UNORM VK_FORMAT_R8G8B8_USCALED VK_FORMAT_R8G8B8A8_SINT VK_FORMAT_R8G8B8A8_SNORM VK_FORMAT_R8G8B8A8_SRGB VK_FORMAT_R8G8B8A8_SSCALED VK_FORMAT_R8G8B8A8_UINT VK_FORMAT_R8G8B8A8_UNORM VK_FORMAT_R8G8B8A8_USCALED VK_FORMAT_S8_UINT VK_FORMAT_UNDEFINED VK_FORMAT_X8_D24_UNORM_PACK32	VkFormat - Available image formats
static int	VK_FRONT_FACE_CLOCKWISE VK_FRONT_FACE_COUNTER_CLOCKWISE	VkFrontFace - Interpret polygon front-facing orientation
static int	VK_HEADER_VERSION	The Vulkan registry version used to generate the LWJGL bindings.
static int	VK_IMAGE_ASPECT_COLOR_BIT VK_IMAGE_ASPECT_DEPTH_BIT VK_IMAGE_ASPECT_METADATA_BIT VK_IMAGE_ASPECT_STENCIL_BIT	VkImageAspectFlagBits - Bitmask specifying which aspects of an image are included in a view
static int	VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT VK_IMAGE_CREATE_SPARSE_ALIASED_BIT VK_IMAGE_CREATE_SPARSE_BINDING_BIT VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT	VkImageCreateFlagBits - Bitmask specifying additional parameters of an image
static int	VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL VK_IMAGE_LAYOUT_GENERAL VK_IMAGE_LAYOUT_PREINITIALIZED VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL VK_IMAGE_LAYOUT_UNDEFINED	VkImageLayout - Layout of image and image subresources
static int	VK_IMAGE_TILING_LINEAR VK_IMAGE_TILING_OPTIMAL	VkImageTiling - Specifies the tiling arrangement of data in an image
static int	VK_IMAGE_TYPE_1D VK_IMAGE_TYPE_2D VK_IMAGE_TYPE_3D	VkImageType - Specifies the type of an image object
static int	VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT VK_IMAGE_USAGE_SAMPLED_BIT VK_IMAGE_USAGE_STORAGE_BIT VK_IMAGE_USAGE_TRANSFER_DST_BIT VK_IMAGE_USAGE_TRANSFER_SRC_BIT VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT	VkImageUsageFlagBits - Bitmask specifying intended usage of an image
static int	VK_IMAGE_VIEW_TYPE_1D VK_IMAGE_VIEW_TYPE_1D_ARRAY VK_IMAGE_VIEW_TYPE_2D VK_IMAGE_VIEW_TYPE_2D_ARRAY VK_IMAGE_VIEW_TYPE_3D VK_IMAGE_VIEW_TYPE_CUBE VK_IMAGE_VIEW_TYPE_CUBE_ARRAY	VkImageViewType - Image view types
static int	VK_INCOMPLETE	VkResult - Vulkan command return codes
static int	VK_INDEX_TYPE_UINT16 VK_INDEX_TYPE_UINT32	VkIndexType - Type of index buffer indices
static int	VK_INTERNAL_ALLOCATION_TYPE_EXECUTABLE	VkInternalAllocationType - Allocation type
static float	VK_LOD_CLAMP_NONE	API Constants
static int	VK_LOGIC_OP_AND VK_LOGIC_OP_AND_INVERTED VK_LOGIC_OP_AND_REVERSE VK_LOGIC_OP_CLEAR VK_LOGIC_OP_COPY VK_LOGIC_OP_COPY_INVERTED VK_LOGIC_OP_EQUIVALENT VK_LOGIC_OP_INVERT VK_LOGIC_OP_NAND VK_LOGIC_OP_NO_OP VK_LOGIC_OP_NOR VK_LOGIC_OP_OR VK_LOGIC_OP_OR_INVERTED VK_LOGIC_OP_OR_REVERSE VK_LOGIC_OP_SET VK_LOGIC_OP_XOR	VkLogicOp - Framebuffer logical operations
static int	VK_MAX_DESCRIPTION_SIZE VK_MAX_EXTENSION_NAME_SIZE VK_MAX_MEMORY_HEAPS VK_MAX_MEMORY_TYPES VK_MAX_PHYSICAL_DEVICE_NAME_SIZE	API Constants
static int	VK_MEMORY_HEAP_DEVICE_LOCAL_BIT	VkMemoryHeapFlagBits - Bitmask specifying attribute flags for a heap
static int	VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT VK_MEMORY_PROPERTY_HOST_CACHED_BIT VK_MEMORY_PROPERTY_HOST_COHERENT_BIT VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT	VkMemoryPropertyFlagBits - Bitmask specifying properties for a memory type
static int	VK_NOT_READY	VkResult - Vulkan command return codes
static long	VK_NULL_HANDLE	The reserved handle VK_NULL_HANDLE can be passed in place of valid object handles when explicitly called out in the specification.
static int	VK_OBJECT_TYPE_BUFFER VK_OBJECT_TYPE_BUFFER_VIEW VK_OBJECT_TYPE_COMMAND_BUFFER VK_OBJECT_TYPE_COMMAND_POOL VK_OBJECT_TYPE_DESCRIPTOR_POOL VK_OBJECT_TYPE_DESCRIPTOR_SET VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT VK_OBJECT_TYPE_DEVICE VK_OBJECT_TYPE_DEVICE_MEMORY VK_OBJECT_TYPE_EVENT VK_OBJECT_TYPE_FENCE VK_OBJECT_TYPE_FRAMEBUFFER VK_OBJECT_TYPE_IMAGE VK_OBJECT_TYPE_IMAGE_VIEW VK_OBJECT_TYPE_INSTANCE VK_OBJECT_TYPE_PHYSICAL_DEVICE VK_OBJECT_TYPE_PIPELINE VK_OBJECT_TYPE_PIPELINE_CACHE VK_OBJECT_TYPE_PIPELINE_LAYOUT VK_OBJECT_TYPE_QUERY_POOL VK_OBJECT_TYPE_QUEUE VK_OBJECT_TYPE_RENDER_PASS VK_OBJECT_TYPE_SAMPLER VK_OBJECT_TYPE_SEMAPHORE VK_OBJECT_TYPE_SHADER_MODULE VK_OBJECT_TYPE_UNKNOWN	VkObjectType - Specify an enumeration to track object handle types
static int	VK_PHYSICAL_DEVICE_TYPE_CPU VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU VK_PHYSICAL_DEVICE_TYPE_OTHER VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU	VkPhysicalDeviceType - Supported physical device types
static int	VK_PIPELINE_BIND_POINT_COMPUTE VK_PIPELINE_BIND_POINT_GRAPHICS	VkPipelineBindPoint - Specify the bind point of a pipeline object to a command buffer
static int	VK_PIPELINE_CACHE_HEADER_VERSION_ONE	VkPipelineCacheHeaderVersion - Encode pipeline cache version
static int	VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT VK_PIPELINE_CREATE_DERIVATIVE_BIT VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT	VkPipelineCreateFlagBits - Bitmask controlling how a pipeline is created
static int	VK_PIPELINE_STAGE_ALL_COMMANDS_BIT VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT VK_PIPELINE_STAGE_HOST_BIT VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT VK_PIPELINE_STAGE_TRANSFER_BIT VK_PIPELINE_STAGE_VERTEX_INPUT_BIT VK_PIPELINE_STAGE_VERTEX_SHADER_BIT	VkPipelineStageFlagBits - Bitmask specifying pipeline stages
static int	VK_POLYGON_MODE_FILL VK_POLYGON_MODE_LINE VK_POLYGON_MODE_POINT	VkPolygonMode - Control polygon rasterization mode
static int	VK_PRIMITIVE_TOPOLOGY_LINE_LIST VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY VK_PRIMITIVE_TOPOLOGY_LINE_STRIP VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY VK_PRIMITIVE_TOPOLOGY_PATCH_LIST VK_PRIMITIVE_TOPOLOGY_POINT_LIST VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY	VkPrimitiveTopology - Supported primitive topologies
static int	VK_QUERY_CONTROL_PRECISE_BIT	VkQueryControlFlagBits - Bitmask specifying constraints on a query
static int	VK_QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT VK_QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT VK_QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT VK_QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT VK_QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT	VkQueryPipelineStatisticFlagBits - Bitmask specifying queried pipeline statistics
static int	VK_QUERY_RESULT_64_BIT VK_QUERY_RESULT_PARTIAL_BIT VK_QUERY_RESULT_WAIT_BIT VK_QUERY_RESULT_WITH_AVAILABILITY_BIT	VkQueryResultFlagBits - Bitmask specifying how and when query results are returned
static int	VK_QUERY_TYPE_OCCLUSION VK_QUERY_TYPE_PIPELINE_STATISTICS VK_QUERY_TYPE_TIMESTAMP	VkQueryType - Specify the type of queries managed by a query pool
static int	VK_QUEUE_COMPUTE_BIT	VkQueueFlagBits - Bitmask specifying capabilities of queues in a queue family
static int	VK_QUEUE_FAMILY_IGNORED	API Constants
static int	VK_QUEUE_GRAPHICS_BIT VK_QUEUE_SPARSE_BINDING_BIT VK_QUEUE_TRANSFER_BIT	VkQueueFlagBits - Bitmask specifying capabilities of queues in a queue family
static int	VK_REMAINING_ARRAY_LAYERS VK_REMAINING_MIP_LEVELS	API Constants
static int	VK_SAMPLE_COUNT_1_BIT VK_SAMPLE_COUNT_16_BIT VK_SAMPLE_COUNT_2_BIT VK_SAMPLE_COUNT_32_BIT VK_SAMPLE_COUNT_4_BIT VK_SAMPLE_COUNT_64_BIT VK_SAMPLE_COUNT_8_BIT	VkSampleCountFlagBits - Bitmask specifying sample counts supported for an image used for storage operations
static int	VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT VK_SAMPLER_ADDRESS_MODE_REPEAT	VkSamplerAddressMode - Specify behavior of sampling with texture coordinates outside an image
static int	VK_SAMPLER_MIPMAP_MODE_LINEAR VK_SAMPLER_MIPMAP_MODE_NEAREST	VkSamplerMipmapMode - Specify mipmap mode used for texture lookups
static int	VK_SHADER_STAGE_ALL VK_SHADER_STAGE_ALL_GRAPHICS VK_SHADER_STAGE_COMPUTE_BIT VK_SHADER_STAGE_FRAGMENT_BIT VK_SHADER_STAGE_GEOMETRY_BIT VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT VK_SHADER_STAGE_VERTEX_BIT	VkShaderStageFlagBits - Bitmask specifying a pipeline stage
static int	VK_SHARING_MODE_CONCURRENT VK_SHARING_MODE_EXCLUSIVE	VkSharingMode - Buffer and image sharing modes
static int	VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT	VkSparseImageFormatFlagBits - Bitmask specifying additional information about a sparse image resource
static int	VK_SPARSE_MEMORY_BIND_METADATA_BIT	VkSparseMemoryBindFlagBits - Bitmask specifying usage of a sparse memory binding operation
static int	VK_STENCIL_FACE_BACK_BIT VK_STENCIL_FACE_FRONT_BIT VK_STENCIL_FRONT_AND_BACK	VkStencilFaceFlagBits - Bitmask specifying sets of stencil state for which to update the compare mask
static int	VK_STENCIL_OP_DECREMENT_AND_CLAMP VK_STENCIL_OP_DECREMENT_AND_WRAP VK_STENCIL_OP_INCREMENT_AND_CLAMP VK_STENCIL_OP_INCREMENT_AND_WRAP VK_STENCIL_OP_INVERT VK_STENCIL_OP_KEEP VK_STENCIL_OP_REPLACE VK_STENCIL_OP_ZERO	VkStencilOp - Stencil comparison function
static int	VK_STRUCTURE_TYPE_APPLICATION_INFO VK_STRUCTURE_TYPE_BIND_SPARSE_INFO VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO VK_STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO VK_STRUCTURE_TYPE_EVENT_CREATE_INFO VK_STRUCTURE_TYPE_FENCE_CREATE_INFO VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO VK_STRUCTURE_TYPE_MEMORY_BARRIER VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO VK_STRUCTURE_TYPE_SUBMIT_INFO VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET	VkStructureType - Vulkan structure types (stype)
static int	VK_SUBPASS_CONTENTS_INLINE VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS	VkSubpassContents - Specify how commands in the first subpass of a render pass are provided
static int	VK_SUBPASS_EXTERNAL	API Constants
static int	VK_SUCCESS	VkResult - Vulkan command return codes
static int	VK_SYSTEM_ALLOCATION_SCOPE_CACHE VK_SYSTEM_ALLOCATION_SCOPE_COMMAND VK_SYSTEM_ALLOCATION_SCOPE_DEVICE VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE VK_SYSTEM_ALLOCATION_SCOPE_OBJECT	VkSystemAllocationScope - Allocation scope
static int	VK_TIMEOUT	VkResult - Vulkan command return codes
static int	VK_TRUE VK_UUID_SIZE	API Constants
static int	VK_VENDOR_ID_KAZAN VK_VENDOR_ID_VIV VK_VENDOR_ID_VSI	VkVendorId - Khronos vendor IDs
static int	VK_VERTEX_INPUT_RATE_INSTANCE VK_VERTEX_INPUT_RATE_VERTEX	VkVertexInputRate - Specify rate at which vertex attributes are pulled from buffers
static long	VK_WHOLE_SIZE	API Constants

Method Summary

Modifier and Type	Method	Description
static int	nvkAllocateCommandBuffers(VkDevice device, long pAllocateInfo, long pCommandBuffers)	Unsafe version of: AllocateCommandBuffers
static int	nvkAllocateDescriptorSets(VkDevice device, long pAllocateInfo, long pDescriptorSets)	Unsafe version of: AllocateDescriptorSets
static int	nvkAllocateMemory(VkDevice device, long pAllocateInfo, long pAllocator, long pMemory)	Unsafe version of: AllocateMemory
static int	nvkBeginCommandBuffer(VkCommandBuffer commandBuffer, long pBeginInfo)	Unsafe version of: BeginCommandBuffer
static void	nvkCmdBeginRenderPass(VkCommandBuffer commandBuffer, long pRenderPassBegin, int contents)	Unsafe version of: CmdBeginRenderPass
static void	nvkCmdBindDescriptorSets(VkCommandBuffer commandBuffer, int pipelineBindPoint, long layout, int firstSet, int descriptorSetCount, long pDescriptorSets, int dynamicOffsetCount, long pDynamicOffsets)	Unsafe version of: CmdBindDescriptorSets
static void	nvkCmdBindVertexBuffers(VkCommandBuffer commandBuffer, int firstBinding, int bindingCount, long pBuffers, long pOffsets)	Unsafe version of: CmdBindVertexBuffers
static void	nvkCmdBlitImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, int regionCount, long pRegions, int filter)	Unsafe version of: CmdBlitImage
static void	nvkCmdClearAttachments(VkCommandBuffer commandBuffer, int attachmentCount, long pAttachments, int rectCount, long pRects)	Unsafe version of: CmdClearAttachments
static void	nvkCmdClearColorImage(VkCommandBuffer commandBuffer, long image, int imageLayout, long pColor, int rangeCount, long pRanges)	Unsafe version of: CmdClearColorImage
static void	nvkCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, long image, int imageLayout, long pDepthStencil, int rangeCount, long pRanges)	Unsafe version of: CmdClearDepthStencilImage
static void	nvkCmdCopyBuffer(VkCommandBuffer commandBuffer, long srcBuffer, long dstBuffer, int regionCount, long pRegions)	Unsafe version of: CmdCopyBuffer
static void	nvkCmdCopyBufferToImage(VkCommandBuffer commandBuffer, long srcBuffer, long dstImage, int dstImageLayout, int regionCount, long pRegions)	Unsafe version of: CmdCopyBufferToImage
static void	nvkCmdCopyImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, int regionCount, long pRegions)	Unsafe version of: CmdCopyImage
static void	nvkCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstBuffer, int regionCount, long pRegions)	Unsafe version of: CmdCopyImageToBuffer
static void	nvkCmdExecuteCommands(VkCommandBuffer commandBuffer, int commandBufferCount, long pCommandBuffers)	Unsafe version of: CmdExecuteCommands
static void	nvkCmdPipelineBarrier(VkCommandBuffer commandBuffer, int srcStageMask, int dstStageMask, int dependencyFlags, int memoryBarrierCount, long pMemoryBarriers, int bufferMemoryBarrierCount, long pBufferMemoryBarriers, int imageMemoryBarrierCount, long pImageMemoryBarriers)	Unsafe version of: CmdPipelineBarrier
static void	nvkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, int size, long pValues)	Unsafe version of: CmdPushConstants
static void	nvkCmdResolveImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, int regionCount, long pRegions)	Unsafe version of: CmdResolveImage
static void	nvkCmdSetBlendConstants(VkCommandBuffer commandBuffer, long blendConstants)	Unsafe version of: CmdSetBlendConstants
static void	nvkCmdSetScissor(VkCommandBuffer commandBuffer, int firstScissor, int scissorCount, long pScissors)	Unsafe version of: CmdSetScissor
static void	nvkCmdSetViewport(VkCommandBuffer commandBuffer, int firstViewport, int viewportCount, long pViewports)	Unsafe version of: CmdSetViewport
static void	nvkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, long dataSize, long pData)	Unsafe version of: CmdUpdateBuffer
static void	nvkCmdWaitEvents(VkCommandBuffer commandBuffer, int eventCount, long pEvents, int srcStageMask, int dstStageMask, int memoryBarrierCount, long pMemoryBarriers, int bufferMemoryBarrierCount, long pBufferMemoryBarriers, int imageMemoryBarrierCount, long pImageMemoryBarriers)	Unsafe version of: CmdWaitEvents
static int	nvkCreateBuffer(VkDevice device, long pCreateInfo, long pAllocator, long pBuffer)	Unsafe version of: CreateBuffer
static int	nvkCreateBufferView(VkDevice device, long pCreateInfo, long pAllocator, long pView)	Unsafe version of: CreateBufferView
static int	nvkCreateCommandPool(VkDevice device, long pCreateInfo, long pAllocator, long pCommandPool)	Unsafe version of: CreateCommandPool
static int	nvkCreateComputePipelines(VkDevice device, long pipelineCache, int createInfoCount, long pCreateInfos, long pAllocator, long pPipelines)	Unsafe version of: CreateComputePipelines
static int	nvkCreateDescriptorPool(VkDevice device, long pCreateInfo, long pAllocator, long pDescriptorPool)	Unsafe version of: CreateDescriptorPool
static int	nvkCreateDescriptorSetLayout(VkDevice device, long pCreateInfo, long pAllocator, long pSetLayout)	Unsafe version of: CreateDescriptorSetLayout
static int	nvkCreateDevice(VkPhysicalDevice physicalDevice, long pCreateInfo, long pAllocator, long pDevice)	Unsafe version of: CreateDevice
static int	nvkCreateEvent(VkDevice device, long pCreateInfo, long pAllocator, long pEvent)	Unsafe version of: CreateEvent
static int	nvkCreateFence(VkDevice device, long pCreateInfo, long pAllocator, long pFence)	Unsafe version of: CreateFence
static int	nvkCreateFramebuffer(VkDevice device, long pCreateInfo, long pAllocator, long pFramebuffer)	Unsafe version of: CreateFramebuffer
static int	nvkCreateGraphicsPipelines(VkDevice device, long pipelineCache, int createInfoCount, long pCreateInfos, long pAllocator, long pPipelines)	Unsafe version of: CreateGraphicsPipelines
static int	nvkCreateImage(VkDevice device, long pCreateInfo, long pAllocator, long pImage)	Unsafe version of: CreateImage
static int	nvkCreateImageView(VkDevice device, long pCreateInfo, long pAllocator, long pView)	Unsafe version of: CreateImageView
static int	nvkCreateInstance(long pCreateInfo, long pAllocator, long pInstance)	Unsafe version of: CreateInstance
static int	nvkCreatePipelineCache(VkDevice device, long pCreateInfo, long pAllocator, long pPipelineCache)	Unsafe version of: CreatePipelineCache
static int	nvkCreatePipelineLayout(VkDevice device, long pCreateInfo, long pAllocator, long pPipelineLayout)	Unsafe version of: CreatePipelineLayout
static int	nvkCreateQueryPool(VkDevice device, long pCreateInfo, long pAllocator, long pQueryPool)	Unsafe version of: CreateQueryPool
static int	nvkCreateRenderPass(VkDevice device, long pCreateInfo, long pAllocator, long pRenderPass)	Unsafe version of: CreateRenderPass
static int	nvkCreateSampler(VkDevice device, long pCreateInfo, long pAllocator, long pSampler)	Unsafe version of: CreateSampler
static int	nvkCreateSemaphore(VkDevice device, long pCreateInfo, long pAllocator, long pSemaphore)	Unsafe version of: CreateSemaphore
static int	nvkCreateShaderModule(VkDevice device, long pCreateInfo, long pAllocator, long pShaderModule)	Unsafe version of: CreateShaderModule
static void	nvkDestroyBuffer(VkDevice device, long buffer, long pAllocator)	Unsafe version of: DestroyBuffer
static void	nvkDestroyBufferView(VkDevice device, long bufferView, long pAllocator)	Unsafe version of: DestroyBufferView
static void	nvkDestroyCommandPool(VkDevice device, long commandPool, long pAllocator)	Unsafe version of: DestroyCommandPool
static void	nvkDestroyDescriptorPool(VkDevice device, long descriptorPool, long pAllocator)	Unsafe version of: DestroyDescriptorPool
static void	nvkDestroyDescriptorSetLayout(VkDevice device, long descriptorSetLayout, long pAllocator)	Unsafe version of: DestroyDescriptorSetLayout
static void	nvkDestroyDevice(VkDevice device, long pAllocator)	Unsafe version of: DestroyDevice
static void	nvkDestroyEvent(VkDevice device, long event, long pAllocator)	Unsafe version of: DestroyEvent
static void	nvkDestroyFence(VkDevice device, long fence, long pAllocator)	Unsafe version of: DestroyFence
static void	nvkDestroyFramebuffer(VkDevice device, long framebuffer, long pAllocator)	Unsafe version of: DestroyFramebuffer
static void	nvkDestroyImage(VkDevice device, long image, long pAllocator)	Unsafe version of: DestroyImage
static void	nvkDestroyImageView(VkDevice device, long imageView, long pAllocator)	Unsafe version of: DestroyImageView
static void	nvkDestroyInstance(VkInstance instance, long pAllocator)	Unsafe version of: DestroyInstance
static void	nvkDestroyPipeline(VkDevice device, long pipeline, long pAllocator)	Unsafe version of: DestroyPipeline
static void	nvkDestroyPipelineCache(VkDevice device, long pipelineCache, long pAllocator)	Unsafe version of: DestroyPipelineCache
static void	nvkDestroyPipelineLayout(VkDevice device, long pipelineLayout, long pAllocator)	Unsafe version of: DestroyPipelineLayout
static void	nvkDestroyQueryPool(VkDevice device, long queryPool, long pAllocator)	Unsafe version of: DestroyQueryPool
static void	nvkDestroyRenderPass(VkDevice device, long renderPass, long pAllocator)	Unsafe version of: DestroyRenderPass
static void	nvkDestroySampler(VkDevice device, long sampler, long pAllocator)	Unsafe version of: DestroySampler
static void	nvkDestroySemaphore(VkDevice device, long semaphore, long pAllocator)	Unsafe version of: DestroySemaphore
static void	nvkDestroyShaderModule(VkDevice device, long shaderModule, long pAllocator)	Unsafe version of: DestroyShaderModule
static int	nvkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, long pLayerName, long pPropertyCount, long pProperties)	Unsafe version of: EnumerateDeviceExtensionProperties
static int	nvkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, long pPropertyCount, long pProperties)	Unsafe version of: EnumerateDeviceLayerProperties
static int	nvkEnumerateInstanceExtensionProperties(long pLayerName, long pPropertyCount, long pProperties)	Unsafe version of: EnumerateInstanceExtensionProperties
static int	nvkEnumerateInstanceLayerProperties(long pPropertyCount, long pProperties)	Unsafe version of: EnumerateInstanceLayerProperties
static int	nvkEnumeratePhysicalDevices(VkInstance instance, long pPhysicalDeviceCount, long pPhysicalDevices)	Unsafe version of: EnumeratePhysicalDevices
static int	nvkFlushMappedMemoryRanges(VkDevice device, int memoryRangeCount, long pMemoryRanges)	Unsafe version of: FlushMappedMemoryRanges
static void	nvkFreeCommandBuffers(VkDevice device, long commandPool, int commandBufferCount, long pCommandBuffers)	Unsafe version of: FreeCommandBuffers
static int	nvkFreeDescriptorSets(VkDevice device, long descriptorPool, int descriptorSetCount, long pDescriptorSets)	Unsafe version of: FreeDescriptorSets
static void	nvkFreeMemory(VkDevice device, long memory, long pAllocator)	Unsafe version of: FreeMemory
static void	nvkGetBufferMemoryRequirements(VkDevice device, long buffer, long pMemoryRequirements)	Unsafe version of: GetBufferMemoryRequirements
static void	nvkGetDeviceMemoryCommitment(VkDevice device, long memory, long pCommittedMemoryInBytes)	Unsafe version of: GetDeviceMemoryCommitment
static long	nvkGetDeviceProcAddr(VkDevice device, long pName)	Unsafe version of: GetDeviceProcAddr
static void	nvkGetDeviceQueue(VkDevice device, int queueFamilyIndex, int queueIndex, long pQueue)	Unsafe version of: GetDeviceQueue
static void	nvkGetImageMemoryRequirements(VkDevice device, long image, long pMemoryRequirements)	Unsafe version of: GetImageMemoryRequirements
static void	nvkGetImageSparseMemoryRequirements(VkDevice device, long image, long pSparseMemoryRequirementCount, long pSparseMemoryRequirements)	Unsafe version of: GetImageSparseMemoryRequirements
static void	nvkGetImageSubresourceLayout(VkDevice device, long image, long pSubresource, long pLayout)	Unsafe version of: GetImageSubresourceLayout
static long	nvkGetInstanceProcAddr(VkInstance instance, long pName)	Unsafe version of: GetInstanceProcAddr
static void	nvkGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, long pFeatures)	Unsafe version of: GetPhysicalDeviceFeatures
static void	nvkGetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice, int format, long pFormatProperties)	Unsafe version of: GetPhysicalDeviceFormatProperties
static int	nvkGetPhysicalDeviceImageFormatProperties(VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, long pImageFormatProperties)	Unsafe version of: GetPhysicalDeviceImageFormatProperties
static void	nvkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice, long pMemoryProperties)	Unsafe version of: GetPhysicalDeviceMemoryProperties
static void	nvkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, long pProperties)	Unsafe version of: GetPhysicalDeviceProperties
static void	nvkGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice, long pQueueFamilyPropertyCount, long pQueueFamilyProperties)	Unsafe version of: GetPhysicalDeviceQueueFamilyProperties
static void	nvkGetPhysicalDeviceSparseImageFormatProperties(VkPhysicalDevice physicalDevice, int format, int type, int samples, int usage, int tiling, long pPropertyCount, long pProperties)	Unsafe version of: GetPhysicalDeviceSparseImageFormatProperties
static int	nvkGetPipelineCacheData(VkDevice device, long pipelineCache, long pDataSize, long pData)	Unsafe version of: GetPipelineCacheData
static int	nvkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, long dataSize, long pData, long stride, int flags)	Unsafe version of: GetQueryPoolResults
static void	nvkGetRenderAreaGranularity(VkDevice device, long renderPass, long pGranularity)	Unsafe version of: GetRenderAreaGranularity
static int	nvkInvalidateMappedMemoryRanges(VkDevice device, int memoryRangeCount, long pMemoryRanges)	Unsafe version of: InvalidateMappedMemoryRanges
static int	nvkMapMemory(VkDevice device, long memory, long offset, long size, int flags, long ppData)	Unsafe version of: MapMemory
static int	nvkMergePipelineCaches(VkDevice device, long dstCache, int srcCacheCount, long pSrcCaches)	Unsafe version of: MergePipelineCaches
static int	nvkQueueBindSparse(VkQueue queue, int bindInfoCount, long pBindInfo, long fence)	Unsafe version of: QueueBindSparse
static int	nvkQueueSubmit(VkQueue queue, int submitCount, long pSubmits, long fence)	Unsafe version of: QueueSubmit
static int	nvkResetFences(VkDevice device, int fenceCount, long pFences)	Unsafe version of: ResetFences
static void	nvkUpdateDescriptorSets(VkDevice device, int descriptorWriteCount, long pDescriptorWrites, int descriptorCopyCount, long pDescriptorCopies)	Unsafe version of: UpdateDescriptorSets
static int	nvkWaitForFences(VkDevice device, int fenceCount, long pFences, int waitAll, long timeout)	Unsafe version of: WaitForFences
static int	VK_MAKE_VERSION(int major, int minor, int patch)	Constructs an API version number.
static int	VK_VERSION_MAJOR(int version)	Extracts the API major version number from a packed version number.
static int	VK_VERSION_MINOR(int version)	Extracts the API minor version number from a packed version number.
static int	VK_VERSION_PATCH(int version)	Extracts the API patch version number from a packed version number.
static int	vkAllocateCommandBuffers(VkDevice device, VkCommandBufferAllocateInfo pAllocateInfo, PointerBuffer pCommandBuffers)	Allocate command buffers from an existing command pool.
static int	vkAllocateDescriptorSets(VkDevice device, VkDescriptorSetAllocateInfo pAllocateInfo, long[] pDescriptorSets)	Array version of: AllocateDescriptorSets
static int	vkAllocateDescriptorSets(VkDevice device, VkDescriptorSetAllocateInfo pAllocateInfo, java.nio.LongBuffer pDescriptorSets)	Allocate one or more descriptor sets.
static int	vkAllocateMemory(VkDevice device, VkMemoryAllocateInfo pAllocateInfo, VkAllocationCallbacks pAllocator, long[] pMemory)	Array version of: AllocateMemory
static int	vkAllocateMemory(VkDevice device, VkMemoryAllocateInfo pAllocateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pMemory)	Allocate device memory.
static int	vkBeginCommandBuffer(VkCommandBuffer commandBuffer, VkCommandBufferBeginInfo pBeginInfo)	Start recording a command buffer.
static int	vkBindBufferMemory(VkDevice device, long buffer, long memory, long memoryOffset)	Bind device memory to a buffer object.
static int	vkBindImageMemory(VkDevice device, long image, long memory, long memoryOffset)	Bind device memory to an image object.
static void	vkCmdBeginQuery(VkCommandBuffer commandBuffer, long queryPool, int query, int flags)	Begin a query.
static void	vkCmdBeginRenderPass(VkCommandBuffer commandBuffer, VkRenderPassBeginInfo pRenderPassBegin, int contents)	Begin a new render pass.
static void	vkCmdBindDescriptorSets(VkCommandBuffer commandBuffer, int pipelineBindPoint, long layout, int firstSet, long[] pDescriptorSets, int[] pDynamicOffsets)	Array version of: CmdBindDescriptorSets
static void	vkCmdBindDescriptorSets(VkCommandBuffer commandBuffer, int pipelineBindPoint, long layout, int firstSet, java.nio.LongBuffer pDescriptorSets, java.nio.IntBuffer pDynamicOffsets)	Binds descriptor sets to a command buffer.
static void	vkCmdBindIndexBuffer(VkCommandBuffer commandBuffer, long buffer, long offset, int indexType)	Bind an index buffer to a command buffer.
static void	vkCmdBindPipeline(VkCommandBuffer commandBuffer, int pipelineBindPoint, long pipeline)	Bind a pipeline object to a command buffer.
static void	vkCmdBindVertexBuffers(VkCommandBuffer commandBuffer, int firstBinding, long[] pBuffers, long[] pOffsets)	Array version of: CmdBindVertexBuffers
static void	vkCmdBindVertexBuffers(VkCommandBuffer commandBuffer, int firstBinding, java.nio.LongBuffer pBuffers, java.nio.LongBuffer pOffsets)	Bind vertex buffers to a command buffer.
static void	vkCmdBlitImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageBlit.Buffer pRegions, int filter)	Copy regions of an image, potentially performing format conversion,.
static void	vkCmdClearAttachments(VkCommandBuffer commandBuffer, VkClearAttachment.Buffer pAttachments, VkClearRect.Buffer pRects)	Clear regions within bound framebuffer attachments.
static void	vkCmdClearColorImage(VkCommandBuffer commandBuffer, long image, int imageLayout, VkClearColorValue pColor, VkImageSubresourceRange pRange)	Clear regions of a color image.
static void	vkCmdClearColorImage(VkCommandBuffer commandBuffer, long image, int imageLayout, VkClearColorValue pColor, VkImageSubresourceRange.Buffer pRanges)	Clear regions of a color image.
static void	vkCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, long image, int imageLayout, VkClearDepthStencilValue pDepthStencil, VkImageSubresourceRange pRange)	Fill regions of a combined depth/stencil image.
static void	vkCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, long image, int imageLayout, VkClearDepthStencilValue pDepthStencil, VkImageSubresourceRange.Buffer pRanges)	Fill regions of a combined depth/stencil image.
static void	vkCmdCopyBuffer(VkCommandBuffer commandBuffer, long srcBuffer, long dstBuffer, VkBufferCopy.Buffer pRegions)	Copy data between buffer regions.
static void	vkCmdCopyBufferToImage(VkCommandBuffer commandBuffer, long srcBuffer, long dstImage, int dstImageLayout, VkBufferImageCopy.Buffer pRegions)	Copy data from a buffer into an image.
static void	vkCmdCopyImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageCopy.Buffer pRegions)	Copy data between images.
static void	vkCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstBuffer, VkBufferImageCopy.Buffer pRegions)	Copy image data into a buffer.
static void	vkCmdCopyQueryPoolResults(VkCommandBuffer commandBuffer, long queryPool, int firstQuery, int queryCount, long dstBuffer, long dstOffset, long stride, int flags)	Copy the results of queries in a query pool to a buffer object.
static void	vkCmdDispatch(VkCommandBuffer commandBuffer, int groupCountX, int groupCountY, int groupCountZ)	Dispatch compute work items.
static void	vkCmdDispatchIndirect(VkCommandBuffer commandBuffer, long buffer, long offset)	Dispatch compute work items using indirect parameters.
static void	vkCmdDraw(VkCommandBuffer commandBuffer, int vertexCount, int instanceCount, int firstVertex, int firstInstance)	Draw primitives.
static void	vkCmdDrawIndexed(VkCommandBuffer commandBuffer, int indexCount, int instanceCount, int firstIndex, int vertexOffset, int firstInstance)	Issue an indexed draw into a command buffer.
static void	vkCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, long buffer, long offset, int drawCount, int stride)	Perform an indexed indirect draw.
static void	vkCmdDrawIndirect(VkCommandBuffer commandBuffer, long buffer, long offset, int drawCount, int stride)	Issue an indirect draw into a command buffer.
static void	vkCmdEndQuery(VkCommandBuffer commandBuffer, long queryPool, int query)	Ends a query.
static void	vkCmdEndRenderPass(VkCommandBuffer commandBuffer)	End the current render pass.
static void	vkCmdExecuteCommands(VkCommandBuffer commandBuffer, PointerBuffer pCommandBuffers)	Execute a secondary command buffer from a primary command buffer.
static void	vkCmdExecuteCommands(VkCommandBuffer commandBuffer, VkCommandBuffer pCommandBuffer)	Execute a secondary command buffer from a primary command buffer.
static void	vkCmdFillBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, long size, int data)	Fill a region of a buffer with a fixed value.
static void	vkCmdNextSubpass(VkCommandBuffer commandBuffer, int contents)	Transition to the next subpass of a render pass.
static void	vkCmdPipelineBarrier(VkCommandBuffer commandBuffer, int srcStageMask, int dstStageMask, int dependencyFlags, VkMemoryBarrier.Buffer pMemoryBarriers, VkBufferMemoryBarrier.Buffer pBufferMemoryBarriers, VkImageMemoryBarrier.Buffer pImageMemoryBarriers)	Insert a memory dependency.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, double[] pValues)	Array version of: CmdPushConstants
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, float[] pValues)	Array version of: CmdPushConstants
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, int[] pValues)	Array version of: CmdPushConstants
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, long[] pValues)	Array version of: CmdPushConstants
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, short[] pValues)	Array version of: CmdPushConstants
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.ByteBuffer pValues)	Update the values of push constants.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.DoubleBuffer pValues)	Update the values of push constants.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.FloatBuffer pValues)	Update the values of push constants.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.IntBuffer pValues)	Update the values of push constants.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.LongBuffer pValues)	Update the values of push constants.
static void	vkCmdPushConstants(VkCommandBuffer commandBuffer, long layout, int stageFlags, int offset, java.nio.ShortBuffer pValues)	Update the values of push constants.
static void	vkCmdResetEvent(VkCommandBuffer commandBuffer, long event, int stageMask)	Reset an event object to non-signaled state.
static void	vkCmdResetQueryPool(VkCommandBuffer commandBuffer, long queryPool, int firstQuery, int queryCount)	Reset queries in a query pool.
static void	vkCmdResolveImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve pRegion)	Resolve regions of an image.
static void	vkCmdResolveImage(VkCommandBuffer commandBuffer, long srcImage, int srcImageLayout, long dstImage, int dstImageLayout, VkImageResolve.Buffer pRegions)	Resolve regions of an image.
static void	vkCmdSetBlendConstants(VkCommandBuffer commandBuffer, float[] blendConstants)	Array version of: CmdSetBlendConstants
static void	vkCmdSetBlendConstants(VkCommandBuffer commandBuffer, java.nio.FloatBuffer blendConstants)	Set the values of blend constants.
static void	vkCmdSetDepthBias(VkCommandBuffer commandBuffer, float depthBiasConstantFactor, float depthBiasClamp, float depthBiasSlopeFactor)	Set the depth bias dynamic state.
static void	vkCmdSetDepthBounds(VkCommandBuffer commandBuffer, float minDepthBounds, float maxDepthBounds)	Set the depth bounds test values for a command buffer.
static void	vkCmdSetEvent(VkCommandBuffer commandBuffer, long event, int stageMask)	Set an event object to signaled state.
static void	vkCmdSetLineWidth(VkCommandBuffer commandBuffer, float lineWidth)	Set the dynamic line width state.
static void	vkCmdSetScissor(VkCommandBuffer commandBuffer, int firstScissor, VkRect2D.Buffer pScissors)	Set the dynamic scissor rectangles on a command buffer.
static void	vkCmdSetStencilCompareMask(VkCommandBuffer commandBuffer, int faceMask, int compareMask)	Set the stencil compare mask dynamic state.
static void	vkCmdSetStencilReference(VkCommandBuffer commandBuffer, int faceMask, int reference)	Set the stencil reference dynamic state.
static void	vkCmdSetStencilWriteMask(VkCommandBuffer commandBuffer, int faceMask, int writeMask)	Set the stencil write mask dynamic state.
static void	vkCmdSetViewport(VkCommandBuffer commandBuffer, int firstViewport, VkViewport.Buffer pViewports)	Set the viewport on a command buffer.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, double[] pData)	Array version of: CmdUpdateBuffer
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, float[] pData)	Array version of: CmdUpdateBuffer
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, int[] pData)	Array version of: CmdUpdateBuffer
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, long[] pData)	Array version of: CmdUpdateBuffer
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, short[] pData)	Array version of: CmdUpdateBuffer
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.ByteBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.DoubleBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.FloatBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.IntBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.LongBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdUpdateBuffer(VkCommandBuffer commandBuffer, long dstBuffer, long dstOffset, java.nio.ShortBuffer pData)	Update a buffer's contents from host memory.
static void	vkCmdWaitEvents(VkCommandBuffer commandBuffer, long[] pEvents, int srcStageMask, int dstStageMask, VkMemoryBarrier.Buffer pMemoryBarriers, VkBufferMemoryBarrier.Buffer pBufferMemoryBarriers, VkImageMemoryBarrier.Buffer pImageMemoryBarriers)	Array version of: CmdWaitEvents
static void	vkCmdWaitEvents(VkCommandBuffer commandBuffer, java.nio.LongBuffer pEvents, int srcStageMask, int dstStageMask, VkMemoryBarrier.Buffer pMemoryBarriers, VkBufferMemoryBarrier.Buffer pBufferMemoryBarriers, VkImageMemoryBarrier.Buffer pImageMemoryBarriers)	Wait for one or more events and insert a set of memory.
static void	vkCmdWriteTimestamp(VkCommandBuffer commandBuffer, int pipelineStage, long queryPool, int query)	Write a device timestamp into a query object.
static int	vkCreateBuffer(VkDevice device, VkBufferCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pBuffer)	Array version of: CreateBuffer
static int	vkCreateBuffer(VkDevice device, VkBufferCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pBuffer)	Create a new buffer object.
static int	vkCreateBufferView(VkDevice device, VkBufferViewCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pView)	Array version of: CreateBufferView
static int	vkCreateBufferView(VkDevice device, VkBufferViewCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pView)	Create a new buffer view object.
static int	vkCreateCommandPool(VkDevice device, VkCommandPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pCommandPool)	Array version of: CreateCommandPool
static int	vkCreateCommandPool(VkDevice device, VkCommandPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pCommandPool)	Create a new command pool object.
static int	vkCreateComputePipelines(VkDevice device, long pipelineCache, VkComputePipelineCreateInfo.Buffer pCreateInfos, VkAllocationCallbacks pAllocator, long[] pPipelines)	Array version of: CreateComputePipelines
static int	vkCreateComputePipelines(VkDevice device, long pipelineCache, VkComputePipelineCreateInfo.Buffer pCreateInfos, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pPipelines)	Creates a new compute pipeline object.
static int	vkCreateDescriptorPool(VkDevice device, VkDescriptorPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pDescriptorPool)	Array version of: CreateDescriptorPool
static int	vkCreateDescriptorPool(VkDevice device, VkDescriptorPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pDescriptorPool)	Creates a descriptor pool object.
static int	vkCreateDescriptorSetLayout(VkDevice device, VkDescriptorSetLayoutCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSetLayout)	Array version of: CreateDescriptorSetLayout
static int	vkCreateDescriptorSetLayout(VkDevice device, VkDescriptorSetLayoutCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSetLayout)	Create a new descriptor set layout.
static int	vkCreateDevice(VkPhysicalDevice physicalDevice, VkDeviceCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, PointerBuffer pDevice)	Create a new device instance.
static int	vkCreateEvent(VkDevice device, VkEventCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pEvent)	Array version of: CreateEvent
static int	vkCreateEvent(VkDevice device, VkEventCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pEvent)	Create a new event object.
static int	vkCreateFence(VkDevice device, VkFenceCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pFence)	Array version of: CreateFence
static int	vkCreateFence(VkDevice device, VkFenceCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFence)	Create a new fence object.
static int	vkCreateFramebuffer(VkDevice device, VkFramebufferCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pFramebuffer)	Array version of: CreateFramebuffer
static int	vkCreateFramebuffer(VkDevice device, VkFramebufferCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pFramebuffer)	Create a new framebuffer object.
static int	vkCreateGraphicsPipelines(VkDevice device, long pipelineCache, VkGraphicsPipelineCreateInfo.Buffer pCreateInfos, VkAllocationCallbacks pAllocator, long[] pPipelines)	Array version of: CreateGraphicsPipelines
static int	vkCreateGraphicsPipelines(VkDevice device, long pipelineCache, VkGraphicsPipelineCreateInfo.Buffer pCreateInfos, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pPipelines)	Create graphics pipelines.
static int	vkCreateImage(VkDevice device, VkImageCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pImage)	Array version of: CreateImage
static int	vkCreateImage(VkDevice device, VkImageCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pImage)	Create a new image object.
static int	vkCreateImageView(VkDevice device, VkImageViewCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pView)	Array version of: CreateImageView
static int	vkCreateImageView(VkDevice device, VkImageViewCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pView)	Create an image view from an existing image.
static int	vkCreateInstance(VkInstanceCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, PointerBuffer pInstance)	Create a new Vulkan instance.
static int	vkCreatePipelineCache(VkDevice device, VkPipelineCacheCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pPipelineCache)	Array version of: CreatePipelineCache
static int	vkCreatePipelineCache(VkDevice device, VkPipelineCacheCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pPipelineCache)	Creates a new pipeline cache.
static int	vkCreatePipelineLayout(VkDevice device, VkPipelineLayoutCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pPipelineLayout)	Array version of: CreatePipelineLayout
static int	vkCreatePipelineLayout(VkDevice device, VkPipelineLayoutCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pPipelineLayout)	Creates a new pipeline layout object.
static int	vkCreateQueryPool(VkDevice device, VkQueryPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pQueryPool)	Array version of: CreateQueryPool
static int	vkCreateQueryPool(VkDevice device, VkQueryPoolCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pQueryPool)	Create a new query pool object.
static int	vkCreateRenderPass(VkDevice device, VkRenderPassCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pRenderPass)	Array version of: CreateRenderPass
static int	vkCreateRenderPass(VkDevice device, VkRenderPassCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pRenderPass)	Create a new render pass object.
static int	vkCreateSampler(VkDevice device, VkSamplerCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSampler)	Array version of: CreateSampler
static int	vkCreateSampler(VkDevice device, VkSamplerCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSampler)	Create a new sampler object.
static int	vkCreateSemaphore(VkDevice device, VkSemaphoreCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSemaphore)	Array version of: CreateSemaphore
static int	vkCreateSemaphore(VkDevice device, VkSemaphoreCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pSemaphore)	Create a new queue semaphore object.
static int	vkCreateShaderModule(VkDevice device, VkShaderModuleCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, long[] pShaderModule)	Array version of: CreateShaderModule
static int	vkCreateShaderModule(VkDevice device, VkShaderModuleCreateInfo pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pShaderModule)	Creates a new shader module object.
static void	vkDestroyBuffer(VkDevice device, long buffer, VkAllocationCallbacks pAllocator)	Destroy a buffer object.
static void	vkDestroyBufferView(VkDevice device, long bufferView, VkAllocationCallbacks pAllocator)	Destroy a buffer view object.
static void	vkDestroyCommandPool(VkDevice device, long commandPool, VkAllocationCallbacks pAllocator)	Destroy a command pool object.
static void	vkDestroyDescriptorPool(VkDevice device, long descriptorPool, VkAllocationCallbacks pAllocator)	Destroy a descriptor pool object.
static void	vkDestroyDescriptorSetLayout(VkDevice device, long descriptorSetLayout, VkAllocationCallbacks pAllocator)	Destroy a descriptor set layout object.
static void	vkDestroyDevice(VkDevice device, VkAllocationCallbacks pAllocator)	Destroy a logical device.
static void	vkDestroyEvent(VkDevice device, long event, VkAllocationCallbacks pAllocator)	Destroy an event object.
static void	vkDestroyFence(VkDevice device, long fence, VkAllocationCallbacks pAllocator)	Destroy a fence object.
static void	vkDestroyFramebuffer(VkDevice device, long framebuffer, VkAllocationCallbacks pAllocator)	Destroy a framebuffer object.
static void	vkDestroyImage(VkDevice device, long image, VkAllocationCallbacks pAllocator)	Destroy an image object.
static void	vkDestroyImageView(VkDevice device, long imageView, VkAllocationCallbacks pAllocator)	Destroy an image view object.
static void	vkDestroyInstance(VkInstance instance, VkAllocationCallbacks pAllocator)	Destroy an instance of Vulkan.
static void	vkDestroyPipeline(VkDevice device, long pipeline, VkAllocationCallbacks pAllocator)	Destroy a pipeline object.
static void	vkDestroyPipelineCache(VkDevice device, long pipelineCache, VkAllocationCallbacks pAllocator)	Destroy a pipeline cache object.
static void	vkDestroyPipelineLayout(VkDevice device, long pipelineLayout, VkAllocationCallbacks pAllocator)	Destroy a pipeline layout object.
static void	vkDestroyQueryPool(VkDevice device, long queryPool, VkAllocationCallbacks pAllocator)	Destroy a query pool object.
static void	vkDestroyRenderPass(VkDevice device, long renderPass, VkAllocationCallbacks pAllocator)	Destroy a render pass object.
static void	vkDestroySampler(VkDevice device, long sampler, VkAllocationCallbacks pAllocator)	Destroy a sampler object.
static void	vkDestroySemaphore(VkDevice device, long semaphore, VkAllocationCallbacks pAllocator)	Destroy a semaphore object.
static void	vkDestroyShaderModule(VkDevice device, long shaderModule, VkAllocationCallbacks pAllocator)	Destroy a shader module module.
static int	vkDeviceWaitIdle(VkDevice device)	Wait for a device to become idle.
static int	vkEndCommandBuffer(VkCommandBuffer commandBuffer)	Finish recording a command buffer.
static int	vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, java.lang.CharSequence pLayerName, int[] pPropertyCount, VkExtensionProperties.Buffer pProperties)	Array version of: EnumerateDeviceExtensionProperties
static int	vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, java.lang.CharSequence pLayerName, java.nio.IntBuffer pPropertyCount, VkExtensionProperties.Buffer pProperties)	Returns properties of available physical device extensions.
static int	vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, java.nio.ByteBuffer pLayerName, int[] pPropertyCount, VkExtensionProperties.Buffer pProperties)	Array version of: EnumerateDeviceExtensionProperties
static int	vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice, java.nio.ByteBuffer pLayerName, java.nio.IntBuffer pPropertyCount, VkExtensionProperties.Buffer pProperties)	Returns properties of available physical device extensions.
static int	vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, int[] pPropertyCount, VkLayerProperties.Buffer pProperties)	Array version of: EnumerateDeviceLayerProperties
static int	vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pPropertyCount, VkLayerProperties.Buffer pProperties)	Returns properties of available physical device layers.
static int	vkEnumerateInstanceExtensionProperties(java.lang.CharSequence pLayerName, int[] pPropertyCount, VkExtensionProperties.Buffer pProperties)	Array version of: EnumerateInstanceExtensionProperties
static int	vkEnumerateInstanceExtensionProperties(java.lang.CharSequence pLayerName, java.nio.IntBuffer pPropertyCount, VkExtensionProperties.Buffer pProperties)	Returns up to requested number of global extension properties.
static int	vkEnumerateInstanceExtensionProperties(java.nio.ByteBuffer pLayerName, int[] pPropertyCount, VkExtensionProperties.Buffer pProperties)	Array version of: EnumerateInstanceExtensionProperties
static int	vkEnumerateInstanceExtensionProperties(java.nio.ByteBuffer pLayerName, java.nio.IntBuffer pPropertyCount, VkExtensionProperties.Buffer pProperties)	Returns up to requested number of global extension properties.
static int	vkEnumerateInstanceLayerProperties(int[] pPropertyCount, VkLayerProperties.Buffer pProperties)	Array version of: EnumerateInstanceLayerProperties
static int	vkEnumerateInstanceLayerProperties(java.nio.IntBuffer pPropertyCount, VkLayerProperties.Buffer pProperties)	Returns up to requested number of global layer properties.
static int	vkEnumeratePhysicalDevices(VkInstance instance, int[] pPhysicalDeviceCount, PointerBuffer pPhysicalDevices)	Array version of: EnumeratePhysicalDevices
static int	vkEnumeratePhysicalDevices(VkInstance instance, java.nio.IntBuffer pPhysicalDeviceCount, PointerBuffer pPhysicalDevices)	Enumerates the physical devices accessible to a Vulkan instance.
static int	vkFlushMappedMemoryRanges(VkDevice device, VkMappedMemoryRange pMemoryRange)	Flush mapped memory ranges.
static int	vkFlushMappedMemoryRanges(VkDevice device, VkMappedMemoryRange.Buffer pMemoryRanges)	Flush mapped memory ranges.
static void	vkFreeCommandBuffers(VkDevice device, long commandPool, PointerBuffer pCommandBuffers)	Free command buffers.
static void	vkFreeCommandBuffers(VkDevice device, long commandPool, VkCommandBuffer pCommandBuffer)	Free command buffers.
static int	vkFreeDescriptorSets(VkDevice device, long descriptorPool, long pDescriptorSet)	Free one or more descriptor sets.
static int	vkFreeDescriptorSets(VkDevice device, long descriptorPool, long[] pDescriptorSets)	Array version of: FreeDescriptorSets
static int	vkFreeDescriptorSets(VkDevice device, long descriptorPool, java.nio.LongBuffer pDescriptorSets)	Free one or more descriptor sets.
static void	vkFreeMemory(VkDevice device, long memory, VkAllocationCallbacks pAllocator)	Free device memory.
static void	vkGetBufferMemoryRequirements(VkDevice device, long buffer, VkMemoryRequirements pMemoryRequirements)	Returns the memory requirements for specified Vulkan object.
static void	vkGetDeviceMemoryCommitment(VkDevice device, long memory, long[] pCommittedMemoryInBytes)	Array version of: GetDeviceMemoryCommitment
static void	vkGetDeviceMemoryCommitment(VkDevice device, long memory, java.nio.LongBuffer pCommittedMemoryInBytes)	Query the current commitment for a VkDeviceMemory.
static long	vkGetDeviceProcAddr(VkDevice device, java.lang.CharSequence pName)	Return a function pointer for a command.
static long	vkGetDeviceProcAddr(VkDevice device, java.nio.ByteBuffer pName)	Return a function pointer for a command.
static void	vkGetDeviceQueue(VkDevice device, int queueFamilyIndex, int queueIndex, PointerBuffer pQueue)	Get a queue handle from a device.
static int	vkGetEventStatus(VkDevice device, long event)	Retrieve the status of an event object.
static int	vkGetFenceStatus(VkDevice device, long fence)	Return the status of a fence.
static void	vkGetImageMemoryRequirements(VkDevice device, long image, VkMemoryRequirements pMemoryRequirements)	Returns the memory requirements for specified Vulkan object.
static void	vkGetImageSparseMemoryRequirements(VkDevice device, long image, int[] pSparseMemoryRequirementCount, VkSparseImageMemoryRequirements.Buffer pSparseMemoryRequirements)	Array version of: GetImageSparseMemoryRequirements
static void	vkGetImageSparseMemoryRequirements(VkDevice device, long image, java.nio.IntBuffer pSparseMemoryRequirementCount, VkSparseImageMemoryRequirements.Buffer pSparseMemoryRequirements)	Query the memory requirements for a sparse image.
static void	vkGetImageSubresourceLayout(VkDevice device, long image, VkImageSubresource pSubresource, VkSubresourceLayout pLayout)	Retrieve information about an image subresource.
static long	vkGetInstanceProcAddr(VkInstance instance, java.lang.CharSequence pName)	Return a function pointer for a command.
static long	vkGetInstanceProcAddr(VkInstance instance, java.nio.ByteBuffer pName)	Return a function pointer for a command.
static void	vkGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures pFeatures)	Reports capabilities of a physical device.
static void	vkGetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice, int format, VkFormatProperties pFormatProperties)	Lists physical device's format capabilities.
static int	vkGetPhysicalDeviceImageFormatProperties(VkPhysicalDevice physicalDevice, int format, int type, int tiling, int usage, int flags, VkImageFormatProperties pImageFormatProperties)	Lists physical device's image format capabilities.
static void	vkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceMemoryProperties pMemoryProperties)	Reports memory information for the specified physical device.
static void	vkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice, VkPhysicalDeviceProperties pProperties)	Returns properties of a physical device.
static void	vkGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice, int[] pQueueFamilyPropertyCount, VkQueueFamilyProperties.Buffer pQueueFamilyProperties)	Array version of: GetPhysicalDeviceQueueFamilyProperties
static void	vkGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice, java.nio.IntBuffer pQueueFamilyPropertyCount, VkQueueFamilyProperties.Buffer pQueueFamilyProperties)	Reports properties of the queues of the specified physical device.
static void	vkGetPhysicalDeviceSparseImageFormatProperties(VkPhysicalDevice physicalDevice, int format, int type, int samples, int usage, int tiling, int[] pPropertyCount, VkSparseImageFormatProperties.Buffer pProperties)	Array version of: GetPhysicalDeviceSparseImageFormatProperties
static void	vkGetPhysicalDeviceSparseImageFormatProperties(VkPhysicalDevice physicalDevice, int format, int type, int samples, int usage, int tiling, java.nio.IntBuffer pPropertyCount, VkSparseImageFormatProperties.Buffer pProperties)	Retrieve properties of an image format applied to sparse images.
static int	vkGetPipelineCacheData(VkDevice device, long pipelineCache, PointerBuffer pDataSize, java.nio.ByteBuffer pData)	Get the data store from a pipeline cache.
static int	vkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, int[] pData, long stride, int flags)	Array version of: GetQueryPoolResults
static int	vkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, long[] pData, long stride, int flags)	Array version of: GetQueryPoolResults
static int	vkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, java.nio.ByteBuffer pData, long stride, int flags)	Copy results of queries in a query pool to a host memory region.
static int	vkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, java.nio.IntBuffer pData, long stride, int flags)	Copy results of queries in a query pool to a host memory region.
static int	vkGetQueryPoolResults(VkDevice device, long queryPool, int firstQuery, int queryCount, java.nio.LongBuffer pData, long stride, int flags)	Copy results of queries in a query pool to a host memory region.
static void	vkGetRenderAreaGranularity(VkDevice device, long renderPass, VkExtent2D pGranularity)	Returns the granularity for optimal render area.
static int	vkInvalidateMappedMemoryRanges(VkDevice device, VkMappedMemoryRange pMemoryRange)	Invalidate ranges of mapped memory objects.
static int	vkInvalidateMappedMemoryRanges(VkDevice device, VkMappedMemoryRange.Buffer pMemoryRanges)	Invalidate ranges of mapped memory objects.
static int	vkMapMemory(VkDevice device, long memory, long offset, long size, int flags, PointerBuffer ppData)	Map a memory object into application address space.
static int	vkMergePipelineCaches(VkDevice device, long dstCache, long[] pSrcCaches)	Array version of: MergePipelineCaches
static int	vkMergePipelineCaches(VkDevice device, long dstCache, java.nio.LongBuffer pSrcCaches)	Combine the data stores of pipeline caches.
static int	vkQueueBindSparse(VkQueue queue, VkBindSparseInfo.Buffer pBindInfo, long fence)	Bind device memory to a sparse resource object.
static int	vkQueueBindSparse(VkQueue queue, VkBindSparseInfo pBindInfo, long fence)	Bind device memory to a sparse resource object.
static int	vkQueueSubmit(VkQueue queue, VkSubmitInfo.Buffer pSubmits, long fence)	Submits a sequence of semaphores or command buffers to a queue.
static int	vkQueueSubmit(VkQueue queue, VkSubmitInfo pSubmit, long fence)	Submits a sequence of semaphores or command buffers to a queue.
static int	vkQueueWaitIdle(VkQueue queue)	Wait for a queue to become idle.
static int	vkResetCommandBuffer(VkCommandBuffer commandBuffer, int flags)	Reset a command buffer to the initial state.
static int	vkResetCommandPool(VkDevice device, long commandPool, int flags)	Reset a command pool.
static int	vkResetDescriptorPool(VkDevice device, long descriptorPool, int flags)	Resets a descriptor pool object.
static int	vkResetEvent(VkDevice device, long event)	Reset an event to non-signaled state.
static int	vkResetFences(VkDevice device, long pFence)	Resets one or more fence objects.
static int	vkResetFences(VkDevice device, long[] pFences)	Array version of: ResetFences
static int	vkResetFences(VkDevice device, java.nio.LongBuffer pFences)	Resets one or more fence objects.
static int	vkSetEvent(VkDevice device, long event)	Set an event to signaled state.
static void	vkUnmapMemory(VkDevice device, long memory)	Unmap a previously mapped memory object.
static void	vkUpdateDescriptorSets(VkDevice device, VkWriteDescriptorSet.Buffer pDescriptorWrites, VkCopyDescriptorSet.Buffer pDescriptorCopies)	Update the contents of a descriptor set object.
static int	vkWaitForFences(VkDevice device, long[] pFences, boolean waitAll, long timeout)	Array version of: WaitForFences
static int	vkWaitForFences(VkDevice device, long pFence, boolean waitAll, long timeout)	Wait for one or more fences to become signaled.
static int	vkWaitForFences(VkDevice device, java.nio.LongBuffer pFences, boolean waitAll, long timeout)	Wait for one or more fences to become signaled.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_PIPELINE_CACHE_HEADER_VERSION_ONE

VkPipelineCacheHeaderVersion - Encode pipeline cache version

Description

• PIPELINE_CACHE_HEADER_VERSION_ONE specifies version one of the pipeline cache.

See Also

CreatePipelineCache, GetPipelineCacheData

VK_SUCCESS, VK_NOT_READY, VK_TIMEOUT, VK_EVENT_SET, VK_EVENT_RESET, VK_INCOMPLETE, VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY, VK_ERROR_INITIALIZATION_FAILED, VK_ERROR_DEVICE_LOST, VK_ERROR_MEMORY_MAP_FAILED, VK_ERROR_LAYER_NOT_PRESENT, VK_ERROR_EXTENSION_NOT_PRESENT, VK_ERROR_FEATURE_NOT_PRESENT, VK_ERROR_INCOMPATIBLE_DRIVER, VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_FORMAT_NOT_SUPPORTED, VK_ERROR_FRAGMENTED_POOL

VkResult - Vulkan command return codes

Description

• SUCCESS Command successfully completed
• NOT_READY A fence or query has not yet completed
• TIMEOUT A wait operation has not completed in the specified time
• EVENT_SET An event is signaled
• EVENT_RESET An event is unsignaled
• INCOMPLETE A return array was too small for the result
• SUBOPTIMAL_KHR A swapchain no longer matches the surface properties exactly, but can still be used to present to the surface successfully.

• ERROR_OUT_OF_HOST_MEMORY A host memory allocation has failed.
• ERROR_OUT_OF_DEVICE_MEMORY A device memory allocation has failed.
• ERROR_INITIALIZATION_FAILED Initialization of an object could not be completed for implementation-specific reasons.
• ERROR_DEVICE_LOST The logical or physical device has been lost. See Lost Device
• ERROR_MEMORY_MAP_FAILED Mapping of a memory object has failed.
• ERROR_LAYER_NOT_PRESENT A requested layer is not present or could not be loaded.
• ERROR_EXTENSION_NOT_PRESENT A requested extension is not supported.
• ERROR_FEATURE_NOT_PRESENT A requested feature is not supported.
• ERROR_INCOMPATIBLE_DRIVER The requested version of Vulkan is not supported by the driver or is otherwise incompatible for implementation-specific reasons.
• ERROR_TOO_MANY_OBJECTS Too many objects of the type have already been created.
• ERROR_FORMAT_NOT_SUPPORTED A requested format is not supported on this device.
• ERROR_FRAGMENTED_POOL A pool allocation has failed due to fragmentation of the pool’s memory. This must only be returned if no attempt to allocate host or device memory was made to accomodate the new allocation. This should be returned in preference to ERROR_OUT_OF_POOL_MEMORY, but only if the implementation is certain that the pool allocation failure was due to fragmentation.
• ERROR_SURFACE_LOST_KHR A surface is no longer available.
• ERROR_NATIVE_WINDOW_IN_USE_KHR The requested window is already in use by Vulkan or another API in a manner which prevents it from being used again.
• ERROR_OUT_OF_DATE_KHR A surface has changed in such a way that it is no longer compatible with the swapchain, and further presentation requests using the swapchain will fail. Applications must query the new surface properties and recreate their swapchain if they wish to continue presenting to the surface.
• ERROR_INCOMPATIBLE_DISPLAY_KHR The display used by a swapchain does not use the same presentable image layout, or is incompatible in a way that prevents sharing an image.
• ERROR_INVALID_SHADER_NV One or more shaders failed to compile or link. More details are reported back to the application via VK_EXT_debug_report if enabled.
• ERROR_OUT_OF_POOL_MEMORY A pool memory allocation has failed. This must only be returned if no attempt to allocate host or device memory was made to accomodate the new allocation. If the failure was definitely due to fragmentation of the pool, ERROR_FRAGMENTED_POOL should be returned instead.
• ERROR_INVALID_EXTERNAL_HANDLE An external handle is not a valid handle of the specified type.
• ERROR_FRAGMENTATION_EXT A descriptor pool creation has failed due to fragmentation.

If a command returns a run time error, unless otherwise specified any output parameters will have undefined contents, except that if the output parameter is a structure with sType and pNext fields, those fields will be unmodified. Any structures chained from pNext will also have undefined contents, except that sType and pNext will be unmodified.

Out of memory errors do not damage any currently existing Vulkan objects. Objects that have already been successfully created can still be used by the application.

Performance-critical commands generally do not have return codes. If a run time error occurs in such commands, the implementation will defer reporting the error until a specified point. For commands that record into command buffers (ftext:vkCmd*) run time errors are reported by EndCommandBuffer.

See Also

No cross-references are available, VkPresentInfoKHR

VK_STRUCTURE_TYPE_APPLICATION_INFO, VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO, VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO, VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO, VK_STRUCTURE_TYPE_SUBMIT_INFO, VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE, VK_STRUCTURE_TYPE_BIND_SPARSE_INFO, VK_STRUCTURE_TYPE_FENCE_CREATE_INFO, VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO, VK_STRUCTURE_TYPE_EVENT_CREATE_INFO, VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO, VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO, VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO, VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO, VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO, VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO, VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO, VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO, VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO, VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO, VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO, VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO, VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET, VK_STRUCTURE_TYPE_COPY_DESCRIPTOR_SET, VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO, VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO, VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO, VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO, VK_STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO, VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO, VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO, VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER, VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER, VK_STRUCTURE_TYPE_MEMORY_BARRIER, VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO, VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO

VkStructureType - Vulkan structure types (stype)

Description

Each value corresponds to a particular structure with a sType member with a matching name. As a general rule, the name of each VkStructureType value is obtained by taking the name of the structure, stripping the leading Vk, prefixing each capital letter with _, converting the entire resulting string to upper case, and prefixing it with VK_STRUCTURE_TYPE_. For example, structures of type VkImageCreateInfo correspond to a VkStructureType of STRUCTURE_TYPE_IMAGE_CREATE_INFO, and thus its sType member must equal that when it is passed to the API.

The values STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO and STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO are reserved for internal use by the loader, and do not have corresponding Vulkan structures in this Specification.

See Also

VkAccelerationStructureCreateInfoNVX, VkAccelerationStructureMemoryRequirementsInfoNVX, VkAcquireNextImageInfoKHR, VkApplicationInfo, VkAttachmentDescription2KHR, VkAttachmentReference2KHR, VkBaseInStructure, VkBaseOutStructure, VkBindAccelerationStructureMemoryInfoNVX, VkBindBufferMemoryDeviceGroupInfo, VkBindBufferMemoryInfo, VkBindImageMemoryDeviceGroupInfo, VkBindImageMemoryInfo, VkBindImageMemorySwapchainInfoKHR, VkBindImagePlaneMemoryInfo, VkBindSparseInfo, VkBufferCreateInfo, VkBufferMemoryBarrier, VkBufferMemoryRequirementsInfo2, VkBufferViewCreateInfo, VkCheckpointDataNV, VkCmdProcessCommandsInfoNVX, VkCmdReserveSpaceForCommandsInfoNVX, VkCommandBufferAllocateInfo, VkCommandBufferBeginInfo, VkCommandBufferInheritanceConditionalRenderingInfoEXT, VkCommandBufferInheritanceInfo, VkCommandPoolCreateInfo, VkComputePipelineCreateInfo, VkConditionalRenderingBeginInfoEXT, VkCopyDescriptorSet, VkD3D12FenceSubmitInfoKHR, VkDebugMarkerMarkerInfoEXT, VkDebugMarkerObjectNameInfoEXT, VkDebugMarkerObjectTagInfoEXT, VkDebugReportCallbackCreateInfoEXT, VkDebugUtilsLabelEXT, VkDebugUtilsMessengerCallbackDataEXT, VkDebugUtilsMessengerCreateInfoEXT, VkDebugUtilsObjectNameInfoEXT, VkDebugUtilsObjectTagInfoEXT, VkDedicatedAllocationBufferCreateInfoNV, VkDedicatedAllocationImageCreateInfoNV, VkDedicatedAllocationMemoryAllocateInfoNV, VkDescriptorAccelerationStructureInfoNVX, VkDescriptorPoolCreateInfo, VkDescriptorPoolInlineUniformBlockCreateInfoEXT, VkDescriptorSetAllocateInfo, VkDescriptorSetLayoutBindingFlagsCreateInfoEXT, VkDescriptorSetLayoutCreateInfo, VkDescriptorSetLayoutSupport, VkDescriptorSetVariableDescriptorCountAllocateInfoEXT, VkDescriptorSetVariableDescriptorCountLayoutSupportEXT, VkDescriptorUpdateTemplateCreateInfo, VkDeviceCreateInfo, VkDeviceEventInfoEXT, VkDeviceGeneratedCommandsFeaturesNVX, VkDeviceGeneratedCommandsLimitsNVX, VkDeviceGroupBindSparseInfo, VkDeviceGroupCommandBufferBeginInfo, VkDeviceGroupDeviceCreateInfo, VkDeviceGroupPresentCapabilitiesKHR, VkDeviceGroupPresentInfoKHR, VkDeviceGroupRenderPassBeginInfo, VkDeviceGroupSubmitInfo, VkDeviceGroupSwapchainCreateInfoKHR, VkDeviceQueueCreateInfo, VkDeviceQueueGlobalPriorityCreateInfoEXT, VkDeviceQueueInfo2, VkDisplayEventInfoEXT, VkDisplayModeCreateInfoKHR, VkDisplayModeProperties2KHR, VkDisplayPlaneCapabilities2KHR, VkDisplayPlaneInfo2KHR, VkDisplayPlaneProperties2KHR, VkDisplayPowerInfoEXT, VkDisplayPresentInfoKHR, VkDisplayProperties2KHR, VkDisplaySurfaceCreateInfoKHR, VkEventCreateInfo, VkExportFenceCreateInfo, VkExportFenceWin32HandleInfoKHR, VkExportMemoryAllocateInfo, VkExportMemoryAllocateInfoNV, VkExportMemoryWin32HandleInfoKHR, VkExportMemoryWin32HandleInfoNV, VkExportSemaphoreCreateInfo, VkExportSemaphoreWin32HandleInfoKHR, VkExternalBufferProperties, VkExternalFenceProperties, VkExternalImageFormatProperties, VkExternalMemoryBufferCreateInfo, VkExternalMemoryImageCreateInfo, VkExternalMemoryImageCreateInfoNV, VkExternalSemaphoreProperties, VkFenceCreateInfo, VkFenceGetFdInfoKHR, VkFenceGetWin32HandleInfoKHR, VkFormatProperties2, VkFramebufferCreateInfo, VkGeometryAABBNVX, VkGeometryNVX, VkGeometryTrianglesNVX, VkGraphicsPipelineCreateInfo, VkHdrMetadataEXT, VkImageCreateInfo, VkImageFormatListCreateInfoKHR, VkImageFormatProperties2, VkImageMemoryBarrier, VkImageMemoryRequirementsInfo2, VkImagePlaneMemoryRequirementsInfo, VkImageSparseMemoryRequirementsInfo2, VkImageSwapchainCreateInfoKHR, VkImageViewASTCDecodeModeEXT, VkImageViewCreateInfo, VkImageViewUsageCreateInfo, VkImportFenceFdInfoKHR, VkImportFenceWin32HandleInfoKHR, VkImportMemoryFdInfoKHR, VkImportMemoryHostPointerInfoEXT, VkImportMemoryWin32HandleInfoKHR, VkImportMemoryWin32HandleInfoNV, VkImportSemaphoreFdInfoKHR, VkImportSemaphoreWin32HandleInfoKHR, VkIndirectCommandsLayoutCreateInfoNVX, VkInstanceCreateInfo, VkMacOSSurfaceCreateInfoMVK, VkMappedMemoryRange, VkMemoryAllocateFlagsInfo, VkMemoryAllocateInfo, VkMemoryBarrier, VkMemoryDedicatedAllocateInfo, VkMemoryDedicatedRequirements, VkMemoryFdPropertiesKHR, VkMemoryGetFdInfoKHR, VkMemoryGetWin32HandleInfoKHR, VkMemoryHostPointerPropertiesEXT, VkMemoryRequirements2, VkMemoryWin32HandlePropertiesKHR, VkMultisamplePropertiesEXT, VkObjectTableCreateInfoNVX, VkPhysicalDevice16BitStorageFeatures, VkPhysicalDevice8BitStorageFeaturesKHR, VkPhysicalDeviceASTCDecodeFeaturesEXT, VkPhysicalDeviceBlendOperationAdvancedFeaturesEXT, VkPhysicalDeviceBlendOperationAdvancedPropertiesEXT, VkPhysicalDeviceComputeShaderDerivativesFeaturesNV, VkPhysicalDeviceConditionalRenderingFeaturesEXT, VkPhysicalDeviceConservativeRasterizationPropertiesEXT, VkPhysicalDeviceCornerSampledImageFeaturesNV, VkPhysicalDeviceDescriptorIndexingFeaturesEXT, VkPhysicalDeviceDescriptorIndexingPropertiesEXT, VkPhysicalDeviceDiscardRectanglePropertiesEXT, VkPhysicalDeviceDriverPropertiesKHR, VkPhysicalDeviceExclusiveScissorFeaturesNV, VkPhysicalDeviceExternalBufferInfo, VkPhysicalDeviceExternalFenceInfo, VkPhysicalDeviceExternalImageFormatInfo, VkPhysicalDeviceExternalMemoryHostPropertiesEXT, VkPhysicalDeviceExternalSemaphoreInfo, VkPhysicalDeviceFeatures2, VkPhysicalDeviceFragmentShaderBarycentricFeaturesNV, VkPhysicalDeviceGroupProperties, VkPhysicalDeviceIDProperties, VkPhysicalDeviceImageFormatInfo2, VkPhysicalDeviceInlineUniformBlockFeaturesEXT, VkPhysicalDeviceInlineUniformBlockPropertiesEXT, VkPhysicalDeviceMaintenance3Properties, VkPhysicalDeviceMemoryProperties2, VkPhysicalDeviceMeshShaderFeaturesNV, VkPhysicalDeviceMeshShaderPropertiesNV, VkPhysicalDeviceMultiviewFeatures, VkPhysicalDeviceMultiviewPerViewAttributesPropertiesNVX, VkPhysicalDeviceMultiviewProperties, VkPhysicalDevicePointClippingProperties, VkPhysicalDeviceProperties2, VkPhysicalDeviceProtectedMemoryFeatures, VkPhysicalDeviceProtectedMemoryProperties, VkPhysicalDevicePushDescriptorPropertiesKHR, VkPhysicalDeviceRaytracingPropertiesNVX, VkPhysicalDeviceRepresentativeFragmentTestFeaturesNV, VkPhysicalDeviceSampleLocationsPropertiesEXT, VkPhysicalDeviceSamplerFilterMinmaxPropertiesEXT, VkPhysicalDeviceSamplerYcbcrConversionFeatures, VkPhysicalDeviceShaderAtomicInt64FeaturesKHR, VkPhysicalDeviceShaderCorePropertiesAMD, VkPhysicalDeviceShaderDrawParameterFeatures, VkPhysicalDeviceShaderImageFootprintFeaturesNV, VkPhysicalDeviceShadingRateImageFeaturesNV, VkPhysicalDeviceShadingRateImagePropertiesNV, VkPhysicalDeviceSparseImageFormatInfo2, VkPhysicalDeviceSubgroupProperties, VkPhysicalDeviceSurfaceInfo2KHR, VkPhysicalDeviceVariablePointerFeatures, VkPhysicalDeviceVertexAttributeDivisorFeaturesEXT, VkPhysicalDeviceVertexAttributeDivisorPropertiesEXT, VkPhysicalDeviceVulkanMemoryModelFeaturesKHR, VkPipelineCacheCreateInfo, VkPipelineColorBlendAdvancedStateCreateInfoEXT, VkPipelineColorBlendStateCreateInfo, VkPipelineCoverageModulationStateCreateInfoNV, VkPipelineCoverageToColorStateCreateInfoNV, VkPipelineDepthStencilStateCreateInfo, VkPipelineDiscardRectangleStateCreateInfoEXT, VkPipelineDynamicStateCreateInfo, VkPipelineInputAssemblyStateCreateInfo, VkPipelineLayoutCreateInfo, VkPipelineMultisampleStateCreateInfo, VkPipelineRasterizationConservativeStateCreateInfoEXT, VkPipelineRasterizationStateCreateInfo, VkPipelineRasterizationStateRasterizationOrderAMD, VkPipelineRepresentativeFragmentTestStateCreateInfoNV, VkPipelineSampleLocationsStateCreateInfoEXT, VkPipelineShaderStageCreateInfo, VkPipelineTessellationDomainOriginStateCreateInfo, VkPipelineTessellationStateCreateInfo, VkPipelineVertexInputDivisorStateCreateInfoEXT, VkPipelineVertexInputStateCreateInfo, VkPipelineViewportCoarseSampleOrderStateCreateInfoNV, VkPipelineViewportExclusiveScissorStateCreateInfoNV, VkPipelineViewportShadingRateImageStateCreateInfoNV, VkPipelineViewportStateCreateInfo, VkPipelineViewportSwizzleStateCreateInfoNV, VkPipelineViewportWScalingStateCreateInfoNV, VkPresentInfoKHR, VkPresentRegionsKHR, VkPresentTimesInfoGOOGLE, VkProtectedSubmitInfo, VkQueryPoolCreateInfo, VkQueueFamilyCheckpointPropertiesNV, VkQueueFamilyProperties2, VkRaytracingPipelineCreateInfoNVX, VkRenderPassBeginInfo, VkRenderPassCreateInfo, VkRenderPassCreateInfo2KHR, VkRenderPassInputAttachmentAspectCreateInfo, VkRenderPassMultiviewCreateInfo, VkRenderPassSampleLocationsBeginInfoEXT, VkSampleLocationsInfoEXT, VkSamplerCreateInfo, VkSamplerReductionModeCreateInfoEXT, VkSamplerYcbcrConversionCreateInfo, VkSamplerYcbcrConversionImageFormatProperties, VkSamplerYcbcrConversionInfo, VkSemaphoreCreateInfo, VkSemaphoreGetFdInfoKHR, VkSemaphoreGetWin32HandleInfoKHR, VkShaderModuleCreateInfo, VkShaderModuleValidationCacheCreateInfoEXT, VkSharedPresentSurfaceCapabilitiesKHR, VkSparseImageFormatProperties2, VkSparseImageMemoryRequirements2, VkSubmitInfo, VkSubpassBeginInfoKHR, VkSubpassDependency2KHR, VkSubpassDescription2KHR, VkSubpassEndInfoKHR, VkSurfaceCapabilities2EXT, VkSurfaceCapabilities2KHR, VkSurfaceFormat2KHR, VkSwapchainCounterCreateInfoEXT, VkSwapchainCreateInfoKHR, VkTextureLODGatherFormatPropertiesAMD, VkValidationCacheCreateInfoEXT, VkValidationFlagsEXT, VkWaylandSurfaceCreateInfoKHR, VkWin32KeyedMutexAcquireReleaseInfoKHR, VkWin32KeyedMutexAcquireReleaseInfoNV, VkWin32SurfaceCreateInfoKHR, VkWriteDescriptorSet, VkWriteDescriptorSetInlineUniformBlockEXT, VkXlibSurfaceCreateInfoKHR

Enum values:

• STRUCTURE_TYPE_APPLICATION_INFO
• STRUCTURE_TYPE_INSTANCE_CREATE_INFO
• STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO
• STRUCTURE_TYPE_DEVICE_CREATE_INFO
• STRUCTURE_TYPE_SUBMIT_INFO
• STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO
• STRUCTURE_TYPE_MAPPED_MEMORY_RANGE
• STRUCTURE_TYPE_BIND_SPARSE_INFO
• STRUCTURE_TYPE_FENCE_CREATE_INFO
• STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO
• STRUCTURE_TYPE_EVENT_CREATE_INFO
• STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO
• STRUCTURE_TYPE_BUFFER_CREATE_INFO
• STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO
• STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
• STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO
• STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO
• STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO
• STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO
• STRUCTURE_TYPE_SAMPLER_CREATE_INFO
• STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO
• STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
• STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
• STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
• STRUCTURE_TYPE_COPY_DESCRIPTOR_SET
• STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
• STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO
• STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO
• STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO
• STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
• STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
• STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
• STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER
• STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER
• STRUCTURE_TYPE_MEMORY_BARRIER

VK_SYSTEM_ALLOCATION_SCOPE_COMMAND, VK_SYSTEM_ALLOCATION_SCOPE_OBJECT, VK_SYSTEM_ALLOCATION_SCOPE_CACHE, VK_SYSTEM_ALLOCATION_SCOPE_DEVICE, VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE

VkSystemAllocationScope - Allocation scope

Description

• SYSTEM_ALLOCATION_SCOPE_COMMAND specifies that the allocation is scoped to the duration of the Vulkan command.
• SYSTEM_ALLOCATION_SCOPE_OBJECT specifies that the allocation is scoped to the lifetime of the Vulkan object that is being created or used.
• SYSTEM_ALLOCATION_SCOPE_CACHE specifies that the allocation is scoped to the lifetime of a VkPipelineCache or VkValidationCacheEXT object.
• SYSTEM_ALLOCATION_SCOPE_DEVICE specifies that the allocation is scoped to the lifetime of the Vulkan device.
• SYSTEM_ALLOCATION_SCOPE_INSTANCE specifies that the allocation is scoped to the lifetime of the Vulkan instance.

Most Vulkan commands operate on a single object, or there is a sole object that is being created or manipulated. When an allocation uses an allocation scope of SYSTEM_ALLOCATION_SCOPE_OBJECT or SYSTEM_ALLOCATION_SCOPE_CACHE, the allocation is scoped to the object being created or manipulated.

When an implementation requires host memory, it will make callbacks to the application using the most specific allocator and allocation scope available:

• If an allocation is scoped to the duration of a command, the allocator will use the SYSTEM_ALLOCATION_SCOPE_COMMAND allocation scope. The most specific allocator available is used: if the object being created or manipulated has an allocator, that object’s allocator will be used, else if the parent VkDevice has an allocator it will be used, else if the parent VkInstance has an allocator it will be used. Else,
• If an allocation is associated with an object of type VkValidationCacheEXT or VkPipelineCache, the allocator will use the SYSTEM_ALLOCATION_SCOPE_CACHE allocation scope. The most specific allocator available is used (cache, else device, else instance). Else,
• If an allocation is scoped to the lifetime of an object, that object is being created or manipulated by the command, and that object’s type is not VkDevice or VkInstance, the allocator will use an allocation scope of SYSTEM_ALLOCATION_SCOPE_OBJECT. The most specific allocator available is used (object, else device, else instance). Else,
• If an allocation is scoped to the lifetime of a device, the allocator will use an allocation scope of SYSTEM_ALLOCATION_SCOPE_DEVICE. The most specific allocator available is used (device, else instance). Else,
• If the allocation is scoped to the lifetime of an instance and the instance has an allocator, its allocator will be used with an allocation scope of SYSTEM_ALLOCATION_SCOPE_INSTANCE.
• Otherwise an implementation will allocate memory through an alternative mechanism that is unspecified.

See Also

VkAllocationCallbacks

VK_INTERNAL_ALLOCATION_TYPE_EXECUTABLE

VkInternalAllocationType - Allocation type

Description

• INTERNAL_ALLOCATION_TYPE_EXECUTABLE specifies that the allocation is intended for execution by the host.

See Also

VkInternalAllocationNotification, VkInternalFreeNotification

VK_FORMAT_UNDEFINED, VK_FORMAT_R4G4_UNORM_PACK8, VK_FORMAT_R4G4B4A4_UNORM_PACK16, VK_FORMAT_B4G4R4A4_UNORM_PACK16, VK_FORMAT_R5G6B5_UNORM_PACK16, VK_FORMAT_B5G6R5_UNORM_PACK16, VK_FORMAT_R5G5B5A1_UNORM_PACK16, VK_FORMAT_B5G5R5A1_UNORM_PACK16, VK_FORMAT_A1R5G5B5_UNORM_PACK16, VK_FORMAT_R8_UNORM, VK_FORMAT_R8_SNORM, VK_FORMAT_R8_USCALED, VK_FORMAT_R8_SSCALED, VK_FORMAT_R8_UINT, VK_FORMAT_R8_SINT, VK_FORMAT_R8_SRGB, VK_FORMAT_R8G8_UNORM, VK_FORMAT_R8G8_SNORM, VK_FORMAT_R8G8_USCALED, VK_FORMAT_R8G8_SSCALED, VK_FORMAT_R8G8_UINT, VK_FORMAT_R8G8_SINT, VK_FORMAT_R8G8_SRGB, VK_FORMAT_R8G8B8_UNORM, VK_FORMAT_R8G8B8_SNORM, VK_FORMAT_R8G8B8_USCALED, VK_FORMAT_R8G8B8_SSCALED, VK_FORMAT_R8G8B8_UINT, VK_FORMAT_R8G8B8_SINT, VK_FORMAT_R8G8B8_SRGB, VK_FORMAT_B8G8R8_UNORM, VK_FORMAT_B8G8R8_SNORM, VK_FORMAT_B8G8R8_USCALED, VK_FORMAT_B8G8R8_SSCALED, VK_FORMAT_B8G8R8_UINT, VK_FORMAT_B8G8R8_SINT, VK_FORMAT_B8G8R8_SRGB, VK_FORMAT_R8G8B8A8_UNORM, VK_FORMAT_R8G8B8A8_SNORM, VK_FORMAT_R8G8B8A8_USCALED, VK_FORMAT_R8G8B8A8_SSCALED, VK_FORMAT_R8G8B8A8_UINT, VK_FORMAT_R8G8B8A8_SINT, VK_FORMAT_R8G8B8A8_SRGB, VK_FORMAT_B8G8R8A8_UNORM, VK_FORMAT_B8G8R8A8_SNORM, VK_FORMAT_B8G8R8A8_USCALED, VK_FORMAT_B8G8R8A8_SSCALED, VK_FORMAT_B8G8R8A8_UINT, VK_FORMAT_B8G8R8A8_SINT, VK_FORMAT_B8G8R8A8_SRGB, VK_FORMAT_A8B8G8R8_UNORM_PACK32, VK_FORMAT_A8B8G8R8_SNORM_PACK32, VK_FORMAT_A8B8G8R8_USCALED_PACK32, VK_FORMAT_A8B8G8R8_SSCALED_PACK32, VK_FORMAT_A8B8G8R8_UINT_PACK32, VK_FORMAT_A8B8G8R8_SINT_PACK32, VK_FORMAT_A8B8G8R8_SRGB_PACK32, VK_FORMAT_A2R10G10B10_UNORM_PACK32, VK_FORMAT_A2R10G10B10_SNORM_PACK32, VK_FORMAT_A2R10G10B10_USCALED_PACK32, VK_FORMAT_A2R10G10B10_SSCALED_PACK32, VK_FORMAT_A2R10G10B10_UINT_PACK32, VK_FORMAT_A2R10G10B10_SINT_PACK32, VK_FORMAT_A2B10G10R10_UNORM_PACK32, VK_FORMAT_A2B10G10R10_SNORM_PACK32, VK_FORMAT_A2B10G10R10_USCALED_PACK32, VK_FORMAT_A2B10G10R10_SSCALED_PACK32, VK_FORMAT_A2B10G10R10_UINT_PACK32, VK_FORMAT_A2B10G10R10_SINT_PACK32, VK_FORMAT_R16_UNORM, VK_FORMAT_R16_SNORM, VK_FORMAT_R16_USCALED, VK_FORMAT_R16_SSCALED, VK_FORMAT_R16_UINT, VK_FORMAT_R16_SINT, VK_FORMAT_R16_SFLOAT, VK_FORMAT_R16G16_UNORM, VK_FORMAT_R16G16_SNORM, VK_FORMAT_R16G16_USCALED, VK_FORMAT_R16G16_SSCALED, VK_FORMAT_R16G16_UINT, VK_FORMAT_R16G16_SINT, VK_FORMAT_R16G16_SFLOAT, VK_FORMAT_R16G16B16_UNORM, VK_FORMAT_R16G16B16_SNORM, VK_FORMAT_R16G16B16_USCALED, VK_FORMAT_R16G16B16_SSCALED, VK_FORMAT_R16G16B16_UINT, VK_FORMAT_R16G16B16_SINT, VK_FORMAT_R16G16B16_SFLOAT, VK_FORMAT_R16G16B16A16_UNORM, VK_FORMAT_R16G16B16A16_SNORM, VK_FORMAT_R16G16B16A16_USCALED, VK_FORMAT_R16G16B16A16_SSCALED, VK_FORMAT_R16G16B16A16_UINT, VK_FORMAT_R16G16B16A16_SINT, VK_FORMAT_R16G16B16A16_SFLOAT, VK_FORMAT_R32_UINT, VK_FORMAT_R32_SINT, VK_FORMAT_R32_SFLOAT, VK_FORMAT_R32G32_UINT, VK_FORMAT_R32G32_SINT, VK_FORMAT_R32G32_SFLOAT, VK_FORMAT_R32G32B32_UINT, VK_FORMAT_R32G32B32_SINT, VK_FORMAT_R32G32B32_SFLOAT, VK_FORMAT_R32G32B32A32_UINT, VK_FORMAT_R32G32B32A32_SINT, VK_FORMAT_R32G32B32A32_SFLOAT, VK_FORMAT_R64_UINT, VK_FORMAT_R64_SINT, VK_FORMAT_R64_SFLOAT, VK_FORMAT_R64G64_UINT, VK_FORMAT_R64G64_SINT, VK_FORMAT_R64G64_SFLOAT, VK_FORMAT_R64G64B64_UINT, VK_FORMAT_R64G64B64_SINT, VK_FORMAT_R64G64B64_SFLOAT, VK_FORMAT_R64G64B64A64_UINT, VK_FORMAT_R64G64B64A64_SINT, VK_FORMAT_R64G64B64A64_SFLOAT, VK_FORMAT_B10G11R11_UFLOAT_PACK32, VK_FORMAT_E5B9G9R9_UFLOAT_PACK32, VK_FORMAT_D16_UNORM, VK_FORMAT_X8_D24_UNORM_PACK32, VK_FORMAT_D32_SFLOAT, VK_FORMAT_S8_UINT, VK_FORMAT_D16_UNORM_S8_UINT, VK_FORMAT_D24_UNORM_S8_UINT, VK_FORMAT_D32_SFLOAT_S8_UINT, VK_FORMAT_BC1_RGB_UNORM_BLOCK, VK_FORMAT_BC1_RGB_SRGB_BLOCK, VK_FORMAT_BC1_RGBA_UNORM_BLOCK, VK_FORMAT_BC1_RGBA_SRGB_BLOCK, VK_FORMAT_BC2_UNORM_BLOCK, VK_FORMAT_BC2_SRGB_BLOCK, VK_FORMAT_BC3_UNORM_BLOCK, VK_FORMAT_BC3_SRGB_BLOCK, VK_FORMAT_BC4_UNORM_BLOCK, VK_FORMAT_BC4_SNORM_BLOCK, VK_FORMAT_BC5_UNORM_BLOCK, VK_FORMAT_BC5_SNORM_BLOCK, VK_FORMAT_BC6H_UFLOAT_BLOCK, VK_FORMAT_BC6H_SFLOAT_BLOCK, VK_FORMAT_BC7_UNORM_BLOCK, VK_FORMAT_BC7_SRGB_BLOCK, VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK, VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK, VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK, VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK, VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK, VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK, VK_FORMAT_EAC_R11_UNORM_BLOCK, VK_FORMAT_EAC_R11_SNORM_BLOCK, VK_FORMAT_EAC_R11G11_UNORM_BLOCK, VK_FORMAT_EAC_R11G11_SNORM_BLOCK, VK_FORMAT_ASTC_4x4_UNORM_BLOCK, VK_FORMAT_ASTC_4x4_SRGB_BLOCK, VK_FORMAT_ASTC_5x4_UNORM_BLOCK, VK_FORMAT_ASTC_5x4_SRGB_BLOCK, VK_FORMAT_ASTC_5x5_UNORM_BLOCK, VK_FORMAT_ASTC_5x5_SRGB_BLOCK, VK_FORMAT_ASTC_6x5_UNORM_BLOCK, VK_FORMAT_ASTC_6x5_SRGB_BLOCK, VK_FORMAT_ASTC_6x6_UNORM_BLOCK, VK_FORMAT_ASTC_6x6_SRGB_BLOCK, VK_FORMAT_ASTC_8x5_UNORM_BLOCK, VK_FORMAT_ASTC_8x5_SRGB_BLOCK, VK_FORMAT_ASTC_8x6_UNORM_BLOCK, VK_FORMAT_ASTC_8x6_SRGB_BLOCK, VK_FORMAT_ASTC_8x8_UNORM_BLOCK, VK_FORMAT_ASTC_8x8_SRGB_BLOCK, VK_FORMAT_ASTC_10x5_UNORM_BLOCK, VK_FORMAT_ASTC_10x5_SRGB_BLOCK, VK_FORMAT_ASTC_10x6_UNORM_BLOCK, VK_FORMAT_ASTC_10x6_SRGB_BLOCK, VK_FORMAT_ASTC_10x8_UNORM_BLOCK, VK_FORMAT_ASTC_10x8_SRGB_BLOCK, VK_FORMAT_ASTC_10x10_UNORM_BLOCK, VK_FORMAT_ASTC_10x10_SRGB_BLOCK, VK_FORMAT_ASTC_12x10_UNORM_BLOCK, VK_FORMAT_ASTC_12x10_SRGB_BLOCK, VK_FORMAT_ASTC_12x12_UNORM_BLOCK, VK_FORMAT_ASTC_12x12_SRGB_BLOCK

VkFormat - Available image formats

Description

• FORMAT_UNDEFINED specifies that the format is not specified.
• FORMAT_R4G4_UNORM_PACK8 specifies a two-component, 8-bit packed unsigned normalized format that has a 4-bit R component in bits 4..7, and a 4-bit G component in bits 0..3.
• FORMAT_R4G4B4A4_UNORM_PACK16 specifies a four-component, 16-bit packed unsigned normalized format that has a 4-bit R component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit B component in bits 4..7, and a 4-bit A component in bits 0..3.
• FORMAT_B4G4R4A4_UNORM_PACK16 specifies a four-component, 16-bit packed unsigned normalized format that has a 4-bit B component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit R component in bits 4..7, and a 4-bit A component in bits 0..3.
• FORMAT_R5G6B5_UNORM_PACK16 specifies a three-component, 16-bit packed unsigned normalized format that has a 5-bit R component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit B component in bits 0..4.
• FORMAT_B5G6R5_UNORM_PACK16 specifies a three-component, 16-bit packed unsigned normalized format that has a 5-bit B component in bits 11..15, a 6-bit G component in bits 5..10, and a 5-bit R component in bits 0..4.
• FORMAT_R5G5B5A1_UNORM_PACK16 specifies a four-component, 16-bit packed unsigned normalized format that has a 5-bit R component in bits 11..15, a 5-bit G component in bits 6..10, a 5-bit B component in bits 1..5, and a 1-bit A component in bit 0.
• FORMAT_B5G5R5A1_UNORM_PACK16 specifies a four-component, 16-bit packed unsigned normalized format that has a 5-bit B component in bits 11..15, a 5-bit G component in bits 6..10, a 5-bit R component in bits 1..5, and a 1-bit A component in bit 0.
• FORMAT_A1R5G5B5_UNORM_PACK16 specifies a four-component, 16-bit packed unsigned normalized format that has a 1-bit A component in bit 15, a 5-bit R component in bits 10..14, a 5-bit G component in bits 5..9, and a 5-bit B component in bits 0..4.
• FORMAT_R8_UNORM specifies a one-component, 8-bit unsigned normalized format that has a single 8-bit R component.
• FORMAT_R8_SNORM specifies a one-component, 8-bit signed normalized format that has a single 8-bit R component.
• FORMAT_R8_USCALED specifies a one-component, 8-bit unsigned scaled integer format that has a single 8-bit R component.
• FORMAT_R8_SSCALED specifies a one-component, 8-bit signed scaled integer format that has a single 8-bit R component.
• FORMAT_R8_UINT specifies a one-component, 8-bit unsigned integer format that has a single 8-bit R component.
• FORMAT_R8_SINT specifies a one-component, 8-bit signed integer format that has a single 8-bit R component.
• FORMAT_R8_SRGB specifies a one-component, 8-bit unsigned normalized format that has a single 8-bit R component stored with sRGB nonlinear encoding.
• FORMAT_R8G8_UNORM specifies a two-component, 16-bit unsigned normalized format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_SNORM specifies a two-component, 16-bit signed normalized format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_USCALED specifies a two-component, 16-bit unsigned scaled integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_SSCALED specifies a two-component, 16-bit signed scaled integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_UINT specifies a two-component, 16-bit unsigned integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_SINT specifies a two-component, 16-bit signed integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
• FORMAT_R8G8_SRGB specifies a two-component, 16-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, and an 8-bit G component stored with sRGB nonlinear encoding in byte 1.
• FORMAT_R8G8B8_UNORM specifies a three-component, 24-bit unsigned normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_SNORM specifies a three-component, 24-bit signed normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_USCALED specifies a three-component, 24-bit unsigned scaled format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_SSCALED specifies a three-component, 24-bit signed scaled format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_UINT specifies a three-component, 24-bit unsigned integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_SINT specifies a three-component, 24-bit signed integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, and an 8-bit B component in byte 2.
• FORMAT_R8G8B8_SRGB specifies a three-component, 24-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, and an 8-bit B component stored with sRGB nonlinear encoding in byte 2.
• FORMAT_B8G8R8_UNORM specifies a three-component, 24-bit unsigned normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_SNORM specifies a three-component, 24-bit signed normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_USCALED specifies a three-component, 24-bit unsigned scaled format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_SSCALED specifies a three-component, 24-bit signed scaled format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_UINT specifies a three-component, 24-bit unsigned integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_SINT specifies a three-component, 24-bit signed integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, and an 8-bit R component in byte 2.
• FORMAT_B8G8R8_SRGB specifies a three-component, 24-bit unsigned normalized format that has an 8-bit B component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, and an 8-bit R component stored with sRGB nonlinear encoding in byte 2.
• FORMAT_R8G8B8A8_UNORM specifies a four-component, 32-bit unsigned normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_SNORM specifies a four-component, 32-bit signed normalized format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_USCALED specifies a four-component, 32-bit unsigned scaled format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_SSCALED specifies a four-component, 32-bit signed scaled format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_UINT specifies a four-component, 32-bit unsigned integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_SINT specifies a four-component, 32-bit signed integer format that has an 8-bit R component in byte 0, an 8-bit G component in byte 1, an 8-bit B component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_R8G8B8A8_SRGB specifies a four-component, 32-bit unsigned normalized format that has an 8-bit R component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, an 8-bit B component stored with sRGB nonlinear encoding in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_UNORM specifies a four-component, 32-bit unsigned normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_SNORM specifies a four-component, 32-bit signed normalized format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_USCALED specifies a four-component, 32-bit unsigned scaled format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_SSCALED specifies a four-component, 32-bit signed scaled format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_UINT specifies a four-component, 32-bit unsigned integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_SINT specifies a four-component, 32-bit signed integer format that has an 8-bit B component in byte 0, an 8-bit G component in byte 1, an 8-bit R component in byte 2, and an 8-bit A component in byte 3.
• FORMAT_B8G8R8A8_SRGB specifies a four-component, 32-bit unsigned normalized format that has an 8-bit B component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in byte 1, an 8-bit R component stored with sRGB nonlinear encoding in byte 2, and an 8-bit A component in byte 3.
• FORMAT_A8B8G8R8_UNORM_PACK32 specifies a four-component, 32-bit packed unsigned normalized format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_SNORM_PACK32 specifies a four-component, 32-bit packed signed normalized format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_USCALED_PACK32 specifies a four-component, 32-bit packed unsigned scaled integer format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_SSCALED_PACK32 specifies a four-component, 32-bit packed signed scaled integer format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_UINT_PACK32 specifies a four-component, 32-bit packed unsigned integer format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_SINT_PACK32 specifies a four-component, 32-bit packed signed integer format that has an 8-bit A component in bits 24..31, an 8-bit B component in bits 16..23, an 8-bit G component in bits 8..15, and an 8-bit R component in bits 0..7.
• FORMAT_A8B8G8R8_SRGB_PACK32 specifies a four-component, 32-bit packed unsigned normalized format that has an 8-bit A component in bits 24..31, an 8-bit B component stored with sRGB nonlinear encoding in bits 16..23, an 8-bit G component stored with sRGB nonlinear encoding in bits 8..15, and an 8-bit R component stored with sRGB nonlinear encoding in bits 0..7.
• FORMAT_A2R10G10B10_UNORM_PACK32 specifies a four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2R10G10B10_SNORM_PACK32 specifies a four-component, 32-bit packed signed normalized format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2R10G10B10_USCALED_PACK32 specifies a four-component, 32-bit packed unsigned scaled integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2R10G10B10_SSCALED_PACK32 specifies a four-component, 32-bit packed signed scaled integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2R10G10B10_UINT_PACK32 specifies a four-component, 32-bit packed unsigned integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2R10G10B10_SINT_PACK32 specifies a four-component, 32-bit packed signed integer format that has a 2-bit A component in bits 30..31, a 10-bit R component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit B component in bits 0..9.
• FORMAT_A2B10G10R10_UNORM_PACK32 specifies a four-component, 32-bit packed unsigned normalized format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_A2B10G10R10_SNORM_PACK32 specifies a four-component, 32-bit packed signed normalized format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_A2B10G10R10_USCALED_PACK32 specifies a four-component, 32-bit packed unsigned scaled integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_A2B10G10R10_SSCALED_PACK32 specifies a four-component, 32-bit packed signed scaled integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_A2B10G10R10_UINT_PACK32 specifies a four-component, 32-bit packed unsigned integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_A2B10G10R10_SINT_PACK32 specifies a four-component, 32-bit packed signed integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and a 10-bit R component in bits 0..9.
• FORMAT_R16_UNORM specifies a one-component, 16-bit unsigned normalized format that has a single 16-bit R component.
• FORMAT_R16_SNORM specifies a one-component, 16-bit signed normalized format that has a single 16-bit R component.
• FORMAT_R16_USCALED specifies a one-component, 16-bit unsigned scaled integer format that has a single 16-bit R component.
• FORMAT_R16_SSCALED specifies a one-component, 16-bit signed scaled integer format that has a single 16-bit R component.
• FORMAT_R16_UINT specifies a one-component, 16-bit unsigned integer format that has a single 16-bit R component.
• FORMAT_R16_SINT specifies a one-component, 16-bit signed integer format that has a single 16-bit R component.
• FORMAT_R16_SFLOAT specifies a one-component, 16-bit signed floating-point format that has a single 16-bit R component.
• FORMAT_R16G16_UNORM specifies a two-component, 32-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_SNORM specifies a two-component, 32-bit signed normalized format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_USCALED specifies a two-component, 32-bit unsigned scaled integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_SSCALED specifies a two-component, 32-bit signed scaled integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_UINT specifies a two-component, 32-bit unsigned integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_SINT specifies a two-component, 32-bit signed integer format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16_SFLOAT specifies a two-component, 32-bit signed floating-point format that has a 16-bit R component in bytes 0..1, and a 16-bit G component in bytes 2..3.
• FORMAT_R16G16B16_UNORM specifies a three-component, 48-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_SNORM specifies a three-component, 48-bit signed normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_USCALED specifies a three-component, 48-bit unsigned scaled integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_SSCALED specifies a three-component, 48-bit signed scaled integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_UINT specifies a three-component, 48-bit unsigned integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_SINT specifies a three-component, 48-bit signed integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16_SFLOAT specifies a three-component, 48-bit signed floating-point format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, and a 16-bit B component in bytes 4..5.
• FORMAT_R16G16B16A16_UNORM specifies a four-component, 64-bit unsigned normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_SNORM specifies a four-component, 64-bit signed normalized format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_USCALED specifies a four-component, 64-bit unsigned scaled integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_SSCALED specifies a four-component, 64-bit signed scaled integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_UINT specifies a four-component, 64-bit unsigned integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_SINT specifies a four-component, 64-bit signed integer format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R16G16B16A16_SFLOAT specifies a four-component, 64-bit signed floating-point format that has a 16-bit R component in bytes 0..1, a 16-bit G component in bytes 2..3, a 16-bit B component in bytes 4..5, and a 16-bit A component in bytes 6..7.
• FORMAT_R32_UINT specifies a one-component, 32-bit unsigned integer format that has a single 32-bit R component.
• FORMAT_R32_SINT specifies a one-component, 32-bit signed integer format that has a single 32-bit R component.
• FORMAT_R32_SFLOAT specifies a one-component, 32-bit signed floating-point format that has a single 32-bit R component.
• FORMAT_R32G32_UINT specifies a two-component, 64-bit unsigned integer format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7.
• FORMAT_R32G32_SINT specifies a two-component, 64-bit signed integer format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7.
• FORMAT_R32G32_SFLOAT specifies a two-component, 64-bit signed floating-point format that has a 32-bit R component in bytes 0..3, and a 32-bit G component in bytes 4..7.
• FORMAT_R32G32B32_UINT specifies a three-component, 96-bit unsigned integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11.
• FORMAT_R32G32B32_SINT specifies a three-component, 96-bit signed integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11.
• FORMAT_R32G32B32_SFLOAT specifies a three-component, 96-bit signed floating-point format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, and a 32-bit B component in bytes 8..11.
• FORMAT_R32G32B32A32_UINT specifies a four-component, 128-bit unsigned integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15.
• FORMAT_R32G32B32A32_SINT specifies a four-component, 128-bit signed integer format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15.
• FORMAT_R32G32B32A32_SFLOAT specifies a four-component, 128-bit signed floating-point format that has a 32-bit R component in bytes 0..3, a 32-bit G component in bytes 4..7, a 32-bit B component in bytes 8..11, and a 32-bit A component in bytes 12..15.
• FORMAT_R64_UINT specifies a one-component, 64-bit unsigned integer format that has a single 64-bit R component.
• FORMAT_R64_SINT specifies a one-component, 64-bit signed integer format that has a single 64-bit R component.
• FORMAT_R64_SFLOAT specifies a one-component, 64-bit signed floating-point format that has a single 64-bit R component.
• FORMAT_R64G64_UINT specifies a two-component, 128-bit unsigned integer format that has a 64-bit R component in bytes 0..7, and a 64-bit G component in bytes 8..15.
• FORMAT_R64G64_SINT specifies a two-component, 128-bit signed integer format that has a 64-bit R component in bytes 0..7, and a 64-bit G component in bytes 8..15.
• FORMAT_R64G64_SFLOAT specifies a two-component, 128-bit signed floating-point format that has a 64-bit R component in bytes 0..7, and a 64-bit G component in bytes 8..15.
• FORMAT_R64G64B64_UINT specifies a three-component, 192-bit unsigned integer format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, and a 64-bit B component in bytes 16..23.
• FORMAT_R64G64B64_SINT specifies a three-component, 192-bit signed integer format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, and a 64-bit B component in bytes 16..23.
• FORMAT_R64G64B64_SFLOAT specifies a three-component, 192-bit signed floating-point format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, and a 64-bit B component in bytes 16..23.
• FORMAT_R64G64B64A64_UINT specifies a four-component, 256-bit unsigned integer format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, a 64-bit B component in bytes 16..23, and a 64-bit A component in bytes 24..31.
• FORMAT_R64G64B64A64_SINT specifies a four-component, 256-bit signed integer format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, a 64-bit B component in bytes 16..23, and a 64-bit A component in bytes 24..31.
• FORMAT_R64G64B64A64_SFLOAT specifies a four-component, 256-bit signed floating-point format that has a 64-bit R component in bytes 0..7, a 64-bit G component in bytes 8..15, a 64-bit B component in bytes 16..23, and a 64-bit A component in bytes 24..31.
• FORMAT_B10G11R11_UFLOAT_PACK32 specifies a three-component, 32-bit packed unsigned floating-point format that has a 10-bit B component in bits 22..31, an 11-bit G component in bits 11..21, an 11-bit R component in bits 0..10. See the “Unsigned 10-Bit Floating-Point Numbers” section and the “Unsigned 11-Bit Floating-Point Numbers” section.
• FORMAT_E5B9G9R9_UFLOAT_PACK32 specifies a three-component, 32-bit packed unsigned floating-point format that has a 5-bit shared exponent in bits 27..31, a 9-bit B component mantissa in bits 18..26, a 9-bit G component mantissa in bits 9..17, and a 9-bit R component mantissa in bits 0..8.
• FORMAT_D16_UNORM specifies a one-component, 16-bit unsigned normalized format that has a single 16-bit depth component.
• FORMAT_X8_D24_UNORM_PACK32 specifies a two-component, 32-bit format that has 24 unsigned normalized bits in the depth component and, optionally:, 8 bits that are unused.
• FORMAT_D32_SFLOAT specifies a one-component, 32-bit signed floating-point format that has 32-bits in the depth component.
• FORMAT_S8_UINT specifies a one-component, 8-bit unsigned integer format that has 8-bits in the stencil component.
• FORMAT_D16_UNORM_S8_UINT specifies a two-component, 24-bit format that has 16 unsigned normalized bits in the depth component and 8 unsigned integer bits in the stencil component.
• FORMAT_D24_UNORM_S8_UINT specifies a two-component, 32-bit packed format that has 8 unsigned integer bits in the stencil component, and 24 unsigned normalized bits in the depth component.
• FORMAT_D32_SFLOAT_S8_UINT specifies a two-component format that has 32 signed float bits in the depth component and 8 unsigned integer bits in the stencil component. There are optionally: 24-bits that are unused.
• FORMAT_BC1_RGB_UNORM_BLOCK specifies a three-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque.
• FORMAT_BC1_RGB_SRGB_BLOCK specifies a three-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has no alpha and is considered opaque.
• FORMAT_BC1_RGBA_UNORM_BLOCK specifies a four-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data, and provides 1 bit of alpha.
• FORMAT_BC1_RGBA_SRGB_BLOCK specifies a four-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding, and provides 1 bit of alpha.
• FORMAT_BC2_UNORM_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values.
• FORMAT_BC2_SRGB_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding.
• FORMAT_BC3_UNORM_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values.
• FORMAT_BC3_SRGB_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding.
• FORMAT_BC4_UNORM_BLOCK specifies a one-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized red texel data.
• FORMAT_BC4_SNORM_BLOCK specifies a one-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data.
• FORMAT_BC5_UNORM_BLOCK specifies a two-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values.
• FORMAT_BC5_SNORM_BLOCK specifies a two-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values.
• FORMAT_BC6H_UFLOAT_BLOCK specifies a three-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned floating-point RGB texel data.
• FORMAT_BC6H_SFLOAT_BLOCK specifies a three-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed floating-point RGB texel data.
• FORMAT_BC7_UNORM_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data.
• FORMAT_BC7_SRGB_BLOCK specifies a four-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ETC2_R8G8B8_UNORM_BLOCK specifies a three-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is considered opaque.
• FORMAT_ETC2_R8G8B8_SRGB_BLOCK specifies a three-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding. This format has no alpha and is considered opaque.
• FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK specifies a four-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data, and provides 1 bit of alpha.
• FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK specifies a four-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding, and provides 1 bit of alpha.
• FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK specifies a four-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values.
• FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK specifies a four-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with the first 64 bits encoding alpha values followed by 64 bits encoding RGB values with sRGB nonlinear encoding applied.
• FORMAT_EAC_R11_UNORM_BLOCK specifies a one-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized red texel data.
• FORMAT_EAC_R11_SNORM_BLOCK specifies a one-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data.
• FORMAT_EAC_R11G11_UNORM_BLOCK specifies a two-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values.
• FORMAT_EAC_R11G11_SNORM_BLOCK specifies a two-component, ETC2 compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of signed normalized RG texel data with the first 64 bits encoding red values followed by 64 bits encoding green values.
• FORMAT_ASTC_4x4_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_4x4_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_5x4_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×4 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_5x4_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_5x5_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×5 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_5x5_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 5×5 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_6x5_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×5 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_6x5_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×5 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_6x6_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×6 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_6x6_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 6×6 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_8x5_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×5 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_8x5_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×5 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_8x6_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×6 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_8x6_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×6 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_8x8_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×8 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_8x8_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×8 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_10x5_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×5 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_10x5_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×5 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_10x6_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×6 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_10x6_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×6 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_10x8_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×8 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_10x8_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×8 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_10x10_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×10 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_10x10_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 10×10 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_12x10_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×10 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_12x10_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×10 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_ASTC_12x12_UNORM_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×12 rectangle of unsigned normalized RGBA texel data.
• FORMAT_ASTC_12x12_SRGB_BLOCK specifies a four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 12×12 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied to the RGB components.
• FORMAT_G8B8G8R8_422_UNORM specifies a four-component, 32-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has an 8-bit G component for the even i coordinate in byte 0, an 8-bit B component in byte 1, an 8-bit G component for the odd i coordinate in byte 2, and an 8-bit R component in byte 3. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_B8G8R8G8_422_UNORM specifies a four-component, 32-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has an 8-bit B component in byte 0, an 8-bit G component for the even i coordinate in byte 1, an 8-bit R component in byte 2, and an 8-bit G component for the odd i coordinate in byte 3. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_G8_B8_R8_3PLANE_420_UNORM specifies an unsigned normalized multi-planar format that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. The horizontal and vertical dimensions of the R and B planes are halved relative to the image dimensions, and each R and B component is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G8_B8R8_2PLANE_420_UNORM specifies an unsigned normalized multi-planar format that has an 8-bit G component in plane 0, and a two-component, 16-bit BR plane 1 consisting of an 8-bit B component in byte 0 and an 8-bit R component in byte 1. The horizontal and vertical dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G8_B8_R8_3PLANE_422_UNORM specifies an unsigned normalized multi-planar format that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. The horizontal dimension of the R and B plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G8_B8R8_2PLANE_422_UNORM specifies an unsigned normalized multi-planar format that has an 8-bit G component in plane 0, and a two-component, 16-bit BR plane 1 consisting of an 8-bit B component in byte 0 and an 8-bit R component in byte 1. The horizontal dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G8_B8_R8_3PLANE_444_UNORM specifies an unsigned normalized multi-planar format that has an 8-bit G component in plane 0, an 8-bit B component in plane 1, and an 8-bit R component in plane 2. Each plane has the same dimensions and each R, G and B component contributes to a single texel. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane.
• FORMAT_R10X6_UNORM_PACK16 specifies a one-component, 16-bit unsigned normalized format that has a single 10-bit R component in the top 10 bits of a 16-bit word, with the bottom 6 bits set to 0.
• FORMAT_R10X6G10X6_UNORM_2PACK16 specifies a two-component, 32-bit unsigned normalized format that has a 10-bit R component in the top 10 bits of the word in bytes 0..1, and a 10-bit G component in the top 10 bits of the word in bytes 2..3, with the bottom 6 bits of each word set to 0.
• FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 specifies a four-component, 64-bit unsigned normalized format that has a 10-bit R component in the top 10 bits of the word in bytes 0..1, a 10-bit G component in the top 10 bits of the word in bytes 2..3, a 10-bit B component in the top 10 bits of the word in bytes 4..5, and a 10-bit A component in the top 10 bits of the word in bytes 6..7, with the bottom 6 bits of each word set to 0.
• FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16 specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 10-bit G component for the even i coordinate in the top 10 bits of the word in bytes 0..1, a 10-bit B component in the top 10 bits of the word in bytes 2..3, a 10-bit G component for the odd i coordinate in the top 10 bits of the word in bytes 4..5, and a 10-bit R component in the top 10 bits of the word in bytes 6..7, with the bottom 6 bits of each word set to 0. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16 specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 10-bit B component in the top 10 bits of the word in bytes 0..1, a 10-bit G component for the even i coordinate in the top 10 bits of the word in bytes 2..3, a 10-bit R component in the top 10 bits of the word in bytes 4..5, and a 10-bit G component for the odd i coordinate in the top 10 bits of the word in bytes 6..7, with the bottom 6 bits of each word set to 0. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R component in the top 10 bits of each 16-bit word of plane 2, with the bottom 6 bits of each word set to 0. The horizontal and vertical dimensions of the R and B planes are halved relative to the image dimensions, and each R and B component is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 10-bit B component in the top 10 bits of the word in bytes 0..1, and a 10-bit R component in the top 10 bits of the word in bytes 2..3, the bottom 6 bits of each word set to 0. The horizontal and vertical dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R component in the top 10 bits of each 16-bit word of plane 2, with the bottom 6 bits of each word set to 0. The horizontal dimension of the R and B plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 10-bit B component in the top 10 bits of the word in bytes 0..1, and a 10-bit R component in the top 10 bits of the word in bytes 2..3, the bottom 6 bits of each word set to 0. The horizontal dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 10-bit G component in the top 10 bits of each 16-bit word of plane 0, a 10-bit B component in the top 10 bits of each 16-bit word of plane 1, and a 10-bit R component in the top 10 bits of each 16-bit word of plane 2, with the bottom 6 bits of each word set to 0. Each plane has the same dimensions and each R, G and B component contributes to a single texel. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane.
• FORMAT_R12X4_UNORM_PACK16 specifies a one-component, 16-bit unsigned normalized format that has a single 12-bit R component in the top 12 bits of a 16-bit word, with the bottom 4 bits set to 0.
• FORMAT_R12X4G12X4_UNORM_2PACK16 specifies a two-component, 32-bit unsigned normalized format that has a 12-bit R component in the top 12 bits of the word in bytes 0..1, and a 12-bit G component in the top 12 bits of the word in bytes 2..3, with the bottom 4 bits of each word set to 0.
• FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16 specifies a four-component, 64-bit unsigned normalized format that has a 12-bit R component in the top 12 bits of the word in bytes 0..1, a 12-bit G component in the top 12 bits of the word in bytes 2..3, a 12-bit B component in the top 12 bits of the word in bytes 4..5, and a 12-bit A component in the top 12 bits of the word in bytes 6..7, with the bottom 4 bits of each word set to 0.
• FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16 specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 12-bit G component for the even i coordinate in the top 12 bits of the word in bytes 0..1, a 12-bit B component in the top 12 bits of the word in bytes 2..3, a 12-bit G component for the odd i coordinate in the top 12 bits of the word in bytes 4..5, and a 12-bit R component in the top 12 bits of the word in bytes 6..7, with the bottom 4 bits of each word set to 0. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16 specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 12-bit B component in the top 12 bits of the word in bytes 0..1, a 12-bit G component for the even i coordinate in the top 12 bits of the word in bytes 2..3, a 12-bit R component in the top 12 bits of the word in bytes 4..5, and a 12-bit G component for the odd i coordinate in the top 12 bits of the word in bytes 6..7, with the bottom 4 bits of each word set to 0. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R component in the top 12 bits of each 16-bit word of plane 2, with the bottom 4 bits of each word set to 0. The horizontal and vertical dimensions of the R and B planes are halved relative to the image dimensions, and each R and B component is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 12-bit B component in the top 12 bits of the word in bytes 0..1, and a 12-bit R component in the top 12 bits of the word in bytes 2..3, the bottom 4 bits of each word set to 0. The horizontal and vertical dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R component in the top 12 bits of each 16-bit word of plane 2, with the bottom 4 bits of each word set to 0. The horizontal dimension of the R and B plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 12-bit B component in the top 12 bits of the word in bytes 0..1, and a 12-bit R component in the top 12 bits of the word in bytes 2..3, the bottom 4 bits of each word set to 0. The horizontal dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 specifies an unsigned normalized multi-planar format that has a 12-bit G component in the top 12 bits of each 16-bit word of plane 0, a 12-bit B component in the top 12 bits of each 16-bit word of plane 1, and a 12-bit R component in the top 12 bits of each 16-bit word of plane 2, with the bottom 4 bits of each word set to 0. Each plane has the same dimensions and each R, G and B component contributes to a single texel. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane.
• FORMAT_G16B16G16R16_422_UNORM specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 16-bit G component for the even i coordinate in the word in bytes 0..1, a 16-bit B component in the word in bytes 2..3, a 16-bit G component for the odd i coordinate in the word in bytes 4..5, and a 16-bit R component in the word in bytes 6..7. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_B16G16R16G16_422_UNORM specifies a four-component, 64-bit format containing a pair of G components, an R component, and a B component, collectively encoding a 2×1 rectangle of unsigned normalized RGB texel data. One G value is present at each i coordinate, with the B and R values shared across both G values and thus recorded at half the horizontal resolution of the image. This format has a 16-bit B component in the word in bytes 0..1, a 16-bit G component for the even i coordinate in the word in bytes 2..3, a 16-bit R component in the word in bytes 4..5, and a 16-bit G component for the odd i coordinate in the word in bytes 6..7. Images in this format must be defined with a width that is a multiple of two. For the purposes of the constraints on copy extents, this format is treated as a compressed format with a 2×1 compressed texel block.
• FORMAT_G16_B16_R16_3PLANE_420_UNORM specifies an unsigned normalized multi-planar format that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. The horizontal and vertical dimensions of the R and B planes are halved relative to the image dimensions, and each R and B component is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G16_B16R16_2PLANE_420_UNORM specifies an unsigned normalized multi-planar format that has a 16-bit G component in each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 16-bit B component in the word in bytes 0..1, and a 16-bit R component in the word in bytes 2..3. The horizontal and vertical dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR and floor(jG × 0.5) = jB = jR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width and height that is a multiple of two.
• FORMAT_G16_B16_R16_3PLANE_422_UNORM specifies an unsigned normalized multi-planar format that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. The horizontal dimension of the R and B plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G16_B16R16_2PLANE_422_UNORM specifies an unsigned normalized multi-planar format that has a 16-bit G component in each 16-bit word of plane 0, and a two-component, 32-bit BR plane 1 consisting of a 16-bit B component in the word in bytes 0..1, and a 16-bit R component in the word in bytes 2..3. The horizontal dimensions of the BR plane is halved relative to the image dimensions, and each R and B value is shared with the G components for which floor(iG × 0.5) = iB = iR. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, and IMAGE_ASPECT_PLANE_1_BIT for the BR plane. Images in this format must be defined with a width that is a multiple of two.
• FORMAT_G16_B16_R16_3PLANE_444_UNORM specifies an unsigned normalized multi-planar format that has a 16-bit G component in each 16-bit word of plane 0, a 16-bit B component in each 16-bit word of plane 1, and a 16-bit R component in each 16-bit word of plane 2. Each plane has the same dimensions and each R, G and B component contributes to a single texel. The location of each plane when this image is in linear layout can be determined via GetImageSubresourceLayout, using IMAGE_ASPECT_PLANE_0_BIT for the G plane, IMAGE_ASPECT_PLANE_1_BIT for the B plane, and IMAGE_ASPECT_PLANE_2_BIT for the R plane.

See Also

VkAttachmentDescription, VkAttachmentDescription2KHR, VkBufferViewCreateInfo, VkGeometryTrianglesNVX, VkImageCreateInfo, VkImageFormatListCreateInfoKHR, VkImageViewASTCDecodeModeEXT, VkImageViewCreateInfo, VkPhysicalDeviceImageFormatInfo2, VkPhysicalDeviceSparseImageFormatInfo2, VkSamplerYcbcrConversionCreateInfo, VkSurfaceFormatKHR, VkSwapchainCreateInfoKHR, VkVertexInputAttributeDescription, GetPhysicalDeviceExternalImageFormatPropertiesNV, GetPhysicalDeviceFormatProperties, GetPhysicalDeviceFormatProperties2, GetPhysicalDeviceFormatProperties2KHR, GetPhysicalDeviceImageFormatProperties, GetPhysicalDeviceSparseImageFormatProperties

VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT, VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT, VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT, VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT, VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT, VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT, VK_FORMAT_FEATURE_VERTEX_BUFFER_BIT, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT, VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT, VK_FORMAT_FEATURE_BLIT_SRC_BIT, VK_FORMAT_FEATURE_BLIT_DST_BIT, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT

VkFormatFeatureFlagBits - Bitmask specifying features supported by a buffer

Description

The following bits may be set in linearTilingFeatures and optimalTilingFeatures, specifying that the features are supported by images or image views created with the queried GetPhysicalDeviceFormatProperties::format:

• FORMAT_FEATURE_SAMPLED_IMAGE_BIT specifies that an image view can be sampled from.
• FORMAT_FEATURE_STORAGE_IMAGE_BIT specifies that an image view can be used as a storage images.
• FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT specifies that an image view can be used as storage image that supports atomic operations.
• FORMAT_FEATURE_COLOR_ATTACHMENT_BIT specifies that an image view can be used as a framebuffer color attachment and as an input attachment.
• FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT specifies that an image view can be used as a framebuffer color attachment that supports blending and as an input attachment.
• FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT specifies that an image view can be used as a framebuffer depth/stencil attachment and as an input attachment.
• FORMAT_FEATURE_BLIT_SRC_BIT specifies that an image can be used as srcImage for the CmdBlitImage command.
• FORMAT_FEATURE_BLIT_DST_BIT specifies that an image can be used as dstImage for the CmdBlitImage command.
• FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT specifies that if FORMAT_FEATURE_SAMPLED_IMAGE_BIT is also set, an image view can be used with a sampler that has either of magFilter or minFilter set to FILTER_LINEAR, or mipmapMode set to SAMPLER_MIPMAP_MODE_LINEAR. If FORMAT_FEATURE_BLIT_SRC_BIT is also set, an image can be used as the srcImage to CmdBlitImage with a filter of FILTER_LINEAR. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT or FORMAT_FEATURE_BLIT_SRC_BIT. If the format being queried is a depth/stencil format, this bit only specifies that the depth aspect (not the stencil aspect) of an image of this format supports linear filtering, and that linear filtering of the depth aspect is supported whether depth compare is enabled in the sampler or not. If this bit is not present, linear filtering with depth compare disabled is unsupported and linear filtering with depth compare enabled is supported, but may compute the filtered value in an implementation-dependent manner which differs from the normal rules of linear filtering. The resulting value must be in the range [0,1] and should be proportional to, or a weighted average of, the number of comparison passes or failures.
• FORMAT_FEATURE_TRANSFER_SRC_BIT specifies that an image can be used as a source image for copy commands.
• FORMAT_FEATURE_TRANSFER_DST_BIT specifies that an image can be used as a destination image for copy commands and clear commands.
• FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT_EXT specifies VkImage can be used as a sampled image with a min or max VkSamplerReductionModeEXT. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
• FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG specifies that VkImage can be used with a sampler that has either of magFilter or minFilter set to FILTER_CUBIC_IMG, or be the source image for a blit with filter set to FILTER_CUBIC_IMG. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT. If the format being queried is a depth/stencil format, this only specifies that the depth aspect is cubic filterable.
• FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT specifies that an application can define a sampler Y’C_BC_R conversion using this format as a source, and that an image of this format can be used with a VkSamplerYcbcrConversionCreateInfo xChromaOffset and/or yChromaOffset of CHROMA_LOCATION_MIDPOINT. Otherwise both xChromaOffset and yChromaOffset must be CHROMA_LOCATION_COSITED_EVEN. If a format does not incorporate chroma downsampling (it is not a “422” or “420” format) but the implementation supports sampler Y’C_BC_R conversion for this format, the implementation must set FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT.
• FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT specifies that an application can define a sampler Y’C_BC_R conversion using this format as a source, and that an image of this format can be used with a VkSamplerYcbcrConversionCreateInfo xChromaOffset and/or yChromaOffset of CHROMA_LOCATION_COSITED_EVEN. Otherwise both xChromaOffset and yChromaOffset must be CHROMA_LOCATION_MIDPOINT. If neither FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT nor FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT is set, the application must not define a sampler Y’C_BC_R conversion using this format as a source.
• FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT specifies that the format can do linear sampler filtering (min/magFilter) whilst sampler Y’C_BC_R conversion is enabled.
• FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT specifies that the format can have different chroma, min, and mag filters.
• FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT specifies that reconstruction is explicit, as described in Chroma Reconstruction. If this bit is not present, reconstruction is implicit by default.
• FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT specifies that reconstruction can be forcibly made explicit by setting VkSamplerYcbcrConversionCreateInfo::forceExplicitReconstruction to TRUE.
• FORMAT_FEATURE_DISJOINT_BIT specifies that a multi-planar image can have the IMAGE_CREATE_DISJOINT_BIT set during image creation. An implementation must not set FORMAT_FEATURE_DISJOINT_BIT for single-plane formats.

The following bits may be set in bufferFeatures, specifying that the features are supported by buffers or buffer views created with the queried GetPhysicalDeviceProperties::format:

• FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT specifies that the format can be used to create a buffer view that can be bound to a DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER descriptor.
• FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT specifies that the format can be used to create a buffer view that can be bound to a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor.
• FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT specifies that atomic operations are supported on DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER with this format.
• FORMAT_FEATURE_VERTEX_BUFFER_BIT specifies that the format can be used as a vertex attribute format (VkVertexInputAttributeDescription::format).

See Also

VkFormatFeatureFlags

VK_IMAGE_TYPE_1D, VK_IMAGE_TYPE_2D, VK_IMAGE_TYPE_3D

VkImageType - Specifies the type of an image object

Description

• IMAGE_TYPE_1D specifies a one-dimensional image.
• IMAGE_TYPE_2D specifies a two-dimensional image.
• IMAGE_TYPE_3D specifies a three-dimensional image.

See Also

VkImageCreateInfo, VkPhysicalDeviceImageFormatInfo2, VkPhysicalDeviceSparseImageFormatInfo2, GetPhysicalDeviceExternalImageFormatPropertiesNV, GetPhysicalDeviceImageFormatProperties, GetPhysicalDeviceSparseImageFormatProperties

VK_IMAGE_TILING_OPTIMAL, VK_IMAGE_TILING_LINEAR

VkImageTiling - Specifies the tiling arrangement of data in an image

Description

• IMAGE_TILING_OPTIMAL specifies optimal tiling (texels are laid out in an implementation-dependent arrangement, for more optimal memory access).
• IMAGE_TILING_LINEAR specifies linear tiling (texels are laid out in memory in row-major order, possibly with some padding on each row).

See Also

VkImageCreateInfo, VkPhysicalDeviceImageFormatInfo2, VkPhysicalDeviceSparseImageFormatInfo2, GetPhysicalDeviceExternalImageFormatPropertiesNV, GetPhysicalDeviceImageFormatProperties, GetPhysicalDeviceSparseImageFormatProperties

VK_IMAGE_USAGE_TRANSFER_SRC_BIT, VK_IMAGE_USAGE_TRANSFER_DST_BIT, VK_IMAGE_USAGE_SAMPLED_BIT, VK_IMAGE_USAGE_STORAGE_BIT, VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT, VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT

VkImageUsageFlagBits - Bitmask specifying intended usage of an image

Description

• IMAGE_USAGE_TRANSFER_SRC_BIT specifies that the image can be used as the source of a transfer command.
• IMAGE_USAGE_TRANSFER_DST_BIT specifies that the image can be used as the destination of a transfer command.
• IMAGE_USAGE_SAMPLED_BIT specifies that the image can be used to create a VkImageView suitable for occupying a VkDescriptorSet slot either of type DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and be sampled by a shader.
• IMAGE_USAGE_STORAGE_BIT specifies that the image can be used to create a VkImageView suitable for occupying a VkDescriptorSet slot of type DESCRIPTOR_TYPE_STORAGE_IMAGE.
• IMAGE_USAGE_COLOR_ATTACHMENT_BIT specifies that the image can be used to create a VkImageView suitable for use as a color or resolve attachment in a VkFramebuffer.
• IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT specifies that the image can be used to create a VkImageView suitable for use as a depth/stencil attachment in a VkFramebuffer.
• IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT specifies that the memory bound to this image will have been allocated with the MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT (see the “Memory Allocation” chapter for more detail). This bit can be set for any image that can be used to create a VkImageView suitable for use as a color, resolve, depth/stencil, or input attachment.
• IMAGE_USAGE_INPUT_ATTACHMENT_BIT specifies that the image can be used to create a VkImageView suitable for occupying VkDescriptorSet slot of type DESCRIPTOR_TYPE_INPUT_ATTACHMENT; be read from a shader as an input attachment; and be used as an input attachment in a framebuffer.
• IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV specifies that the image can be used to create a VkImageView suitable for use as a shading rate image.

See Also

VkImageUsageFlags

VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, VK_IMAGE_CREATE_SPARSE_ALIASED_BIT, VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT

VkImageCreateFlagBits - Bitmask specifying additional parameters of an image

Description

• IMAGE_CREATE_SPARSE_BINDING_BIT specifies that the image will be backed using sparse memory binding.
• IMAGE_CREATE_SPARSE_RESIDENCY_BIT specifies that the image can be partially backed using sparse memory binding. Images created with this flag must also be created with the IMAGE_CREATE_SPARSE_BINDING_BIT flag.
• IMAGE_CREATE_SPARSE_ALIASED_BIT specifies that the image will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another image (or another portion of the same image). Images created with this flag must also be created with the IMAGE_CREATE_SPARSE_BINDING_BIT flag
• IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that the image can be used to create a VkImageView with a different format from the image. For multi-planar formats, IMAGE_CREATE_MUTABLE_FORMAT_BIT specifies that a VkImageView can be created of a plane of the image.
• IMAGE_CREATE_CUBE_COMPATIBLE_BIT specifies that the image can be used to create a VkImageView of type IMAGE_VIEW_TYPE_CUBE or IMAGE_VIEW_TYPE_CUBE_ARRAY.
• IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT specifies that the image can be used to create a VkImageView of type IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY.
• IMAGE_CREATE_PROTECTED_BIT specifies that the image is a protected image.
• IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT specifies that the image can be used with a non-zero value of the splitInstanceBindRegionCount member of a VkBindImageMemoryDeviceGroupInfo structure passed into BindImageMemory2. This flag also has the effect of making the image use the standard sparse image block dimensions.
• IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT specifies that the image having a compressed format can be used to create a VkImageView with an uncompressed format where each texel in the image view corresponds to a compressed texel block of the image.
• IMAGE_CREATE_EXTENDED_USAGE_BIT specifies that the image can be created with usage flags that are not supported for the format the image is created with but are supported for at least one format a VkImageView created from the image can have.
• IMAGE_CREATE_DISJOINT_BIT specifies that an image with a multi-planar format must have each plane separately bound to memory, rather than having a single memory binding for the whole image; the presence of this bit distinguishes a disjoint image from an image without this bit set.
• IMAGE_CREATE_ALIAS_BIT specifies that two images created with the same creation parameters and aliased to the same memory can interpret the contents of the memory consistently with each other, subject to the rules described in the Memory Aliasing section. This flag further specifies that each plane of a disjoint image can share an in-memory non-linear representation with single-plane images, and that a single-plane image can share an in-memory non-linear representation with a plane of a multi-planar disjoint image, according to the rules in the “Compatible formats of planes of multi-planar formats” section. If the pNext chain includes a VkExternalMemoryImageCreateInfo or VkExternalMemoryImageCreateInfoNV structure whose handleTypes member is not 0, it is as if IMAGE_CREATE_ALIAS_BIT is set.
• IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT specifies that an image with a depth or depth/stencil format can be used with custom sample locations when used as a depth/stencil attachment.
• IMAGE_CREATE_CORNER_SAMPLED_BIT_NV specifies that the image is a corner-sampled image.

See Sparse Resource Features and Sparse Physical Device Features for more details.

See Also

VkImageCreateFlags

VK_SAMPLE_COUNT_1_BIT, VK_SAMPLE_COUNT_2_BIT, VK_SAMPLE_COUNT_4_BIT, VK_SAMPLE_COUNT_8_BIT, VK_SAMPLE_COUNT_16_BIT, VK_SAMPLE_COUNT_32_BIT, VK_SAMPLE_COUNT_64_BIT

VkSampleCountFlagBits - Bitmask specifying sample counts supported for an image used for storage operations

Description

• SAMPLE_COUNT_1_BIT specifies an image with one sample per pixel.
• SAMPLE_COUNT_2_BIT specifies an image with 2 samples per pixel.
• SAMPLE_COUNT_4_BIT specifies an image with 4 samples per pixel.
• SAMPLE_COUNT_8_BIT specifies an image with 8 samples per pixel.
• SAMPLE_COUNT_16_BIT specifies an image with 16 samples per pixel.
• SAMPLE_COUNT_32_BIT specifies an image with 32 samples per pixel.
• SAMPLE_COUNT_64_BIT specifies an image with 64 samples per pixel.

See Also

VkAttachmentDescription, VkAttachmentDescription2KHR, VkImageCreateInfo, VkPhysicalDeviceSparseImageFormatInfo2, VkPipelineMultisampleStateCreateInfo, VkSampleCountFlags, VkSampleLocationsInfoEXT, GetPhysicalDeviceMultisamplePropertiesEXT, GetPhysicalDeviceSparseImageFormatProperties

VK_PHYSICAL_DEVICE_TYPE_OTHER, VK_PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU, VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU, VK_PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU, VK_PHYSICAL_DEVICE_TYPE_CPU

VkPhysicalDeviceType - Supported physical device types

Description

• PHYSICAL_DEVICE_TYPE_OTHER - the device does not match any other available types.
• PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU - the device is typically one embedded in or tightly coupled with the host.
• PHYSICAL_DEVICE_TYPE_DISCRETE_GPU - the device is typically a separate processor connected to the host via an interlink.
• PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU - the device is typically a virtual node in a virtualization environment.
• PHYSICAL_DEVICE_TYPE_CPU - the device is typically running on the same processors as the host.

The physical device type is advertised for informational purposes only, and does not directly affect the operation of the system. However, the device type may correlate with other advertised properties or capabilities of the system, such as how many memory heaps there are.

See Also

VkPhysicalDeviceProperties

VK_QUEUE_GRAPHICS_BIT, VK_QUEUE_COMPUTE_BIT, VK_QUEUE_TRANSFER_BIT, VK_QUEUE_SPARSE_BINDING_BIT

VkQueueFlagBits - Bitmask specifying capabilities of queues in a queue family

Description

• QUEUE_GRAPHICS_BIT specifies that queues in this queue family support graphics operations.
• QUEUE_COMPUTE_BIT specifies that queues in this queue family support compute operations.
• QUEUE_TRANSFER_BIT specifies that queues in this queue family support transfer operations.
• QUEUE_SPARSE_BINDING_BIT specifies that queues in this queue family support sparse memory management operations (see Sparse Resources). If any of the sparse resource features are enabled, then at least one queue family must support this bit.
• if QUEUE_PROTECTED_BIT is set, then the queues in this queue family support the DEVICE_QUEUE_CREATE_PROTECTED_BIT bit. (see Protected Memory). If the protected memory physical device feature is supported, then at least one queue family of at least one physical device exposed by the implementation must support this bit.

If an implementation exposes any queue family that supports graphics operations, at least one queue family of at least one physical device exposed by the implementation must support both graphics and compute operations.

Furthermore, if the protected memory physical device feature is supported, then at least one queue family of at least one physical device exposed by the implementation must support graphics operations, compute operations, and protected memory operations.

Note

All commands that are allowed on a queue that supports transfer operations are also allowed on a queue that supports either graphics or compute operations. Thus, if the capabilities of a queue family include QUEUE_GRAPHICS_BIT or QUEUE_COMPUTE_BIT, then reporting the QUEUE_TRANSFER_BIT capability separately for that queue family is optional:.

For further details see Queues.

See Also

VkQueueFlags

VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, VK_MEMORY_PROPERTY_HOST_COHERENT_BIT, VK_MEMORY_PROPERTY_HOST_CACHED_BIT, VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT

VkMemoryPropertyFlagBits - Bitmask specifying properties for a memory type

Description

• MEMORY_PROPERTY_DEVICE_LOCAL_BIT bit specifies that memory allocated with this type is the most efficient for device access. This property will be set if and only if the memory type belongs to a heap with the MEMORY_HEAP_DEVICE_LOCAL_BIT set.
• MEMORY_PROPERTY_HOST_VISIBLE_BIT bit specifies that memory allocated with this type can be mapped for host access using MapMemory.
• MEMORY_PROPERTY_HOST_COHERENT_BIT bit specifies that the host cache management commands FlushMappedMemoryRanges and InvalidateMappedMemoryRanges are not needed to flush host writes to the device or make device writes visible to the host, respectively.
• MEMORY_PROPERTY_HOST_CACHED_BIT bit specifies that memory allocated with this type is cached on the host. Host memory accesses to uncached memory are slower than to cached memory, however uncached memory is always host coherent.
• MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT bit specifies that the memory type only allows device access to the memory. Memory types must not have both MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT and MEMORY_PROPERTY_HOST_VISIBLE_BIT set. Additionally, the object’s backing memory may be provided by the implementation lazily as specified in Lazily Allocated Memory.
• MEMORY_PROPERTY_PROTECTED_BIT bit specifies that the memory type only allows device access to the memory, and allows protected queue operations to access the memory. Memory types must not have MEMORY_PROPERTY_PROTECTED_BIT set and any of MEMORY_PROPERTY_HOST_VISIBLE_BIT set, or MEMORY_PROPERTY_HOST_COHERENT_BIT set, or MEMORY_PROPERTY_HOST_CACHED_BIT set.

See Also

VkMemoryPropertyFlags

VK_MEMORY_HEAP_DEVICE_LOCAL_BIT

VkMemoryHeapFlagBits - Bitmask specifying attribute flags for a heap

Description

• MEMORY_HEAP_DEVICE_LOCAL_BIT specifies that the heap corresponds to device local memory. Device local memory may have different performance characteristics than host local memory, and may support different memory property flags.
• MEMORY_HEAP_MULTI_INSTANCE_BIT specifies that in a logical device representing more than one physical device, there is a per-physical device instance of the heap memory. By default, an allocation from such a heap will be replicated to each physical device’s instance of the heap.

See Also

VkMemoryHeapFlags

VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT, VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT, VK_PIPELINE_STAGE_VERTEX_INPUT_BIT, VK_PIPELINE_STAGE_VERTEX_SHADER_BIT, VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, VK_PIPELINE_STAGE_HOST_BIT, VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT

VkPipelineStageFlagBits - Bitmask specifying pipeline stages

Description

• PIPELINE_STAGE_TOP_OF_PIPE_BIT specifies the stage of the pipeline where any commands are initially received by the queue.
• PIPELINE_STAGE_DRAW_INDIRECT_BIT specifies the stage of the pipeline where Draw/DispatchIndirect data structures are consumed. This stage also includes reading commands written by CmdProcessCommandsNVX.
• PIPELINE_STAGE_TASK_SHADER_BIT_NV specifies the task shader stage.
• PIPELINE_STAGE_MESH_SHADER_BIT_NV specifies the mesh shader stage.
• PIPELINE_STAGE_VERTEX_INPUT_BIT specifies the stage of the pipeline where vertex and index buffers are consumed.
• PIPELINE_STAGE_VERTEX_SHADER_BIT specifies the vertex shader stage.
• PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT specifies the tessellation control shader stage.
• PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT specifies the tessellation evaluation shader stage.
• PIPELINE_STAGE_GEOMETRY_SHADER_BIT specifies the geometry shader stage.
• PIPELINE_STAGE_FRAGMENT_SHADER_BIT specifies the fragment shader stage.
• PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT specifies the stage of the pipeline where early fragment tests (depth and stencil tests before fragment shading) are performed. This stage also includes subpass load operations for framebuffer attachments with a depth/stencil format.
• PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT specifies the stage of the pipeline where late fragment tests (depth and stencil tests after fragment shading) are performed. This stage also includes subpass store operations for framebuffer attachments with a depth/stencil format.
• PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT specifies the stage of the pipeline after blending where the final color values are output from the pipeline. This stage also includes subpass load and store operations and multisample resolve operations for framebuffer attachments with a color format.
• PIPELINE_STAGE_COMPUTE_SHADER_BIT specifies the execution of a compute shader.
• PIPELINE_STAGE_TRANSFER_BIT specifies the execution of copy commands. This includes the operations resulting from all copy commands, clear commands (with the exception of CmdClearAttachments), and CmdCopyQueryPoolResults.
• PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT specifies the final stage in the pipeline where operations generated by all commands complete execution.
• PIPELINE_STAGE_HOST_BIT specifies a pseudo-stage indicating execution on the host of reads/writes of device memory. This stage is not invoked by any commands recorded in a command buffer.
• PIPELINE_STAGE_RAYTRACING_BIT_NVX specifies the execution of the ray tracing stages.
• PIPELINE_STAGE_ALL_GRAPHICS_BIT specifies the execution of all graphics pipeline stages, and is equivalent to the logical OR of:
  • PIPELINE_STAGE_TOP_OF_PIPE_BIT
  • PIPELINE_STAGE_DRAW_INDIRECT_BIT
  • PIPELINE_STAGE_TASK_SHADER_BIT_NV
  • PIPELINE_STAGE_MESH_SHADER_BIT_NV
  • PIPELINE_STAGE_VERTEX_INPUT_BIT
  • PIPELINE_STAGE_VERTEX_SHADER_BIT
  • PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT
  • PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
  • PIPELINE_STAGE_GEOMETRY_SHADER_BIT
  • PIPELINE_STAGE_FRAGMENT_SHADER_BIT
  • PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT
  • PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT
  • PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
  • PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT
  • PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT
  • PIPELINE_STAGE_SHADING_RATE_IMAGE_BIT_NV
• PIPELINE_STAGE_ALL_COMMANDS_BIT is equivalent to the logical OR of every other pipeline stage flag that is supported on the queue it is used with.
• PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT specifies the stage of the pipeline where the predicate of conditional rendering is consumed.
• PIPELINE_STAGE_COMMAND_PROCESS_BIT_NVX specifies the stage of the pipeline where device-side generation of commands via CmdProcessCommandsNVX is handled.
• PIPELINE_STAGE_SHADING_RATE_IMAGE_BIT_NV specifies the stage of the pipeline where the shading rate image is read to determine the shading rate for portions of a rasterized primitive.

Note

An execution dependency with only PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT in the destination stage mask will only prevent that stage from executing in subsequently submitted commands. As this stage does not perform any actual execution, this is not observable - in effect, it does not delay processing of subsequent commands. Similarly an execution dependency with only PIPELINE_STAGE_TOP_OF_PIPE_BIT in the source stage mask will effectively not wait for any prior commands to complete.

When defining a memory dependency, using only PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT or PIPELINE_STAGE_TOP_OF_PIPE_BIT would never make any accesses available and/or visible because these stages do not access memory.

PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT and PIPELINE_STAGE_TOP_OF_PIPE_BIT are useful for accomplishing layout transitions and queue ownership operations when the required execution dependency is satisfied by other means - for example, semaphore operations between queues.

See Also

VkCheckpointDataNV, VkPipelineStageFlags, CmdWriteBufferMarkerAMD, CmdWriteTimestamp

VK_IMAGE_ASPECT_COLOR_BIT, VK_IMAGE_ASPECT_DEPTH_BIT, VK_IMAGE_ASPECT_STENCIL_BIT, VK_IMAGE_ASPECT_METADATA_BIT

VkImageAspectFlagBits - Bitmask specifying which aspects of an image are included in a view

Description

• IMAGE_ASPECT_COLOR_BIT specifies the color aspect.
• IMAGE_ASPECT_DEPTH_BIT specifies the depth aspect.
• IMAGE_ASPECT_STENCIL_BIT specifies the stencil aspect.
• IMAGE_ASPECT_METADATA_BIT specifies the metadata aspect, used for sparse sparse resource operations.

See Also

VkBindImagePlaneMemoryInfo, VkImageAspectFlags, VkImagePlaneMemoryRequirementsInfo

VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT, VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT, VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT

VkSparseImageFormatFlagBits - Bitmask specifying additional information about a sparse image resource

Description

• SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT specifies that the image uses a single mip tail region for all array layers.
• SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT specifies that the first mip level whose dimensions are not integer multiples of the corresponding dimensions of the sparse image block begins the mip tail region.
• SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT specifies that the image uses non-standard sparse image block dimensions, and the imageGranularity values do not match the standard sparse image block dimensions for the given format.

See Also

VkSparseImageFormatFlags

VK_SPARSE_MEMORY_BIND_METADATA_BIT

VkSparseMemoryBindFlagBits - Bitmask specifying usage of a sparse memory binding operation

Description

• SPARSE_MEMORY_BIND_METADATA_BIT specifies that the memory being bound is only for the metadata aspect.

See Also

VkSparseMemoryBindFlags

VK_FENCE_CREATE_SIGNALED_BIT

VkFenceCreateFlagBits - Bitmask specifying initial state and behavior of a fence

Description

• FENCE_CREATE_SIGNALED_BIT specifies that the fence object is created in the signaled state. Otherwise, it is created in the unsignaled state.

See Also

VkFenceCreateFlags

VK_QUERY_TYPE_OCCLUSION, VK_QUERY_TYPE_PIPELINE_STATISTICS, VK_QUERY_TYPE_TIMESTAMP

VkQueryType - Specify the type of queries managed by a query pool

Description

• QUERY_TYPE_OCCLUSION specifies an occlusion query.
• QUERY_TYPE_PIPELINE_STATISTICS specifies a pipeline statistics query.
• QUERY_TYPE_TIMESTAMP specifies a timestamp query.

See Also

VkQueryPoolCreateInfo, CmdWriteAccelerationStructurePropertiesNVX

VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT, VK_QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT, VK_QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT, VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT, VK_QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT, VK_QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT, VK_QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT, VK_QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT, VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT, VK_QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT, VK_QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT

VkQueryPipelineStatisticFlagBits - Bitmask specifying queried pipeline statistics

Description

• QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT specifies that queries managed by the pool will count the number of vertices processed by the input assembly stage. Vertices corresponding to incomplete primitives may contribute to the count.
• QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives processed by the input assembly stage. If primitive restart is enabled, restarting the primitive topology has no effect on the count. Incomplete primitives may be counted.
• QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of vertex shader invocations. This counter’s value is incremented each time a vertex shader is invoked.
• QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of geometry shader invocations. This counter’s value is incremented each time a geometry shader is invoked. In the case of instanced geometry shaders, the geometry shader invocations count is incremented for each separate instanced invocation.
• QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives generated by geometry shader invocations. The counter’s value is incremented each time the geometry shader emits a primitive. Restarting primitive topology using the SPIR-V instructions OpEndPrimitive or OpEndStreamPrimitive has no effect on the geometry shader output primitives count.
• QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of primitives processed by the Primitive Clipping stage of the pipeline. The counter’s value is incremented each time a primitive reaches the primitive clipping stage.
• QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT specifies that queries managed by the pool will count the number of primitives output by the Primitive Clipping stage of the pipeline. The counter’s value is incremented each time a primitive passes the primitive clipping stage. The actual number of primitives output by the primitive clipping stage for a particular input primitive is implementation-dependent but must satisfy the following conditions:
  • If at least one vertex of the input primitive lies inside the clipping volume, the counter is incremented by one or more.
  • Otherwise, the counter is incremented by zero or more.
• QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of fragment shader invocations. The counter’s value is incremented each time the fragment shader is invoked.
• QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT specifies that queries managed by the pool will count the number of patches processed by the tessellation control shader. The counter’s value is incremented once for each patch for which a tessellation control shader is invoked.
• QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of invocations of the tessellation evaluation shader. The counter’s value is incremented each time the tessellation evaluation shader is invoked.
• QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT specifies that queries managed by the pool will count the number of compute shader invocations. The counter’s value is incremented every time the compute shader is invoked. Implementations may skip the execution of certain compute shader invocations or execute additional compute shader invocations for implementation-dependent reasons as long as the results of rendering otherwise remain unchanged.

These values are intended to measure relative statistics on one implementation. Various device architectures will count these values differently. Any or all counters may be affected by the issues described in Query Operation.

Note

For example, tile-based rendering devices may need to replay the scene multiple times, affecting some of the counts.

If a pipeline has rasterizerDiscardEnable enabled, implementations may discard primitives after the final vertex processing stage. As a result, if rasterizerDiscardEnable is enabled, the clipping input and output primitives counters may not be incremented.

When a pipeline statistics query finishes, the result for that query is marked as available. The application can copy the result to a buffer (via CmdCopyQueryPoolResults), or request it be put into host memory (via GetQueryPoolResults).

See Also

VkQueryPipelineStatisticFlags

VK_QUERY_RESULT_64_BIT, VK_QUERY_RESULT_WAIT_BIT, VK_QUERY_RESULT_WITH_AVAILABILITY_BIT, VK_QUERY_RESULT_PARTIAL_BIT

VkQueryResultFlagBits - Bitmask specifying how and when query results are returned

Description

• QUERY_RESULT_64_BIT specifies the results will be written as an array of 64-bit unsigned integer values. If this bit is not set, the results will be written as an array of 32-bit unsigned integer values.
• QUERY_RESULT_WAIT_BIT specifies that Vulkan will wait for each query’s status to become available before retrieving its results.
• QUERY_RESULT_WITH_AVAILABILITY_BIT specifies that the availability status accompanies the results.
• QUERY_RESULT_PARTIAL_BIT specifies that returning partial results is acceptable.

See Also

VkQueryResultFlags

VK_BUFFER_CREATE_SPARSE_BINDING_BIT, VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT, VK_BUFFER_CREATE_SPARSE_ALIASED_BIT

VkBufferCreateFlagBits - Bitmask specifying additional parameters of a buffer

Description

• BUFFER_CREATE_SPARSE_BINDING_BIT specifies that the buffer will be backed using sparse memory binding.
• BUFFER_CREATE_SPARSE_RESIDENCY_BIT specifies that the buffer can be partially backed using sparse memory binding. Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.
• BUFFER_CREATE_SPARSE_ALIASED_BIT specifies that the buffer will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another buffer (or another portion of the same buffer). Buffers created with this flag must also be created with the BUFFER_CREATE_SPARSE_BINDING_BIT flag.
• BUFFER_CREATE_PROTECTED_BIT specifies that the buffer is a protected buffer.

See Sparse Resource Features and Physical Device Features for details of the sparse memory features supported on a device.

See Also

VkBufferCreateFlags

VK_BUFFER_USAGE_TRANSFER_SRC_BIT, VK_BUFFER_USAGE_TRANSFER_DST_BIT, VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, VK_BUFFER_USAGE_INDEX_BUFFER_BIT, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT, VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT

VkBufferUsageFlagBits - Bitmask specifying allowed usage of a buffer

Description

• BUFFER_USAGE_TRANSFER_SRC_BIT specifies that the buffer can be used as the source of a transfer command (see the definition of PIPELINE_STAGE_TRANSFER_BIT).
• BUFFER_USAGE_TRANSFER_DST_BIT specifies that the buffer can be used as the destination of a transfer command.
• BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a VkBufferView suitable for occupying a VkDescriptorSet slot of type DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER.
• BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT specifies that the buffer can be used to create a VkBufferView suitable for occupying a VkDescriptorSet slot of type DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER.
• BUFFER_USAGE_UNIFORM_BUFFER_BIT specifies that the buffer can be used in a VkDescriptorBufferInfo suitable for occupying a VkDescriptorSet slot either of type DESCRIPTOR_TYPE_UNIFORM_BUFFER or DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC.
• BUFFER_USAGE_STORAGE_BUFFER_BIT specifies that the buffer can be used in a VkDescriptorBufferInfo suitable for occupying a VkDescriptorSet slot either of type DESCRIPTOR_TYPE_STORAGE_BUFFER or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC.
• BUFFER_USAGE_INDEX_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to CmdBindIndexBuffer.
• BUFFER_USAGE_VERTEX_BUFFER_BIT specifies that the buffer is suitable for passing as an element of the pBuffers array to CmdBindVertexBuffers.
• BUFFER_USAGE_INDIRECT_BUFFER_BIT specifies that the buffer is suitable for passing as the buffer parameter to CmdDrawIndirect, CmdDrawIndexedIndirect, CmdDrawMeshTasksIndirectNV, CmdDrawMeshTasksIndirectCountNV, or CmdDispatchIndirect. It is also suitable for passing as the buffer member of VkIndirectCommandsTokenNVX, or sequencesCountBuffer or sequencesIndexBuffer member of VkCmdProcessCommandsInfoNVX
• BUFFER_USAGE_CONDITIONAL_RENDERING_BIT_EXT specifies that the buffer is suitable for passing as the buffer parameter to CmdBeginConditionalRenderingEXT.

See Also

VkBufferUsageFlags

VK_SHARING_MODE_EXCLUSIVE, VK_SHARING_MODE_CONCURRENT

VkSharingMode - Buffer and image sharing modes

Description

• SHARING_MODE_EXCLUSIVE specifies that access to any range or image subresource of the object will be exclusive to a single queue family at a time.
• SHARING_MODE_CONCURRENT specifies that concurrent access to any range or image subresource of the object from multiple queue families is supported.

Note

SHARING_MODE_CONCURRENT may result in lower performance access to the buffer or image than SHARING_MODE_EXCLUSIVE.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_EXCLUSIVE must only be accessed by queues in the queue family that has ownership of the resource. Upon creation, such resources are not owned by any queue family; ownership is implicitly acquired upon first use within a queue. Once a resource using SHARING_MODE_EXCLUSIVE is owned by some queue family, the application must perform a queue family ownership transfer to make the memory contents of a range or image subresource accessible to a different queue family.

Note

Images still require a layout transition from IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED before being used on the first queue.

A queue family can take ownership of an image subresource or buffer range of a resource created with SHARING_MODE_EXCLUSIVE, without an ownership transfer, in the same way as for a resource that was just created; however, taking ownership in this way has the effect that the contents of the image subresource or buffer range are undefined.

Ranges of buffers and image subresources of image objects created using SHARING_MODE_CONCURRENT must only be accessed by queues from the queue families specified through the queueFamilyIndexCount and pQueueFamilyIndices members of the corresponding create info structures.

See Also

VkBufferCreateInfo, VkImageCreateInfo, VkSwapchainCreateInfoKHR

VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_GENERAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, VK_IMAGE_LAYOUT_PREINITIALIZED

VkImageLayout - Layout of image and image subresources

Description

The type(s) of device access supported by each layout are:

• IMAGE_LAYOUT_UNDEFINED does not support device access. This layout must only be used as the initialLayout member of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition. When transitioning out of this layout, the contents of the memory are not guaranteed to be preserved.
• IMAGE_LAYOUT_PREINITIALIZED does not support device access. This layout must only be used as the initialLayout member of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition. When transitioning out of this layout, the contents of the memory are preserved. This layout is intended to be used as the initial layout for an image whose contents are written by the host, and hence the data can be written to memory immediately, without first executing a layout transition. Currently, IMAGE_LAYOUT_PREINITIALIZED is only useful with linear images because there is not a standard layout defined for IMAGE_TILING_OPTIMAL images.
• IMAGE_LAYOUT_GENERAL supports all types of device access.
• IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL must only be used as a color or resolve attachment in a VkFramebuffer. This layout is valid only for image subresources of images created with the IMAGE_USAGE_COLOR_ATTACHMENT_BIT usage bit enabled.
• IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL must only be used as a depth/stencil attachment in a VkFramebuffer. This layout is valid only for image subresources of images created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled.
• IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL must only be used as a read-only depth/stencil attachment in a VkFramebuffer and/or as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment). This layout is valid only for image subresources of images created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled. Only image subresources of images created with IMAGE_USAGE_SAMPLED_BIT can be used as a sampled image or combined image/sampler in a shader. Similarly, only image subresources of images created with IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as input attachments.
• IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL: must only be used as a depth/stencil attachment in a VkFramebuffer, where the depth aspect is read-only, and/or as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment) where only the depth aspect is accessed. This layout is valid only for image subresources of images created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled. Only image subresources of images created with IMAGE_USAGE_SAMPLED_BIT can be used as a sampled image or combined image/sampler in a shader. Similarly, only image subresources of images created with IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as input attachments.
• IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL: must only be used as a depth/stencil attachment in a VkFramebuffer, where the stencil aspect is read-only, and/or as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment) where only the stencil aspect is accessed. This layout is valid only for image subresources of images created with the IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT usage bit enabled. Only image subresources of images created with IMAGE_USAGE_SAMPLED_BIT can be used as a sampled image or combined image/sampler in a shader. Similarly, only image subresources of images created with IMAGE_USAGE_INPUT_ATTACHMENT_BIT can be used as input attachments.
• IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL must only be used as a read-only image in a shader (which can be read as a sampled image, combined image/sampler and/or input attachment). This layout is valid only for image subresources of images created with the IMAGE_USAGE_SAMPLED_BIT or IMAGE_USAGE_INPUT_ATTACHMENT_BIT usage bit enabled.
• IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL must only be used as a source image of a transfer command (see the definition of PIPELINE_STAGE_TRANSFER_BIT). This layout is valid only for image subresources of images created with the IMAGE_USAGE_TRANSFER_SRC_BIT usage bit enabled.
• IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL must only be used as a destination image of a transfer command. This layout is valid only for image subresources of images created with the IMAGE_USAGE_TRANSFER_DST_BIT usage bit enabled.
• IMAGE_LAYOUT_PRESENT_SRC_KHR must only be used for presenting a presentable image for display. A swapchain’s image must be transitioned to this layout before calling QueuePresentKHR, and must be transitioned away from this layout after calling AcquireNextImageKHR.
• IMAGE_LAYOUT_SHARED_PRESENT_KHR is valid only for shared presentable images, and must be used for any usage the image supports.
• IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV must only be used as a read-only shading-rate-image. This layout is valid only for image subresources of images created with the IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV usage bit enabled.

The layout of each image subresource is not a state of the image subresource itself, but is rather a property of how the data in memory is organized, and thus for each mechanism of accessing an image in the API the application must specify a parameter or structure member that indicates which image layout the image subresource(s) are considered to be in when the image will be accessed. For transfer commands, this is a parameter to the command (see the “Clear Commands” section and the “Copy Commands” section). For use as a framebuffer attachment, this is a member in the substructures of the VkRenderPassCreateInfo (see Render Pass). For use in a descriptor set, this is a member in the VkDescriptorImageInfo structure (see the “Descriptor Set Updates” section).

See Also

VkAttachmentDescription, VkAttachmentDescription2KHR, VkAttachmentReference, VkAttachmentReference2KHR, VkDescriptorImageInfo, VkImageCreateInfo, VkImageMemoryBarrier, CmdBindShadingRateImageNV, CmdBlitImage, CmdClearColorImage, CmdClearDepthStencilImage, CmdCopyBufferToImage, CmdCopyImage, CmdCopyImageToBuffer, CmdResolveImage

VK_IMAGE_VIEW_TYPE_1D, VK_IMAGE_VIEW_TYPE_2D, VK_IMAGE_VIEW_TYPE_3D, VK_IMAGE_VIEW_TYPE_CUBE, VK_IMAGE_VIEW_TYPE_1D_ARRAY, VK_IMAGE_VIEW_TYPE_2D_ARRAY, VK_IMAGE_VIEW_TYPE_CUBE_ARRAY

VkImageViewType - Image view types

Description

The exact image view type is partially implicit, based on the image's type and sample count, as well as the view creation parameters as described in the image view compatibility table for CreateImageView. This table also shows which SPIR-V OpTypeImage Dim and Arrayed parameters correspond to each image view type.

See Also

VkImageViewCreateInfo

Enum values:

• IMAGE_VIEW_TYPE_1D
• IMAGE_VIEW_TYPE_2D
• IMAGE_VIEW_TYPE_3D
• IMAGE_VIEW_TYPE_CUBE
• IMAGE_VIEW_TYPE_1D_ARRAY
• IMAGE_VIEW_TYPE_2D_ARRAY
• IMAGE_VIEW_TYPE_CUBE_ARRAY

VK_COMPONENT_SWIZZLE_IDENTITY, VK_COMPONENT_SWIZZLE_ZERO, VK_COMPONENT_SWIZZLE_ONE, VK_COMPONENT_SWIZZLE_R, VK_COMPONENT_SWIZZLE_G, VK_COMPONENT_SWIZZLE_B, VK_COMPONENT_SWIZZLE_A

VkComponentSwizzle - Specify how a component is swizzled

Description

• COMPONENT_SWIZZLE_IDENTITY specifies that the component is set to the identity swizzle.
• COMPONENT_SWIZZLE_ZERO specifies that the component is set to zero.
• COMPONENT_SWIZZLE_ONE specifies that the component is set to either 1 or 1.0, depending on whether the type of the image view format is integer or floating-point respectively, as determined by the Format Definition section for each VkFormat.
• COMPONENT_SWIZZLE_R specifies that the component is set to the value of the R component of the image.
• COMPONENT_SWIZZLE_G specifies that the component is set to the value of the G component of the image.
• COMPONENT_SWIZZLE_B specifies that the component is set to the value of the B component of the image.
• COMPONENT_SWIZZLE_A specifies that the component is set to the value of the A component of the image.

Setting the identity swizzle on a component is equivalent to setting the identity mapping on that component. That is:

Component Mappings Equivalent To ename:VK_COMPONENT_SWIZZLE_IDENTITY

Component	Identity Mapping
components.r	COMPONENT_SWIZZLE_R
components.g	COMPONENT_SWIZZLE_G
components.b	COMPONENT_SWIZZLE_B
components.a	COMPONENT_SWIZZLE_A

See Also

VkComponentMapping

VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT, VK_PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT, VK_PIPELINE_CREATE_DERIVATIVE_BIT

VkPipelineCreateFlagBits - Bitmask controlling how a pipeline is created

Description

• PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT specifies that the created pipeline will not be optimized. Using this flag may reduce the time taken to create the pipeline.
• PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT specifies that the pipeline to be created is allowed to be the parent of a pipeline that will be created in a subsequent call to CreateGraphicsPipelines or CreateComputePipelines.
• PIPELINE_CREATE_DERIVATIVE_BIT specifies that the pipeline to be created will be a child of a previously created parent pipeline.
• PIPELINE_CREATE_VIEW_INDEX_FROM_DEVICE_INDEX_BIT specifies that any shader input variables decorated as ViewIndex will be assigned values as if they were decorated as DeviceIndex.
• PIPELINE_CREATE_DISPATCH_BASE specifies that a compute pipeline can be used with CmdDispatchBase with a non-zero base workgroup.

It is valid to set both PIPELINE_CREATE_ALLOW_DERIVATIVES_BIT and PIPELINE_CREATE_DERIVATIVE_BIT. This allows a pipeline to be both a parent and possibly a child in a pipeline hierarchy. See Pipeline Derivatives for more information.

See Also

VkPipelineCreateFlags

VK_SHADER_STAGE_VERTEX_BIT, VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT, VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT, VK_SHADER_STAGE_GEOMETRY_BIT, VK_SHADER_STAGE_FRAGMENT_BIT, VK_SHADER_STAGE_COMPUTE_BIT, VK_SHADER_STAGE_ALL_GRAPHICS, VK_SHADER_STAGE_ALL

VkShaderStageFlagBits - Bitmask specifying a pipeline stage

Description

• SHADER_STAGE_VERTEX_BIT specifies the vertex stage.
• SHADER_STAGE_TESSELLATION_CONTROL_BIT specifies the tessellation control stage.
• SHADER_STAGE_TESSELLATION_EVALUATION_BIT specifies the tessellation evaluation stage.
• SHADER_STAGE_GEOMETRY_BIT specifies the geometry stage.
• SHADER_STAGE_FRAGMENT_BIT specifies the fragment stage.
• SHADER_STAGE_COMPUTE_BIT specifies the compute stage.
• SHADER_STAGE_TASK_BIT_NV specifies the task stage.
• SHADER_STAGE_MESH_BIT_NV specifies the mesh stage.
• SHADER_STAGE_ALL_GRAPHICS is a combination of bits used as shorthand to specify all graphics stages defined above (excluding the compute stage).
• SHADER_STAGE_ALL is a combination of bits used as shorthand to specify all shader stages supported by the device, including all additional stages which are introduced by extensions.
• SHADER_STAGE_RAYGEN_BIT_NVX specifies the ray generation stage.
• SHADER_STAGE_ANY_HIT_BIT_NVX specifies the any hit stage.
• SHADER_STAGE_CLOSEST_HIT_BIT_NVX specifies the closest hit stage.
• SHADER_STAGE_MISS_BIT_NVX specifies the miss stage.
• SHADER_STAGE_INTERSECTION_BIT_NVX specifies the intersection stage.
• SHADER_STAGE_CALLABLE_BIT_NVX specifies the callable stage.

Note

SHADER_STAGE_ALL_GRAPHICS only includes the original five graphics stages included in Vulkan 1.0, and not any stages added by extensions. Thus, it may not have the desired effect in all cases.

See Also

VkPipelineShaderStageCreateInfo, VkShaderStageFlags, GetShaderInfoAMD

VK_VERTEX_INPUT_RATE_VERTEX, VK_VERTEX_INPUT_RATE_INSTANCE

VkVertexInputRate - Specify rate at which vertex attributes are pulled from buffers

Description

• VERTEX_INPUT_RATE_VERTEX specifies that vertex attribute addressing is a function of the vertex index.
• VERTEX_INPUT_RATE_INSTANCE specifies that vertex attribute addressing is a function of the instance index.

See Also

VkVertexInputBindingDescription

VK_PRIMITIVE_TOPOLOGY_POINT_LIST, VK_PRIMITIVE_TOPOLOGY_LINE_LIST, VK_PRIMITIVE_TOPOLOGY_LINE_STRIP, VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST, VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP, VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN, VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY, VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY, VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY, VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY, VK_PRIMITIVE_TOPOLOGY_PATCH_LIST

VkPrimitiveTopology - Supported primitive topologies

See Also

VkPipelineInputAssemblyStateCreateInfo

Enum values:

• PRIMITIVE_TOPOLOGY_POINT_LIST
• PRIMITIVE_TOPOLOGY_LINE_LIST
• PRIMITIVE_TOPOLOGY_LINE_STRIP
• PRIMITIVE_TOPOLOGY_TRIANGLE_LIST
• PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP
• PRIMITIVE_TOPOLOGY_TRIANGLE_FAN
• PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY
• PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY
• PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY
• PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY
• PRIMITIVE_TOPOLOGY_PATCH_LIST

VK_POLYGON_MODE_FILL, VK_POLYGON_MODE_LINE, VK_POLYGON_MODE_POINT

VkPolygonMode - Control polygon rasterization mode

Description

• POLYGON_MODE_POINT specifies that polygon vertices are drawn as points.
• POLYGON_MODE_LINE specifies that polygon edges are drawn as line segments.
• POLYGON_MODE_FILL specifies that polygons are rendered using the polygon rasterization rules in this section.
• POLYGON_MODE_FILL_RECTANGLE_NV specifies that polygons are rendered using polygon rasterization rules, modified to consider a sample within the primitive if the sample location is inside the axis-aligned bounding box of the triangle after projection. Note that the barycentric weights used in attribute interpolation can extend outside the range [0,1] when these primitives are shaded. Special treatment is given to a sample position on the boundary edge of the bounding box. In such a case, if two rectangles lie on either side of a common edge (with identical endpoints) on which a sample position lies, then exactly one of the triangles must produce a fragment that covers that sample during rasterization. Polygons rendered in POLYGON_MODE_FILL_RECTANGLE_NV mode may be clipped by the frustum or by user clip planes. If clipping is applied, the triangle is culled rather than clipped.

  Area calculation and facingness are determined for POLYGON_MODE_FILL_RECTANGLE_NV mode using the triangle's vertices.

These modes affect only the final rasterization of polygons: in particular, a polygon's vertices are shaded and the polygon is clipped and possibly culled before these modes are applied.

See Also

VkPipelineRasterizationStateCreateInfo

VK_CULL_MODE_NONE, VK_CULL_MODE_FRONT_BIT, VK_CULL_MODE_BACK_BIT, VK_CULL_MODE_FRONT_AND_BACK

VkCullModeFlagBits - Bitmask controlling triangle culling

Description

• CULL_MODE_NONE specifies that no triangles are discarded
• CULL_MODE_FRONT_BIT specifies that front-facing triangles are discarded
• CULL_MODE_BACK_BIT specifies that back-facing triangles are discarded
• CULL_MODE_FRONT_AND_BACK specifies that all triangles are discarded.

Following culling, fragments are produced for any triangles which have not been discarded.

See Also

VkCullModeFlags

VK_FRONT_FACE_COUNTER_CLOCKWISE, VK_FRONT_FACE_CLOCKWISE

VkFrontFace - Interpret polygon front-facing orientation

Description

• FRONT_FACE_COUNTER_CLOCKWISE specifies that a triangle with positive area is considered front-facing.
• FRONT_FACE_CLOCKWISE specifies that a triangle with negative area is considered front-facing.

Any triangle which is not front-facing is back-facing, including zero-area triangles.

See Also

VkPipelineRasterizationStateCreateInfo

VK_COMPARE_OP_NEVER, VK_COMPARE_OP_LESS, VK_COMPARE_OP_EQUAL, VK_COMPARE_OP_LESS_OR_EQUAL, VK_COMPARE_OP_GREATER, VK_COMPARE_OP_NOT_EQUAL, VK_COMPARE_OP_GREATER_OR_EQUAL, VK_COMPARE_OP_ALWAYS

VkCompareOp - Stencil comparison function

Description

• COMPARE_OP_NEVER specifies that the test never passes.
• COMPARE_OP_LESS specifies that the test passes when R < S.
• COMPARE_OP_EQUAL specifies that the test passes when R = S.
• COMPARE_OP_LESS_OR_EQUAL specifies that the test passes when R ≤ S.
• COMPARE_OP_GREATER specifies that the test passes when R > S.
• COMPARE_OP_NOT_EQUAL specifies that the test passes when R ≠ S.
• COMPARE_OP_GREATER_OR_EQUAL specifies that the test passes when R ≥ S.
• COMPARE_OP_ALWAYS specifies that the test always passes.

See Also

VkPipelineDepthStencilStateCreateInfo, VkSamplerCreateInfo, VkStencilOpState

VK_STENCIL_OP_KEEP, VK_STENCIL_OP_ZERO, VK_STENCIL_OP_REPLACE, VK_STENCIL_OP_INCREMENT_AND_CLAMP, VK_STENCIL_OP_DECREMENT_AND_CLAMP, VK_STENCIL_OP_INVERT, VK_STENCIL_OP_INCREMENT_AND_WRAP, VK_STENCIL_OP_DECREMENT_AND_WRAP

VkStencilOp - Stencil comparison function

Description

• STENCIL_OP_KEEP keeps the current value.
• STENCIL_OP_ZERO sets the value to 0.
• STENCIL_OP_REPLACE sets the value to reference.
• STENCIL_OP_INCREMENT_AND_CLAMP increments the current value and clamps to the maximum representable unsigned value.
• STENCIL_OP_DECREMENT_AND_CLAMP decrements the current value and clamps to 0.
• STENCIL_OP_INVERT bitwise-inverts the current value.
• STENCIL_OP_INCREMENT_AND_WRAP increments the current value and wraps to 0 when the maximum value would have been exceeded.
• STENCIL_OP_DECREMENT_AND_WRAP decrements the current value and wraps to the maximum possible value when the value would go below 0.

For purposes of increment and decrement, the stencil bits are considered as an unsigned integer.

If the stencil test fails, the sample's coverage bit is cleared in the fragment. If there is no stencil framebuffer attachment, stencil modification cannot occur, and it is as if the stencil tests always pass.

If the stencil test passes, the writeMask member of the VkStencilOpState structures controls how the updated stencil value is written to the stencil framebuffer attachment.

The least significant s bits of writeMask, where s is the number of bits in the stencil framebuffer attachment, specify an integer mask. Where a 1 appears in this mask, the corresponding bit in the stencil value in the depth/stencil attachment is written; where a 0 appears, the bit is not written. The writeMask value uses either the front-facing or back-facing state based on the facingness of the fragment. Fragments generated by front-facing primitives use the front mask and fragments generated by back-facing primitives use the back mask.

See Also

VkStencilOpState

VK_LOGIC_OP_CLEAR, VK_LOGIC_OP_AND, VK_LOGIC_OP_AND_REVERSE, VK_LOGIC_OP_COPY, VK_LOGIC_OP_AND_INVERTED, VK_LOGIC_OP_NO_OP, VK_LOGIC_OP_XOR, VK_LOGIC_OP_OR, VK_LOGIC_OP_NOR, VK_LOGIC_OP_EQUIVALENT, VK_LOGIC_OP_INVERT, VK_LOGIC_OP_OR_REVERSE, VK_LOGIC_OP_COPY_INVERTED, VK_LOGIC_OP_OR_INVERTED, VK_LOGIC_OP_NAND, VK_LOGIC_OP_SET

VkLogicOp - Framebuffer logical operations

Description

The logical operations supported by Vulkan are summarized in the following table in which

• ¬ is bitwise invert,
• ∧ is bitwise and,
• ∨ is bitwise or,
• ⊕ is bitwise exclusive or,
• s is the fragment’s Rs0, Gs0, Bs0 or As0 component value for the fragment output corresponding to the color attachment being updated, and
• d is the color attachment’s R, G, B or A component value:

Logical Operations

Mode	Operation
LOGIC_OP_CLEAR	0
LOGIC_OP_AND	s ∧ d
LOGIC_OP_AND_REVERSE	s ∧ ¬ d
LOGIC_OP_COPY	s
LOGIC_OP_AND_INVERTED	¬ s ∧ d
LOGIC_OP_NO_OP	d
LOGIC_OP_XOR	s ⊕ d
LOGIC_OP_OR	s ∨ d
LOGIC_OP_NOR	¬ (s ∨ d)
LOGIC_OP_EQUIVALENT	¬ (s ⊕ d)
LOGIC_OP_INVERT	¬ d
LOGIC_OP_OR_REVERSE	s ∨ ¬ d
LOGIC_OP_COPY_INVERTED	¬ s
LOGIC_OP_OR_INVERTED	¬ s ∨ d
LOGIC_OP_NAND	¬ (s ∧ d)
LOGIC_OP_SET	all 1s

The result of the logical operation is then written to the color attachment as controlled by the component write mask, described in Blend Operations.

See Also

VkPipelineColorBlendStateCreateInfo

VK_BLEND_FACTOR_ZERO, VK_BLEND_FACTOR_ONE, VK_BLEND_FACTOR_SRC_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC_COLOR, VK_BLEND_FACTOR_DST_COLOR, VK_BLEND_FACTOR_ONE_MINUS_DST_COLOR, VK_BLEND_FACTOR_SRC_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA, VK_BLEND_FACTOR_DST_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_DST_ALPHA, VK_BLEND_FACTOR_CONSTANT_COLOR, VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR, VK_BLEND_FACTOR_CONSTANT_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA, VK_BLEND_FACTOR_SRC_ALPHA_SATURATE, VK_BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

VkBlendFactor - Framebuffer blending factors

Description

The semantics of each enum value is described in the table below:

Blend Factors

VkBlendFactor	RGB Blend Factors (Sr,Sg,Sb) or (Dr,Dg,Db)	Alpha Blend Factor (Sa or Da)
BLEND_FACTOR_ZERO	(0,0,0)	0
BLEND_FACTOR_ONE	(1,1,1)	1
BLEND_FACTOR_SRC_COLOR	(Rs0,Gs0,Bs0)	As0
BLEND_FACTOR_ONE_MINUS_SRC_COLOR	(1-Rs0,1-Gs0,1-Bs0)	1-As0
BLEND_FACTOR_DST_COLOR	(Rd,Gd,Bd)	Ad
BLEND_FACTOR_ONE_MINUS_DST_COLOR	(1-Rd,1-Gd,1-Bd)	1-Ad
BLEND_FACTOR_SRC_ALPHA	(As0,As0,As0)	As0
BLEND_FACTOR_ONE_MINUS_SRC_ALPHA	(1-As0,1-As0,1-As0)	1-As0
BLEND_FACTOR_DST_ALPHA	(Ad,Ad,Ad)	Ad
BLEND_FACTOR_ONE_MINUS_DST_ALPHA	(1-Ad,1-Ad,1-Ad)	1-Ad
BLEND_FACTOR_CONSTANT_COLOR	(Rc,Gc,Bc)	Ac
BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR	(1-Rc,1-Gc,1-Bc)	1-Ac
BLEND_FACTOR_CONSTANT_ALPHA	(Ac,Ac,Ac)	Ac
BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA	(1-Ac,1-Ac,1-Ac)	1-Ac
BLEND_FACTOR_SRC_ALPHA_SATURATE	(f,f,f); f = min(As0,1-Ad)	1
BLEND_FACTOR_SRC1_COLOR	(Rs1,Gs1,Bs1)	As1
BLEND_FACTOR_ONE_MINUS_SRC1_COLOR	(1-Rs1,1-Gs1,1-Bs1)	1-As1
BLEND_FACTOR_SRC1_ALPHA	(As1,As1,As1)	As1
BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA	(1-As1,1-As1,1-As1)	1-As1

In this table, the following conventions are used:

• Rs0,Gs0,Bs0 and As0 represent the first source color R, G, B, and A components, respectively, for the fragment output location corresponding to the color attachment being blended.
• Rs1,Gs1,Bs1 and As1 represent the second source color R, G, B, and A components, respectively, used in dual source blending modes, for the fragment output location corresponding to the color attachment being blended.
• Rd,Gd,Bd and Ad represent the R, G, B, and A components of the destination color. That is, the color currently in the corresponding color attachment for this fragment/sample.
• Rc,Gc,Bc and Ac represent the blend constant R, G, B, and A components, respectively.

See Also

VkPipelineColorBlendAttachmentState

VK_BLEND_OP_ADD, VK_BLEND_OP_SUBTRACT, VK_BLEND_OP_REVERSE_SUBTRACT, VK_BLEND_OP_MIN, VK_BLEND_OP_MAX

VkBlendOp - Framebuffer blending operations

Description

The semantics of each basic blend operations is described in the table below:

Basic Blend Operations

VkBlendOp	RGB Components	Alpha Component
BLEND_OP_ADD	R = Rs0 × Sr + Rd × Dr G = Gs0 × Sg + Gd × Dg B = Bs0 × Sb + Bd × Db	A = As0 × Sa + Ad × Da
BLEND_OP_SUBTRACT	R = Rs0 × Sr - Rd × Dr G = Gs0 × Sg - Gd × Dg B = Bs0 × Sb - Bd × Db	A = As0 × Sa - Ad × Da
BLEND_OP_REVERSE_SUBTRACT	R = Rd × Dr - Rs0 × Sr G = Gd × Dg - Gs0 × Sg B = Bd × Db - Bs0 × Sb	A = Ad × Da - As0 × Sa
BLEND_OP_MIN	R = min(Rs0,Rd) G = min(Gs0,Gd) B = min(Bs0,Bd)	A = min(As0,Ad)
BLEND_OP_MAX	R = max(Rs0,Rd) G = max(Gs0,Gd) B = max(Bs0,Bd)	A = max(As0,Ad)

In this table, the following conventions are used:

• Rs0, Gs0, Bs0 and As0 represent the first source color R, G, B, and A components, respectively.
• Rd, Gd, Bd and Ad represent the R, G, B, and A components of the destination color. That is, the color currently in the corresponding color attachment for this fragment/sample.
• Sr, Sg, Sb and Sa represent the source blend factor R, G, B, and A components, respectively.
• Dr, Dg, Db and Da represent the destination blend factor R, G, B, and A components, respectively.

The blending operation produces a new set of values R, G, B and A, which are written to the framebuffer attachment. If blending is not enabled for this attachment, then R, G, B and A are assigned Rs0, Gs0, Bs0 and As0, respectively.

If the color attachment is fixed-point, the components of the source and destination values and blend factors are each clamped to [0,1] or [-1,1] respectively for an unsigned normalized or signed normalized color attachment prior to evaluating the blend operations. If the color attachment is floating-point, no clamping occurs.

See Also

VkPipelineColorBlendAttachmentState

VK_COLOR_COMPONENT_R_BIT, VK_COLOR_COMPONENT_G_BIT, VK_COLOR_COMPONENT_B_BIT, VK_COLOR_COMPONENT_A_BIT

VkColorComponentFlagBits - Bitmask controlling which components are written to the framebuffer

Description

• COLOR_COMPONENT_R_BIT specifies that the R value is written to the color attachment for the appropriate sample. Otherwise, the value in memory is unmodified.
• COLOR_COMPONENT_G_BIT specifies that the G value is written to the color attachment for the appropriate sample. Otherwise, the value in memory is unmodified.
• COLOR_COMPONENT_B_BIT specifies that the B value is written to the color attachment for the appropriate sample. Otherwise, the value in memory is unmodified.
• COLOR_COMPONENT_A_BIT specifies that the A value is written to the color attachment for the appropriate sample. Otherwise, the value in memory is unmodified.

The color write mask operation is applied regardless of whether blending is enabled.

See Also

VkColorComponentFlags

VK_DYNAMIC_STATE_VIEWPORT, VK_DYNAMIC_STATE_SCISSOR, VK_DYNAMIC_STATE_LINE_WIDTH, VK_DYNAMIC_STATE_DEPTH_BIAS, VK_DYNAMIC_STATE_BLEND_CONSTANTS, VK_DYNAMIC_STATE_DEPTH_BOUNDS, VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK, VK_DYNAMIC_STATE_STENCIL_WRITE_MASK, VK_DYNAMIC_STATE_STENCIL_REFERENCE

VkDynamicState - Indicate which dynamic state is taken from dynamic state commands

Description

• DYNAMIC_STATE_VIEWPORT specifies that the pViewports state in VkPipelineViewportStateCreateInfo will be ignored and must be set dynamically with CmdSetViewport before any draw commands. The number of viewports used by a pipeline is still specified by the viewportCount member of VkPipelineViewportStateCreateInfo.
• DYNAMIC_STATE_SCISSOR specifies that the pScissors state in VkPipelineViewportStateCreateInfo will be ignored and must be set dynamically with CmdSetScissor before any draw commands. The number of scissor rectangles used by a pipeline is still specified by the scissorCount member of VkPipelineViewportStateCreateInfo.
• DYNAMIC_STATE_LINE_WIDTH specifies that the lineWidth state in VkPipelineRasterizationStateCreateInfo will be ignored and must be set dynamically with CmdSetLineWidth before any draw commands that generate line primitives for the rasterizer.
• DYNAMIC_STATE_DEPTH_BIAS specifies that the depthBiasConstantFactor, depthBiasClamp and depthBiasSlopeFactor states in VkPipelineRasterizationStateCreateInfo will be ignored and must be set dynamically with CmdSetDepthBias before any draws are performed with depthBiasEnable in VkPipelineRasterizationStateCreateInfo set to TRUE.
• DYNAMIC_STATE_BLEND_CONSTANTS specifies that the blendConstants state in VkPipelineColorBlendStateCreateInfo will be ignored and must be set dynamically with CmdSetBlendConstants before any draws are performed with a pipeline state with VkPipelineColorBlendAttachmentState member blendEnable set to TRUE and any of the blend functions using a constant blend color.
• DYNAMIC_STATE_DEPTH_BOUNDS specifies that the minDepthBounds and maxDepthBounds states of VkPipelineDepthStencilStateCreateInfo will be ignored and must be set dynamically with CmdSetDepthBounds before any draws are performed with a pipeline state with VkPipelineDepthStencilStateCreateInfo member depthBoundsTestEnable set to TRUE.
• DYNAMIC_STATE_STENCIL_COMPARE_MASK specifies that the compareMask state in VkPipelineDepthStencilStateCreateInfo for both front and back will be ignored and must be set dynamically with CmdSetStencilCompareMask before any draws are performed with a pipeline state with VkPipelineDepthStencilStateCreateInfo member stencilTestEnable set to TRUE
• DYNAMIC_STATE_STENCIL_WRITE_MASK specifies that the writeMask state in VkPipelineDepthStencilStateCreateInfo for both front and back will be ignored and must be set dynamically with CmdSetStencilWriteMask before any draws are performed with a pipeline state with VkPipelineDepthStencilStateCreateInfo member stencilTestEnable set to TRUE
• DYNAMIC_STATE_STENCIL_REFERENCE specifies that the reference state in VkPipelineDepthStencilStateCreateInfo for both front and back will be ignored and must be set dynamically with CmdSetStencilReference before any draws are performed with a pipeline state with VkPipelineDepthStencilStateCreateInfo member stencilTestEnable set to TRUE
• DYNAMIC_STATE_VIEWPORT_W_SCALING_NV specifies that the pViewportScalings state in VkPipelineViewportWScalingStateCreateInfoNV will be ignored and must be set dynamically with CmdSetViewportWScalingNV before any draws are performed with a pipeline state with VkPipelineViewportWScalingStateCreateInfo member viewportScalingEnable set to TRUE
• DYNAMIC_STATE_DISCARD_RECTANGLE_EXT specifies that the pDiscardRectangles state in VkPipelineDiscardRectangleStateCreateInfoEXT will be ignored and must be set dynamically with CmdSetDiscardRectangleEXT before any draw or clear commands. The VkDiscardRectangleModeEXT and the number of active discard rectangles is still specified by the discardRectangleMode and discardRectangleCount members of VkPipelineDiscardRectangleStateCreateInfoEXT.
• DYNAMIC_STATE_SAMPLE_LOCATIONS_EXT specifies that the sampleLocationsInfo state in VkPipelineSampleLocationsStateCreateInfoEXT will be ignored and must be set dynamically with CmdSetSampleLocationsEXT before any draw or clear commands. Enabling custom sample locations is still indicated by the sampleLocationsEnable member of VkPipelineSampleLocationsStateCreateInfoEXT.
• DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV specifies that the pExclusiveScissors state in VkPipelineViewportExclusiveScissorStateCreateInfoNV will be ignored and must be set dynamically with CmdSetExclusiveScissorNV before any draw commands. The number of exclusive scissor rectangles used by a pipeline is still specified by the exclusiveScissorCount member of VkPipelineViewportExclusiveScissorStateCreateInfoNV.
• DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV specifies that the pShadingRatePalettes state in VkPipelineViewportShadingRateImageStateCreateInfoNV will be ignored and must be set dynamically with CmdSetViewportShadingRatePaletteNV before any draw commands.
• DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV specifies that the coarse sample order state in VkPipelineViewportCoarseSampleOrderStateCreateInfoNV will be ignored and must be set dynamically with CmdSetCoarseSampleOrderNV before any draw commands.

See Also

VkPipelineDynamicStateCreateInfo

VK_FILTER_NEAREST, VK_FILTER_LINEAR

VkFilter - Specify filters used for texture lookups

Description

• FILTER_NEAREST specifies nearest filtering.
• FILTER_LINEAR specifies linear filtering.
• FILTER_CUBIC_IMG specifies cubic filtering.

These filters are described in detail in Texel Filtering.

See Also

VkSamplerCreateInfo, VkSamplerYcbcrConversionCreateInfo, CmdBlitImage

VK_SAMPLER_MIPMAP_MODE_NEAREST, VK_SAMPLER_MIPMAP_MODE_LINEAR

VkSamplerMipmapMode - Specify mipmap mode used for texture lookups

Description

• SAMPLER_MIPMAP_MODE_NEAREST specifies nearest filtering.
• SAMPLER_MIPMAP_MODE_LINEAR specifies linear filtering.

These modes are described in detail in Texel Filtering.

See Also

VkSamplerCreateInfo

VK_SAMPLER_ADDRESS_MODE_REPEAT, VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT, VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE, VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER

VkSamplerAddressMode - Specify behavior of sampling with texture coordinates outside an image

Description

• SAMPLER_ADDRESS_MODE_REPEAT specifies that the repeat wrap mode will be used.
• SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT specifies that the mirrored repeat wrap mode will be used.
• SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE specifies that the clamp to edge wrap mode will be used.
• SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER specifies that the clamp to border wrap mode will be used.
• SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE specifies that the mirror clamp to edge wrap mode will be used. This is only valid if the VK_KHR_sampler_mirror_clamp_to_edge extension is enabled.

See Also

VkSamplerCreateInfo

VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK, VK_BORDER_COLOR_INT_TRANSPARENT_BLACK, VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK, VK_BORDER_COLOR_INT_OPAQUE_BLACK, VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE, VK_BORDER_COLOR_INT_OPAQUE_WHITE

VkBorderColor - Specify border color used for texture lookups

Description

• BORDER_COLOR_FLOAT_TRANSPARENT_BLACK specifies a transparent, floating-point format, black color.
• BORDER_COLOR_INT_TRANSPARENT_BLACK specifies a transparent, integer format, black color.
• BORDER_COLOR_FLOAT_OPAQUE_BLACK specifies an opaque, floating-point format, black color.
• BORDER_COLOR_INT_OPAQUE_BLACK specifies an opaque, integer format, black color.
• BORDER_COLOR_FLOAT_OPAQUE_WHITE specifies an opaque, floating-point format, white color.
• BORDER_COLOR_INT_OPAQUE_WHITE specifies an opaque, integer format, white color.

These colors are described in detail in Texel Replacement.

See Also

VkSamplerCreateInfo

VK_DESCRIPTOR_TYPE_SAMPLER, VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE, VK_DESCRIPTOR_TYPE_STORAGE_IMAGE, VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER, VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, VK_DESCRIPTOR_TYPE_STORAGE_BUFFER, VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT

VkDescriptorType - Specifies the type of a descriptor in a descriptor set

Description

• DESCRIPTOR_TYPE_SAMPLER specifies a sampler descriptor.
• DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER specifies a combined image sampler descriptor.
• DESCRIPTOR_TYPE_SAMPLED_IMAGE specifies a sampled image descriptor.
• DESCRIPTOR_TYPE_STORAGE_IMAGE specifies a storage image descriptor.
• DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER specifies a uniform texel buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER specifies a storage texel buffer descriptor.
• DESCRIPTOR_TYPE_UNIFORM_BUFFER specifies a uniform buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_BUFFER specifies a storage buffer descriptor.
• DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC specifies a dynamic uniform buffer descriptor.
• DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC specifies a dynamic storage buffer descriptor.
• DESCRIPTOR_TYPE_INPUT_ATTACHMENT specifies an input attachment descriptor.
• DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT specifies an inline uniform block.

When a descriptor set is updated via elements of VkWriteDescriptorSet, members of pImageInfo, pBufferInfo and pTexelBufferView are only accessed by the implementation when they correspond to descriptor type being defined - otherwise they are ignored. The members accessed are as follows for each descriptor type:

• For DESCRIPTOR_TYPE_SAMPLER, only the sampler member of each element of VkWriteDescriptorSet::pImageInfo is accessed.
• For DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_INPUT_ATTACHMENT, only the imageView and imageLayout members of each element of VkWriteDescriptorSet::pImageInfo are accessed.
• For DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, all members of each element of VkWriteDescriptorSet::pImageInfo are accessed.
• For DESCRIPTOR_TYPE_UNIFORM_BUFFER, DESCRIPTOR_TYPE_STORAGE_BUFFER, DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC, or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC, all members of each element of VkWriteDescriptorSet::pBufferInfo are accessed.
• For DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER or DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER, each element of VkWriteDescriptorSet::pTexelBufferView is accessed.

When updating descriptors with a descriptorType of DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT, none of the pImageInfo, pBufferInfo, or pTexelBufferView members are accessed, instead the source data of the descriptor update operation is taken from the instance of VkWriteDescriptorSetInlineUniformBlockEXT in the pNext chain of VkWriteDescriptorSet.

See Also

VkDescriptorPoolSize, VkDescriptorSetLayoutBinding, VkDescriptorUpdateTemplateEntry, VkWriteDescriptorSet

VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT

VkDescriptorPoolCreateFlagBits - Bitmask specifying certain supported operations on a descriptor pool

Description

• DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT specifies that descriptor sets can return their individual allocations to the pool, i.e. all of AllocateDescriptorSets, FreeDescriptorSets, and ResetDescriptorPool are allowed. Otherwise, descriptor sets allocated from the pool must not be individually freed back to the pool, i.e. only AllocateDescriptorSets and ResetDescriptorPool are allowed.
• DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT specifies that descriptor sets allocated from this pool can include bindings with the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT bit set. It is valid to allocate descriptor sets that have bindings that do not set the DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT_EXT bit from a pool that has DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT set.

See Also

VkDescriptorPoolCreateFlags

VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT

VkAttachmentDescriptionFlagBits - Bitmask specifying additional properties of an attachment

Description

• ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT specifies that the attachment aliases the same device memory as other attachments.

See Also

VkAttachmentDescriptionFlags

VK_ATTACHMENT_LOAD_OP_LOAD, VK_ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_LOAD_OP_DONT_CARE

VkAttachmentLoadOp - Specify how contents of an attachment are treated at the beginning of a subpass

Description

• ATTACHMENT_LOAD_OP_LOAD specifies that the previous contents of the image within the render area will be preserved. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_READ_BIT.
• ATTACHMENT_LOAD_OP_CLEAR specifies that the contents within the render area will be cleared to a uniform value, which is specified when a render pass instance is begun. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.
• ATTACHMENT_LOAD_OP_DONT_CARE specifies that the previous contents within the area need not be preserved; the contents of the attachment will be undefined inside the render area. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

See Also

VkAttachmentDescription, VkAttachmentDescription2KHR

VK_ATTACHMENT_STORE_OP_STORE, VK_ATTACHMENT_STORE_OP_DONT_CARE

VkAttachmentStoreOp - Specify how contents of an attachment are treated at the end of a subpass

Description

• ATTACHMENT_STORE_OP_STORE specifies the contents generated during the render pass and within the render area are written to memory. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.
• ATTACHMENT_STORE_OP_DONT_CARE specifies the contents within the render area are not needed after rendering, and may be discarded; the contents of the attachment will be undefined inside the render area. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

See Also

VkAttachmentDescription, VkAttachmentDescription2KHR

VK_PIPELINE_BIND_POINT_GRAPHICS, VK_PIPELINE_BIND_POINT_COMPUTE

VkPipelineBindPoint - Specify the bind point of a pipeline object to a command buffer

Description

• PIPELINE_BIND_POINT_COMPUTE specifies binding as a compute pipeline.
• PIPELINE_BIND_POINT_GRAPHICS specifies binding as a graphics pipeline.

See Also

VkDescriptorUpdateTemplateCreateInfo, VkIndirectCommandsLayoutCreateInfoNVX, VkSubpassDescription, VkSubpassDescription2KHR, CmdBindDescriptorSets, CmdBindPipeline, CmdPushDescriptorSetKHR

VK_ACCESS_INDIRECT_COMMAND_READ_BIT, VK_ACCESS_INDEX_READ_BIT, VK_ACCESS_VERTEX_ATTRIBUTE_READ_BIT, VK_ACCESS_UNIFORM_READ_BIT, VK_ACCESS_INPUT_ATTACHMENT_READ_BIT, VK_ACCESS_SHADER_READ_BIT, VK_ACCESS_SHADER_WRITE_BIT, VK_ACCESS_COLOR_ATTACHMENT_READ_BIT, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT, VK_ACCESS_TRANSFER_READ_BIT, VK_ACCESS_TRANSFER_WRITE_BIT, VK_ACCESS_HOST_READ_BIT, VK_ACCESS_HOST_WRITE_BIT, VK_ACCESS_MEMORY_READ_BIT, VK_ACCESS_MEMORY_WRITE_BIT

VkAccessFlagBits - Bitmask specifying memory access types that will participate in a memory dependency

Description

• ACCESS_INDIRECT_COMMAND_READ_BIT specifies read access to an indirect command structure read as part of an indirect drawing or dispatch command.
• ACCESS_INDEX_READ_BIT specifies read access to an index buffer as part of an indexed drawing command, bound by CmdBindIndexBuffer.
• ACCESS_VERTEX_ATTRIBUTE_READ_BIT specifies read access to a vertex buffer as part of a drawing command, bound by CmdBindVertexBuffers.
• ACCESS_UNIFORM_READ_BIT specifies read access to a uniform buffer.
• ACCESS_INPUT_ATTACHMENT_READ_BIT specifies read access to an input attachment within a render pass during fragment shading.
• ACCESS_SHADER_READ_BIT specifies read access to a storage buffer, uniform texel buffer, storage texel buffer, sampled image, or storage image.
• ACCESS_SHADER_WRITE_BIT specifies write access to a storage buffer, storage texel buffer, or storage image.
• ACCESS_COLOR_ATTACHMENT_READ_BIT specifies read access to a color attachment, such as via blending, logic operations, or via certain subpass load operations. It does not include advanced blend operations.
• ACCESS_COLOR_ATTACHMENT_WRITE_BIT specifies write access to a color or resolve attachment during a render pass or via certain subpass load and store operations.
• ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT specifies read access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load operations.
• ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT specifies write access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load and store operations.
• ACCESS_TRANSFER_READ_BIT specifies read access to an image or buffer in a copy operation.
• ACCESS_TRANSFER_WRITE_BIT specifies write access to an image or buffer in a clear or copy operation.
• ACCESS_HOST_READ_BIT specifies read access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.
• ACCESS_HOST_WRITE_BIT specifies write access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.
• ACCESS_MEMORY_READ_BIT specifies read access via non-specific entities. These entities include the Vulkan device and host, but may also include entities external to the Vulkan device or otherwise not part of the core Vulkan pipeline. When included in a destination access mask, makes all available writes visible to all future read accesses on entities known to the Vulkan device.
• ACCESS_MEMORY_WRITE_BIT specifies write access via non-specific entities. These entities include the Vulkan device and host, but may also include entities external to the Vulkan device or otherwise not part of the core Vulkan pipeline. When included in a source access mask, all writes that are performed by entities known to the Vulkan device are made available. When included in a destination access mask, makes all available writes visible to all future write accesses on entities known to the Vulkan device.
• ACCESS_CONDITIONAL_RENDERING_READ_BIT_EXT specifies read access to a predicate as part of conditional rendering.
• ACCESS_COMMAND_PROCESS_READ_BIT_NVX specifies reads from VkBuffer inputs to CmdProcessCommandsNVX.
• ACCESS_COMMAND_PROCESS_WRITE_BIT_NVX specifies writes to the target command buffer in CmdProcessCommandsNVX.
• ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT is similar to ACCESS_COLOR_ATTACHMENT_READ_BIT, but also includes advanced blend operations.
• ACCESS_SHADING_RATE_IMAGE_READ_BIT_NV specifies read access to a shading rate image as part of a drawing command, as bound by CmdBindShadingRateImageNV.

Certain access types are only performed by a subset of pipeline stages. Any synchronization command that takes both stage masks and access masks uses both to define the access scopes - only the specified access types performed by the specified stages are included in the access scope. An application must not specify an access flag in a synchronization command if it does not include a pipeline stage in the corresponding stage mask that is able to perform accesses of that type. The following table lists, for each access flag, which pipeline stages can perform that type of access.

Supported access types

Access flag	Supported pipeline stages
ACCESS_INDIRECT_COMMAND_READ_BIT	PIPELINE_STAGE_DRAW_INDIRECT_BIT
ACCESS_INDEX_READ_BIT	PIPELINE_STAGE_VERTEX_INPUT_BIT
ACCESS_VERTEX_ATTRIBUTE_READ_BIT	PIPELINE_STAGE_VERTEX_INPUT_BIT
ACCESS_UNIFORM_READ_BIT	PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_SHADER_READ_BIT	PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_SHADER_WRITE_BIT	PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_INPUT_ATTACHMENT_READ_BIT	PIPELINE_STAGE_FRAGMENT_SHADER_BIT
ACCESS_COLOR_ATTACHMENT_READ_BIT	PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_COLOR_ATTACHMENT_WRITE_BIT	PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT	PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, or PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT
ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT	PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, or PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT
ACCESS_TRANSFER_READ_BIT	PIPELINE_STAGE_TRANSFER_BIT
ACCESS_TRANSFER_WRITE_BIT	PIPELINE_STAGE_TRANSFER_BIT
ACCESS_HOST_READ_BIT	PIPELINE_STAGE_HOST_BIT
ACCESS_HOST_WRITE_BIT	PIPELINE_STAGE_HOST_BIT
ACCESS_MEMORY_READ_BIT	N/A
ACCESS_MEMORY_WRITE_BIT	N/A
ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT	PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_COMMAND_PROCESS_READ_BIT_NVX	PIPELINE_STAGE_COMMAND_PROCESS_BIT_NVX
ACCESS_COMMAND_PROCESS_WRITE_BIT_NVX	PIPELINE_STAGE_COMMAND_PROCESS_BIT_NVX
ACCESS_CONDITIONAL_RENDERING_READ_BIT_EXT	PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT
ACCESS_SHADING_RATE_IMAGE_READ_BIT_NV	PIPELINE_STAGE_SHADING_RATE_IMAGE_BIT_NV

If a memory object does not have the MEMORY_PROPERTY_HOST_COHERENT_BIT property, then FlushMappedMemoryRanges must be called in order to guarantee that writes to the memory object from the host are made available to the host domain, where they can be further made available to the device domain via a domain operation. Similarly, InvalidateMappedMemoryRanges must be called to guarantee that writes which are available to the host domain are made visible to host operations.

If the memory object does have the MEMORY_PROPERTY_HOST_COHERENT_BIT property flag, writes to the memory object from the host are automatically made available to the host domain. Similarly, writes made available to the host domain are automatically made visible to the host.

Note

The QueueSubmit command automatically performs a domain operation from host to device for all writes performed before the command executes, so in most cases an explicit memory barrier is not needed for this case. In the few circumstances where a submit does not occur between the host write and the device read access, writes can be made available by using an explicit memory barrier.

See Also

VkAccessFlags

VK_DEPENDENCY_BY_REGION_BIT

VkDependencyFlagBits - Bitmask specifying how execution and memory dependencies are formed

Description

• DEPENDENCY_BY_REGION_BIT specifies that dependencies will be framebuffer-local.
• DEPENDENCY_VIEW_LOCAL_BIT specifies that a subpass has more than one view.
• DEPENDENCY_DEVICE_GROUP_BIT specifies that dependencies are non-device-local dependency.

See Also

VkDependencyFlags

VK_COMMAND_POOL_CREATE_TRANSIENT_BIT, VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT

VkCommandPoolCreateFlagBits - Bitmask specifying usage behavior for a command pool

Description

• COMMAND_POOL_CREATE_TRANSIENT_BIT specifies that command buffers allocated from the pool will be short-lived, meaning that they will be reset or freed in a relatively short timeframe. This flag may be used by the implementation to control memory allocation behavior within the pool.
• COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT allows any command buffer allocated from a pool to be individually reset to the initial state; either by calling ResetCommandBuffer, or via the implicit reset when calling BeginCommandBuffer. If this flag is not set on a pool, then ResetCommandBuffer must not be called for any command buffer allocated from that pool.
• COMMAND_POOL_CREATE_PROTECTED_BIT specifies that command buffers allocated from the pool are protected command buffers. If the protected memory feature is not enabled, the COMMAND_POOL_CREATE_PROTECTED_BIT bit of flags must not be set.

See Also

VkCommandPoolCreateFlags

VK_COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT

VkCommandPoolResetFlagBits - Bitmask controlling behavior of a command pool reset

Description

• COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT specifies that resetting a command pool recycles all of the resources from the command pool back to the system.

See Also

VkCommandPoolResetFlags

VK_COMMAND_BUFFER_LEVEL_PRIMARY, VK_COMMAND_BUFFER_LEVEL_SECONDARY

VkCommandBufferLevel - Enumerant specifying a command buffer level

Description

• COMMAND_BUFFER_LEVEL_PRIMARY specifies a primary command buffer.
• COMMAND_BUFFER_LEVEL_SECONDARY specifies a secondary command buffer.

See Also

VkCommandBufferAllocateInfo

VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT, VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT

VkCommandBufferUsageFlagBits - Bitmask specifying usage behavior for command buffer

Description

• COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT specifies that each recording of the command buffer will only be submitted once, and the command buffer will be reset and recorded again between each submission.
• COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT specifies that a secondary command buffer is considered to be entirely inside a render pass. If this is a primary command buffer, then this bit is ignored.
• COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT specifies that a command buffer can be resubmitted to a queue while it is in the pending state, and recorded into multiple primary command buffers.

See Also

VkCommandBufferUsageFlags

VK_QUERY_CONTROL_PRECISE_BIT

VkQueryControlFlagBits - Bitmask specifying constraints on a query

Description

• QUERY_CONTROL_PRECISE_BIT specifies the precision of occlusion queries.

See Also

VkQueryControlFlags

VK_COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT

VkCommandBufferResetFlagBits - Bitmask controlling behavior of a command buffer reset

Description

• COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT specifies that most or all memory resources currently owned by the command buffer should be returned to the parent command pool. If this flag is not set, then the command buffer may hold onto memory resources and reuse them when recording commands. commandBuffer is moved to the initial state.

See Also

VkCommandBufferResetFlags

VK_STENCIL_FACE_FRONT_BIT, VK_STENCIL_FACE_BACK_BIT, VK_STENCIL_FRONT_AND_BACK

VkStencilFaceFlagBits - Bitmask specifying sets of stencil state for which to update the compare mask

Description

• STENCIL_FACE_FRONT_BIT specifies that only the front set of stencil state is updated.
• STENCIL_FACE_BACK_BIT specifies that only the back set of stencil state is updated.
• STENCIL_FRONT_AND_BACK is the combination of STENCIL_FACE_FRONT_BIT and STENCIL_FACE_BACK_BIT, and specifies that both sets of stencil state are updated.

See Also

VkStencilFaceFlags

VK_INDEX_TYPE_UINT16, VK_INDEX_TYPE_UINT32

VkIndexType - Type of index buffer indices

Description

• INDEX_TYPE_UINT16 specifies that indices are 16-bit unsigned integer values.
• INDEX_TYPE_UINT32 specifies that indices are 32-bit unsigned integer values.

See Also

VkGeometryTrianglesNVX, VkObjectTableIndexBufferEntryNVX, CmdBindIndexBuffer

VK_SUBPASS_CONTENTS_INLINE, VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS

VkSubpassContents - Specify how commands in the first subpass of a render pass are provided

Description

• SUBPASS_CONTENTS_INLINE specifies that the contents of the subpass will be recorded inline in the primary command buffer, and secondary command buffers must not be executed within the subpass.
• SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS specifies that the contents are recorded in secondary command buffers that will be called from the primary command buffer, and CmdExecuteCommands is the only valid command on the command buffer until CmdNextSubpass or CmdEndRenderPass.

See Also

VkSubpassBeginInfoKHR, CmdBeginRenderPass, CmdNextSubpass

VK_OBJECT_TYPE_UNKNOWN, VK_OBJECT_TYPE_INSTANCE, VK_OBJECT_TYPE_PHYSICAL_DEVICE, VK_OBJECT_TYPE_DEVICE, VK_OBJECT_TYPE_QUEUE, VK_OBJECT_TYPE_SEMAPHORE, VK_OBJECT_TYPE_COMMAND_BUFFER, VK_OBJECT_TYPE_FENCE, VK_OBJECT_TYPE_DEVICE_MEMORY, VK_OBJECT_TYPE_BUFFER, VK_OBJECT_TYPE_IMAGE, VK_OBJECT_TYPE_EVENT, VK_OBJECT_TYPE_QUERY_POOL, VK_OBJECT_TYPE_BUFFER_VIEW, VK_OBJECT_TYPE_IMAGE_VIEW, VK_OBJECT_TYPE_SHADER_MODULE, VK_OBJECT_TYPE_PIPELINE_CACHE, VK_OBJECT_TYPE_PIPELINE_LAYOUT, VK_OBJECT_TYPE_RENDER_PASS, VK_OBJECT_TYPE_PIPELINE, VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT, VK_OBJECT_TYPE_SAMPLER, VK_OBJECT_TYPE_DESCRIPTOR_POOL, VK_OBJECT_TYPE_DESCRIPTOR_SET, VK_OBJECT_TYPE_FRAMEBUFFER, VK_OBJECT_TYPE_COMMAND_POOL

VkObjectType - Specify an enumeration to track object handle types

Description

VkObjectType and Vulkan Handle Relationship

VkObjectType	Vulkan Handle Type
OBJECT_TYPE_UNKNOWN	Unknown/Undefined Handle
OBJECT_TYPE_INSTANCE	VkInstance
OBJECT_TYPE_PHYSICAL_DEVICE	VkPhysicalDevice
OBJECT_TYPE_DEVICE	VkDevice
OBJECT_TYPE_QUEUE	VkQueue
OBJECT_TYPE_SEMAPHORE	VkSemaphore
OBJECT_TYPE_COMMAND_BUFFER	VkCommandBuffer
OBJECT_TYPE_FENCE	VkFence
OBJECT_TYPE_DEVICE_MEMORY	VkDeviceMemory
OBJECT_TYPE_BUFFER	VkBuffer
OBJECT_TYPE_IMAGE	VkImage
OBJECT_TYPE_EVENT	VkEvent
OBJECT_TYPE_QUERY_POOL	VkQueryPool
OBJECT_TYPE_BUFFER_VIEW	VkBufferView
OBJECT_TYPE_IMAGE_VIEW	VkImageView
OBJECT_TYPE_SHADER_MODULE	VkShaderModule
OBJECT_TYPE_PIPELINE_CACHE	VkPipelineCache
OBJECT_TYPE_PIPELINE_LAYOUT	VkPipelineLayout
OBJECT_TYPE_RENDER_PASS	VkRenderPass
OBJECT_TYPE_PIPELINE	VkPipeline
OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT	VkDescriptorSetLayout
OBJECT_TYPE_SAMPLER	VkSampler
OBJECT_TYPE_DESCRIPTOR_POOL	VkDescriptorPool
OBJECT_TYPE_DESCRIPTOR_SET	VkDescriptorSet
OBJECT_TYPE_FRAMEBUFFER	VkFramebuffer
OBJECT_TYPE_COMMAND_POOL	VkCommandPool
OBJECT_TYPE_SURFACE_KHR	VkSurfaceKHR
OBJECT_TYPE_SWAPCHAIN_KHR	VkSwapchainKHR
OBJECT_TYPE_DISPLAY_KHR	VkDisplayKHR
OBJECT_TYPE_DISPLAY_MODE_KHR	VkDisplayModeKHR
OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT	VkDebugReportCallbackEXT
OBJECT_TYPE_DESCRIPTOR_UPDATE_TEMPLATE	VkDescriptorUpdateTemplate
OBJECT_TYPE_OBJECT_TABLE_NVX	VkObjectTableNVX
OBJECT_TYPE_INDIRECT_COMMANDS_LAYOUT_NVX	VkIndirectCommandsLayoutNVX
OBJECT_TYPE_VALIDATION_CACHE_EXT	VkValidationCacheEXT

See Also

VkDebugUtilsObjectNameInfoEXT, VkDebugUtilsObjectTagInfoEXT

VK_VENDOR_ID_VIV, VK_VENDOR_ID_VSI, VK_VENDOR_ID_KAZAN

VkVendorId - Khronos vendor IDs

Description

Note

Khronos vendor IDs may be allocated by vendors at any time. Only the latest canonical versions of this Specification, of the corresponding vk.xml API Registry, and of the corresponding vulkan_core.h header file must contain all reserved Khronos vendor IDs.

Only Khronos vendor IDs are given symbolic names at present. PCI vendor IDs returned by the implementation can be looked up in the PCI-SIG database.

See Also

No cross-references are available

Enum values:

• VENDOR_ID_VIV
• VENDOR_ID_VSI
• VENDOR_ID_KAZAN

VK_API_VERSION_1_0

The API version number for Vulkan 1.0.

The patch version number in this macro will always be zero. The supported patch version for a physical device can be queried with GetPhysicalDeviceProperties.

VK_HEADER_VERSION

The Vulkan registry version used to generate the LWJGL bindings.

VK_NULL_HANDLE

The reserved handle VK_NULL_HANDLE can be passed in place of valid object handles when explicitly called out in the specification. Any command that creates an object successfully must not return VK_NULL_HANDLE. It is valid to pass VK_NULL_HANDLE to any vkDestroy* or vkFree* command, which will silently ignore these values.

VK_MAX_PHYSICAL_DEVICE_NAME_SIZE, VK_UUID_SIZE, VK_MAX_EXTENSION_NAME_SIZE, VK_MAX_DESCRIPTION_SIZE, VK_MAX_MEMORY_TYPES, VK_MAX_MEMORY_HEAPS, VK_REMAINING_MIP_LEVELS, VK_REMAINING_ARRAY_LAYERS, VK_ATTACHMENT_UNUSED, VK_TRUE, VK_FALSE, VK_QUEUE_FAMILY_IGNORED, VK_SUBPASS_EXTERNAL, VK_LOD_CLAMP_NONE, VK_WHOLE_SIZE

API Constants

Method Detail

nvkCreateInstance

public static int nvkCreateInstance(long pCreateInfo,
                                    long pAllocator,
                                    long pInstance)

Unsafe version of: CreateInstance

vkCreateInstance

public static int vkCreateInstance(VkInstanceCreateInfo pCreateInfo,
                                   @Nullable
                                   VkAllocationCallbacks pAllocator,
                                   PointerBuffer pInstance)

Create a new Vulkan instance.

C Specification

To create an instance object, call:

 VkResult vkCreateInstance(
     const VkInstanceCreateInfo*                 pCreateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkInstance*                                 pInstance);

Description

CreateInstance verifies that the requested layers exist. If not, CreateInstance will return ERROR_LAYER_NOT_PRESENT. Next CreateInstance verifies that the requested extensions are supported (e.g. in the implementation or in any enabled instance layer) and if any requested extension is not supported, CreateInstance must return ERROR_EXTENSION_NOT_PRESENT. After verifying and enabling the instance layers and extensions the VkInstance object is created and returned to the application. If a requested extension is only supported by a layer, both the layer and the extension need to be specified at CreateInstance time for the creation to succeed.

Valid Usage

• All required extensions for each extension in the VkInstanceCreateInfo::ppEnabledExtensionNames list must also be present in that list.

Valid Usage (Implicit)

• pCreateInfo must be a valid pointer to a valid VkInstanceCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pInstance must be a valid pointer to a VkInstance handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED
• ERROR_LAYER_NOT_PRESENT
• ERROR_EXTENSION_NOT_PRESENT
• ERROR_INCOMPATIBLE_DRIVER

See Also

VkAllocationCallbacks, VkInstanceCreateInfo

Parameters:

pCreateInfo - points to an instance of VkInstanceCreateInfo controlling creation of the instance.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pInstance - points a VkInstance handle in which the resulting instance is returned.

nvkDestroyInstance

public static void nvkDestroyInstance(VkInstance instance,
                                      long pAllocator)

Unsafe version of: DestroyInstance

vkDestroyInstance

public static void vkDestroyInstance(VkInstance instance,
                                     @Nullable
                                     VkAllocationCallbacks pAllocator)

Destroy an instance of Vulkan.

C Specification

To destroy an instance, call:

 void vkDestroyInstance(
     VkInstance                                  instance,
     const VkAllocationCallbacks*                pAllocator);

Valid Usage

• All child objects created using instance must have been destroyed prior to destroying instance
• If VkAllocationCallbacks were provided when instance was created, a compatible set of callbacks must be provided here
• If no VkAllocationCallbacks were provided when instance was created, pAllocator must be NULL

Valid Usage (Implicit)

• If instance is not NULL, instance must be a valid VkInstance handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

Host Synchronization

• Host access to instance must be externally synchronized

See Also

VkAllocationCallbacks

Parameters:

instance - the handle of the instance to destroy.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

nvkEnumeratePhysicalDevices

public static int nvkEnumeratePhysicalDevices(VkInstance instance,
                                              long pPhysicalDeviceCount,
                                              long pPhysicalDevices)

Unsafe version of: EnumeratePhysicalDevices

Parameters:

pPhysicalDeviceCount - a pointer to an integer related to the number of physical devices available or queried, as described below.

vkEnumeratePhysicalDevices

public static int vkEnumeratePhysicalDevices(VkInstance instance,
                                             java.nio.IntBuffer pPhysicalDeviceCount,
                                             @Nullable
                                             PointerBuffer pPhysicalDevices)

Enumerates the physical devices accessible to a Vulkan instance.

C Specification

To retrieve a list of physical device objects representing the physical devices installed in the system, call:

 VkResult vkEnumeratePhysicalDevices(
     VkInstance                                  instance,
     uint32_t*                                   pPhysicalDeviceCount,
     VkPhysicalDevice*                           pPhysicalDevices);

Description

If pPhysicalDevices is NULL, then the number of physical devices available is returned in pPhysicalDeviceCount. Otherwise, pPhysicalDeviceCount must point to a variable set by the user to the number of elements in the pPhysicalDevices array, and on return the variable is overwritten with the number of handles actually written to pPhysicalDevices. If pPhysicalDeviceCount is less than the number of physical devices available, at most pPhysicalDeviceCount structures will be written. If pPhysicalDeviceCount is smaller than the number of physical devices available, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available physical devices were returned.

Valid Usage (Implicit)

• instance must be a valid VkInstance handle
• pPhysicalDeviceCount must be a valid pointer to a uint32_t value
• If the value referenced by pPhysicalDeviceCount is not 0, and pPhysicalDevices is not NULL, pPhysicalDevices must be a valid pointer to an array of pPhysicalDeviceCount VkPhysicalDevice handles

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED

Parameters:

instance - a handle to a Vulkan instance previously created with CreateInstance.

pPhysicalDeviceCount - a pointer to an integer related to the number of physical devices available or queried, as described below.

pPhysicalDevices - either NULL or a pointer to an array of VkPhysicalDevice handles.

nvkGetPhysicalDeviceFeatures

public static void nvkGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
                                                long pFeatures)

Unsafe version of: GetPhysicalDeviceFeatures

vkGetPhysicalDeviceFeatures

public static void vkGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice,
                                               VkPhysicalDeviceFeatures pFeatures)

Reports capabilities of a physical device.

C Specification

To query supported features, call:

 void vkGetPhysicalDeviceFeatures(
     VkPhysicalDevice                            physicalDevice,
     VkPhysicalDeviceFeatures*                   pFeatures);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pFeatures must be a valid pointer to a VkPhysicalDeviceFeatures structure

See Also

VkPhysicalDeviceFeatures

Parameters:

physicalDevice - the physical device from which to query the supported features.

pFeatures - a pointer to a VkPhysicalDeviceFeatures structure in which the physical device features are returned. For each feature, a value of TRUE specifies that the feature is supported on this physical device, and FALSE specifies that the feature is not supported.

nvkGetPhysicalDeviceFormatProperties

public static void nvkGetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
                                                        int format,
                                                        long pFormatProperties)

Unsafe version of: GetPhysicalDeviceFormatProperties

vkGetPhysicalDeviceFormatProperties

public static void vkGetPhysicalDeviceFormatProperties(VkPhysicalDevice physicalDevice,
                                                       int format,
                                                       VkFormatProperties pFormatProperties)

Lists physical device's format capabilities.

C Specification

To query supported format features which are properties of the physical device, call:

 void vkGetPhysicalDeviceFormatProperties(
     VkPhysicalDevice                            physicalDevice,
     VkFormat                                    format,
     VkFormatProperties*                         pFormatProperties);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• format must be a valid VkFormat value
• pFormatProperties must be a valid pointer to a VkFormatProperties structure

See Also

VkFormatProperties

Parameters:

physicalDevice - the physical device from which to query the format properties.

format - the format whose properties are queried.

pFormatProperties - a pointer to a VkFormatProperties structure in which physical device properties for format are returned.

nvkGetPhysicalDeviceImageFormatProperties

public static int nvkGetPhysicalDeviceImageFormatProperties(VkPhysicalDevice physicalDevice,
                                                            int format,
                                                            int type,
                                                            int tiling,
                                                            int usage,
                                                            int flags,
                                                            long pImageFormatProperties)

Unsafe version of: GetPhysicalDeviceImageFormatProperties

vkGetPhysicalDeviceImageFormatProperties

public static int vkGetPhysicalDeviceImageFormatProperties(VkPhysicalDevice physicalDevice,
                                                           int format,
                                                           int type,
                                                           int tiling,
                                                           int usage,
                                                           int flags,
                                                           VkImageFormatProperties pImageFormatProperties)

Lists physical device's image format capabilities.

C Specification

To query additional capabilities specific to image types, call:

 VkResult vkGetPhysicalDeviceImageFormatProperties(
     VkPhysicalDevice                            physicalDevice,
     VkFormat                                    format,
     VkImageType                                 type,
     VkImageTiling                               tiling,
     VkImageUsageFlags                           usage,
     VkImageCreateFlags                          flags,
     VkImageFormatProperties*                    pImageFormatProperties);

Description

The format, type, tiling, usage, and flags parameters correspond to parameters that would be consumed by CreateImage (as members of VkImageCreateInfo).

If format is not a supported image format, or if the combination of format, type, tiling, usage, and flags is not supported for images, then GetPhysicalDeviceImageFormatProperties returns ERROR_FORMAT_NOT_SUPPORTED.

The limitations on an image format that are reported by GetPhysicalDeviceImageFormatProperties have the following property: if usage1 and usage2 of type VkImageUsageFlags are such that the bits set in usage1 are a subset of the bits set in usage2, and flags1 and flags2 of type VkImageCreateFlags are such that the bits set in flags1 are a subset of the bits set in flags2, then the limitations for usage1 and flags1 must be no more strict than the limitations for usage2 and flags2, for all values of format, type, and tiling.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• format must be a valid VkFormat value
• type must be a valid VkImageType value
• tiling must be a valid VkImageTiling value
• usage must be a valid combination of VkImageUsageFlagBits values
• usage must not be 0
• flags must be a valid combination of VkImageCreateFlagBits values
• pImageFormatProperties must be a valid pointer to a VkImageFormatProperties structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_FORMAT_NOT_SUPPORTED

See Also

VkImageFormatProperties

Parameters:

physicalDevice - the physical device from which to query the image capabilities.

format - a VkFormat value specifying the image format, corresponding to VkImageCreateInfo::format.

type - a VkImageType value specifying the image type, corresponding to VkImageCreateInfo::imageType.

tiling - a VkImageTiling value specifying the image tiling, corresponding to VkImageCreateInfo::tiling.

usage - a bitmask of VkImageUsageFlagBits specifying the intended usage of the image, corresponding to VkImageCreateInfo::usage.

flags - a bitmask of VkImageCreateFlagBits specifying additional parameters of the image, corresponding to VkImageCreateInfo::flags.

pImageFormatProperties - points to an instance of the VkImageFormatProperties structure in which capabilities are returned.

nvkGetPhysicalDeviceProperties

public static void nvkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
                                                  long pProperties)

Unsafe version of: GetPhysicalDeviceProperties

vkGetPhysicalDeviceProperties

public static void vkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
                                                 VkPhysicalDeviceProperties pProperties)

Returns properties of a physical device.

C Specification

To query general properties of physical devices once enumerated, call:

 void vkGetPhysicalDeviceProperties(
     VkPhysicalDevice                            physicalDevice,
     VkPhysicalDeviceProperties*                 pProperties);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pProperties must be a valid pointer to a VkPhysicalDeviceProperties structure

See Also

VkPhysicalDeviceProperties

Parameters:

physicalDevice - the handle to the physical device whose properties will be queried.

pProperties - points to an instance of the VkPhysicalDeviceProperties structure, that will be filled with returned information.

nvkGetPhysicalDeviceQueueFamilyProperties

public static void nvkGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
                                                             long pQueueFamilyPropertyCount,
                                                             long pQueueFamilyProperties)

Unsafe version of: GetPhysicalDeviceQueueFamilyProperties

Parameters:

pQueueFamilyPropertyCount - a pointer to an integer related to the number of queue families available or queried, as described below.

vkGetPhysicalDeviceQueueFamilyProperties

public static void vkGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
                                                            java.nio.IntBuffer pQueueFamilyPropertyCount,
                                                            @Nullable
                                                            VkQueueFamilyProperties.Buffer pQueueFamilyProperties)

Reports properties of the queues of the specified physical device.

C Specification

To query properties of queues available on a physical device, call:

 void vkGetPhysicalDeviceQueueFamilyProperties(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pQueueFamilyPropertyCount,
     VkQueueFamilyProperties*                    pQueueFamilyProperties);

Description

If pQueueFamilyProperties is NULL, then the number of queue families available is returned in pQueueFamilyPropertyCount. Otherwise, pQueueFamilyPropertyCount must point to a variable set by the user to the number of elements in the pQueueFamilyProperties array, and on return the variable is overwritten with the number of structures actually written to pQueueFamilyProperties. If pQueueFamilyPropertyCount is less than the number of queue families available, at most pQueueFamilyPropertyCount structures will be written.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pQueueFamilyPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pQueueFamilyPropertyCount is not 0, and pQueueFamilyProperties is not NULL, pQueueFamilyProperties must be a valid pointer to an array of pQueueFamilyPropertyCount VkQueueFamilyProperties structures

See Also

VkQueueFamilyProperties

Parameters:

physicalDevice - the handle to the physical device whose properties will be queried.

pQueueFamilyPropertyCount - a pointer to an integer related to the number of queue families available or queried, as described below.

pQueueFamilyProperties - either NULL or a pointer to an array of VkQueueFamilyProperties structures.

nvkGetPhysicalDeviceMemoryProperties

public static void nvkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice,
                                                        long pMemoryProperties)

Unsafe version of: GetPhysicalDeviceMemoryProperties

vkGetPhysicalDeviceMemoryProperties

public static void vkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice,
                                                       VkPhysicalDeviceMemoryProperties pMemoryProperties)

Reports memory information for the specified physical device.

C Specification

To query memory properties, call:

 void vkGetPhysicalDeviceMemoryProperties(
     VkPhysicalDevice                            physicalDevice,
     VkPhysicalDeviceMemoryProperties*           pMemoryProperties);

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pMemoryProperties must be a valid pointer to a VkPhysicalDeviceMemoryProperties structure

See Also

VkPhysicalDeviceMemoryProperties

Parameters:

physicalDevice - the handle to the device to query.

pMemoryProperties - points to an instance of VkPhysicalDeviceMemoryProperties structure in which the properties are returned.

nvkGetInstanceProcAddr

public static long nvkGetInstanceProcAddr(VkInstance instance,
                                          long pName)

Unsafe version of: GetInstanceProcAddr

vkGetInstanceProcAddr

public static long vkGetInstanceProcAddr(VkInstance instance,
                                         java.nio.ByteBuffer pName)

public static long vkGetInstanceProcAddr(VkInstance instance,
                                         java.lang.CharSequence pName)

Return a function pointer for a command.

C Specification

Vulkan commands are not necessarily exposed statically on a platform. Function pointers for all Vulkan commands can be obtained with the command:

 PFN_vkVoidFunction vkGetInstanceProcAddr(
     VkInstance                                  instance,
     const char*                                 pName);

Description

GetInstanceProcAddr itself is obtained in a platform- and loader- specific manner. Typically, the loader library will export this command as a function symbol, so applications can link against the loader library, or load it dynamically and look up the symbol using platform-specific APIs.

The table below defines the various use cases for GetInstanceProcAddr and expected return value ("fp" is "function pointer") for each case.

The returned function pointer is of type PFN_vkVoidFunction, and must be cast to the type of the command being queried.

vkGetInstanceProcAddr behavior

instance	pName	return value
*	NULL	undefined
invalid instance	*	undefined
NULL	EnumerateInstanceVersion	fp
NULL	EnumerateInstanceExtensionProperties	fp
NULL	EnumerateInstanceLayerProperties	fp
NULL	CreateInstance	fp
NULL	* (any pName not covered above)	NULL
instance	core Vulkan command	fp1
instance	enabled instance extension commands for instance	fp1
instance	available device extension2 commands for instance	fp1
instance	* (any pName not covered above)	NULL

1

The returned function pointer must only be called with a dispatchable object (the first parameter) that is instance or a child of instance, e.g. VkInstance, VkPhysicalDevice, VkDevice, VkQueue, or VkCommandBuffer.

2

An “available device extension” is a device extension supported by any physical device enumerated by instance.

Valid Usage (Implicit)

• If instance is not NULL, instance must be a valid VkInstance handle
• pName must be a null-terminated UTF-8 string

See Also

PFN_vkVoidFunction

Parameters:

instance - the instance that the function pointer will be compatible with, or NULL for commands not dependent on any instance.

pName - the name of the command to obtain.

nvkGetDeviceProcAddr

public static long nvkGetDeviceProcAddr(VkDevice device,
                                        long pName)

Unsafe version of: GetDeviceProcAddr

vkGetDeviceProcAddr

public static long vkGetDeviceProcAddr(VkDevice device,
                                       java.nio.ByteBuffer pName)

public static long vkGetDeviceProcAddr(VkDevice device,
                                       java.lang.CharSequence pName)

Return a function pointer for a command.

C Specification

In order to support systems with multiple Vulkan implementations, the function pointers returned by GetInstanceProcAddr may point to dispatch code that calls a different real implementation for different VkDevice objects or their child objects. The overhead of the internal dispatch for VkDevice objects can be avoided by obtaining device-specific function pointers for any commands that use a device or device-child object as their dispatchable object. Such function pointers can be obtained with the command:

 PFN_vkVoidFunction vkGetDeviceProcAddr(
     VkDevice                                    device,
     const char*                                 pName);

Description

The returned function pointer is of type PFN_vkVoidFunction, and must be cast to the type of the command being queried. The function pointer must only be called with a dispatchable object (the first parameter) that is device or a child of device.

vkGetDeviceProcAddr behavior

device	pName	return value
NULL	*	undefined
invalid device	*	undefined
device	NULL	undefined
device	core device-level Vulkan command	fp
device	enabled device extension commands	fp
device	* (any pName not covered above)	NULL

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pName must be a null-terminated UTF-8 string

See Also

PFN_vkVoidFunction

nvkCreateDevice

public static int nvkCreateDevice(VkPhysicalDevice physicalDevice,
                                  long pCreateInfo,
                                  long pAllocator,
                                  long pDevice)

Unsafe version of: CreateDevice

vkCreateDevice

public static int vkCreateDevice(VkPhysicalDevice physicalDevice,
                                 VkDeviceCreateInfo pCreateInfo,
                                 @Nullable
                                 VkAllocationCallbacks pAllocator,
                                 PointerBuffer pDevice)

Create a new device instance.

C Specification

A logical device is created as a connection to a physical device. To create a logical device, call:

 VkResult vkCreateDevice(
     VkPhysicalDevice                            physicalDevice,
     const VkDeviceCreateInfo*                   pCreateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkDevice*                                   pDevice);

Description

CreateDevice verifies that extensions and features requested in the ppEnabledExtensionNames and pEnabledFeatures members of pCreateInfo, respectively, are supported by the implementation. If any requested extension is not supported, CreateDevice must return ERROR_EXTENSION_NOT_PRESENT. If any requested feature is not supported, CreateDevice must return ERROR_FEATURE_NOT_PRESENT. Support for extensions can be checked before creating a device by querying EnumerateDeviceExtensionProperties. Support for features can similarly be checked by querying GetPhysicalDeviceFeatures.

After verifying and enabling the extensions the VkDevice object is created and returned to the application. If a requested extension is only supported by a layer, both the layer and the extension need to be specified at CreateInstance time for the creation to succeed.

Multiple logical devices can be created from the same physical device. Logical device creation may fail due to lack of device-specific resources (in addition to the other errors). If that occurs, CreateDevice will return ERROR_TOO_MANY_OBJECTS.

Valid Usage

• All required extensions for each extension in the VkDeviceCreateInfo::ppEnabledExtensionNames list must also be present in that list.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pCreateInfo must be a valid pointer to a valid VkDeviceCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pDevice must be a valid pointer to a VkDevice handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_INITIALIZATION_FAILED
• ERROR_EXTENSION_NOT_PRESENT
• ERROR_FEATURE_NOT_PRESENT
• ERROR_TOO_MANY_OBJECTS
• ERROR_DEVICE_LOST

See Also

VkAllocationCallbacks, VkDeviceCreateInfo

Parameters:

physicalDevice - must be one of the device handles returned from a call to EnumeratePhysicalDevices (see Physical Device Enumeration).

pCreateInfo - a pointer to a VkDeviceCreateInfo structure containing information about how to create the device.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pDevice - points to a handle in which the created VkDevice is returned.

nvkDestroyDevice

public static void nvkDestroyDevice(VkDevice device,
                                    long pAllocator)

Unsafe version of: DestroyDevice

vkDestroyDevice

public static void vkDestroyDevice(VkDevice device,
                                   @Nullable
                                   VkAllocationCallbacks pAllocator)

Destroy a logical device.

C Specification

To destroy a device, call:

 void vkDestroyDevice(
     VkDevice                                    device,
     const VkAllocationCallbacks*                pAllocator);

Description

To ensure that no work is active on the device, DeviceWaitIdle can be used to gate the destruction of the device. Prior to destroying a device, an application is responsible for destroying/freeing any Vulkan objects that were created using that device as the first parameter of the corresponding ftext:vkCreate* or ftext:vkAllocate* command.

Note

The lifetime of each of these objects is bound by the lifetime of the VkDevice object. Therefore, to avoid resource leaks, it is critical that an application explicitly free all of these resources prior to calling DestroyDevice.

Valid Usage

• All child objects created on device must have been destroyed prior to destroying device
• If VkAllocationCallbacks were provided when device was created, a compatible set of callbacks must be provided here
• If no VkAllocationCallbacks were provided when device was created, pAllocator must be NULL

Valid Usage (Implicit)

• If device is not NULL, device must be a valid VkDevice handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure

Host Synchronization

• Host access to device must be externally synchronized

See Also

VkAllocationCallbacks

Parameters:

device - the logical device to destroy.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

nvkEnumerateInstanceExtensionProperties

public static int nvkEnumerateInstanceExtensionProperties(long pLayerName,
                                                          long pPropertyCount,
                                                          long pProperties)

Unsafe version of: EnumerateInstanceExtensionProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of extension properties available or queried, as described below.

vkEnumerateInstanceExtensionProperties

public static int vkEnumerateInstanceExtensionProperties(@Nullable
                                                         java.nio.ByteBuffer pLayerName,
                                                         java.nio.IntBuffer pPropertyCount,
                                                         @Nullable
                                                         VkExtensionProperties.Buffer pProperties)

public static int vkEnumerateInstanceExtensionProperties(@Nullable
                                                         java.lang.CharSequence pLayerName,
                                                         java.nio.IntBuffer pPropertyCount,
                                                         @Nullable
                                                         VkExtensionProperties.Buffer pProperties)

Returns up to requested number of global extension properties.

C Specification

To query the available instance extensions, call:

 VkResult vkEnumerateInstanceExtensionProperties(
     const char*                                 pLayerName,
     uint32_t*                                   pPropertyCount,
     VkExtensionProperties*                      pProperties);

Description

When pLayerName parameter is NULL, only extensions provided by the Vulkan implementation or by implicitly enabled layers are returned. When pLayerName is the name of a layer, the instance extensions provided by that layer are returned.

If pProperties is NULL, then the number of extensions properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of extension properties available, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of extensions available, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available properties were returned.

Because the list of available layers may change externally between calls to vkEnumerateInstanceExtensionProperties, two calls may retrieve different results if a pLayerName is available in one call but not in another. The extensions supported by a layer may also change between two calls, e.g. if the layer implementation is replaced by a different version between those calls.

Valid Usage (Implicit)

• If pLayerName is not NULL, pLayerName must be a null-terminated UTF-8 string
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkExtensionProperties structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_LAYER_NOT_PRESENT

See Also

VkExtensionProperties

Parameters:

pLayerName - either NULL or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.

pPropertyCount - a pointer to an integer related to the number of extension properties available or queried, as described below.

pProperties - either NULL or a pointer to an array of VkExtensionProperties structures.

nvkEnumerateDeviceExtensionProperties

public static int nvkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
                                                        long pLayerName,
                                                        long pPropertyCount,
                                                        long pProperties)

Unsafe version of: EnumerateDeviceExtensionProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of extension properties available or queried, and is treated in the same fashion as the EnumerateInstanceExtensionProperties::pPropertyCount parameter.

vkEnumerateDeviceExtensionProperties

public static int vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
                                                       @Nullable
                                                       java.nio.ByteBuffer pLayerName,
                                                       java.nio.IntBuffer pPropertyCount,
                                                       @Nullable
                                                       VkExtensionProperties.Buffer pProperties)

public static int vkEnumerateDeviceExtensionProperties(VkPhysicalDevice physicalDevice,
                                                       @Nullable
                                                       java.lang.CharSequence pLayerName,
                                                       java.nio.IntBuffer pPropertyCount,
                                                       @Nullable
                                                       VkExtensionProperties.Buffer pProperties)

Returns properties of available physical device extensions.

C Specification

To query the extensions available to a given physical device, call:

 VkResult vkEnumerateDeviceExtensionProperties(
     VkPhysicalDevice                            physicalDevice,
     const char*                                 pLayerName,
     uint32_t*                                   pPropertyCount,
     VkExtensionProperties*                      pProperties);

Description

When pLayerName parameter is NULL, only extensions provided by the Vulkan implementation or by implicitly enabled layers are returned. When pLayerName is the name of a layer, the device extensions provided by that layer are returned.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• If pLayerName is not NULL, pLayerName must be a null-terminated UTF-8 string
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkExtensionProperties structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_LAYER_NOT_PRESENT

See Also

VkExtensionProperties

Parameters:

physicalDevice - the physical device that will be queried.

pLayerName - either NULL or a pointer to a null-terminated UTF-8 string naming the layer to retrieve extensions from.

pPropertyCount - a pointer to an integer related to the number of extension properties available or queried, and is treated in the same fashion as the EnumerateInstanceExtensionProperties::pPropertyCount parameter.

pProperties - either NULL or a pointer to an array of VkExtensionProperties structures.

nvkEnumerateInstanceLayerProperties

public static int nvkEnumerateInstanceLayerProperties(long pPropertyCount,
                                                      long pProperties)

Unsafe version of: EnumerateInstanceLayerProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of layer properties available or queried, as described below.

vkEnumerateInstanceLayerProperties

public static int vkEnumerateInstanceLayerProperties(java.nio.IntBuffer pPropertyCount,
                                                     @Nullable
                                                     VkLayerProperties.Buffer pProperties)

Returns up to requested number of global layer properties.

C Specification

To query the available layers, call:

 VkResult vkEnumerateInstanceLayerProperties(
     uint32_t*                                   pPropertyCount,
     VkLayerProperties*                          pProperties);

Description

If pProperties is NULL, then the number of layer properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of layer properties available, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of layers available, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available layer properties were returned.

The list of available layers may change at any time due to actions outside of the Vulkan implementation, so two calls to EnumerateInstanceLayerProperties with the same parameters may return different results, or retrieve different pPropertyCount values or pProperties contents. Once an instance has been created, the layers enabled for that instance will continue to be enabled and valid for the lifetime of that instance, even if some of them become unavailable for future instances.

Valid Usage (Implicit)

• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkLayerProperties structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkLayerProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of layer properties available or queried, as described below.

pProperties - either NULL or a pointer to an array of VkLayerProperties structures.

nvkEnumerateDeviceLayerProperties

public static int nvkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
                                                    long pPropertyCount,
                                                    long pProperties)

Unsafe version of: EnumerateDeviceLayerProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of layer properties available or queried.

vkEnumerateDeviceLayerProperties

public static int vkEnumerateDeviceLayerProperties(VkPhysicalDevice physicalDevice,
                                                   java.nio.IntBuffer pPropertyCount,
                                                   @Nullable
                                                   VkLayerProperties.Buffer pProperties)

Returns properties of available physical device layers.

C Specification

To enumerate device layers, call:

 VkResult vkEnumerateDeviceLayerProperties(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pPropertyCount,
     VkLayerProperties*                          pProperties);

Description

If pProperties is NULL, then the number of layer properties available is returned in pPropertyCount. Otherwise, pPropertyCount must point to a variable set by the user to the number of elements in the pProperties array, and on return the variable is overwritten with the number of structures actually written to pProperties. If pPropertyCount is less than the number of layer properties available, at most pPropertyCount structures will be written. If pPropertyCount is smaller than the number of layers available, INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available layer properties were returned.

The list of layers enumerated by EnumerateDeviceLayerProperties must be exactly the sequence of layers enabled for the instance. The members of VkLayerProperties for each enumerated layer must be the same as the properties when the layer was enumerated by EnumerateInstanceLayerProperties.

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle
• pPropertyCount must be a valid pointer to a uint32_t value
• If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount VkLayerProperties structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkLayerProperties

Parameters:

pPropertyCount - a pointer to an integer related to the number of layer properties available or queried.

pProperties - either NULL or a pointer to an array of VkLayerProperties structures.

nvkGetDeviceQueue

public static void nvkGetDeviceQueue(VkDevice device,
                                     int queueFamilyIndex,
                                     int queueIndex,
                                     long pQueue)

Unsafe version of: GetDeviceQueue

vkGetDeviceQueue

public static void vkGetDeviceQueue(VkDevice device,
                                    int queueFamilyIndex,
                                    int queueIndex,
                                    PointerBuffer pQueue)

Get a queue handle from a device.

C Specification

To retrieve a handle to a VkQueue object, call:

 void vkGetDeviceQueue(
     VkDevice                                    device,
     uint32_t                                    queueFamilyIndex,
     uint32_t                                    queueIndex,
     VkQueue*                                    pQueue);

Description

GetDeviceQueue must only be used to get queues that were created with the flags parameter of VkDeviceQueueCreateInfo set to zero. To get queues that were created with a non-zero flags parameter use GetDeviceQueue2.

Valid Usage

• queueFamilyIndex must be one of the queue family indices specified when device was created, via the VkDeviceQueueCreateInfo structure
• queueIndex must be less than the number of queues created for the specified queue family index when device was created, via the queueCount member of the VkDeviceQueueCreateInfo structure
• VkDeviceQueueCreateInfo::flags must have been set to zero when device was created

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pQueue must be a valid pointer to a VkQueue handle

Parameters:

device - the logical device that owns the queue.

queueFamilyIndex - the index of the queue family to which the queue belongs.

queueIndex - the index within this queue family of the queue to retrieve.

pQueue - a pointer to a VkQueue object that will be filled with the handle for the requested queue.

nvkQueueSubmit

public static int nvkQueueSubmit(VkQueue queue,
                                 int submitCount,
                                 long pSubmits,
                                 long fence)

Unsafe version of: QueueSubmit

Parameters:

submitCount - the number of elements in the pSubmits array.

vkQueueSubmit

public static int vkQueueSubmit(VkQueue queue,
                                @Nullable
                                VkSubmitInfo.Buffer pSubmits,
                                long fence)

Submits a sequence of semaphores or command buffers to a queue.

C Specification

To submit command buffers to a queue, call:

 VkResult vkQueueSubmit(
     VkQueue                                     queue,
     uint32_t                                    submitCount,
     const VkSubmitInfo*                         pSubmits,
     VkFence                                     fence);

Description

Note

Submission can be a high overhead operation, and applications should attempt to batch work together into as few calls to QueueSubmit as possible.

QueueSubmit is a queue submission command, with each batch defined by an element of pSubmits as an instance of the VkSubmitInfo structure. Batches begin execution in the order they appear in pSubmits, but may complete out of order.

Fence and semaphore operations submitted with QueueSubmit have additional ordering constraints compared to other submission commands, with dependencies involving previous and subsequent queue operations. Information about these additional constraints can be found in the semaphore and fence sections of the synchronization chapter.

Details on the interaction of pWaitDstStageMask with synchronization are described in the semaphore wait operation section of the synchronization chapter.

The order that batches appear in pSubmits is used to determine submission order, and thus all the implicit ordering guarantees that respect it. Other than these implicit ordering guarantees and any explicit synchronization primitives, these batches may overlap or otherwise execute out of order.

If any command buffer submitted to this queue is in the executable state, it is moved to the pending state. Once execution of all submissions of a command buffer complete, it moves from the pending state, back to the executable state. If a command buffer was recorded with the COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag, it instead moves back to the invalid state.

If QueueSubmit fails, it may return ERROR_OUT_OF_HOST_MEMORY or ERROR_OUT_OF_DEVICE_MEMORY. If it does, the implementation must ensure that the state and contents of any resources or synchronization primitives referenced by the submitted command buffers and any semaphores referenced by pSubmits is unaffected by the call or its failure. If QueueSubmit fails in such a way that the implementation is unable to make that guarantee, the implementation must return ERROR_DEVICE_LOST. See Lost Device.

Valid Usage

• If fence is not NULL_HANDLE, fence must be unsignaled
• If fence is not NULL_HANDLE, fence must not be associated with any other queue command that has not yet completed execution on that queue
• Any calls to CmdSetEvent, CmdResetEvent or CmdWaitEvents that have been recorded into any of the command buffer elements of the pCommandBuffers member of any element of pSubmits, must not reference any VkEvent that is referenced by any of those commands in a command buffer that has been submitted to another queue and is still in the pending state.
• Any stage flag included in any element of the pWaitDstStageMask member of any element of pSubmits must be a pipeline stage supported by one of the capabilities of queue, as specified in the table of supported pipeline stages.
• Each element of the pSignalSemaphores member of any element of pSubmits must be unsignaled when the semaphore signal operation it defines is executed on the device
• When a semaphore unsignal operation defined by any element of the pWaitSemaphores member of any element of pSubmits executes on queue, no other queue must be waiting on the same semaphore.
• All elements of the pWaitSemaphores member of all elements of pSubmits must be semaphores that are signaled, or have semaphore signal operations previously submitted for execution.
• Each element of the pCommandBuffers member of each element of pSubmits must be in the pending or executable state.
• If any element of the pCommandBuffers member of any element of pSubmits was not recorded with the COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must not be in the pending state.
• Any secondary command buffers recorded into any element of the pCommandBuffers member of any element of pSubmits must be in the pending or executable state.
• If any secondary command buffers recorded into any element of the pCommandBuffers member of any element of pSubmits was not recorded with the COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must not be in the pending state.
• Each element of the pCommandBuffers member of each element of pSubmits must have been allocated from a VkCommandPool that was created for the same queue family queue belongs to.
• If any element of pSubmits→pCommandBuffers includes a Queue Family Transfer Acquire Operation, there must exist a previously submitted Queue Family Transfer Release Operation on a queue in the queue family identified by the acquire operation, with parameters matching the acquire operation as defined in the definition of such acquire operations, and which happens before the acquire operation.

Valid Usage (Implicit)

• queue must be a valid VkQueue handle
• If submitCount is not 0, pSubmits must be a valid pointer to an array of submitCount valid VkSubmitInfo structures
• If fence is not NULL_HANDLE, fence must be a valid VkFence handle
• Both of fence, and queue that are valid handles must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

• Host access to queue must be externally synchronized
• Host access to pSubmits[].pWaitSemaphores[] must be externally synchronized
• Host access to pSubmits[].pSignalSemaphores[] must be externally synchronized
• Host access to fence must be externally synchronized

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
-	-	Any	-

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

VkSubmitInfo

Parameters:

queue - the queue that the command buffers will be submitted to.

pSubmits - a pointer to an array of VkSubmitInfo structures, each specifying a command buffer submission batch.

fence - an optional: handle to a fence to be signaled once all submitted command buffers have completed execution. If fence is not NULL_HANDLE, it defines a fence signal operation.

vkQueueSubmit

public static int vkQueueSubmit(VkQueue queue,
                                VkSubmitInfo pSubmit,
                                long fence)

Submits a sequence of semaphores or command buffers to a queue.

C Specification

To submit command buffers to a queue, call:

 VkResult vkQueueSubmit(
     VkQueue                                     queue,
     uint32_t                                    submitCount,
     const VkSubmitInfo*                         pSubmits,
     VkFence                                     fence);

Description

Note

Submission can be a high overhead operation, and applications should attempt to batch work together into as few calls to QueueSubmit as possible.

QueueSubmit is a queue submission command, with each batch defined by an element of pSubmits as an instance of the VkSubmitInfo structure. Batches begin execution in the order they appear in pSubmits, but may complete out of order.

Fence and semaphore operations submitted with QueueSubmit have additional ordering constraints compared to other submission commands, with dependencies involving previous and subsequent queue operations. Information about these additional constraints can be found in the semaphore and fence sections of the synchronization chapter.

Details on the interaction of pWaitDstStageMask with synchronization are described in the semaphore wait operation section of the synchronization chapter.

The order that batches appear in pSubmits is used to determine submission order, and thus all the implicit ordering guarantees that respect it. Other than these implicit ordering guarantees and any explicit synchronization primitives, these batches may overlap or otherwise execute out of order.

If any command buffer submitted to this queue is in the executable state, it is moved to the pending state. Once execution of all submissions of a command buffer complete, it moves from the pending state, back to the executable state. If a command buffer was recorded with the COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT flag, it instead moves back to the invalid state.

If QueueSubmit fails, it may return ERROR_OUT_OF_HOST_MEMORY or ERROR_OUT_OF_DEVICE_MEMORY. If it does, the implementation must ensure that the state and contents of any resources or synchronization primitives referenced by the submitted command buffers and any semaphores referenced by pSubmits is unaffected by the call or its failure. If QueueSubmit fails in such a way that the implementation is unable to make that guarantee, the implementation must return ERROR_DEVICE_LOST. See Lost Device.

Valid Usage

• If fence is not NULL_HANDLE, fence must be unsignaled
• If fence is not NULL_HANDLE, fence must not be associated with any other queue command that has not yet completed execution on that queue
• Any calls to CmdSetEvent, CmdResetEvent or CmdWaitEvents that have been recorded into any of the command buffer elements of the pCommandBuffers member of any element of pSubmits, must not reference any VkEvent that is referenced by any of those commands in a command buffer that has been submitted to another queue and is still in the pending state.
• Any stage flag included in any element of the pWaitDstStageMask member of any element of pSubmits must be a pipeline stage supported by one of the capabilities of queue, as specified in the table of supported pipeline stages.
• Each element of the pSignalSemaphores member of any element of pSubmits must be unsignaled when the semaphore signal operation it defines is executed on the device
• When a semaphore unsignal operation defined by any element of the pWaitSemaphores member of any element of pSubmits executes on queue, no other queue must be waiting on the same semaphore.
• All elements of the pWaitSemaphores member of all elements of pSubmits must be semaphores that are signaled, or have semaphore signal operations previously submitted for execution.
• Each element of the pCommandBuffers member of each element of pSubmits must be in the pending or executable state.
• If any element of the pCommandBuffers member of any element of pSubmits was not recorded with the COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must not be in the pending state.
• Any secondary command buffers recorded into any element of the pCommandBuffers member of any element of pSubmits must be in the pending or executable state.
• If any secondary command buffers recorded into any element of the pCommandBuffers member of any element of pSubmits was not recorded with the COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT, it must not be in the pending state.
• Each element of the pCommandBuffers member of each element of pSubmits must have been allocated from a VkCommandPool that was created for the same queue family queue belongs to.
• If any element of pSubmits→pCommandBuffers includes a Queue Family Transfer Acquire Operation, there must exist a previously submitted Queue Family Transfer Release Operation on a queue in the queue family identified by the acquire operation, with parameters matching the acquire operation as defined in the definition of such acquire operations, and which happens before the acquire operation.

Valid Usage (Implicit)

• queue must be a valid VkQueue handle
• If submitCount is not 0, pSubmits must be a valid pointer to an array of submitCount valid VkSubmitInfo structures
• If fence is not NULL_HANDLE, fence must be a valid VkFence handle
• Both of fence, and queue that are valid handles must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

• Host access to queue must be externally synchronized
• Host access to pSubmits[].pWaitSemaphores[] must be externally synchronized
• Host access to pSubmits[].pSignalSemaphores[] must be externally synchronized
• Host access to fence must be externally synchronized

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
-	-	Any	-

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

See Also

VkSubmitInfo

Parameters:

queue - the queue that the command buffers will be submitted to.

fence - an optional: handle to a fence to be signaled once all submitted command buffers have completed execution. If fence is not NULL_HANDLE, it defines a fence signal operation.

vkQueueWaitIdle

public static int vkQueueWaitIdle(VkQueue queue)

Wait for a queue to become idle.

C Specification

To wait on the host for the completion of outstanding queue operations for a given queue, call:

 VkResult vkQueueWaitIdle(
     VkQueue                                     queue);

Description

QueueWaitIdle is equivalent to submitting a fence to a queue and waiting with an infinite timeout for that fence to signal.

Valid Usage (Implicit)

• queue must be a valid VkQueue handle

Command Properties

Command Buffer Levels	Render Pass Scope	Supported Queue Types	Pipeline Type
-	-	Any	-

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

Parameters:

queue - the queue on which to wait.

vkDeviceWaitIdle

public static int vkDeviceWaitIdle(VkDevice device)

Wait for a device to become idle.

C Specification

To wait on the host for the completion of outstanding queue operations for all queues on a given logical device, call:

 VkResult vkDeviceWaitIdle(
     VkDevice                                    device);

Description

DeviceWaitIdle is equivalent to calling QueueWaitIdle for all queues owned by device.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

Host Synchronization

• Host access to all VkQueue objects created from device must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST

Parameters:

device - the logical device to idle.

nvkAllocateMemory

public static int nvkAllocateMemory(VkDevice device,
                                    long pAllocateInfo,
                                    long pAllocator,
                                    long pMemory)

Unsafe version of: AllocateMemory

vkAllocateMemory

public static int vkAllocateMemory(VkDevice device,
                                   VkMemoryAllocateInfo pAllocateInfo,
                                   @Nullable
                                   VkAllocationCallbacks pAllocator,
                                   java.nio.LongBuffer pMemory)

Allocate device memory.

C Specification

To allocate memory objects, call:

 VkResult vkAllocateMemory(
     VkDevice                                    device,
     const VkMemoryAllocateInfo*                 pAllocateInfo,
     const VkAllocationCallbacks*                pAllocator,
     VkDeviceMemory*                             pMemory);

Description

Allocations returned by AllocateMemory are guaranteed to meet any alignment requirement of the implementation. For example, if an implementation requires 128 byte alignment for images and 64 byte alignment for buffers, the device memory returned through this mechanism would be 128-byte aligned. This ensures that applications can correctly suballocate objects of different types (with potentially different alignment requirements) in the same memory object.

When memory is allocated, its contents are undefined with the following constraint:

• The contents of unprotected memory must not be a function of data protected memory objects, even if those memory objects were previously freed.

Note

The contents of memory allocated by one application should not be a function of data from protected memory objects of another application, even if those memory objects were previously freed.

The maximum number of valid memory allocations that can exist simultaneously within a VkDevice may be restricted by implementation- or platform-dependent limits. If a call to AllocateMemory would cause the total number of allocations to exceed these limits, such a call will fail and must return ERROR_TOO_MANY_OBJECTS. The maxMemoryAllocationCount feature describes the number of allocations that can exist simultaneously before encountering these internal limits.

Some platforms may have a limit on the maximum size of a single allocation. For example, certain systems may fail to create allocations with a size greater than or equal to 4GB. Such a limit is implementation-dependent, and if such a failure occurs then the error ERROR_OUT_OF_DEVICE_MEMORY must be returned. This limit is advertised in VkPhysicalDeviceMaintenance3Properties::maxMemoryAllocationSize.

Valid Usage

• pAllocateInfo->allocationSize must be less than or equal to sVkPhysicalDeviceMemoryProperties::memoryHeaps[pAllocateInfo->memoryTypeIndex].size as returned by GetPhysicalDeviceMemoryProperties for the VkPhysicalDevice that device was created from.
• pAllocateInfo->memoryTypeIndex must be less than VkPhysicalDeviceMemoryProperties::memoryTypeCount as returned by GetPhysicalDeviceMemoryProperties for the VkPhysicalDevice that device was created from.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pAllocateInfo must be a valid pointer to a valid VkMemoryAllocateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pMemory must be a valid pointer to a VkDeviceMemory handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_TOO_MANY_OBJECTS
• ERROR_INVALID_EXTERNAL_HANDLE

See Also

VkAllocationCallbacks, VkMemoryAllocateInfo

Parameters:

device - the logical device that owns the memory.

pAllocateInfo - a pointer to an instance of the VkMemoryAllocateInfo structure describing parameters of the allocation. A successful returned allocation must use the requested parameters — no substitution is permitted by the implementation.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pMemory - a pointer to a VkDeviceMemory handle in which information about the allocated memory is returned.

nvkFreeMemory

public static void nvkFreeMemory(VkDevice device,
                                 long memory,
                                 long pAllocator)

Unsafe version of: FreeMemory

vkFreeMemory

public static void vkFreeMemory(VkDevice device,
                                long memory,
                                @Nullable
                                VkAllocationCallbacks pAllocator)

Free device memory.

C Specification

To free a memory object, call:

 void vkFreeMemory(
     VkDevice                                    device,
     VkDeviceMemory                              memory,
     const VkAllocationCallbacks*                pAllocator);

Description

Before freeing a memory object, an application must ensure the memory object is no longer in use by the device--for example by command buffers in the pending state. The memory can remain bound to images or buffers at the time the memory object is freed, but any further use of them (on host or device) for anything other than destroying those objects will result in undefined behavior. If there are still any bound images or buffers, the memory may not be immediately released by the implementation, but must be released by the time all bound images and buffers have been destroyed. Once memory is released, it is returned to the heap from which it was allocated.

How memory objects are bound to Images and Buffers is described in detail in the Resource Memory Association section.

If a memory object is mapped at the time it is freed, it is implicitly unmapped.

Note

As described below, host writes are not implicitly flushed when the memory object is unmapped, but the implementation must guarantee that writes that have not been flushed do not affect any other memory.

Valid Usage

• All submitted commands that refer to memory (via images or buffers) must have completed execution

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• If memory is not NULL_HANDLE, memory must be a valid VkDeviceMemory handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• If memory is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to memory must be externally synchronized

See Also

VkAllocationCallbacks

Parameters:

device - the logical device that owns the memory.

memory - the VkDeviceMemory object to be freed.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

nvkMapMemory

public static int nvkMapMemory(VkDevice device,
                               long memory,
                               long offset,
                               long size,
                               int flags,
                               long ppData)

Unsafe version of: MapMemory

vkMapMemory

public static int vkMapMemory(VkDevice device,
                              long memory,
                              long offset,
                              long size,
                              int flags,
                              PointerBuffer ppData)

Map a memory object into application address space.

C Specification

To retrieve a host virtual address pointer to a region of a mappable memory object, call:

 VkResult vkMapMemory(
     VkDevice                                    device,
     VkDeviceMemory                              memory,
     VkDeviceSize                                offset,
     VkDeviceSize                                size,
     VkMemoryMapFlags                            flags,
     void**                                      ppData);

Description

It is an application error to call MapMemory on a memory object that is already mapped.

Note

MapMemory will fail if the implementation is unable to allocate an appropriately sized contiguous virtual address range, e.g. due to virtual address space fragmentation or platform limits. In such cases, MapMemory must return ERROR_MEMORY_MAP_FAILED. The application can improve the likelihood of success by reducing the size of the mapped range and/or removing unneeded mappings using fname:VkUnmapMemory.

MapMemory does not check whether the device memory is currently in use before returning the host-accessible pointer. The application must guarantee that any previously submitted command that writes to this range has completed before the host reads from or writes to that range, and that any previously submitted command that reads from that range has completed before the host writes to that region (see here for details on fulfilling such a guarantee). If the device memory was allocated without the MEMORY_PROPERTY_HOST_COHERENT_BIT set, these guarantees must be made for an extended range: the application must round down the start of the range to the nearest multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize, and round the end of the range up to the nearest multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize.

While a range of device memory is mapped for host access, the application is responsible for synchronizing both device and host access to that memory range.

Note

It is important for the application developer to become meticulously familiar with all of the mechanisms described in the chapter on Synchronization and Cache Control as they are crucial to maintaining memory access ordering.

Valid Usage

• memory must not be currently mapped
• offset must be less than the size of memory
• If size is not equal to WHOLE_SIZE, size must be greater than 0
• If size is not equal to WHOLE_SIZE, size must be less than or equal to the size of the memory minus offset
• memory must have been created with a memory type that reports MEMORY_PROPERTY_HOST_VISIBLE_BIT
• memory must not have been allocated with multiple instances.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• memory must be a valid VkDeviceMemory handle
• flags must be 0
• ppData must be a valid pointer to a pointer value
• memory must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to memory must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_MEMORY_MAP_FAILED

Parameters:

device - the logical device that owns the memory.

memory - the VkDeviceMemory object to be mapped.

offset - a zero-based byte offset from the beginning of the memory object.

size - the size of the memory range to map, or WHOLE_SIZE to map from offset to the end of the allocation.

flags - reserved for future use.

ppData - points to a pointer in which is returned a host-accessible pointer to the beginning of the mapped range. This pointer minus offset must be aligned to at least VkPhysicalDeviceLimits::minMemoryMapAlignment.

vkUnmapMemory

public static void vkUnmapMemory(VkDevice device,
                                 long memory)

Unmap a previously mapped memory object.

C Specification

To unmap a memory object once host access to it is no longer needed by the application, call:

 void vkUnmapMemory(
     VkDevice                                    device,
     VkDeviceMemory                              memory);

Valid Usage

• memory must be currently mapped

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• memory must be a valid VkDeviceMemory handle
• memory must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to memory must be externally synchronized

Parameters:

device - the logical device that owns the memory.

memory - the memory object to be unmapped.

nvkFlushMappedMemoryRanges

public static int nvkFlushMappedMemoryRanges(VkDevice device,
                                             int memoryRangeCount,
                                             long pMemoryRanges)

Unsafe version of: FlushMappedMemoryRanges

Parameters:

memoryRangeCount - the length of the pMemoryRanges array.

vkFlushMappedMemoryRanges

public static int vkFlushMappedMemoryRanges(VkDevice device,
                                            VkMappedMemoryRange.Buffer pMemoryRanges)

Flush mapped memory ranges.

C Specification

To flush ranges of non-coherent memory from the host caches, call:

 VkResult vkFlushMappedMemoryRanges(
     VkDevice                                    device,
     uint32_t                                    memoryRangeCount,
     const VkMappedMemoryRange*                  pMemoryRanges);

Description

FlushMappedMemoryRanges guarantees that host writes to the memory ranges described by pMemoryRanges are made available to the host memory domain, such that they can be made available to the device memory domain via memory domain operations using the ACCESS_HOST_WRITE_BIT access type.

Within each range described by pMemoryRanges, each set of nonCoherentAtomSize bytes in that range is flushed if any byte in that set has been written by the host since it was first mapped, or the last time it was flushed. If pMemoryRanges includes sets of nonCoherentAtomSize bytes where no bytes have been written by the host, those bytes must not be flushed.

Unmapping non-coherent memory does not implicitly flush the mapped memory, and host writes that have not been flushed may not ever be visible to the device. However, implementations must ensure that writes that have not been flushed do not become visible to any other memory.

Note

The above guarantee avoids a potential memory corruption in scenarios where host writes to a mapped memory object have not been flushed before the memory is unmapped (or freed), and the virtual address range is subsequently reused for a different mapping (or memory allocation).

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pMemoryRanges must be a valid pointer to an array of memoryRangeCount valid VkMappedMemoryRange structures
• memoryRangeCount must be greater than 0

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkMappedMemoryRange

Parameters:

device - the logical device that owns the memory ranges.

pMemoryRanges - a pointer to an array of VkMappedMemoryRange structures describing the memory ranges to flush.

vkFlushMappedMemoryRanges

public static int vkFlushMappedMemoryRanges(VkDevice device,
                                            VkMappedMemoryRange pMemoryRange)

Flush mapped memory ranges.

C Specification

To flush ranges of non-coherent memory from the host caches, call:

 VkResult vkFlushMappedMemoryRanges(
     VkDevice                                    device,
     uint32_t                                    memoryRangeCount,
     const VkMappedMemoryRange*                  pMemoryRanges);

Description

FlushMappedMemoryRanges guarantees that host writes to the memory ranges described by pMemoryRanges are made available to the host memory domain, such that they can be made available to the device memory domain via memory domain operations using the ACCESS_HOST_WRITE_BIT access type.

Within each range described by pMemoryRanges, each set of nonCoherentAtomSize bytes in that range is flushed if any byte in that set has been written by the host since it was first mapped, or the last time it was flushed. If pMemoryRanges includes sets of nonCoherentAtomSize bytes where no bytes have been written by the host, those bytes must not be flushed.

Unmapping non-coherent memory does not implicitly flush the mapped memory, and host writes that have not been flushed may not ever be visible to the device. However, implementations must ensure that writes that have not been flushed do not become visible to any other memory.

Note

The above guarantee avoids a potential memory corruption in scenarios where host writes to a mapped memory object have not been flushed before the memory is unmapped (or freed), and the virtual address range is subsequently reused for a different mapping (or memory allocation).

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pMemoryRanges must be a valid pointer to an array of memoryRangeCount valid VkMappedMemoryRange structures
• memoryRangeCount must be greater than 0

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkMappedMemoryRange

Parameters:

device - the logical device that owns the memory ranges.

nvkInvalidateMappedMemoryRanges

public static int nvkInvalidateMappedMemoryRanges(VkDevice device,
                                                  int memoryRangeCount,
                                                  long pMemoryRanges)

Unsafe version of: InvalidateMappedMemoryRanges

Parameters:

memoryRangeCount - the length of the pMemoryRanges array.

vkInvalidateMappedMemoryRanges

public static int vkInvalidateMappedMemoryRanges(VkDevice device,
                                                 VkMappedMemoryRange.Buffer pMemoryRanges)

Invalidate ranges of mapped memory objects.

C Specification

To invalidate ranges of non-coherent memory from the host caches, call:

 VkResult vkInvalidateMappedMemoryRanges(
     VkDevice                                    device,
     uint32_t                                    memoryRangeCount,
     const VkMappedMemoryRange*                  pMemoryRanges);

Description

InvalidateMappedMemoryRanges guarantees that device writes to the memory ranges described by pMemoryRanges, which have been made available to the host memory domain using the ACCESS_HOST_WRITE_BIT and ACCESS_HOST_READ_BIT access types, are made visible to the host. If a range of non-coherent memory is written by the host and then invalidated without first being flushed, its contents are undefined.

Within each range described by pMemoryRanges, each set of nonCoherentAtomSize bytes in that range is invalidated if any byte in that set has been written by the device since it was first mapped, or the last time it was invalidated.

Note

Mapping non-coherent memory does not implicitly invalidate the mapped memory, and device writes that have not been invalidated must be made visible before the host reads or overwrites them.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pMemoryRanges must be a valid pointer to an array of memoryRangeCount valid VkMappedMemoryRange structures
• memoryRangeCount must be greater than 0

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkMappedMemoryRange

Parameters:

device - the logical device that owns the memory ranges.

pMemoryRanges - a pointer to an array of VkMappedMemoryRange structures describing the memory ranges to invalidate.

vkInvalidateMappedMemoryRanges

public static int vkInvalidateMappedMemoryRanges(VkDevice device,
                                                 VkMappedMemoryRange pMemoryRange)

Invalidate ranges of mapped memory objects.

C Specification

To invalidate ranges of non-coherent memory from the host caches, call:

 VkResult vkInvalidateMappedMemoryRanges(
     VkDevice                                    device,
     uint32_t                                    memoryRangeCount,
     const VkMappedMemoryRange*                  pMemoryRanges);

Description

InvalidateMappedMemoryRanges guarantees that device writes to the memory ranges described by pMemoryRanges, which have been made available to the host memory domain using the ACCESS_HOST_WRITE_BIT and ACCESS_HOST_READ_BIT access types, are made visible to the host. If a range of non-coherent memory is written by the host and then invalidated without first being flushed, its contents are undefined.

Within each range described by pMemoryRanges, each set of nonCoherentAtomSize bytes in that range is invalidated if any byte in that set has been written by the device since it was first mapped, or the last time it was invalidated.

Note

Mapping non-coherent memory does not implicitly invalidate the mapped memory, and device writes that have not been invalidated must be made visible before the host reads or overwrites them.

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pMemoryRanges must be a valid pointer to an array of memoryRangeCount valid VkMappedMemoryRange structures
• memoryRangeCount must be greater than 0

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkMappedMemoryRange

Parameters:

device - the logical device that owns the memory ranges.

nvkGetDeviceMemoryCommitment

public static void nvkGetDeviceMemoryCommitment(VkDevice device,
                                                long memory,
                                                long pCommittedMemoryInBytes)

Unsafe version of: GetDeviceMemoryCommitment

vkGetDeviceMemoryCommitment

public static void vkGetDeviceMemoryCommitment(VkDevice device,
                                               long memory,
                                               java.nio.LongBuffer pCommittedMemoryInBytes)

Query the current commitment for a VkDeviceMemory.

C Specification

To determine the amount of lazily-allocated memory that is currently committed for a memory object, call:

 void vkGetDeviceMemoryCommitment(
     VkDevice                                    device,
     VkDeviceMemory                              memory,
     VkDeviceSize*                               pCommittedMemoryInBytes);

Description

The implementation may update the commitment at any time, and the value returned by this query may be out of date.

The implementation guarantees to allocate any committed memory from the heapIndex indicated by the memory type that the memory object was created with.

Valid Usage

• memory must have been created with a memory type that reports MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• memory must be a valid VkDeviceMemory handle
• pCommittedMemoryInBytes must be a valid pointer to a VkDeviceSize value
• memory must have been created, allocated, or retrieved from device

Parameters:

device - the logical device that owns the memory.

memory - the memory object being queried.

pCommittedMemoryInBytes - a pointer to a VkDeviceSize value in which the number of bytes currently committed is returned, on success.

vkBindBufferMemory

public static int vkBindBufferMemory(VkDevice device,
                                     long buffer,
                                     long memory,
                                     long memoryOffset)

Bind device memory to a buffer object.

C Specification

To attach memory to a buffer object, call:

 VkResult vkBindBufferMemory(
     VkDevice                                    device,
     VkBuffer                                    buffer,
     VkDeviceMemory                              memory,
     VkDeviceSize                                memoryOffset);

Description

BindBufferMemory is equivalent to passing the same parameters through VkBindBufferMemoryInfo to BindBufferMemory2.

Valid Usage

• buffer must not already be backed by a memory object
• buffer must not have been created with any sparse memory binding flags
• memoryOffset must be less than the size of memory
• memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the VkMemoryRequirements structure returned from a call to GetBufferMemoryRequirements with buffer
• memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to GetBufferMemoryRequirements with buffer
• The size member of the VkMemoryRequirements structure returned from a call to GetBufferMemoryRequirements with buffer must be less than or equal to the size of memory minus memoryOffset
• If buffer requires a dedicated allocation(as reported by GetBufferMemoryRequirements2 in VkMemoryDedicatedRequirements::requiresDedicatedAllocation for buffer), memory must have been created with VkMemoryDedicatedAllocateInfo::buffer equal to buffer
• If the VkMemoryAllocateInfo provided when memory was allocated included an instance of VkMemoryDedicatedAllocateInfo in its pNext chain, and VkMemoryDedicatedAllocateInfo::buffer was not NULL_HANDLE, then buffer must equal VkMemoryDedicatedAllocateInfo::buffer, and memoryOffset must be zero.
• If buffer was created with the BUFFER_CREATE_PROTECTED_BIT bit set, the buffer must be bound to a memory object allocated with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT
• If buffer was created with the BUFFER_CREATE_PROTECTED_BIT bit not set, the buffer must not be bound to a memory object created with a memory type that reports MEMORY_PROPERTY_PROTECTED_BIT
• If buffer was created with VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE, memory must have been created with VkDedicatedAllocationMemoryAllocateInfoNV::buffer equal to a buffer handle created with identical creation parameters to buffer and memoryOffset must be zero

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• buffer must be a valid VkBuffer handle
• memory must be a valid VkDeviceMemory handle
• buffer must have been created, allocated, or retrieved from device
• memory must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to buffer must be externally synchronized

Return Codes

On success, this command returns

• SUCCES