VKCREATESHADERMODULE(3)

NAME
vkCreateShaderModule - Creates a new shader module object

C SPECIFICATION

To create a shader module, call:

    VkResult vkCreateShaderModule(
        VkDevice                                    device,
        const VkShaderModuleCreateInfo*             pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkShaderModule*                             pShaderModule);

PARAMETERS

    • device is the logical device that creates the shader module.

    • pCreateInfo parameter is a pointer to an instance of the VkShaderModuleCreateInfo structure.

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

    • pShaderModule points to a VkShaderModule handle in which the resulting shader module object is returned.

DESCRIPTION

Once a shader module has been created, any entry points it contains can be used in pipeline shader stages as described in Compute Pipelines and Graphics Pipelines. Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkShaderModuleCreateInfo structure

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

    • pShaderModule must be a pointer to a VkShaderModule handle
Return Codes

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

VkAllocationCallbacks, VkDevice, VkShaderModule, VkShaderModuleCreateInfo

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateShaderModule

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.