LWJGL 3.3.3 · org.lwjgl.vulkan.EXTSwapchainMaintenance1

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.

VK_EXT_swapchain_maintenance1

Name String

VK_EXT_swapchain_maintenance1

Extension Type

Device extension

Registered Extension Number

276

Revision

Extension and Version Dependencies

VK_KHR_swapchain and VK_EXT_surface_maintenance1 and VK_KHR_get_physical_device_properties2

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

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

Access	Constructor and Description
protected	EXTSwapchainMaintenance1()

Method Summary

Modifier and Type	Method and Description
public static int	nvkReleaseSwapchainImagesEXT(VkDevice device, long pReleaseInfo) Unsafe version of: `ReleaseSwapchainImagesEXT`
public static int	vkReleaseSwapchainImagesEXT(VkDevice the device associated with `VkReleaseSwapchainImagesInfoEXT::swapchain`. device, VkReleaseSwapchainImagesInfoEXT a pointer to a `VkReleaseSwapchainImagesInfoEXT` structure containing parameters of the release. pReleaseInfo) Release previously acquired but unused images.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

VK_EXT_SWAPCHAIN_MAINTENANCE_1_EXTENSION_NAME	back to summary
public static final String VK_EXT_SWAPCHAIN_MAINTENANCE_1_EXTENSION_NAME The extension name.

VK_EXT_SWAPCHAIN_MAINTENANCE_1_SPEC_VERSION	back to summary
public static final int VK_EXT_SWAPCHAIN_MAINTENANCE_1_SPEC_VERSION The extension specification version.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT back to summary

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SWAPCHAIN_MAINTENANCE_1_FEATURES_EXT

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT back to summary

VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT back to summary

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_FENCE_INFO_EXT

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT back to summary

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT back to summary

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT back to summary

VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT	back to summary
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`

public static final int VK_STRUCTURE_TYPE_SWAPCHAIN_PRESENT_SCALING_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

VK_SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT	back to summary
public static final int VK_SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_EXT Extends `VkSwapchainCreateFlagBitsKHR`.

Constructor Detail

EXTSwapchainMaintenance1	back to summary
protected EXTSwapchainMaintenance1()

Method Detail

nvkReleaseSwapchainImagesEXT	back to summary
public static int nvkReleaseSwapchainImagesEXT(VkDevice device, long pReleaseInfo) Unsafe version of: `ReleaseSwapchainImagesEXT`

vkReleaseSwapchainImagesEXT back to summary

vkReleaseSwapchainImagesEXT	back to summary
public static int vkReleaseSwapchainImagesEXT(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 (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:VkDevice the device associated with `VkReleaseSwapchainImagesInfoEXT::swapchain`. pReleaseInfo:VkReleaseSwapchainImagesInfoEXT a pointer to a `VkReleaseSwapchainImagesInfoEXT` structure containing parameters of the release. Annotations @NativeType:VkResult

public static int vkReleaseSwapchainImagesEXT(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 (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

public Class EXTSwapchainMaintenance1

VK_EXT_swapchain_maintenance1

Other Extension Metadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Description

Note

Valid Usage (Implicit)

Return Codes

See Also