Package org.lwjgl.vulkan
Class VkAcquireNextImageInfoKHR
- 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 thedeviceMask
. 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 notNULL_HANDLE
it must be unsignaled - If
semaphore
is notNULL_HANDLE
it must not have any uncompleted signal or wait operations pending - If
fence
is notNULL_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
andfence
must not both be equal toNULL_HANDLE
deviceMask
must be a valid device maskdeviceMask
must not be zero
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_ACQUIRE_NEXT_IMAGE_INFO_KHR
pNext
must beNULL
swapchain
must be a validVkSwapchainKHR
handle- If
semaphore
is notNULL_HANDLE
,semaphore
must be a validVkSemaphore
handle - If
fence
is notNULL_HANDLE
,fence
must be a validVkFence
handle - Each of
fence
,semaphore
, andswapchain
that are valid handles must have been created, allocated, or retrieved from the sameVkInstance
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
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 Description static class
VkAcquireNextImageInfoKHR.Buffer
An array ofVkAcquireNextImageInfoKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkAcquireNextImageInfoKHR(java.nio.ByteBuffer container)
Creates aVkAcquireNextImageInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkAcquireNextImageInfoKHR
calloc()
Returns a newVkAcquireNextImageInfoKHR
instance allocated withmemCalloc
.static VkAcquireNextImageInfoKHR.Buffer
calloc(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withmemCalloc
.static VkAcquireNextImageInfoKHR
callocStack()
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAcquireNextImageInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAcquireNextImageInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAcquireNextImageInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAcquireNextImageInfoKHR
create()
Returns a newVkAcquireNextImageInfoKHR
instance allocated withBufferUtils
.static VkAcquireNextImageInfoKHR.Buffer
create(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withBufferUtils
.static VkAcquireNextImageInfoKHR
create(long address)
Returns a newVkAcquireNextImageInfoKHR
instance for the specified memory address.static VkAcquireNextImageInfoKHR.Buffer
create(long address, int capacity)
Create aVkAcquireNextImageInfoKHR.Buffer
instance at the specified memory.static VkAcquireNextImageInfoKHR
createSafe(long address)
static VkAcquireNextImageInfoKHR.Buffer
createSafe(long address, int capacity)
int
deviceMask()
Returns the value of thedeviceMask
field.VkAcquireNextImageInfoKHR
deviceMask(int value)
Sets the specified value to thedeviceMask
field.long
fence()
Returns the value of thefence
field.VkAcquireNextImageInfoKHR
fence(long value)
Sets the specified value to thefence
field.static VkAcquireNextImageInfoKHR
malloc()
Returns a newVkAcquireNextImageInfoKHR
instance allocated withmemAlloc
.static VkAcquireNextImageInfoKHR.Buffer
malloc(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withmemAlloc
.static VkAcquireNextImageInfoKHR
mallocStack()
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the thread-localMemoryStack
.static VkAcquireNextImageInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkAcquireNextImageInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkAcquireNextImageInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the specifiedMemoryStack
.static int
ndeviceMask(long struct)
Unsafe version ofdeviceMask()
.static void
ndeviceMask(long struct, int value)
Unsafe version ofdeviceMask
.static long
nfence(long struct)
Unsafe version offence()
.static void
nfence(long struct, long value)
Unsafe version offence
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static long
nsemaphore(long struct)
Unsafe version ofsemaphore()
.static void
nsemaphore(long struct, long value)
Unsafe version ofsemaphore
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static long
nswapchain(long struct)
Unsafe version ofswapchain()
.static void
nswapchain(long struct, long value)
Unsafe version ofswapchain
.static long
ntimeout(long struct)
Unsafe version oftimeout()
.static void
ntimeout(long struct, long value)
Unsafe version oftimeout
.long
pNext()
Returns the value of thepNext
field.VkAcquireNextImageInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.long
semaphore()
Returns the value of thesemaphore
field.VkAcquireNextImageInfoKHR
semaphore(long value)
Sets the specified value to thesemaphore
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 thesType
field.VkAcquireNextImageInfoKHR
sType(int value)
Sets the specified value to thesType
field.long
swapchain()
Returns the value of theswapchain
field.VkAcquireNextImageInfoKHR
swapchain(long value)
Sets the specified value to theswapchain
field.long
timeout()
Returns the value of thetimeout
field.VkAcquireNextImageInfoKHR
timeout(long value)
Sets the specified value to thetimeout
field.
-
-
-
Constructor Detail
-
VkAcquireNextImageInfoKHR
public VkAcquireNextImageInfoKHR(java.nio.ByteBuffer container)
Creates aVkAcquireNextImageInfoKHR
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
swapchain
public long swapchain()
Returns the value of theswapchain
field.
-
timeout
public long timeout()
Returns the value of thetimeout
field.
-
semaphore
public long semaphore()
Returns the value of thesemaphore
field.
-
fence
public long fence()
Returns the value of thefence
field.
-
deviceMask
public int deviceMask()
Returns the value of thedeviceMask
field.
-
sType
public VkAcquireNextImageInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkAcquireNextImageInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
swapchain
public VkAcquireNextImageInfoKHR swapchain(long value)
Sets the specified value to theswapchain
field.
-
timeout
public VkAcquireNextImageInfoKHR timeout(long value)
Sets the specified value to thetimeout
field.
-
semaphore
public VkAcquireNextImageInfoKHR semaphore(long value)
Sets the specified value to thesemaphore
field.
-
fence
public VkAcquireNextImageInfoKHR fence(long value)
Sets the specified value to thefence
field.
-
deviceMask
public VkAcquireNextImageInfoKHR deviceMask(int value)
Sets the specified value to thedeviceMask
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 newVkAcquireNextImageInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkAcquireNextImageInfoKHR calloc()
Returns a newVkAcquireNextImageInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkAcquireNextImageInfoKHR create()
Returns a newVkAcquireNextImageInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkAcquireNextImageInfoKHR create(long address)
Returns a newVkAcquireNextImageInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkAcquireNextImageInfoKHR createSafe(long address)
-
malloc
public static VkAcquireNextImageInfoKHR.Buffer malloc(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkAcquireNextImageInfoKHR.Buffer calloc(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAcquireNextImageInfoKHR.Buffer create(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAcquireNextImageInfoKHR.Buffer create(long address, int capacity)
Create aVkAcquireNextImageInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkAcquireNextImageInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkAcquireNextImageInfoKHR mallocStack()
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkAcquireNextImageInfoKHR callocStack()
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkAcquireNextImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkAcquireNextImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR
instance allocated on the specifiedMemoryStack
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 newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
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 newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkAcquireNextImageInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAcquireNextImageInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nswapchain
public static long nswapchain(long struct)
Unsafe version ofswapchain()
.
-
ntimeout
public static long ntimeout(long struct)
Unsafe version oftimeout()
.
-
nsemaphore
public static long nsemaphore(long struct)
Unsafe version ofsemaphore()
.
-
nfence
public static long nfence(long struct)
Unsafe version offence()
.
-
ndeviceMask
public static int ndeviceMask(long struct)
Unsafe version ofdeviceMask()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nswapchain
public static void nswapchain(long struct, long value)
Unsafe version ofswapchain
.
-
ntimeout
public static void ntimeout(long struct, long value)
Unsafe version oftimeout
.
-
nsemaphore
public static void nsemaphore(long struct, long value)
Unsafe version ofsemaphore
.
-
nfence
public static void nfence(long struct, long value)
Unsafe version offence
.
-
ndeviceMask
public static void ndeviceMask(long struct, int value)
Unsafe version ofdeviceMask
.
-
-