Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPresentInfoKHR

extends Struct<VkPresentInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing parameters of a queue presentation.
Description

Before an application can present an image, the image’s layout must be transitioned to the IMAGE_LAYOUT_PRESENT_SRC_KHR layout, or for a shared presentable image the IMAGE_LAYOUT_SHARED_PRESENT_KHR layout.

Note

When transitioning the image to IMAGE_LAYOUT_SHARED_PRESENT_KHR or IMAGE_LAYOUT_PRESENT_SRC_KHR, there is no need to delay subsequent processing, or perform any visibility operations (as QueuePresentKHR performs automatic visibility operations). To achieve this, the dstAccessMask member of the VkImageMemoryBarrier should be set to 0, and the dstStageMask parameter should be set to PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT.

Valid Usage
Valid Usage (Implicit)
See Also

QueuePresentKHR

Layout


struct VkPresentInfoKHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t waitSemaphoreCount;
    VkSemaphore const * pWaitSemaphores;
    uint32_t swapchainCount;
    VkSwapchainKHR const * pSwapchains;
    uint32_t const * pImageIndices;
    VkResult * pResults;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PIMAGEINDICES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PRESULTS

The struct member offsets.

public static final int
PSWAPCHAINS

The struct member offsets.

public static final int
PWAITSEMAPHORES

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
SWAPCHAINCOUNT

The struct member offsets.

public static final int
WAITSEMAPHORECOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPresentInfoKHR(long address, ByteBuffer container)

public
VkPresentInfoKHR(ByteBuffer container)

Creates a VkPresentInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPresentInfoKHR
calloc()

Returns a new VkPresentInfoKHR instance allocated with memCalloc.

public static VkPresentInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPresentInfoKHR.Buffer instance allocated with memCalloc.

public static VkPresentInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkPresentInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkPresentInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkPresentInfoKHR
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 VkPresentInfoKHR
create()

Returns a new VkPresentInfoKHR instance allocated with BufferUtils.

public static VkPresentInfoKHR
create(long address)

Returns a new VkPresentInfoKHR instance for the specified memory address.

public static VkPresentInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPresentInfoKHR.Buffer instance allocated with BufferUtils.

public static VkPresentInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkPresentInfoKHR.Buffer instance at the specified memory.

public static VkPresentInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPresentInfoKHR
malloc()

Returns a new VkPresentInfoKHR instance allocated with memAlloc.

public static VkPresentInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPresentInfoKHR.Buffer instance allocated with memAlloc.

public static VkPresentInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPresentInfoKHR instance allocated on the specified MemoryStack.

public static VkPresentInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkPresentInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPresentInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static IntBuffer
npImageIndices(long struct)

Unsafe version of pImageIndices.

public static void
npImageIndices(long struct, IntBuffer value)

Unsafe version of pImageIndices.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static IntBuffer
npResults(long struct)

Unsafe version of pResults.

public static void
npResults(long struct, IntBuffer value)

Unsafe version of pResults.

public static LongBuffer
npSwapchains(long struct)

Unsafe version of pSwapchains.

public static void
npSwapchains(long struct, LongBuffer value)

Unsafe version of pSwapchains.

public static LongBuffer
npWaitSemaphores(long struct)

Unsafe version of pWaitSemaphores.

public static void
npWaitSemaphores(long struct, LongBuffer value)

Unsafe version of pWaitSemaphores.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nswapchainCount(long struct)

Unsafe version of swapchainCount.

public static void
nswapchainCount(long struct, int value)

Sets the specified value to the swapchainCount field of the specified struct.

public static int
nwaitSemaphoreCount(long struct)

Unsafe version of waitSemaphoreCount.

public static void
nwaitSemaphoreCount(long struct, int value)

Sets the specified value to the waitSemaphoreCount field of the specified struct.

public IntBuffer
pImageIndices()

a pointer to an array of indices into the array of each swapchain’s presentable images, with swapchainCount entries.

public VkPresentInfoKHR
pImageIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the pImageIndices field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPresentInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkPresentInfoKHR
pNext(VkDeviceGroupPresentInfoKHR value)

Prepends the specified VkDeviceGroupPresentInfoKHR value to the pNext chain.

public VkPresentInfoKHR
pNext(VkDisplayPresentInfoKHR value)

Prepends the specified VkDisplayPresentInfoKHR value to the pNext chain.

public VkPresentInfoKHR
pNext(VkFrameBoundaryEXT value)

Prepends the specified VkFrameBoundaryEXT value to the pNext chain.

public VkPresentInfoKHR
pNext(VkPresentIdKHR value)

Prepends the specified VkPresentIdKHR value to the pNext chain.

public VkPresentInfoKHR
pNext(VkPresentRegionsKHR value)

Prepends the specified VkPresentRegionsKHR value to the pNext chain.

public VkPresentInfoKHR
pNext(VkPresentTimesInfoGOOGLE value)

Prepends the specified VkPresentTimesInfoGOOGLE value to the pNext chain.

public VkPresentInfoKHR
pNext(VkSwapchainPresentFenceInfoEXT value)

Prepends the specified VkSwapchainPresentFenceInfoEXT value to the pNext chain.

public VkPresentInfoKHR
pNext(VkSwapchainPresentModeInfoEXT value)

Prepends the specified VkSwapchainPresentModeInfoEXT value to the pNext chain.

public IntBuffer
pResults()

a pointer to an array of VkResult typed elements with swapchainCount entries.

public VkPresentInfoKHR
pResults(IntBuffer value)

Sets the address of the specified IntBuffer to the pResults field.

public LongBuffer
pSwapchains()

a pointer to an array of VkSwapchainKHR objects with swapchainCount entries.

public VkPresentInfoKHR
pSwapchains(LongBuffer value)

Sets the address of the specified LongBuffer to the pSwapchains field.

public LongBuffer
pWaitSemaphores()

NULL or a pointer to an array of VkSemaphore objects with waitSemaphoreCount entries, and specifies the semaphores to wait for before issuing the present request.

public VkPresentInfoKHR
pWaitSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the pWaitSemaphores field.

public VkPresentInfoKHR
set(int sType, long pNext, LongBuffer pWaitSemaphores, int swapchainCount, LongBuffer pSwapchains, IntBuffer pImageIndices, IntBuffer pResults)

Initializes this struct with the specified values.

public VkPresentInfoKHR

Returns:

this struct
set
(VkPresentInfoKHR
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 VkPresentInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkPresentInfoKHR
sType$Default()

Sets the STRUCTURE_TYPE_PRESENT_INFO_KHR value to the sType field.

public int
swapchainCount()

the number of swapchains being presented to by this command.

public VkPresentInfoKHR
swapchainCount(int value)

Sets the specified value to the swapchainCount field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
waitSemaphoreCount()

the number of semaphores to wait for before issuing the present request.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate