Package org.lwjgl.vulkan

Class KHRSharedPresentableImage

java.lang.Object

org.lwjgl.vulkan.KHRSharedPresentableImage

public class KHRSharedPresentableImage
extends Object

This extension extends VK_KHR_swapchain to enable creation of a shared presentable image. This allows the application to use the image while the presention engine is accessing it, in order to reduce the latency between rendering and presentation.

VK_KHR_shared_presentable_image

Name String

VK_KHR_shared_presentable_image

Extension Type

Device extension

Registered Extension Number

112

Revision

1

Extension and Version Dependencies

VK_KHR_swapchain and VK_KHR_get_surface_capabilities2 and VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Alon Or-bach alonorbach

Other Extension Metadata

Last Modified Date

2017-03-20

IP Status

No known IP claims.

Contributors

• Alon Or-bach, Samsung Electronics
• Ian Elliott, Google
• Jesse Hall, Google
• Pablo Ceballos, Google
• Chris Forbes, Google
• Jeff Juliano, NVIDIA
• James Jones, NVIDIA
• Daniel Rakos, AMD
• Tobias Hector, Imagination Technologies
• Graham Connor, Imagination Technologies
• Michael Worcester, Imagination Technologies
• Cass Everitt, Oculus
• Johannes Van Waveren, Oculus

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR	Extends VkImageLayout.
static final String	VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAME	The extension name.
static final int	VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSION	The extension specification version.
static final int	VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR	Extends VkPresentModeKHR.
static final int	VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR	Extends VkPresentModeKHR.
static final int	VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static int	vkGetSwapchainStatusKHR(org.lwjgl.vulkan.VkDevice device, long swapchain)	Get a swapchain’s status.

Methods inherited from class java.lang.Object

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

Field Details

VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSION

public static final int VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAME

public static final String VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

public static final int VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

Extends VkStructureType.

See Also:

• Constant Field Values

VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR

public static final int VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR

Extends VkPresentModeKHR.

Enum values:

• PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR
• PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

See Also:

• Constant Field Values

VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

public static final int VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

Extends VkPresentModeKHR.

Enum values:

• PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR
• PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

See Also:

• Constant Field Values

VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

public static final int VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

Extends VkImageLayout.

See Also:

• Constant Field Values

Method Details

vkGetSwapchainStatusKHR

public static int vkGetSwapchainStatusKHR(org.lwjgl.vulkan.VkDevice device,
 long swapchain)

Get a swapchain’s status.

C Specification

In order to query a swapchain’s status when rendering to a shared presentable image, call:

 VkResult vkGetSwapchainStatusKHR(
     VkDevice                                    device,
     VkSwapchainKHR                              swapchain);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• swapchain must be a valid VkSwapchainKHR handle
• swapchain must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to swapchain must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS
• SUBOPTIMAL_KHR

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_DEVICE_LOST
• ERROR_OUT_OF_DATE_KHR
• ERROR_SURFACE_LOST_KHR
• ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT

Parameters:

device - the device associated with swapchain.

swapchain - the swapchain to query.