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 VkSemaphoreType of SEMAPHORE_TYPE_BINARY

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 VkDevice

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

Layout


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

Nested and Inner Type Summary

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

Field Summary

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

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkAcquireNextImageInfoKHR(long address, ByteBuffer container)
public	VkAcquireNextImageInfoKHR(ByteBuffer container) Creates a `VkAcquireNextImageInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkAcquireNextImageInfoKHR	calloc() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memCalloc`.
public static VkAcquireNextImageInfoKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memCalloc`.
public static VkAcquireNextImageInfoKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAcquireNextImageInfoKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAcquireNextImageInfoKHR	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkAcquireNextImageInfoKHR	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkAcquireNextImageInfoKHR	create() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `BufferUtils`.
public static VkAcquireNextImageInfoKHR	create(long address) Returns a new `VkAcquireNextImageInfoKHR` instance for the specified memory address.
public static VkAcquireNextImageInfoKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `BufferUtils`.
public static VkAcquireNextImageInfoKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkAcquireNextImageInfoKHR.Buffer` instance at the specified memory.
public static VkAcquireNextImageInfoKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkAcquireNextImageInfoKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	deviceMask() a mask of physical devices for which the swapchain image will be ready to use when the semaphore or fence is signaled.
public VkAcquireNextImageInfoKHR	deviceMask(int value) Sets the specified value to the `deviceMask` field.
public long	fence() `NULL_HANDLE` or a fence to signal.
public VkAcquireNextImageInfoKHR	fence(long value) Sets the specified value to the `fence` field.
public static VkAcquireNextImageInfoKHR	malloc() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memAlloc`.
public static VkAcquireNextImageInfoKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memAlloc`.
public static VkAcquireNextImageInfoKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack`.
public static VkAcquireNextImageInfoKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static VkAcquireNextImageInfoKHR	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkAcquireNextImageInfoKHR.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ndeviceMask(long struct) Unsafe version of `deviceMask`.
public static void	ndeviceMask(long struct, int value) Unsafe version of `deviceMask`.
public static long	nfence(long struct) Unsafe version of `fence`.
public static void	nfence(long struct, long value) Unsafe version of `fence`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static long	nsemaphore(long struct) Unsafe version of `semaphore`.
public static void	nsemaphore(long struct, long value) Unsafe version of `semaphore`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static long	nswapchain(long struct) Unsafe version of `swapchain`.
public static void	nswapchain(long struct, long value) Unsafe version of `swapchain`.
public static long	ntimeout(long struct) Unsafe version of `timeout`.
public static void	ntimeout(long struct, long value) Unsafe version of `timeout`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkAcquireNextImageInfoKHR	pNext(long value) Sets the specified value to the `pNext` field.
public long	semaphore() `NULL_HANDLE` or a semaphore to signal.
public VkAcquireNextImageInfoKHR	semaphore(long value) Sets the specified value to the `semaphore` field.
public VkAcquireNextImageInfoKHR	set(int sType, long pNext, long swapchain, long timeout, long semaphore, long fence, int deviceMask) Initializes this struct with the specified values.
public VkAcquireNextImageInfoKHR	Returns: this struct set(VkAcquireNextImageInfoKHR the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkAcquireNextImageInfoKHR	sType(int value) Sets the specified value to the `sType` field.
public VkAcquireNextImageInfoKHR	sType$Default() Sets the `STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR` value to the `sType` field.
public long	swapchain() a non-retired swapchain from which an image is acquired.
public VkAcquireNextImageInfoKHR	swapchain(long value) Sets the specified value to the `swapchain` field.
public long	timeout() specifies how long the function waits, in nanoseconds, if no image is available.
public VkAcquireNextImageInfoKHR	timeout(long value) Sets the specified value to the `timeout` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

DEVICEMASK	back to summary
public static final int DEVICEMASK The struct member offsets.

FENCE	back to summary
public static final int FENCE The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SEMAPHORE	back to summary
public static final int SEMAPHORE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

SWAPCHAIN	back to summary
public static final int SWAPCHAIN The struct member offsets.

TIMEOUT	back to summary
public static final int TIMEOUT The struct member offsets.

Constructor Detail

VkAcquireNextImageInfoKHR	back to summary
protected VkAcquireNextImageInfoKHR(long address, ByteBuffer container)

VkAcquireNextImageInfoKHR back to summary

VkAcquireNextImageInfoKHR	back to summary
public VkAcquireNextImageInfoKHR(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.

public VkAcquireNextImageInfoKHR(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

calloc	back to summary
public static VkAcquireNextImageInfoKHR calloc() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity)

Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkAcquireNextImageInfoKHR calloc(MemoryStack stack) Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkAcquireNextImageInfoKHR calloc(MemoryStack stack)

Returns a new VkAcquireNextImageInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkAcquireNextImageInfoKHR callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkAcquireNextImageInfoKHR callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkAcquireNextImageInfoKHR create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkAcquireNextImageInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkAcquireNextImageInfoKHR create() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `BufferUtils`.

create	back to summary
public static VkAcquireNextImageInfoKHR create(long address) Returns a new `VkAcquireNextImageInfoKHR` instance for the specified memory address.

create back to summary

create	back to summary
public static VkAcquireNextImageInfoKHR.Buffer create(int capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkAcquireNextImageInfoKHR.Buffer create(int capacity)

Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkAcquireNextImageInfoKHR.Buffer create(long address, int capacity) Create a `VkAcquireNextImageInfoKHR.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkAcquireNextImageInfoKHR.Buffer create(long address, int capacity)

Create a VkAcquireNextImageInfoKHR.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkAcquireNextImageInfoKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkAcquireNextImageInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkAcquireNextImageInfoKHR.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkAcquireNextImageInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

deviceMask	back to summary
public int deviceMask() a mask of physical devices for which the swapchain image will be ready to use when the semaphore or fence is signaled. Annotations @NativeType:uint32_t

deviceMask

back to summary

public int deviceMask()

a mask of physical devices for which the swapchain image will be ready to use when the semaphore or fence is signaled.

Annotations

@NativeType:uint32_t

deviceMask	back to summary
public VkAcquireNextImageInfoKHR deviceMask(int value) Sets the specified value to the `deviceMask` field.

fence back to summary

fence	back to summary
public long fence() `NULL_HANDLE` or a fence to signal. Annotations @NativeType:VkFence

public long fence()

NULL_HANDLE or a fence to signal.

Annotations

@NativeType:VkFence

fence	back to summary
public VkAcquireNextImageInfoKHR fence(long value) Sets the specified value to the `fence` field.

malloc	back to summary
public static VkAcquireNextImageInfoKHR malloc() Returns a new `VkAcquireNextImageInfoKHR` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity)

Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkAcquireNextImageInfoKHR malloc(MemoryStack stack) Returns a new `VkAcquireNextImageInfoKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkAcquireNextImageInfoKHR malloc(MemoryStack stack)

Returns a new VkAcquireNextImageInfoKHR instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkAcquireNextImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkAcquireNextImageInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkAcquireNextImageInfoKHR mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkAcquireNextImageInfoKHR mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkAcquireNextImageInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

ndeviceMask	back to summary
public static int ndeviceMask(long struct) Unsafe version of `deviceMask`.

ndeviceMask	back to summary
public static void ndeviceMask(long struct, int value) Unsafe version of `deviceMask`.

nfence	back to summary
public static long nfence(long struct) Unsafe version of `fence`.

nfence	back to summary
public static void nfence(long struct, long value) Unsafe version of `fence`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsemaphore	back to summary
public static long nsemaphore(long struct) Unsafe version of `semaphore`.

nsemaphore	back to summary
public static void nsemaphore(long struct, long value) Unsafe version of `semaphore`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

nswapchain	back to summary
public static long nswapchain(long struct) Unsafe version of `swapchain`.

nswapchain	back to summary
public static void nswapchain(long struct, long value) Unsafe version of `swapchain`.

ntimeout	back to summary
public static long ntimeout(long struct) Unsafe version of `timeout`.

ntimeout	back to summary
public static void ntimeout(long struct, long value) Unsafe version of `timeout`.

pNext back to summary

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkAcquireNextImageInfoKHR pNext(long value) Sets the specified value to the `pNext` field.

semaphore back to summary

public long semaphore()

NULL_HANDLE or a semaphore to signal.

Annotations

@NativeType:VkSemaphore

semaphore	back to summary
public VkAcquireNextImageInfoKHR semaphore(long value) Sets the specified value to the `semaphore` field.

set	back to summary
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

back to summary

public VkAcquireNextImageInfoKHR set(VkAcquireNextImageInfoKHR src)

Copies the specified struct data to this struct.

Parameters

src:VkAcquireNextImageInfoKHR: the source struct

Returns:VkAcquireNextImageInfoKHR

this struct

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkAcquireNextImageInfoKHR sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkAcquireNextImageInfoKHR sType$Default() Sets the `STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR` value to the `sType` field.

swapchain

back to summary

public long swapchain()

a non-retired swapchain from which an image is acquired.

Annotations

@NativeType:VkSwapchainKHR

swapchain	back to summary
public VkAcquireNextImageInfoKHR swapchain(long value) Sets the specified value to the `swapchain` field.

timeout

back to summary

public long timeout()

specifies how long the function waits, in nanoseconds, if no image is available.

Annotations

@NativeType:uint64_t

timeout	back to summary
public VkAcquireNextImageInfoKHR timeout(long value) Sets the specified value to the `timeout` field.

org.lwjgl.vulkan back to summary

public Class VkAcquireNextImageInfoKHR.Buffer

Class Inheritance

extends StructBuffer<VkAcquireNextImageInfoKHR, VkAcquireNextImageInfoKHR.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkAcquireNextImageInfoKHR.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkAcquireNextImageInfoKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkAcquireNextImageInfoKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkAcquireNextImageInfoKHR.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkAcquireNextImageInfoKHR#deviceMask` field. deviceMask()
public VkAcquireNextImageInfoKHR.Buffer	deviceMask(int value) Sets the specified value to the `VkAcquireNextImageInfoKHR#deviceMask` field.
public long	Returns: the value of the `VkAcquireNextImageInfoKHR#fence` field. fence()
public VkAcquireNextImageInfoKHR.Buffer	fence(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#fence` field.
protected VkAcquireNextImageInfoKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkAcquireNextImageInfoKHR#pNext` field. pNext()
public VkAcquireNextImageInfoKHR.Buffer	pNext(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#pNext` field.
protected VkAcquireNextImageInfoKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkAcquireNextImageInfoKHR#semaphore` field. semaphore()
public VkAcquireNextImageInfoKHR.Buffer	semaphore(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#semaphore` field.
public int	Returns: the value of the `VkAcquireNextImageInfoKHR#sType` field. sType()
public VkAcquireNextImageInfoKHR.Buffer	sType(int value) Sets the specified value to the `VkAcquireNextImageInfoKHR#sType` field.
public VkAcquireNextImageInfoKHR.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR` value to the `VkAcquireNextImageInfoKHR#sType` field.
public long	Returns: the value of the `VkAcquireNextImageInfoKHR#swapchain` field. swapchain()
public VkAcquireNextImageInfoKHR.Buffer	swapchain(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#swapchain` field.
public long	Returns: the value of the `VkAcquireNextImageInfoKHR#timeout` field. timeout()
public VkAcquireNextImageInfoKHR.Buffer	timeout(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#timeout` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkAcquireNextImageInfoKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkAcquireNextImageInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkAcquireNextImageInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

deviceMask	back to summary
public int deviceMask() Returns:int the value of the `VkAcquireNextImageInfoKHR#deviceMask` field. Annotations @NativeType:uint32_t

deviceMask	back to summary
public VkAcquireNextImageInfoKHR.Buffer deviceMask(int value) Sets the specified value to the `VkAcquireNextImageInfoKHR#deviceMask` field.

fence	back to summary
public long fence() Returns:long the value of the `VkAcquireNextImageInfoKHR#fence` field. Annotations @NativeType:VkFence

fence	back to summary
public VkAcquireNextImageInfoKHR.Buffer fence(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#fence` field.

getElementFactory

back to summary

protected VkAcquireNextImageInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkAcquireNextImageInfoKHR#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkAcquireNextImageInfoKHR.Buffer pNext(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#pNext` field.

self

back to summary

protected VkAcquireNextImageInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

semaphore	back to summary
public long semaphore() Returns:long the value of the `VkAcquireNextImageInfoKHR#semaphore` field. Annotations @NativeType:VkSemaphore

semaphore	back to summary
public VkAcquireNextImageInfoKHR.Buffer semaphore(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#semaphore` field.

sType	back to summary
public int sType() Returns:int the value of the `VkAcquireNextImageInfoKHR#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkAcquireNextImageInfoKHR.Buffer sType(int value) Sets the specified value to the `VkAcquireNextImageInfoKHR#sType` field.

sType$Default	back to summary
public VkAcquireNextImageInfoKHR.Buffer sType$Default() Sets the `STRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR` value to the `VkAcquireNextImageInfoKHR#sType` field.

swapchain	back to summary
public long swapchain() Returns:long the value of the `VkAcquireNextImageInfoKHR#swapchain` field. Annotations @NativeType:VkSwapchainKHR

swapchain	back to summary
public VkAcquireNextImageInfoKHR.Buffer swapchain(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#swapchain` field.

timeout	back to summary
public long timeout() Returns:long the value of the `VkAcquireNextImageInfoKHR#timeout` field. Annotations @NativeType:uint64_t

timeout	back to summary
public VkAcquireNextImageInfoKHR.Buffer timeout(long value) Sets the specified value to the `VkAcquireNextImageInfoKHR#timeout` field.

public Class VkAcquireNextImageInfoKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkAcquireNextImageInfoKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail