VkAcquireNextImageInfoKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkAcquireNextImageInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAcquireNextImageInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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 must have a VkSemaphoreTypeKHR of SEMAPHORE_TYPE_BINARY_KHR
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 of non-ignored parameters 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.
- pNext – NULL 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.
- semaphore – NULL_HANDLE or a semaphore to signal.
- fence – NULL_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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkAcquireNextImageInfoKHR.Buffer
An array of VkAcquireNextImageInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkAcquireNextImageInfoKHR.Buffer` An array of `VkAcquireNextImageInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DEVICEMASK` The struct member offsets.
`static int`	`FENCE` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SEMAPHORE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`SWAPCHAIN` The struct member offsets.
`static int`	`TIMEOUT` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkAcquireNextImageInfoKHR(java.nio.ByteBuffer container)` Creates a `VkAcquireNextImageInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkAcquireNextImageInfoKHR`	`calloc()` Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memCalloc`.
`static VkAcquireNextImageInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkAcquireNextImageInfoKHR`	`callocStack()` Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAcquireNextImageInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAcquireNextImageInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAcquireNextImageInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAcquireNextImageInfoKHR`	`create()` Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `BufferUtils`.
`static VkAcquireNextImageInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkAcquireNextImageInfoKHR`	`create(long address)` Returns a new `VkAcquireNextImageInfoKHR` instance for the specified memory address.
`static VkAcquireNextImageInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkAcquireNextImageInfoKHR.Buffer` instance at the specified memory.
`static VkAcquireNextImageInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAcquireNextImageInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`deviceMask()` Returns the value of the `deviceMask` field.
`VkAcquireNextImageInfoKHR`	`deviceMask(int value)` Sets the specified value to the `deviceMask` field.
`long`	`fence()` Returns the value of the `fence` field.
`VkAcquireNextImageInfoKHR`	`fence(long value)` Sets the specified value to the `fence` field.
`static VkAcquireNextImageInfoKHR`	`malloc()` Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memAlloc`.
`static VkAcquireNextImageInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkAcquireNextImageInfoKHR`	`mallocStack()` Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkAcquireNextImageInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAcquireNextImageInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAcquireNextImageInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`ndeviceMask(long struct)` Unsafe version of `deviceMask()`.
`static void`	`ndeviceMask(long struct, int value)` Unsafe version of `deviceMask`.
`static long`	`nfence(long struct)` Unsafe version of `fence()`.
`static void`	`nfence(long struct, long value)` Unsafe version of `fence`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static long`	`nsemaphore(long struct)` Unsafe version of `semaphore()`.
`static void`	`nsemaphore(long struct, long value)` Unsafe version of `semaphore`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static long`	`nswapchain(long struct)` Unsafe version of `swapchain()`.
`static void`	`nswapchain(long struct, long value)` Unsafe version of `swapchain`.
`static long`	`ntimeout(long struct)` Unsafe version of `timeout()`.
`static void`	`ntimeout(long struct, long value)` Unsafe version of `timeout`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkAcquireNextImageInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`long`	`semaphore()` Returns the value of the `semaphore` field.
`VkAcquireNextImageInfoKHR`	`semaphore(long value)` Sets the specified value to the `semaphore` field.
`VkAcquireNextImageInfoKHR`	`set(int sType, long pNext, long swapchain, long timeout, long semaphore, long fence, int deviceMask)` Initializes this struct with the specified values.
`VkAcquireNextImageInfoKHR`	`set(VkAcquireNextImageInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkAcquireNextImageInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`long`	`swapchain()` Returns the value of the `swapchain` field.
`VkAcquireNextImageInfoKHR`	`swapchain(long value)` Sets the specified value to the `swapchain` field.
`long`	`timeout()` Returns the value of the `timeout` field.
`VkAcquireNextImageInfoKHR`	`timeout(long value)` Sets the specified value to the `timeout` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - SWAPCHAIN
```
public static final int SWAPCHAIN
```
    The struct member offsets.
  - TIMEOUT
```
public static final int TIMEOUT
```
    The struct member offsets.
  - SEMAPHORE
```
public static final int SEMAPHORE
```
    The struct member offsets.
  - FENCE
```
public static final int FENCE
```
    The struct member offsets.
  - DEVICEMASK
```
public static final int DEVICEMASK
```
    The struct member offsets.
- Constructor Detail
  - VkAcquireNextImageInfoKHR
```
public VkAcquireNextImageInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkAcquireNextImageInfoKHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - swapchain
```
public long swapchain()
```
    Returns the value of the swapchain field.
  - timeout
```
public long timeout()
```
    Returns the value of the timeout field.
  - semaphore
```
public long semaphore()
```
    Returns the value of the semaphore field.
  - fence
```
public long fence()
```
    Returns the value of the fence field.
  - deviceMask
```
public int deviceMask()
```
    Returns the value of the deviceMask field.
  - sType
```
public VkAcquireNextImageInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkAcquireNextImageInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - swapchain
```
public VkAcquireNextImageInfoKHR swapchain(long value)
```
    Sets the specified value to the swapchain field.
  - timeout
```
public VkAcquireNextImageInfoKHR timeout(long value)
```
    Sets the specified value to the timeout field.
  - semaphore
```
public VkAcquireNextImageInfoKHR semaphore(long value)
```
    Sets the specified value to the semaphore field.
  - fence
```
public VkAcquireNextImageInfoKHR fence(long value)
```
    Sets the specified value to the fence field.
  - deviceMask
```
public VkAcquireNextImageInfoKHR deviceMask(int value)
```
    Sets the specified value to the deviceMask field.
  - set
```
public VkAcquireNextImageInfoKHR set(int sType,
                                     long pNext,
                                     long swapchain,
                                     long timeout,
                                     long semaphore,
                                     long fence,
                                     int deviceMask)
```
    Initializes this struct with the specified values.
  - set
```
public VkAcquireNextImageInfoKHR set(VkAcquireNextImageInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAcquireNextImageInfoKHR malloc()
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAcquireNextImageInfoKHR calloc()
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAcquireNextImageInfoKHR create()
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkAcquireNextImageInfoKHR create(long address)
```
    Returns a new VkAcquireNextImageInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAcquireNextImageInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAcquireNextImageInfoKHR.Buffer create(int capacity)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAcquireNextImageInfoKHR.Buffer create(long address,
                                                      int capacity)
```
    Create a VkAcquireNextImageInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAcquireNextImageInfoKHR.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkAcquireNextImageInfoKHR mallocStack()
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAcquireNextImageInfoKHR callocStack()
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAcquireNextImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAcquireNextImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAcquireNextImageInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nswapchain
```
public static long nswapchain(long struct)
```
    Unsafe version of swapchain().
  - ntimeout
```
public static long ntimeout(long struct)
```
    Unsafe version of timeout().
  - nsemaphore
```
public static long nsemaphore(long struct)
```
    Unsafe version of semaphore().
  - nfence
```
public static long nfence(long struct)
```
    Unsafe version of fence().
  - ndeviceMask
```
public static int ndeviceMask(long struct)
```
    Unsafe version of deviceMask().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nswapchain
```
public static void nswapchain(long struct,
                              long value)
```
    Unsafe version of swapchain.
  - ntimeout
```
public static void ntimeout(long struct,
                            long value)
```
    Unsafe version of timeout.
  - nsemaphore
```
public static void nsemaphore(long struct,
                              long value)
```
    Unsafe version of semaphore.
  - nfence
```
public static void nfence(long struct,
                          long value)
```
    Unsafe version of fence.
  - ndeviceMask
```
public static void ndeviceMask(long struct,
                               int value)
```
    Unsafe version of deviceMask.

Class VkAcquireNextImageInfoKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

SWAPCHAIN

TIMEOUT

SEMAPHORE

FENCE

DEVICEMASK

Constructor Detail

VkAcquireNextImageInfoKHR

Method Detail

sizeof

sType

pNext

swapchain

timeout

semaphore

fence

deviceMask

sType

pNext

swapchain

timeout

semaphore

fence

deviceMask

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nswapchain

ntimeout

nsemaphore

nfence

ndeviceMask

nsType

npNext

nswapchain

ntimeout

nsemaphore

nfence