Package org.lwjgl.vulkan

Class EXTSwapchainMaintenance1

java.lang.Object

org.lwjgl.vulkan.EXTSwapchainMaintenance1

public class EXTSwapchainMaintenance1
extends Object

VK_EXT_swapchain_maintenance1 adds a collection of window system integration features that were intentionally left out or overlooked in the original VK_KHR_swapchain extension.

The new features are as follows:

• Specify a fence that will be signaled when the resources associated with a present operation can be safely destroyed.
• Allow changing the present mode a swapchain is using at per-present granularity.
• Allow applications to define the behavior when presenting a swapchain image to a surface with different dimensions than the image. Using this feature may allow implementations to avoid returning ERROR_OUT_OF_DATE_KHR in this situation.
• Allow applications to defer swapchain memory allocation for improved startup time and memory footprint.
• Allow applications to release previously acquired images without presenting them.

Name String

VK_EXT_swapchain_maintenance1

Extension Type

Device extension

Registered Extension Number

276

Revision

1

Extension and Version Dependencies

VK_KHR_swapchain and VK_EXT_surface_maintenance1 and VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Shahbaz Youssefi syoussefi

Extension Proposal

VK_EXT_swapchain_maintenance1

Other Extension Metadata

Last Modified Date

2022-10-28

Contributors

• Jeff Juliano, NVIDIA
• Shahbaz Youssefi, Google
• Chris Forbes, Google
• Ian Elliott, Google
• Yiwei Zhang, Google
• Charlie Lao, Google
• Lina Versace, Google
• Ralph Potter, Samsung
• Igor Nazarov, Samsung
• Hyunchang Kim, Samsung
• Suenghwan Lee, Samsung
• Munseong Kang, Samsung
• Joonyong Park, Samsung
• Hans-Kristian Arntzen, Valve
• Lisa Wu, Arm
• Daniel Stone, Collabora
• Pan Gao, Huawei

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VK_EXT_SWAPCHAIN_MAINTENANCE_1_EXTENSION_NAME	The extension name.
static final int	VK_EXT_SWAPCHAIN_MAINTENANCE_1_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT	Extends VkStructureType.
static final int	VK_SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT	Extends VkSwapchainCreateFlagBitsKHR.

Method Summary

Modifier and Type	Method	Description
static int	nvkReleaseSwapchainImagesEXT(org.lwjgl.vulkan.VkDevice device, long pReleaseInfo)	Unsafe version of: ReleaseSwapchainImagesEXT
static int	vkReleaseSwapchainImagesEXT(org.lwjgl.vulkan.VkDevice device, VkReleaseSwapchainImagesInfoEXT pReleaseInfo)	Release previously acquired but unused images.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_EXT_SWAPCHAIN_MAINTENANCE_1_SPEC_VERSION

public static final int VK_EXT_SWAPCHAIN_MAINTENANCE_1_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_EXT_SWAPCHAIN_MAINTENANCE_1_EXTENSION_NAME

public static final String VK_EXT_SWAPCHAIN_MAINTENANCE_1_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

public static final int VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT
• STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT
• STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

See Also:

• Constant Field Values

VK_SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT

public static final int VK_SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT

Extends VkSwapchainCreateFlagBitsKHR.

See Also:

• Constant Field Values

Method Details

nvkReleaseSwapchainImagesEXT

public static int nvkReleaseSwapchainImagesEXT(org.lwjgl.vulkan.VkDevice device,
 long pReleaseInfo)

Unsafe version of: ReleaseSwapchainImagesEXT

vkReleaseSwapchainImagesEXT

public static int vkReleaseSwapchainImagesEXT(org.lwjgl.vulkan.VkDevice device,
 VkReleaseSwapchainImagesInfoEXT pReleaseInfo)

Release previously acquired but unused images.

C Specification

To release images previously acquired through AcquireNextImage2KHR or AcquireNextImageKHR, call:

 VkResult vkReleaseSwapchainImagesEXT(
     VkDevice                                    device,
     const VkReleaseSwapchainImagesInfoEXT*      pReleaseInfo);

Description

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.

Note

This functionality is useful during swapchain recreation, where acquired images from the old swapchain can be released instead of presented.

Valid Usage

• Feature swapchainMaintenance1 must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pReleaseInfo must be a valid pointer to a valid VkReleaseSwapchainImagesInfoEXT structure

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_SURFACE_LOST_KHR

See Also

VkReleaseSwapchainImagesInfoEXT

Parameters:

device - the device associated with VkReleaseSwapchainImagesInfoEXT::swapchain.

pReleaseInfo - a pointer to a VkReleaseSwapchainImagesInfoEXT structure containing parameters of the release.