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

76 lines
2.1 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkCreateComputePipelines(3)
===========================
Name
----
vkCreateComputePipelines - Creates a new compute pipeline object.
C Specification
---------------
// refBegin vkCreateComputePipelines Creates a new compute pipeline object.
To create compute pipelines, call:
include::../api/protos/vkCreateComputePipelines.txt[]
Parameters
----------
* pname:device is the logical device that creates the compute pipelines.
* pname:pipelineCache is either dlink:VK_NULL_HANDLE, indicating that
pipeline caching is disabled; or the handle of a valid
<<pipelines-cache,pipeline cache>> object, in which case use of that
cache is enabled for the duration of the command.
* pname:createInfoCount is the length of the pname:pCreateInfos and
pname:pPipelines arrays.
* pname:pCreateInfos is an array of sname:VkComputePipelineCreateInfo
structures.
* pname:pAllocator controls host memory allocation as described in the
<<memory-allocation, Memory Allocation>> chapter.
* pname:pPipelines is a pointer to an array in which the resulting compute
pipeline objects are returned.
+
--
ifdef::editing-notes[]
[NOTE]
.editing-note
====
TODO (Jon) - Should we say something like ``the i'th element of the
pname:pPipelines array is created based on the corresponding element of the
pname:pCreateInfos array''? Also for flink:vkCreateGraphicsPipelines below.
====
endif::editing-notes[]
--
Description
-----------
include::../validity/protos/vkCreateComputePipelines.txt[]
See Also
--------
slink:VkAllocationCallbacks, slink:VkComputePipelineCreateInfo, slink:VkDevice, slink:VkPipeline, slink:VkPipelineCache
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateComputePipelines
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]