VKCMDSETEVENT(3)

NAME
vkCmdSetEvent - Set an event object to signaled state.

C SPECIFICATION

    void vkCmdSetEvent(
        VkCommandBuffer                             commandBuffer,
        VkEvent                                     event,
        VkPipelineStageFlags                        stageMask);

PARAMETERS

commandBuffer
    The command buffer into which to insert the command.

event
    The event object to set to signaled state.

stageMask
    Specifies when the event becomes signaled (see VkPipelineStageFlags for more detail).

DESCRIPTION

vkCmdSetEvent causes the event object specified in event to be moved to the signaled state when the pipeline stages specified by stageMask have completed executing prior commands.

For definitions of the pipeline stages, see VkPipelineStageFlags.

VALID USAGE

    • commandBuffer must be a valid VkCommandBuffer handle

    • event must be a valid VkEvent handle

    • stageMask must be a valid combination of VkPipelineStageFlagBits values

    • stageMask must not be 0

    • commandBuffer must be in the recording state

    • The VkCommandPool that commandBuffer was allocated from must support graphics or compute operations

    • This command must only be called outside of a render pass instance

    • Each of commandBuffer and event must have been created, allocated or retrieved from the same VkDevice

    • If the geometry shaders feature is not enabled, stageMask must not contain VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT

    • If the tessellation shaders feature is not enabled, stageMask must not contain VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT

HOST SYNCHRONIZATION

    • Host access to commandBuffer must be externally synchronized

COMMAND PROPERTIES
Command Buffer Levels | Render Pass Scope | Supported Queue Types
Primary Secondary | Outside | GRAPHICS COMPUTE

SEE ALSO

vkCmdResetEvent, vkSetEvent, vkResetEvent, VkPipelineStageFlags

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.