Package org.lwjgl.vulkan
Class VkPresentInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPresentInfoKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPresentInfoKHR extends Struct
Khronos Reference Page
Vulkan SpecificationSpecifies the parameters of an image presentation.
Valid Usage
sTypemust beSTRUCTURE_TYPE_PRESENT_INFO_KHRpNextmust beNULL- If
waitSemaphoreCountis not 0, andpWaitSemaphoresis notNULL,pWaitSemaphoresmust be a pointer to an array ofwaitSemaphoreCountvalidVkSemaphorehandles pSwapchainsmust be a pointer to an array ofswapchainCountvalidVkSwapchainKHRhandlespImageIndicesmust be a pointer to an array ofswapchainCountuint32_tvalues- If
pResultsis notNULL,pResultsmust be a pointer to an array ofswapchainCountVkResultvalues swapchainCountmust be greater than 0- Each of the elements of
pSwapchainsand the elements ofpWaitSemaphoresthat are valid handles must have been created, allocated or retrieved from the sameVkInstance - Any given element of
pImageIndicesmust be the index of a presentable image acquired from the swapchain specified by the corresponding element of thepSwapchainsarray - Any given element of
VkSemaphoreinpWaitSemaphoresmust refer to a prior signal of thatVkSemaphorethat won't be consumed by any other wait on that semaphore
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_PRESENT_INFO_KHRpNext– reserved for use by extensionswaitSemaphoreCount– the number of semaphores to wait for before issuing the present request. The number may be zero.pWaitSemaphores– if non-NULL, is an array ofVkSemaphoreobjects withwaitSemaphoreCountentries, and specifies the semaphores to wait for before issuing the present requestswapchainCount– the number of swapchains being presented to by this commandpSwapchains– an array ofVkSwapchainKHRobjects withswapchainCountentries. A given swapchain must not appear in this list more than once.pImageIndices– an array of indices into the array of each swapchain’s presentable images, withswapchainCountentries. Each entry in this array identifies the image to present on the corresponding entry in thepSwapchainsarray.pResults– an array ofVkResulttyped elements withswapchainCountentries. Applications that don’t need per-swapchain results can useNULLforpResults. If non-NULL, each entry inpResultswill be set to theVkResultfor presenting the swapchain corresponding to the same index inpSwapchains.
Layout
struct VkPresentInfoKHR { VkStructureType sType; const void * pNext; uint32_t waitSemaphoreCount; const VkSemaphore * pWaitSemaphores; uint32_t swapchainCount; const VkSwapchainKHR * pSwapchains; const uint32_t * pImageIndices; VkResult * pResults; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkPresentInfoKHR.BufferAn array ofVkPresentInfoKHRstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkPresentInfoKHR(java.nio.ByteBuffer container)Creates aVkPresentInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkPresentInfoKHRcalloc()Returns a newVkPresentInfoKHRinstance allocated withmemCalloc.static VkPresentInfoKHR.Buffercalloc(int capacity)Returns a newVkPresentInfoKHR.Bufferinstance allocated withmemCalloc.static VkPresentInfoKHRcallocStack()Returns a newVkPresentInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPresentInfoKHR.BuffercallocStack(int capacity)Returns a newVkPresentInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPresentInfoKHR.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPresentInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPresentInfoKHRcallocStack(MemoryStack stack)Returns a newVkPresentInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPresentInfoKHRcreate()Returns a newVkPresentInfoKHRinstance allocated withBufferUtils.static VkPresentInfoKHR.Buffercreate(int capacity)Returns a newVkPresentInfoKHR.Bufferinstance allocated withBufferUtils.static VkPresentInfoKHRcreate(long address)Returns a newVkPresentInfoKHRinstance for the specified memory address ornullif the address isNULL.static VkPresentInfoKHR.Buffercreate(long address, int capacity)Create aVkPresentInfoKHR.Bufferinstance at the specified memory.static VkPresentInfoKHRmalloc()Returns a newVkPresentInfoKHRinstance allocated withmemAlloc.static VkPresentInfoKHR.Buffermalloc(int capacity)Returns a newVkPresentInfoKHR.Bufferinstance allocated withmemAlloc.static VkPresentInfoKHRmallocStack()Returns a newVkPresentInfoKHRinstance allocated on the thread-localMemoryStack.static VkPresentInfoKHR.BuffermallocStack(int capacity)Returns a newVkPresentInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkPresentInfoKHR.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPresentInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkPresentInfoKHRmallocStack(MemoryStack stack)Returns a newVkPresentInfoKHRinstance allocated on the specifiedMemoryStack.VkPresentInfoKHRnset(long struct)Unsafe version ofset.java.nio.IntBufferpImageIndices()Returns aIntBufferview of the data pointed to by thepImageIndicesfield.VkPresentInfoKHRpImageIndices(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepImageIndicesfield.longpNext()Returns the value of thepNextfield.VkPresentInfoKHRpNext(long value)Sets the specified value to thepNextfield.java.nio.IntBufferpResults()Returns aIntBufferview of the data pointed to by thepResultsfield.VkPresentInfoKHRpResults(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepResultsfield.java.nio.LongBufferpSwapchains()Returns aLongBufferview of the data pointed to by thepSwapchainsfield.VkPresentInfoKHRpSwapchains(java.nio.LongBuffer value)Sets the address of the specifiedLongBufferto thepSwapchainsfield.java.nio.LongBufferpWaitSemaphores()Returns aLongBufferview of the data pointed to by thepWaitSemaphoresfield.VkPresentInfoKHRpWaitSemaphores(java.nio.LongBuffer value)Sets the address of the specifiedLongBufferto thepWaitSemaphoresfield.VkPresentInfoKHRset(int sType, long pNext, java.nio.LongBuffer pWaitSemaphores, int swapchainCount, java.nio.LongBuffer pSwapchains, java.nio.IntBuffer pImageIndices, java.nio.IntBuffer pResults)Initializes this struct with the specified values.VkPresentInfoKHRset(VkPresentInfoKHR src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkPresentInfoKHRsType(int value)Sets the specified value to thesTypefield.intswapchainCount()Returns the value of theswapchainCountfield.VkPresentInfoKHRswapchainCount(int value)Sets the specified value to theswapchainCountfield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)CallsVkPresentInfoKHR.validate(long)for each struct contained in the specified struct array.intwaitSemaphoreCount()Returns the value of thewaitSemaphoreCountfield.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkPresentInfoKHR
public VkPresentInfoKHR(java.nio.ByteBuffer container)
Creates aVkPresentInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
waitSemaphoreCount
public int waitSemaphoreCount()
Returns the value of thewaitSemaphoreCountfield.
-
pWaitSemaphores
public java.nio.LongBuffer pWaitSemaphores()
Returns aLongBufferview of the data pointed to by thepWaitSemaphoresfield.
-
swapchainCount
public int swapchainCount()
Returns the value of theswapchainCountfield.
-
pSwapchains
public java.nio.LongBuffer pSwapchains()
Returns aLongBufferview of the data pointed to by thepSwapchainsfield.
-
pImageIndices
public java.nio.IntBuffer pImageIndices()
Returns aIntBufferview of the data pointed to by thepImageIndicesfield.
-
pResults
public java.nio.IntBuffer pResults()
Returns aIntBufferview of the data pointed to by thepResultsfield.
-
sType
public VkPresentInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPresentInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
pWaitSemaphores
public VkPresentInfoKHR pWaitSemaphores(java.nio.LongBuffer value)
Sets the address of the specifiedLongBufferto thepWaitSemaphoresfield.
-
swapchainCount
public VkPresentInfoKHR swapchainCount(int value)
Sets the specified value to theswapchainCountfield.
-
pSwapchains
public VkPresentInfoKHR pSwapchains(java.nio.LongBuffer value)
Sets the address of the specifiedLongBufferto thepSwapchainsfield.
-
pImageIndices
public VkPresentInfoKHR pImageIndices(java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepImageIndicesfield.
-
pResults
public VkPresentInfoKHR pResults(java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepResultsfield.
-
set
public VkPresentInfoKHR set(int sType, long pNext, java.nio.LongBuffer pWaitSemaphores, int swapchainCount, java.nio.LongBuffer pSwapchains, java.nio.IntBuffer pImageIndices, java.nio.IntBuffer pResults)
Initializes this struct with the specified values.
-
nset
public VkPresentInfoKHR nset(long struct)
Unsafe version ofset.
-
set
public VkPresentInfoKHR set(VkPresentInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPresentInfoKHR malloc()
Returns a newVkPresentInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPresentInfoKHR calloc()
Returns a newVkPresentInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPresentInfoKHR create()
Returns a newVkPresentInfoKHRinstance allocated withBufferUtils.
-
create
public static VkPresentInfoKHR create(long address)
Returns a newVkPresentInfoKHRinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPresentInfoKHR.Buffer malloc(int capacity)
Returns a newVkPresentInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPresentInfoKHR.Buffer calloc(int capacity)
Returns a newVkPresentInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPresentInfoKHR.Buffer create(int capacity)
Returns a newVkPresentInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPresentInfoKHR.Buffer create(long address, int capacity)
Create aVkPresentInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPresentInfoKHR mallocStack()
Returns a newVkPresentInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPresentInfoKHR callocStack()
Returns a newVkPresentInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPresentInfoKHR mallocStack(MemoryStack stack)
Returns a newVkPresentInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPresentInfoKHR callocStack(MemoryStack stack)
Returns a newVkPresentInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPresentInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkPresentInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPresentInfoKHR.Buffer callocStack(int capacity)
Returns a newVkPresentInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPresentInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPresentInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPresentInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPresentInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
validate
public static void validate(long array, int count)CallsVkPresentInfoKHR.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-