The list of presentation identifiers.

Description

For applications to be able to reference specific presentation events queued by a call to vkQueuePresentKHR, an identifier needs to be associated with them. When the presentId feature is enabled, applications can include the VkPresentIdKHR structure in the pNext chain of the VkPresentInfoKHR structure to supply identifiers.

Each VkSwapchainKHR has a presentId associated with it. This value is initially set to zero when the VkSwapchainKHR is created.

When a VkPresentIdKHR structure with a non-NULL pPresentIds is included in the pNext chain of a VkPresentInfoKHR structure, each pSwapchains entry has a presentId associated in the pPresentIds array at the same index as the swapchain in the pSwapchains array. If this presentId is non-zero, then the application can later use this value to refer to that image presentation. A value of zero indicates that this presentation has no associated presentId. A non-zero presentId must be greater than any non-zero presentId passed previously by the application for the same swapchain.

There is no requirement for any precise timing relationship between the presentation of the image to the user and the update of the presentId value, but implementations should make this as close as possible to the presentation of the first pixel in the new image to the user.

Valid Usage

swapchainCount must be the same value as VkPresentInfoKHR::swapchainCount, where this VkPresentIdKHR is in the pNext chain of the VkPresentInfoKHR structure
Each presentIds entry must be greater than any previous presentIds entry passed for the associated pSwapchains entry

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PRESENT_ID_KHR
If pPresentIds is not NULL, pPresentIds must be a valid pointer to an array of swapchainCount uint64_t values
swapchainCount must be greater than 0

Layout


struct VkPresentIdKHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t swapchainCount;
    uint64_t const * pPresentIds;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PNEXT The struct member offsets.
public static final int	PPRESENTIDS 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.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static VkPresentIdKHR	calloc() Returns a new `VkPresentIdKHR` instance allocated with `memCalloc`.
public static VkPresentIdKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPresentIdKHR.Buffer` instance allocated with `memCalloc`.
public static VkPresentIdKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPresentIdKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPresentIdKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPresentIdKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkPresentIdKHR	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 VkPresentIdKHR	create() Returns a new `VkPresentIdKHR` instance allocated with `BufferUtils`.
public static VkPresentIdKHR	create(long address) Returns a new `VkPresentIdKHR` instance for the specified memory address.
public static VkPresentIdKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkPresentIdKHR.Buffer` instance allocated with `BufferUtils`.
public static VkPresentIdKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPresentIdKHR.Buffer` instance at the specified memory.
public static VkPresentIdKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPresentIdKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPresentIdKHR	malloc() Returns a new `VkPresentIdKHR` instance allocated with `memAlloc`.
public static VkPresentIdKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPresentIdKHR.Buffer` instance allocated with `memAlloc`.
public static VkPresentIdKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPresentIdKHR` instance allocated on the specified `MemoryStack`.
public static VkPresentIdKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPresentIdKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static LongBuffer	npPresentIds(long struct) Unsafe version of `pPresentIds`.
public static void	npPresentIds(long struct, LongBuffer value) Unsafe version of `pPresentIds`.
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 long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPresentIdKHR	pNext(long value) Sets the specified value to the `pNext` field.
public LongBuffer	pPresentIds() `NULL` or a pointer to an array of `uint64_t` with `swapchainCount` entries.
public VkPresentIdKHR	pPresentIds(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pPresentIds` field.
public VkPresentIdKHR	set(int sType, long pNext, int swapchainCount, LongBuffer pPresentIds) Initializes this struct with the specified values.
public VkPresentIdKHR	Returns: this struct set(VkPresentIdKHR 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 VkPresentIdKHR	sType(int value) Sets the specified value to the `sType` field.
public VkPresentIdKHR	sType$Default() Sets the `STRUCTURE_TYPE_PRESENT_ID_KHR` value to the `sType` field.
public int	swapchainCount() the number of swapchains being presented to the `vkQueuePresentKHR` command.
public VkPresentIdKHR	swapchainCount(int value) Sets the specified value to the `swapchainCount` field.

Field Detail

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

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

PPRESENTIDS	back to summary
public static final int PPRESENTIDS 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.

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

Constructor Detail

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

VkPresentIdKHR back to summary

VkPresentIdKHR	back to summary
public VkPresentIdKHR(ByteBuffer container) Creates a `VkPresentIdKHR` 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 VkPresentIdKHR(ByteBuffer container)

Creates a VkPresentIdKHR 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 VkPresentIdKHR calloc() Returns a new `VkPresentIdKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkPresentIdKHR.Buffer calloc(int capacity)

Returns a new VkPresentIdKHR.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 VkPresentIdKHR calloc(MemoryStack stack) Returns a new `VkPresentIdKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkPresentIdKHR calloc(MemoryStack stack)

Returns a new VkPresentIdKHR 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 VkPresentIdKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkPresentIdKHR.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 VkPresentIdKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPresentIdKHR.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

create back to summary

create	back to summary
protected VkPresentIdKHR 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 VkPresentIdKHR 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 VkPresentIdKHR create() Returns a new `VkPresentIdKHR` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkPresentIdKHR.Buffer create(int capacity)

Returns a new VkPresentIdKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkPresentIdKHR.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 VkPresentIdKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkPresentIdKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

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

malloc back to summary

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

public static VkPresentIdKHR.Buffer malloc(int capacity)

Returns a new VkPresentIdKHR.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 VkPresentIdKHR malloc(MemoryStack stack) Returns a new `VkPresentIdKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkPresentIdKHR malloc(MemoryStack stack)

Returns a new VkPresentIdKHR 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 VkPresentIdKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkPresentIdKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

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`.

npPresentIds back to summary

npPresentIds	back to summary
public static LongBuffer npPresentIds(long struct) Unsafe version of `pPresentIds`. Annotations @Nullable

public static LongBuffer npPresentIds(long struct)

Unsafe version of pPresentIds.

Annotations

@Nullable

npPresentIds	back to summary
public static void npPresentIds(long struct, LongBuffer value) Unsafe version of `pPresentIds`.

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`.

nswapchainCount	back to summary
public static int nswapchainCount(long struct) Unsafe version of `swapchainCount`.

nswapchainCount	back to summary
public static void nswapchainCount(long struct, int value) Sets the specified value to the `swapchainCount` field of the specified `struct`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

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

pPresentIds back to summary

pPresentIds	back to summary
public LongBuffer pPresentIds() `NULL` or a pointer to an array of `uint64_t` with `swapchainCount` entries. If not `NULL`, each non-zero value in `pPresentIds` specifies the present id to be associated with the presentation of the swapchain with the same index in the `QueuePresentKHR` call. Annotations @Nullable @NativeType:uint64_t const *

public LongBuffer pPresentIds()

NULL or a pointer to an array of uint64_t with swapchainCount entries. If not NULL, each non-zero value in pPresentIds specifies the present id to be associated with the presentation of the swapchain with the same index in the QueuePresentKHR call.

Annotations

@Nullable
@NativeType:uint64_t const *

pPresentIds	back to summary
public VkPresentIdKHR pPresentIds(LongBuffer value) Sets the address of the specified `LongBuffer` to the `pPresentIds` field.

set	back to summary
public VkPresentIdKHR set(int sType, long pNext, int swapchainCount, LongBuffer pPresentIds) Initializes this struct with the specified values.

set	back to summary
public VkPresentIdKHR set(VkPresentIdKHR src) Copies the specified struct data to this struct. Parameters src:VkPresentIdKHR the source struct Returns:VkPresentIdKHR this struct

set

back to summary

public VkPresentIdKHR set(VkPresentIdKHR src)

Copies the specified struct data to this struct.

Parameters

src:VkPresentIdKHR: the source struct

Returns:VkPresentIdKHR

this struct

sizeof back to summary

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

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

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

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

sType$Default	back to summary
public VkPresentIdKHR sType$Default() Sets the `STRUCTURE_TYPE_PRESENT_ID_KHR` value to the `sType` field.

swapchainCount back to summary

swapchainCount	back to summary
public int swapchainCount() the number of swapchains being presented to the `vkQueuePresentKHR` command. Annotations @NativeType:uint32_t

public int swapchainCount()

the number of swapchains being presented to the vkQueuePresentKHR command.

Annotations

@NativeType:uint32_t

swapchainCount	back to summary
public VkPresentIdKHR swapchainCount(int value) Sets the specified value to the `swapchainCount` field.

org.lwjgl.vulkan back to summary

public Class VkPresentIdKHR.Buffer

Class Inheritance

extends StructBuffer<VkPresentIdKHR, VkPresentIdKHR.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of VkPresentIdKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkPresentIdKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkPresentIdKHR.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
protected VkPresentIdKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkPresentIdKHR#pNext` field. pNext()
public VkPresentIdKHR.Buffer	pNext(long value) Sets the specified value to the `VkPresentIdKHR#pNext` field.
public LongBuffer	Returns: a `LongBuffer` view of the data pointed to by the `VkPresentIdKHR#pPresentIds` field. pPresentIds()
public VkPresentIdKHR.Buffer	pPresentIds(LongBuffer value) Sets the address of the specified `LongBuffer` to the `VkPresentIdKHR#pPresentIds` field.
protected VkPresentIdKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkPresentIdKHR#sType` field. sType()
public VkPresentIdKHR.Buffer	sType(int value) Sets the specified value to the `VkPresentIdKHR#sType` field.
public VkPresentIdKHR.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_PRESENT_ID_KHR` value to the `VkPresentIdKHR#sType` field.
public int	Returns: the value of the `VkPresentIdKHR#swapchainCount` field. swapchainCount()
public VkPresentIdKHR.Buffer	swapchainCount(int value) Sets the specified value to the `VkPresentIdKHR#swapchainCount` 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 VkPresentIdKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkPresentIdKHR.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 VkPresentIdKHR#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

getElementFactory

back to summary

protected VkPresentIdKHR getElementFactory()

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

Annotations

@Override

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

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

pPresentIds	back to summary
public LongBuffer pPresentIds() Returns:LongBuffer a `LongBuffer` view of the data pointed to by the `VkPresentIdKHR#pPresentIds` field. Annotations @Nullable @NativeType:uint64_t const *

pPresentIds	back to summary
public VkPresentIdKHR.Buffer pPresentIds(LongBuffer value) Sets the address of the specified `LongBuffer` to the `VkPresentIdKHR#pPresentIds` field.

self

back to summary

protected VkPresentIdKHR.Buffer self()

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

Annotations

@Override

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

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

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

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

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