vkCreateDevice - Create a new device instance

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 Device 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 DeviceCreateInfo::ppEnabledExtensionNames list must also be present in that list

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• pCreateInfo must be a valid pointer to a valid DeviceCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pDevice must be a valid pointer to a Device handle

Return Codes

Success

• SUCCESS

Failure

• 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

AllocationCallbacks, Device, DeviceCreateInfo, PhysicalDevice

A convenience wrapper to make a compatible pair of calls to createDevice and destroyDevice

To ensure that destroyDevice is always called: pass bracket (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass (,) as the first argument.

vkDestroyDevice - Destroy a logical device

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 vkCreate* or vkAllocate* command.

Note

The lifetime of each of these objects is bound by the lifetime of the Device 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 AllocationCallbacks were provided when device was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when device was created, pAllocator must be NULL

Valid Usage (Implicit)

• If device is not NULL, device must be a valid Device handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

Host Synchronization

• Host access to device must be externally synchronized

• Host access to all Queue objects received from device must be externally synchronized

See Also

AllocationCallbacks, Device

VkDeviceQueueCreateInfo - Structure specifying parameters of a newly created device queue

Valid Usage

• queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by getPhysicalDeviceQueueFamilyProperties

• queueCount must be less than or equal to the queueCount member of the QueueFamilyProperties structure, as returned by getPhysicalDeviceQueueFamilyProperties in the pQueueFamilyProperties[queueFamilyIndex]
• Each element of pQueuePriorities must be between 0.0 and 1.0 inclusive
• If the protected memory feature is not enabled, the DEVICE_QUEUE_CREATE_PROTECTED_BIT bit of flags must not be set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of DeviceQueueGlobalPriorityCreateInfoEXT
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of DeviceQueueCreateFlagBits values
• pQueuePriorities must be a valid pointer to an array of queueCount float values
• queueCount must be greater than 0

See Also

DeviceCreateInfo, DeviceQueueCreateFlags, StructureType

VkDeviceCreateInfo - Structure specifying parameters of a newly created device

Valid Usage

• The queueFamilyIndex member of each element of pQueueCreateInfos must be unique within pQueueCreateInfos, except that two members can share the same queueFamilyIndex if one is a protected-capable queue and one is not a protected-capable queue

• If the pNext chain includes a PhysicalDeviceFeatures2 structure, then pEnabledFeatures must be NULL
• ppEnabledExtensionNames must not contain VK_AMD_negative_viewport_height
• ppEnabledExtensionNames must not contain both VK_KHR_buffer_device_address and VK_EXT_buffer_device_address
• If the pNext chain includes a PhysicalDeviceVulkan11Features structure, then it must not include a PhysicalDevice16BitStorageFeatures, PhysicalDeviceMultiviewFeatures, PhysicalDeviceVariablePointersFeatures, PhysicalDeviceProtectedMemoryFeatures, PhysicalDeviceSamplerYcbcrConversionFeatures, or PhysicalDeviceShaderDrawParametersFeatures structure
• If the pNext chain includes a PhysicalDeviceVulkan12Features structure, then it must not include a PhysicalDevice8BitStorageFeatures, PhysicalDeviceShaderAtomicInt64Features, PhysicalDeviceShaderFloat16Int8Features, PhysicalDeviceDescriptorIndexingFeatures, PhysicalDeviceScalarBlockLayoutFeatures, PhysicalDeviceImagelessFramebufferFeatures, PhysicalDeviceUniformBufferStandardLayoutFeatures, PhysicalDeviceShaderSubgroupExtendedTypesFeatures, PhysicalDeviceSeparateDepthStencilLayoutsFeatures, PhysicalDeviceHostQueryResetFeatures, PhysicalDeviceTimelineSemaphoreFeatures, PhysicalDeviceBufferDeviceAddressFeatures, or PhysicalDeviceVulkanMemoryModelFeatures structure
• If ppEnabledExtensions contains "VK_KHR_draw_indirect_count" and the pNext chain includes a PhysicalDeviceVulkan12Features structure, then PhysicalDeviceVulkan12Features::drawIndirectCount must be TRUE
• If ppEnabledExtensions contains "VK_KHR_sampler_mirror_clamp_to_edge" and the pNext chain includes a PhysicalDeviceVulkan12Features structure, then PhysicalDeviceVulkan12Features::samplerMirrorClampToEdge must be TRUE
• If ppEnabledExtensions contains "VK_EXT_descriptor_indexing" and the pNext chain includes a PhysicalDeviceVulkan12Features structure, then PhysicalDeviceVulkan12Features::descriptorIndexing must be TRUE
• If ppEnabledExtensions contains "VK_EXT_sampler_filter_minmax" and the pNext chain includes a PhysicalDeviceVulkan12Features structure, then PhysicalDeviceVulkan12Features::samplerFilterMinmax must be TRUE
• If ppEnabledExtensions contains "VK_EXT_shader_viewport_index_layer" and the pNext chain includes a PhysicalDeviceVulkan12Features structure, then PhysicalDeviceVulkan12Features::shaderOutputViewportIndex and PhysicalDeviceVulkan12Features::shaderOutputLayer must both be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of DeviceDiagnosticsConfigCreateInfoNV, DeviceGroupDeviceCreateInfo, DeviceMemoryOverallocationCreateInfoAMD, DevicePrivateDataCreateInfoEXT, PhysicalDevice16BitStorageFeatures, PhysicalDevice4444FormatsFeaturesEXT, PhysicalDevice8BitStorageFeatures, PhysicalDeviceASTCDecodeFeaturesEXT, PhysicalDeviceBlendOperationAdvancedFeaturesEXT, PhysicalDeviceBufferDeviceAddressFeatures, PhysicalDeviceBufferDeviceAddressFeaturesEXT, PhysicalDeviceCoherentMemoryFeaturesAMD, PhysicalDeviceComputeShaderDerivativesFeaturesNV, PhysicalDeviceConditionalRenderingFeaturesEXT, PhysicalDeviceCooperativeMatrixFeaturesNV, PhysicalDeviceCornerSampledImageFeaturesNV, PhysicalDeviceCoverageReductionModeFeaturesNV, PhysicalDeviceCustomBorderColorFeaturesEXT, PhysicalDeviceDedicatedAllocationImageAliasingFeaturesNV, PhysicalDeviceDepthClipEnableFeaturesEXT, PhysicalDeviceDescriptorIndexingFeatures, PhysicalDeviceDeviceGeneratedCommandsFeaturesNV, PhysicalDeviceDiagnosticsConfigFeaturesNV, PhysicalDeviceExclusiveScissorFeaturesNV, PhysicalDeviceExtendedDynamicStateFeaturesEXT, PhysicalDeviceFeatures2, PhysicalDeviceFragmentDensityMap2FeaturesEXT, PhysicalDeviceFragmentDensityMapFeaturesEXT, PhysicalDeviceFragmentShaderBarycentricFeaturesNV, PhysicalDeviceFragmentShaderInterlockFeaturesEXT, PhysicalDeviceHostQueryResetFeatures, PhysicalDeviceImageRobustnessFeaturesEXT, PhysicalDeviceImagelessFramebufferFeatures, PhysicalDeviceIndexTypeUint8FeaturesEXT, PhysicalDeviceInlineUniformBlockFeaturesEXT, PhysicalDeviceLineRasterizationFeaturesEXT, PhysicalDeviceMemoryPriorityFeaturesEXT, PhysicalDeviceMeshShaderFeaturesNV, PhysicalDeviceMultiviewFeatures, PhysicalDevicePerformanceQueryFeaturesKHR, PhysicalDevicePipelineCreationCacheControlFeaturesEXT, PhysicalDevicePipelineExecutablePropertiesFeaturesKHR, PhysicalDevicePrivateDataFeaturesEXT, PhysicalDeviceProtectedMemoryFeatures, PhysicalDeviceRayTracingFeaturesKHR, PhysicalDeviceRepresentativeFragmentTestFeaturesNV, PhysicalDeviceRobustness2FeaturesEXT, PhysicalDeviceSamplerYcbcrConversionFeatures, PhysicalDeviceScalarBlockLayoutFeatures, PhysicalDeviceSeparateDepthStencilLayoutsFeatures, PhysicalDeviceShaderAtomicFloatFeaturesEXT, PhysicalDeviceShaderAtomicInt64Features, PhysicalDeviceShaderClockFeaturesKHR, PhysicalDeviceShaderDemoteToHelperInvocationFeaturesEXT, PhysicalDeviceShaderDrawParametersFeatures, PhysicalDeviceShaderFloat16Int8Features, PhysicalDeviceShaderImageFootprintFeaturesNV, PhysicalDeviceShaderIntegerFunctions2FeaturesINTEL, PhysicalDeviceShaderSMBuiltinsFeaturesNV, PhysicalDeviceShaderSubgroupExtendedTypesFeatures, PhysicalDeviceShadingRateImageFeaturesNV, PhysicalDeviceSubgroupSizeControlFeaturesEXT, PhysicalDeviceTexelBufferAlignmentFeaturesEXT, PhysicalDeviceTextureCompressionASTCHDRFeaturesEXT, PhysicalDeviceTimelineSemaphoreFeatures, PhysicalDeviceTransformFeedbackFeaturesEXT, PhysicalDeviceUniformBufferStandardLayoutFeatures, PhysicalDeviceVariablePointersFeatures, PhysicalDeviceVertexAttributeDivisorFeaturesEXT, PhysicalDeviceVulkan11Features, PhysicalDeviceVulkan12Features, PhysicalDeviceVulkanMemoryModelFeatures, or PhysicalDeviceYcbcrImageArraysFeaturesEXT
• The sType value of each struct in the pNext chain must be unique, with the exception of structures of type DevicePrivateDataCreateInfoEXT
• flags must be 0
• pQueueCreateInfos must be a valid pointer to an array of queueCreateInfoCount valid DeviceQueueCreateInfo structures
• If enabledLayerCount is not 0, ppEnabledLayerNames must be a valid pointer to an array of enabledLayerCount null-terminated UTF-8 strings
• If enabledExtensionCount is not 0, ppEnabledExtensionNames must be a valid pointer to an array of enabledExtensionCount null-terminated UTF-8 strings
• If pEnabledFeatures is not NULL, pEnabledFeatures must be a valid pointer to a valid PhysicalDeviceFeatures structure
• queueCreateInfoCount must be greater than 0

See Also

DeviceCreateFlags, DeviceQueueCreateInfo, PhysicalDeviceFeatures, StructureType, createDevice

VkDevice - Opaque handle to a device object

See Also

acquireFullScreenExclusiveModeEXT, acquireNextImage2KHR, acquireNextImageKHR, acquirePerformanceConfigurationINTEL, acquireProfilingLockKHR, allocateCommandBuffers, allocateDescriptorSets, allocateMemory, bindAccelerationStructureMemoryKHR, bindAccelerationStructureMemoryNV, bindBufferMemory, bindBufferMemory2, bindBufferMemory2KHR, bindImageMemory, bindImageMemory2, bindImageMemory2KHR, buildAccelerationStructureKHR, compileDeferredNV, copyAccelerationStructureKHR, copyAccelerationStructureToMemoryKHR, copyMemoryToAccelerationStructureKHR, createAccelerationStructureKHR, createAccelerationStructureNV, createBuffer, createBufferView, createCommandPool, createComputePipelines, createDeferredOperationKHR, createDescriptorPool, createDescriptorSetLayout, createDescriptorUpdateTemplate, createDescriptorUpdateTemplateKHR, createDevice, createEvent, createFence, createFramebuffer, createGraphicsPipelines, createImage, createImageView, createIndirectCommandsLayoutNV, createPipelineCache, createPipelineLayout, createPrivateDataSlotEXT, createQueryPool, createRayTracingPipelinesKHR, createRayTracingPipelinesNV, createRenderPass, createRenderPass2, createRenderPass2KHR, createSampler, createSamplerYcbcrConversion, createSamplerYcbcrConversionKHR, createSemaphore, createShaderModule, createSharedSwapchainsKHR, createSwapchainKHR, createValidationCacheEXT, debugMarkerSetObjectNameEXT, debugMarkerSetObjectTagEXT, deferredOperationJoinKHR, destroyAccelerationStructureKHR, destroyAccelerationStructureNV, destroyBuffer, destroyBufferView, destroyCommandPool, destroyDeferredOperationKHR, destroyDescriptorPool, destroyDescriptorSetLayout, destroyDescriptorUpdateTemplate, destroyDescriptorUpdateTemplateKHR, destroyDevice, destroyEvent, destroyFence, destroyFramebuffer, destroyImage, destroyImageView, destroyIndirectCommandsLayoutNV, destroyPipeline, destroyPipelineCache, destroyPipelineLayout, destroyPrivateDataSlotEXT, destroyQueryPool, destroyRenderPass, destroySampler, destroySamplerYcbcrConversion, destroySamplerYcbcrConversionKHR, destroySemaphore, destroyShaderModule, destroySwapchainKHR, destroyValidationCacheEXT, deviceWaitIdle, displayPowerControlEXT, flushMappedMemoryRanges, freeCommandBuffers, freeDescriptorSets, freeMemory, getAccelerationStructureDeviceAddressKHR, getAccelerationStructureHandleNV, getAccelerationStructureMemoryRequirementsKHR, getAccelerationStructureMemoryRequirementsNV, getAndroidHardwareBufferPropertiesANDROID, getBufferDeviceAddress, getBufferDeviceAddressEXT, getBufferDeviceAddressKHR, getBufferMemoryRequirements, getBufferMemoryRequirements2, getBufferMemoryRequirements2KHR, getBufferOpaqueCaptureAddress, getBufferOpaqueCaptureAddressKHR, getCalibratedTimestampsEXT, getDeferredOperationMaxConcurrencyKHR, getDeferredOperationResultKHR, getDescriptorSetLayoutSupport, getDescriptorSetLayoutSupportKHR, getDeviceAccelerationStructureCompatibilityKHR, getDeviceGroupPeerMemoryFeatures, getDeviceGroupPeerMemoryFeaturesKHR, getDeviceGroupPresentCapabilitiesKHR, getDeviceGroupSurfacePresentModes2EXT, getDeviceGroupSurfacePresentModesKHR, getDeviceMemoryCommitment, getDeviceMemoryOpaqueCaptureAddress, getDeviceMemoryOpaqueCaptureAddressKHR, getDeviceProcAddr, getDeviceQueue, getDeviceQueue2, getEventStatus, getFenceFdKHR, getFenceStatus, getFenceWin32HandleKHR, getGeneratedCommandsMemoryRequirementsNV, getImageDrmFormatModifierPropertiesEXT, getImageMemoryRequirements, getImageMemoryRequirements2, getImageMemoryRequirements2KHR, getImageSparseMemoryRequirements, getImageSparseMemoryRequirements2, getImageSparseMemoryRequirements2KHR, getImageSubresourceLayout, getImageViewAddressNVX, getImageViewHandleNVX, getMemoryAndroidHardwareBufferANDROID, getMemoryFdKHR, getMemoryFdPropertiesKHR, getMemoryHostPointerPropertiesEXT, getMemoryWin32HandleKHR, getMemoryWin32HandleNV, getMemoryWin32HandlePropertiesKHR, getPastPresentationTimingGOOGLE, getPerformanceParameterINTEL, getPipelineCacheData, getPipelineExecutableInternalRepresentationsKHR, getPipelineExecutablePropertiesKHR, getPipelineExecutableStatisticsKHR, getPrivateDataEXT, getQueryPoolResults, getRayTracingCaptureReplayShaderGroupHandlesKHR, getRayTracingShaderGroupHandlesKHR, getRayTracingShaderGroupHandlesNV, getRefreshCycleDurationGOOGLE, getRenderAreaGranularity, getSemaphoreCounterValue, getSemaphoreCounterValueKHR, getSemaphoreFdKHR, getSemaphoreWin32HandleKHR, getShaderInfoAMD, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, getValidationCacheDataEXT, importFenceFdKHR, importFenceWin32HandleKHR, importSemaphoreFdKHR, importSemaphoreWin32HandleKHR, initializePerformanceApiINTEL, invalidateMappedMemoryRanges, mapMemory, mergePipelineCaches, mergeValidationCachesEXT, registerDeviceEventEXT, registerDisplayEventEXT, releaseFullScreenExclusiveModeEXT, releasePerformanceConfigurationINTEL, releaseProfilingLockKHR, resetCommandPool, resetDescriptorPool, resetEvent, resetFences, resetQueryPool, resetQueryPoolEXT, setDebugUtilsObjectNameEXT, setDebugUtilsObjectTagEXT, setEvent, setHdrMetadataEXT, setLocalDimmingAMD, setPrivateDataEXT, signalSemaphore, signalSemaphoreKHR, trimCommandPool, trimCommandPoolKHR, uninitializePerformanceApiINTEL, unmapMemory, updateDescriptorSetWithTemplate, updateDescriptorSetWithTemplateKHR, updateDescriptorSets, waitForFences, waitSemaphores, waitSemaphoresKHR, writeAccelerationStructuresPropertiesKHR

VkDeviceCreateFlags - Reserved for future use

Description

DeviceCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

DeviceCreateInfo

VkDeviceQueueCreateFlagBits - Bitmask specifying behavior of the queue

See Also

DeviceQueueCreateFlags