vkCmdEncodeVideoKHR(3)

C Specification

To launch video encode operations, call:

// Provided by VK_KHR_video_encode_queue
void vkCmdEncodeVideoKHR(
    VkCommandBuffer                             commandBuffer,
    const VkVideoEncodeInfoKHR*                 pEncodeInfo);

Parameters

commandBuffer is the command buffer to be filled with this function for encoding to generate a bitstream.
pEncodeInfo is a pointer to a VkVideoEncodeInfoKHR structure.

Description

Each call issues one or more video encode operations. The implicit parameter opCount corresponds to the number of video encode operations issued by the command. After calling this command, the active query index of each active query is incremented by opCount.

Currently each call to this command results in the issue of a single video encode operation.

Valid Usage

VUID-vkCmdEncodeVideoKHR-opCount-07174
For each active query, the active query index corresponding to the query type of that query plus opCount must be less than or equal to the last activatable query index corresponding to the query type of that query plus one

Valid Usage (Implicit)

VUID-vkCmdEncodeVideoKHR-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdEncodeVideoKHR-pEncodeInfo-parameter
pEncodeInfo must be a valid pointer to a valid VkVideoEncodeInfoKHR structure
VUID-vkCmdEncodeVideoKHR-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdEncodeVideoKHR-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support encode operations
VUID-vkCmdEncodeVideoKHR-renderpass
This command must only be called outside of a render pass instance
VUID-vkCmdEncodeVideoKHR-videocoding
This command must only be called inside of a video coding scope
VUID-vkCmdEncodeVideoKHR-bufferlevel
commandBuffer must be a primary VkCommandBuffer

Host Synchronization

Host access to commandBuffer must be externally synchronized
Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized