Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class KHRSharedPresentableImage

extends Object
Class Inheritance
Imports
org.lwjgl.system.*
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
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

Modifier and TypeField and Description
public static final int
VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

Extends VkImageLayout.

public static final String
VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAME

The extension name.

public static final int
VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSION

The extension specification version.

public static final int
VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

Extends VkPresentModeKHR.

public static final int
VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR

Extends VkPresentModeKHR.

public static final int
VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

Extends VkStructureType.

Constructor Summary

AccessConstructor and Description
protected
KHRSharedPresentableImage()

Method Summary

Modifier and TypeMethod and Description
public static int
vkGetSwapchainStatusKHR(VkDevice
the device associated with swapchain.
device, long
the swapchain to query.
swapchain)

Get a swapchain’s status.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_IMAGE_LAYOUT_SHARED_PRESENT_KHRback to summary
public static final int VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR

Extends VkImageLayout.

VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAMEback to summary
public static final String VK_KHR_SHARED_PRESENTABLE_IMAGE_EXTENSION_NAME

The extension name.

VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSIONback to summary
public static final int VK_KHR_SHARED_PRESENTABLE_IMAGE_SPEC_VERSION

The extension specification version.

VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHRback to summary
public static final int VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR

Extends VkPresentModeKHR.

Enum values:
VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHRback to summary
public static final int VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR

Extends VkPresentModeKHR.

Enum values:
VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHRback to summary
public static final int VK_STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

Extends VkStructureType.

Constructor Detail

KHRSharedPresentableImageback to summary
protected KHRSharedPresentableImage()

Method Detail

vkGetSwapchainStatusKHRback to summary
public static int vkGetSwapchainStatusKHR(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
On failure, this command returns
Parameters
device:VkDevice

the device associated with swapchain.

swapchain:long

the swapchain to query.

Annotations
@NativeType:VkResult