VKCREATEEVENT(3)

NAME
vkCreateEvent - Create a new event object.

C SPECIFICATION

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

PARAMETERS

device
    A handle to the device with which to create the event.

pCreateInfo
    A pointer to the creation info structure.

pEvent
    The address of an VK_EVENT variable that will receive the handle to the new event.

DESCRIPTION

vkCreateEvent creates a new event object using the device specified as device. A handle to the newly created event object is placed the variable pointed to by pEvent. pCreateInfo is a pointer to an instance of a VkEventCreateInfo structure containing information about the state in which to create the new object. The definition of VkEventCreateInfo is:

    typedef struct VkEventCreateInfo {
        VkStructureType       sType;
        const void*           pNext;
        VkEventCreateFlags    flags;
    } VkEventCreateInfo;

The sType member of the VkEventCreateInfo structure should be set to VK_STRUCTURE_TYPE_EVENT_CREATE_INFO. The pNext member is reserved for use by extensions and should be set to NULL.

The flags member specifies additional information about the event to be created. There are presently no flags defined for this member and it should be set to zero.

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

vkSetEvent, vkResetEvent, vkCmdSetEvent, vkCmdResetEvent

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.