Class VkAcquireNextImageInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkAcquireNextImageInfoKHR
    extends Struct
    implements NativeResource
    Structure specifying parameters of the acquire.
    Description

    If AcquireNextImageKHR is used, the device mask is considered to include all physical devices in the logical device.

    Note

    AcquireNextImage2KHR signals at most one semaphore, even if the application requests waiting for multiple physical devices to be ready via the deviceMask. However, only a single physical device can wait on that semaphore, since the semaphore becomes unsignaled when the wait succeeds. For other physical devices to wait for the image to be ready, it is necessary for the application to submit semaphore signal operation(s) to that first physical device to signal additional semaphore(s) after the wait succeeds, which the other physical device(s) can wait upon.

    Valid Usage
    • swapchain must not be in the retired state
    • If semaphore is not NULL_HANDLE it must be unsignaled
    • If semaphore is not NULL_HANDLE it must not have any uncompleted signal or wait operations pending
    • If fence is not NULL_HANDLE it must be unsignaled and must not be associated with any other queue command that has not yet completed execution on that queue
    • semaphore and fence must not both be equal to NULL_HANDLE
    • deviceMask must be a valid device mask
    • deviceMask must not be zero
    • semaphore and fence must not both be equal to NULL_HANDLE.
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
    • pNext must be NULL
    • swapchain must be a valid VkSwapchainKHR handle
    • If semaphore is not NULL_HANDLE, semaphore must be a valid VkSemaphore handle
    • If fence is not NULL_HANDLE, fence must be a valid VkFence handle
    • Each of fence, semaphore, and swapchain that are valid handles must have been created, allocated, or retrieved from the same VkInstance
    Host Synchronization
    • Host access to swapchain must be externally synchronized
    • Host access to semaphore must be externally synchronized
    • Host access to fence must be externally synchronized
    See Also

    AcquireNextImage2KHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • swapchain – a non-retired swapchain from which an image is acquired.
    • timeout – specifies how long the function waits, in nanoseconds, if no image is available.
    • semaphoreNULL_HANDLE or a semaphore to signal.
    • fenceNULL_HANDLE or a fence to signal.
    • deviceMask – a mask of physical devices for which the swapchain image will be ready to use when the semaphore or fence is signaled.

    Layout

    
     struct VkAcquireNextImageInfoKHR {
         VkStructureType sType;
         void const * pNext;
         VkSwapchainKHR swapchain;
         uint64_t timeout;
         VkSemaphore semaphore;
         VkFence fence;
         uint32_t deviceMask;
     }