Module com.io7m.jcoronado.extensions.khr.surface.api
Package com.io7m.jcoronado.extensions.khr_swapchain.api

Interface VulkanSwapChainImageAcquisitionType

  • All Known Implementing Classes:
    VulkanSwapChainImageAcquisition
    @Immutable
public interface VulkanSwapChainImageAcquisitionType
    The result of an attempt to acquire an image from the swap chain.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.OptionalInt imageIndex()  
      boolean subOptimal()
      If an image became available, and the swapchain no longer matches the surface properties exactly but can still be used to present to the surface successfully, this method will return true.
      boolean timedOut()  

    • Method Detail

      • imageIndex

        @Parameter
java.util.OptionalInt imageIndex()
        Returns:
        The index of the acquired image in the swapchain

      • subOptimal

        @Parameter
boolean subOptimal()
        If an image became available, and the swapchain no longer matches the surface properties exactly but can still be used to present to the surface successfully, this method will return true.
        Returns:
        true if the image is now suboptimal

      • timedOut

        @Parameter
boolean timedOut()
        Returns:
        true iff a timeout was specified and no image was available within that time