C Specification
To get memory requirements for a video session, call:
// Provided by VK_KHR_video_queue
VkResult vkGetVideoSessionMemoryRequirementsKHR(
VkDevice device,
VkVideoSessionKHR videoSession,
uint32_t* pVideoSessionMemoryRequirementsCount,
VkVideoGetMemoryPropertiesKHR* pVideoSessionMemoryRequirements);
Parameters
-
device
is the logical device that owns the video session. -
videoSession
is the video session to query. -
pVideoSessionMemoryRequirementsCount
is the number of the memory requirements structures of type VkVideoGetMemoryPropertiesKHR thatpVideoSessionMemoryRequirements
points to. -
pVideoSessionMemoryRequirements
is the pointer to an instance of the VkVideoGetMemoryPropertiesKHR in which the memory heap requirements of the video session are returned - one entry for each memory heap type required by the implementation.
Description
If pVideoSessionMemoryRequirements
is NULL
, then the number of
memory heap types required for the video session is returned in
pVideoSessionMemoryRequirementsCount
.
Otherwise, pVideoSessionMemoryRequirementsCount
must point to a
variable set by the user with the number of elements in the
pVideoSessionMemoryRequirements
array, and on return the variable is
overwritten with the number of formats actually written to
pVideoSessionMemoryRequirements
.
If pVideoSessionMemoryRequirementsCount
is less than the number of
memory heap types required for the video session then at most
pVideoSessionMemoryRequirementsCount
elements will be written to
pVideoSessionMemoryRequirements
, and
vkGetVideoSessionMemoryRequirementsKHR will return VK_INCOMPLETE
instead of VK_SUCCESS
to indicate that not all required memory heap
types were returned.
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.