VKCREATEEVENT(3)

NAME
vkCreateEvent - Create a new event object.

C SPECIFICATION

To create an event, call:

    VkResult vkCreateEvent(
        VkDevice                                    device,
        const VkEventCreateInfo*                    pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkEvent*                                    pEvent);

PARAMETERS

    • device is the logical device that creates the event.

    • pCreateInfo is a pointer to an instance of the VkEventCreateInfo structure which contains information about how the event is to be created.

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

    • pEvent points to a handle in which the resulting event object is returned.

DESCRIPTION

When created, the event object is in the unsignaled state.

VALID USAGE

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkEventCreateInfo structure

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

    • pEvent must be a pointer to a VkEvent 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, VkEvent, VkEventCreateInfo

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.