vkUpdateVideoSessionParametersKHR(3)

# vkUpdateVideoSessionParametersKHR(3) Manual Page

## Name

vkUpdateVideoSessionParametersKHR - updates video session video session parameter object

Loading… please wait.

## C Specification

To update, add, or remove video session parameters state, call:

    // Provided by VK_KHR_video_queue
    VkResult vkUpdateVideoSessionParametersKHR(
        VkDevice                                    device,
        VkVideoSessionParametersKHR                 videoSessionParameters,
        const VkVideoSessionParametersUpdateInfoKHR* pUpdateInfo);

## Parameters

- `device` is the logical device that was used for the creation of the video session object.

- `videoSessionParameters` is the video session object that is going to be updated.

- `pUpdateInfo` is a pointer to `VkVideoSessionParametersUpdateInfoKHR` structure containing the session parameters update info.

## Description

Valid Usage (Implicit)

- VUID-vkUpdateVideoSessionParametersKHR-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkUpdateVideoSessionParametersKHR-videoSessionParameters-parameter
  `videoSessionParameters` must be a valid VkVideoSessionParametersKHR handle

- VUID-vkUpdateVideoSessionParametersKHR-pUpdateInfo-parameter
  `pUpdateInfo` must be a valid pointer to a valid VkVideoSessionParametersUpdateInfoKHR structure

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_INITIALIZATION_FAILED`

  - `VK_ERROR_TOO_MANY_OBJECTS`

## See Also

VkDevice, VkVideoSessionParametersKHR, VkVideoSessionParametersUpdateInfoKHR

## 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