Enum VulkanPresentModeKHR

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      VK_PRESENT_MODE_FIFO_KHR
      The presentation engine waits for the next vertical blanking period to update the current image.
      VK_PRESENT_MODE_FIFO_RELAXED_KHR
      The presentation engine generally waits for the next vertical blanking period to update the current image.
      VK_PRESENT_MODE_IMMEDIATE_KHR
      The presentation engine does not wait for a vertical blanking period to update the current image, meaning this mode may result in visible tearing.
      VK_PRESENT_MODE_MAILBOX_KHR
      The presentation engine waits for the next vertical blanking period to update the current image.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Optional<VulkanPresentModeKHR> ofInteger​(int x)  
      int value()  
      static VulkanPresentModeKHR valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static VulkanPresentModeKHR[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • VK_PRESENT_MODE_IMMEDIATE_KHR

        public static final VulkanPresentModeKHR VK_PRESENT_MODE_IMMEDIATE_KHR
        The presentation engine does not wait for a vertical blanking period to update the current image, meaning this mode may result in visible tearing. No internal queuing of presentation requests is needed, as the requests are applied immediately.
      • VK_PRESENT_MODE_MAILBOX_KHR

        public static final VulkanPresentModeKHR VK_PRESENT_MODE_MAILBOX_KHR
        The presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal single-entry queue is used to hold pending presentation requests. If the queue is full when a new presentation request is received, the new request replaces the existing entry, and any images associated with the prior entry become available for re-use by the application. One request is removed from the queue and processed during each vertical blanking period in which the queue is non-empty.
      • VK_PRESENT_MODE_FIFO_KHR

        public static final VulkanPresentModeKHR VK_PRESENT_MODE_FIFO_KHR
        The presentation engine waits for the next vertical blanking period to update the current image. Tearing cannot be observed. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during each vertical blanking period in which the queue is non-empty. This is the only value of presentMode that is required to be supported.
      • VK_PRESENT_MODE_FIFO_RELAXED_KHR

        public static final VulkanPresentModeKHR VK_PRESENT_MODE_FIFO_RELAXED_KHR
        The presentation engine generally waits for the next vertical blanking period to update the current image. If a vertical blanking period has already passed since the last update of the current image then the presentation engine does not wait for another vertical blanking period for the update, meaning this mode may result in visible tearing in this case. This mode is useful for reducing visual stutter with an application that will mostly present a new image before the next vertical blanking period, but may occassionally be late, and present a new image just after the the next vertical blanking period. An internal queue is used to hold pending presentation requests. New requests are appended to the end of the queue, and one request is removed from the beginning of the queue and processed during or after each vertical blanking period in which the queue is non-empty.
    • Method Detail

      • values

        public static VulkanPresentModeKHR[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (VulkanPresentModeKHR c : VulkanPresentModeKHR.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static VulkanPresentModeKHR valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • ofInteger

        public static java.util.Optional<VulkanPresentModeKHR> ofInteger​(int x)
        Parameters:
        x - An integer value
        Returns:
        The constant associated with the given integer value, if any