Function Prototype

vkGetVideoSessionMemoryRequirementsKHR

Get the memory requirements for a video session

To determine the memory requirements for a video session object, call:

VkResult vkGetVideoSessionMemoryRequirementsKHR(
    VkDevice device,
    VkVideoSessionKHR videoSession,
    uint32_t* pMemoryRequirementsCount,
    VkVideoSessionMemoryRequirementsKHR* pMemoryRequirements);
  • device is the logical device that owns the video session.
  • videoSession is the video session to query.
  • pMemoryRequirementsCount is a pointer to an integer related to the number of memory binding requirements available or queried, as described below.
  • pMemoryRequirements is NULL or a pointer to an array of VkVideoSessionMemoryRequirementsKHR structures in which the memory binding requirements of the video session are returned.

If pMemoryRequirements is NULL, then the number of memory bindings required for the video session is returned in pMemoryRequirementsCount. Otherwise, pMemoryRequirementsCount must point to a variable set by the application to the number of elements in the pMemoryRequirements array, and on return the variable is overwritten with the number of memory binding requirements actually written to pMemoryRequirements. If pMemoryRequirementsCount is less than the number of memory bindings required for the video session, then at most pMemoryRequirementsCount elements will be written to pMemoryRequirements, and VK_INCOMPLETE will be returned, instead of VK_SUCCESS, to indicate that not all required memory binding requirements were returned.

Valid Usage (Implicit)

VUID-vkGetVideoSessionMemoryRequirementsKHR-pMemoryRequirementsCount-parameter

pMemoryRequirementsCount must be a valid pointer to a uint32_t value

VUID-vkGetVideoSessionMemoryRequirementsKHR-pMemoryRequirements-parameter

If the value referenced by pMemoryRequirementsCount is not 0, and pMemoryRequirements is not NULL, pMemoryRequirements must be a valid pointer to an array of pMemoryRequirementsCount VkVideoSessionMemoryRequirementsKHR structures

VUID-vkGetVideoSessionMemoryRequirementsKHR-videoSession-parent

videoSession must have been created, allocated, or retrieved from device