vkBindVideoSessionMemoryKHR(3)

# vkBindVideoSessionMemoryKHR(3) Manual Page

## Name

vkBindVideoSessionMemoryKHR - Bind Video Memory

Loading… please wait.

## C Specification

To attach memory to a video session object, call:

    // Provided by VK_KHR_video_queue
    VkResult vkBindVideoSessionMemoryKHR(
        VkDevice                                    device,
        VkVideoSessionKHR                           videoSession,
        uint32_t                                    videoSessionBindMemoryCount,
        const VkVideoBindMemoryKHR*                 pVideoSessionBindMemories);

## Parameters

- `device` is the logical device that owns the video session’s memory.

- `videoSession` is the video session to be bound with device memory.

- `videoSessionBindMemoryCount` is the number of `pVideoSessionBindMemories` to be bound.

- `pVideoSessionBindMemories` is a pointer to an array of VkVideoBindMemoryKHR structures specifying memory regions to be bound to a device memory heap.

## Description

Valid Usage (Implicit)

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

- VUID-vkBindVideoSessionMemoryKHR-videoSession-parameter
  `videoSession` must be a valid VkVideoSessionKHR handle

- VUID-vkBindVideoSessionMemoryKHR-pVideoSessionBindMemories-parameter
  `pVideoSessionBindMemories` must be a valid pointer to an array of `videoSessionBindMemoryCount` valid VkVideoBindMemoryKHR structures

- VUID-vkBindVideoSessionMemoryKHR-videoSessionBindMemoryCount-arraylength
  `videoSessionBindMemoryCount` must be greater than `0`

- VUID-vkBindVideoSessionMemoryKHR-videoSession-parent
  `videoSession` must have been created, allocated, or retrieved from `device`

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

  - `VK_ERROR_INITIALIZATION_FAILED`

## See Also

VK_KHR_video_queue, VkDevice, VkVideoBindMemoryKHR, VkVideoSessionKHR

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

SPDX-License-Identifier: CC-BY-4.0