Interface JCSwapchainImageType

All Superinterfaces:

AutoCloseable

public interface JCSwapchainImageType
extends AutoCloseable

An image acquired from a swapchain.

Method Summary

Modifier and Type	Method	Description
void	close()
VulkanFormat	format()
VulkanImageType	image()
VulkanSemaphoreBinaryType	imageReadySemaphore()
VulkanImageViewType	imageView()
JCSwapchainImageIndex	index()
void	present()	Submit this image for presentation.
VulkanSemaphoreBinaryType	renderFinishedSemaphore()
VulkanExtent2D	size()
VulkanExtKHRSwapChainType.VulkanKHRSwapChainType	swapchain()

Method Details

format

VulkanFormat format()

Returns:

The format of the image

size

VulkanExtent2D size()

Returns:

The image size

index

JCSwapchainImageIndex index()

Returns:

The index of the image within the swapchain

image

VulkanImageType image()

Returns:

The image

imageView

VulkanImageViewType imageView()

Returns:

The image view

close

void close()
    throws VulkanException

Specified by:

close in interface AutoCloseable

Throws:

VulkanException

present

void present()
      throws VulkanException

Submit this image for presentation.

Throws:

VulkanException - On errors

imageReadySemaphore

VulkanSemaphoreBinaryType imageReadySemaphore()

Returns:

A semaphore signalled when the image is ready

renderFinishedSemaphore

VulkanSemaphoreBinaryType renderFinishedSemaphore()

Returns:

A semaphore to be signalled when rendering to the image is done

swapchain

VulkanExtKHRSwapChainType.VulkanKHRSwapChainType swapchain()

Returns:

The swapchain to which the image belongs