C Specification

Additional information about the video encode use case can be provided by adding a VkVideoEncodeUsageInfoKHR structure to the pNext chain of VkVideoProfileInfoKHR.

The VkVideoEncodeUsageInfoKHR structure is defined as:

// Provided by VK_KHR_video_encode_queue
typedef struct VkVideoEncodeUsageInfoKHR {
    VkStructureType                 sType;
    const void*                     pNext;
    VkVideoEncodeUsageFlagsKHR      videoUsageHints;
    VkVideoEncodeContentFlagsKHR    videoContentHints;
    VkVideoEncodeTuningModeKHR      tuningMode;
} VkVideoEncodeUsageInfoKHR;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • videoUsageHints is a bitmask of VkVideoEncodeUsageFlagBitsKHR specifying hints about the intended use of the video encode profile.

  • videoContentHints is a bitmask of VkVideoEncodeContentFlagBitsKHR specifying hints about the content to be encoded using the video encode profile.

  • tuningMode is a VkVideoEncodeTuningModeKHR value specifying the tuning mode to use when encoding with the video profile.

Description

Valid Usage (Implicit)

  • VUID-VkVideoEncodeUsageInfoKHR-sType-sType
    sType must be VK_STRUCTURE_TYPE_VIDEO_ENCODE_USAGE_INFO_KHR

  • VUID-VkVideoEncodeUsageInfoKHR-videoUsageHints-parameter
    videoUsageHints must be a valid combination of VkVideoEncodeUsageFlagBitsKHR values

  • VUID-VkVideoEncodeUsageInfoKHR-videoContentHints-parameter
    videoContentHints must be a valid combination of VkVideoEncodeContentFlagBitsKHR values

  • VUID-VkVideoEncodeUsageInfoKHR-tuningMode-parameter
    If tuningMode is not 0, tuningMode must be a valid VkVideoEncodeTuningModeKHR value

See Also

VK_KHR_video_encode_queue, VkStructureType, VkVideoEncodeContentFlagsKHR, VkVideoEncodeTuningModeKHR, VkVideoEncodeUsageFlagsKHR

Document Notes

For more information, see the Vulkan Specification

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

Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0