Vulkan-Docs/doc/specs/vulkan/man/vkCreateDevice.txt

71 lines
2.5 KiB
Plaintext
Raw Normal View History

2016-02-16 01:53:44 -08:00
vkCreateDevice(3)
==================
Name
----
vkCreateDevice - Create a new device instance.
C Specification
---------------
include::../protos/vkCreateDevice.txt[]
Parameters
----------
pname:physicalDevice::
Handle to the physical device upon which to create the logical device.
pname:pCreateInfo::
Pointer to a structure containing creation info.
pname:pDevice::
Pointer to a variable to receive the handle to the new device instance.
Description
-----------
fname:vkCreateDevice creates a new device instance on the physical device specified by
pname:physicalDevice and places the resulting device handle in the variable pointed to
by pname:pDevice. Information about how the device should be created is passed in an
instance of slink:VkDeviceCreateInfo whose address is passed in pname:pCreateInfo.
The definition of slink:VkDeviceCreateInfo is:
include::../structs/VkDeviceCreateInfo.txt[]
include::../validity/protos/vkCreateDevice.txt[]
Change log for June 17, 2016 Vulkan 1.0.17 spec update: * Bump API patch number and header version number to 17 for this update. Github Issues: * Update description of vertex shader reuse in <<shaders-vertex-execution>> (public issue 106). * Simplify validity language around pname:ppEnabledExtensionNames and pname:ppEnabledLayerNames (in the <<initialization-instances>> and <<devsandqueues-device-creation>> sections) (public issue 214). * Add missing validity rule to flink:vkCmdBeginRenderPass requiring compatibility between slink:VkAttachmentDescription pname:initalLayout members and the corresponding attached framebuffer images (public issue 233). * Fix Unicode arrows appearing in output instead of relational operators (public issue 239). * Correctly describe the required number of elements for code:TessLevelInner and code:TessLevelOuter arrays in the <<interfaces-builtin-variables,Built-In Variables>> section as two and four, respectively, instead of the other way around, and refer to this section from the <<tessellation,Tessellation>> chapter (public issue 246). Internal Issues: * Document deprecation of ename:VK_COLORSPACE_SRGB_NONLINEAR_KHR in the VK_KHR_surface extension branch, and of ename:VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT in the VK_EXT_debug_report branch (internal issue 328). * Added language to define what a valid usage statement is and should be, with a note about some apparent weirdnesses this might entail (internal issue 357). Other Commits: * Added missing ename:VK_ERROR_DEVICE_LOST error to flink:vkQueueBindSparse.
2016-06-17 15:39:39 -07:00
* pname:sType is the type of this structure.
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
* pname:flags is reserved for future use.
* pname:queueCreateInfoCount is the unsigned integer size of the
pname:pQueueCreateInfos array. Refer to the
<<devsandqueues-queue-creation,Queue Creation>> section below for
further details.
* pname:pQueueCreateInfos is a pointer to an array of
slink:VkDeviceQueueCreateInfo structures describing the queues that are
requested to be created along with the logical device. Refer to the
<<devsandqueues-queue-creation,Queue Creation>> section below for
further details.
* pname:enabledLayerCount is deprecated and ignored.
* pname:ppEnabledLayerNames is deprecated and ignored. See
<<extended-functionality-device-layer-deprecation,Device Layer Deprecation>>.
* pname:enabledExtensionCount is the number of device extensions to
enable.
* pname:ppEnabledExtensionNames is a pointer to an array of
pname:enabledExtensionCount null-terminated UTF-8 strings containing the
names of extensions to enable for the created device. See the
<<extended-functionality-extensions,Extensions>> section for further
details.
* pname:pEnabledFeatures is `NULL` or a pointer to a
slink:VkPhysicalDeviceFeatures structure that contains boolean
indicators of all the features to be enabled. Refer to the
<<features-features,Features>> section for further details.
2016-02-16 01:53:44 -08:00
See Also
--------
flink:vkDestroyDevice
include::footer.txt[]