Function Prototype
vkReleaseSwapchainImagesKHR
Release previously acquired but unused images
To release images previously acquired through vkAcquireNextImage2KHR or vkAcquireNextImageKHR, call:
VkResult vkReleaseSwapchainImagesKHR(
VkDevice device,
const VkReleaseSwapchainImagesInfoKHR* pReleaseInfo);
pub fn release_swapchain_images_khr(
device: vk::Device,
p_release_info: *const vk::ReleaseSwapchainImagesInfoKHR,
) -> vk::Result;
VkResult vkReleaseSwapchainImagesEXT(
VkDevice device,
const VkReleaseSwapchainImagesInfoKHR* pReleaseInfo);
pub fn release_swapchain_images_ext(
device: vk::Device,
p_release_info: *const vk::ReleaseSwapchainImagesInfoKHR,
) -> vk::Result;
deviceis the device associated with VkReleaseSwapchainImagesInfoKHR::swapchain.pReleaseInfois a pointer to a VkReleaseSwapchainImagesInfoKHR structure containing parameters of the release.
Only images that are not in use by the device can be released.
Releasing images is a read-only operation that will not affect the content of the released images. Upon reacquiring the image, the image contents and its layout will be the same as they were prior to releasing it. However, if a mechanism other than Vulkan is used to modify the platform window associated with the swapchain, the content of all presentable images in the swapchain becomes undefined.
This functionality is useful during swapchain recreation, where acquired
images from the old swapchain can be released instead of presented.
Valid Usage
VUID-vkReleaseSwapchainImagesKHR-swapchainMaintenance1-10159
Feature swapchainMaintenance1must be enabled
Valid Usage (Implicit)
VUID-vkReleaseSwapchainImagesKHR-device-parameter
device must be a valid VkDevice handle
VUID-vkReleaseSwapchainImagesKHR-pReleaseInfo-parameter
pReleaseInfo must be a valid pointer to a valid VkReleaseSwapchainImagesInfoKHR structure
Type
Function Prototype