VkVideoEncodeRateControlInfoKHR(3)

# VkVideoEncodeRateControlInfoKHR(3) Manual Page

## Name

VkVideoEncodeRateControlInfoKHR - Structure to set encode rate control parameters

Loading… please wait.

## C Specification

The VkVideoEncodeRateControlInfoKHR structure is defined as:

    // Provided by VK_KHR_video_encode_queue
    typedef struct VkVideoEncodeRateControlInfoKHR {
        VkStructureType                            sType;
        const void*                                pNext;
        VkVideoEncodeRateControlFlagsKHR           flags;
        VkVideoEncodeRateControlModeFlagBitsKHR    rateControlMode;
        uint32_t                                   averageBitrate;
        uint16_t                                   peakToAverageBitrateRatio;
        uint16_t                                   frameRateNumerator;
        uint16_t                                   frameRateDenominator;
        uint32_t                                   virtualBufferSizeInMs;
    } VkVideoEncodeRateControlInfoKHR;

## Members

A codec-specific extension structure for further rate control parameter settings may be chained to VkVideoEncodeRateControlInfoKHR.

## Description

Valid Usage (Implicit)

- VUID-VkVideoEncodeRateControlInfoKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR`

- VUID-VkVideoEncodeRateControlInfoKHR-flags-parameter
  `flags` must be a valid combination of VkVideoEncodeRateControlFlagBitsKHR values

- VUID-VkVideoEncodeRateControlInfoKHR-flags-requiredbitmask
  `flags` must not be `0`

- VUID-VkVideoEncodeRateControlInfoKHR-rateControlMode-parameter
  `rateControlMode` must be a valid VkVideoEncodeRateControlModeFlagBitsKHR value

## See Also

VkStructureType, VkVideoEncodeRateControlFlagsKHR, VkVideoEncodeRateControlModeFlagBitsKHR

## 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-2021 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0