Package org.lwjgl.vulkan

Class VkLatencySubmissionPresentIdNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkLatencySubmissionPresentIdNV>

org.lwjgl.vulkan.VkLatencySubmissionPresentIdNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkLatencySubmissionPresentIdNV
extends org.lwjgl.system.Struct<VkLatencySubmissionPresentIdNV>
implements org.lwjgl.system.NativeResource

Structure used to associate a queueSubmit with a presentId.

Description

For any submission to be tracked with low latency mode pacing, it needs to be associated with other submissions in a given present. To associate a submission with presentID for low latency mode, the pNext chain of QueueSubmit must include a VkLatencySubmissionPresentIdNV structure.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV

Layout

 struct VkLatencySubmissionPresentIdNV {
     VkStructureType sType();
     void const * pNext();
     uint64_t presentID();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkLatencySubmissionPresentIdNV.Buffer	An array of VkLatencySubmissionPresentIdNV structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PRESENTID	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkLatencySubmissionPresentIdNV(ByteBuffer container)	Creates a VkLatencySubmissionPresentIdNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkLatencySubmissionPresentIdNV	calloc()	Returns a new VkLatencySubmissionPresentIdNV instance allocated with memCalloc.
static VkLatencySubmissionPresentIdNV.Buffer	calloc(int capacity)	Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated with memCalloc.
static VkLatencySubmissionPresentIdNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLatencySubmissionPresentIdNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySubmissionPresentIdNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLatencySubmissionPresentIdNV	create()	Returns a new VkLatencySubmissionPresentIdNV instance allocated with BufferUtils.
static VkLatencySubmissionPresentIdNV.Buffer	create(int capacity)	Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated with BufferUtils.
static VkLatencySubmissionPresentIdNV	create(long address)	Returns a new VkLatencySubmissionPresentIdNV instance for the specified memory address.
static VkLatencySubmissionPresentIdNV.Buffer	create(long address, int capacity)	Create a VkLatencySubmissionPresentIdNV.Buffer instance at the specified memory.
static @Nullable VkLatencySubmissionPresentIdNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkLatencySubmissionPresentIdNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkLatencySubmissionPresentIdNV	malloc()	Returns a new VkLatencySubmissionPresentIdNV instance allocated with memAlloc.
static VkLatencySubmissionPresentIdNV.Buffer	malloc(int capacity)	Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated with memAlloc.
static VkLatencySubmissionPresentIdNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated on the specified MemoryStack.
static VkLatencySubmissionPresentIdNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkLatencySubmissionPresentIdNV instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	npresentID(long struct)	Unsafe version of presentID().
static void	npresentID(long struct, long value)	Unsafe version of presentID.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkLatencySubmissionPresentIdNV	pNext(long value)	Sets the specified value to the pNext() field.
long	presentID()	used to associate the vkQueueSubmit with the presentId used for a given vkQueuePresentKHR via VkPresentIdKHR::pPresentIds.
VkLatencySubmissionPresentIdNV	presentID(long value)	Sets the specified value to the presentID() field.
VkLatencySubmissionPresentIdNV	set(int sType, long pNext, long presentID)	Initializes this struct with the specified values.
VkLatencySubmissionPresentIdNV	set(VkLatencySubmissionPresentIdNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkLatencySubmissionPresentIdNV	sType(int value)	Sets the specified value to the sType() field.
VkLatencySubmissionPresentIdNV	sType$Default()	Sets the STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

PRESENTID

public static final int PRESENTID

The struct member offsets.

Constructor Details

VkLatencySubmissionPresentIdNV

public VkLatencySubmissionPresentIdNV(ByteBuffer container)

Creates a VkLatencySubmissionPresentIdNV 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkLatencySubmissionPresentIdNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

presentID

public long presentID()

used to associate the vkQueueSubmit with the presentId used for a given vkQueuePresentKHR via VkPresentIdKHR::pPresentIds.

sType

public VkLatencySubmissionPresentIdNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkLatencySubmissionPresentIdNV sType$Default()

Sets the STRUCTURE_TYPE_LATENCY_SUBMISSION_PRESENT_ID_NV value to the sType() field.

pNext

public VkLatencySubmissionPresentIdNV pNext(long value)

Sets the specified value to the pNext() field.

presentID

public VkLatencySubmissionPresentIdNV presentID(long value)

Sets the specified value to the presentID() field.

set

public VkLatencySubmissionPresentIdNV set(int sType,
 long pNext,
 long presentID)

Initializes this struct with the specified values.

set

public VkLatencySubmissionPresentIdNV set(VkLatencySubmissionPresentIdNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkLatencySubmissionPresentIdNV malloc()

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

calloc

public static VkLatencySubmissionPresentIdNV calloc()

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

create

public static VkLatencySubmissionPresentIdNV create()

Returns a new VkLatencySubmissionPresentIdNV instance allocated with BufferUtils.

create

public static VkLatencySubmissionPresentIdNV create(long address)

Returns a new VkLatencySubmissionPresentIdNV instance for the specified memory address.

createSafe

public static @Nullable VkLatencySubmissionPresentIdNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkLatencySubmissionPresentIdNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkLatencySubmissionPresentIdNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkLatencySubmissionPresentIdNV.Buffer create(int capacity)

Returns a new VkLatencySubmissionPresentIdNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkLatencySubmissionPresentIdNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkLatencySubmissionPresentIdNV.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkLatencySubmissionPresentIdNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkLatencySubmissionPresentIdNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkLatencySubmissionPresentIdNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkLatencySubmissionPresentIdNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkLatencySubmissionPresentIdNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

npresentID

public static long npresentID(long struct)

Unsafe version of presentID().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

npresentID

public static void npresentID(long struct,
 long value)

Unsafe version of presentID.