Package org.lwjgl.vulkan

Class VkGetLatencyMarkerInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkGetLatencyMarkerInfoNV>

org.lwjgl.vulkan.VkGetLatencyMarkerInfoNV

All Implemented Interfaces:

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

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

Structure specifying the parameters of vkGetLatencyTimingsNV.

Description

If pTimings is NULL then the maximum number of queryable frame data is returned in timingCount. Otherwise, timingCount must be set by the application to the number of elements in the pTimings array, and on return the variable is overwritten with the number of values actually written to pTimings. The elements of pTimings are arranged in the order they were requested in, with the oldest data in the first entry.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV
• If timingCount is not 0, and pTimings is not NULL, pTimings must be a valid pointer to an array of timingCount VkLatencyTimingsFrameReportNV structures

See Also

VkLatencyTimingsFrameReportNV, GetLatencyTimingsNV

Layout

 struct VkGetLatencyMarkerInfoNV {
     VkStructureType sType();
     void const * pNext();
     uint32_t timingCount();
     VkLatencyTimingsFrameReportNV * pTimings();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkGetLatencyMarkerInfoNV.Buffer	An array of VkGetLatencyMarkerInfoNV 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	PTIMINGS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TIMINGCOUNT	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
VkGetLatencyMarkerInfoNV(ByteBuffer container)	Creates a VkGetLatencyMarkerInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkGetLatencyMarkerInfoNV	calloc()	Returns a new VkGetLatencyMarkerInfoNV instance allocated with memCalloc.
static VkGetLatencyMarkerInfoNV.Buffer	calloc(int capacity)	Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated with memCalloc.
static VkGetLatencyMarkerInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkGetLatencyMarkerInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkGetLatencyMarkerInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkGetLatencyMarkerInfoNV	create()	Returns a new VkGetLatencyMarkerInfoNV instance allocated with BufferUtils.
static VkGetLatencyMarkerInfoNV.Buffer	create(int capacity)	Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated with BufferUtils.
static VkGetLatencyMarkerInfoNV	create(long address)	Returns a new VkGetLatencyMarkerInfoNV instance for the specified memory address.
static VkGetLatencyMarkerInfoNV.Buffer	create(long address, int capacity)	Create a VkGetLatencyMarkerInfoNV.Buffer instance at the specified memory.
static @Nullable VkGetLatencyMarkerInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkGetLatencyMarkerInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkGetLatencyMarkerInfoNV	malloc()	Returns a new VkGetLatencyMarkerInfoNV instance allocated with memAlloc.
static VkGetLatencyMarkerInfoNV.Buffer	malloc(int capacity)	Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated with memAlloc.
static VkGetLatencyMarkerInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkGetLatencyMarkerInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkGetLatencyMarkerInfoNV 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 @Nullable VkLatencyTimingsFrameReportNV.Buffer	npTimings(long struct)	Unsafe version of pTimings().
static void	npTimings(long struct, @Nullable VkLatencyTimingsFrameReportNV.Buffer value)	Unsafe version of pTimings.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntimingCount(long struct)	Unsafe version of timingCount().
static void	ntimingCount(long struct, int value)	Sets the specified value to the timingCount field of the specified struct.
long	pNext()	either NULL or a pointer to a structure extending this structure.
VkGetLatencyMarkerInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable VkLatencyTimingsFrameReportNV.Buffer	pTimings()	either NULL or a pointer to an array of VkLatencyTimingsFrameReportNV structures.
VkGetLatencyMarkerInfoNV	pTimings(@Nullable VkLatencyTimingsFrameReportNV.Buffer value)	Sets the address of the specified VkLatencyTimingsFrameReportNV.Buffer to the pTimings() field.
VkGetLatencyMarkerInfoNV	set(int sType, long pNext, int timingCount, @Nullable VkLatencyTimingsFrameReportNV.Buffer pTimings)	Initializes this struct with the specified values.
VkGetLatencyMarkerInfoNV	set(VkGetLatencyMarkerInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkGetLatencyMarkerInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkGetLatencyMarkerInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV value to the sType() field.
int	timingCount()	an integer related to the number of previous frames of latency data available or queried, as described below.
VkGetLatencyMarkerInfoNV	timingCount(int value)	Sets the specified value to the timingCount() 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.

TIMINGCOUNT

public static final int TIMINGCOUNT

The struct member offsets.

PTIMINGS

public static final int PTIMINGS

The struct member offsets.

Constructor Details

VkGetLatencyMarkerInfoNV

public VkGetLatencyMarkerInfoNV(ByteBuffer container)

Creates a VkGetLatencyMarkerInfoNV 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<VkGetLatencyMarkerInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

either NULL or a pointer to a structure extending this structure.

timingCount

public int timingCount()

an integer related to the number of previous frames of latency data available or queried, as described below.

pTimings

public @Nullable VkLatencyTimingsFrameReportNV.Buffer pTimings()

either NULL or a pointer to an array of VkLatencyTimingsFrameReportNV structures.

sType

public VkGetLatencyMarkerInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkGetLatencyMarkerInfoNV sType$Default()

Sets the STRUCTURE_TYPE_GET_LATENCY_MARKER_INFO_NV value to the sType() field.

pNext

public VkGetLatencyMarkerInfoNV pNext(long value)

Sets the specified value to the pNext() field.

timingCount

public VkGetLatencyMarkerInfoNV timingCount(int value)

Sets the specified value to the timingCount() field.

pTimings

public VkGetLatencyMarkerInfoNV pTimings(@Nullable VkLatencyTimingsFrameReportNV.Buffer value)

Sets the address of the specified VkLatencyTimingsFrameReportNV.Buffer to the pTimings() field.

set

public VkGetLatencyMarkerInfoNV set(int sType,
 long pNext,
 int timingCount,
 @Nullable VkLatencyTimingsFrameReportNV.Buffer pTimings)

Initializes this struct with the specified values.

set

public VkGetLatencyMarkerInfoNV set(VkGetLatencyMarkerInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkGetLatencyMarkerInfoNV malloc()

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

calloc

public static VkGetLatencyMarkerInfoNV calloc()

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

create

public static VkGetLatencyMarkerInfoNV create()

Returns a new VkGetLatencyMarkerInfoNV instance allocated with BufferUtils.

create

public static VkGetLatencyMarkerInfoNV create(long address)

Returns a new VkGetLatencyMarkerInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkGetLatencyMarkerInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkGetLatencyMarkerInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkGetLatencyMarkerInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkGetLatencyMarkerInfoNV.Buffer create(int capacity)

Returns a new VkGetLatencyMarkerInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkGetLatencyMarkerInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkGetLatencyMarkerInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkGetLatencyMarkerInfoNV.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().

ntimingCount

public static int ntimingCount(long struct)

Unsafe version of timingCount().

npTimings

public static @Nullable VkLatencyTimingsFrameReportNV.Buffer npTimings(long struct)

Unsafe version of pTimings().

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.

ntimingCount

public static void ntimingCount(long struct,
 int value)

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

npTimings

public static void npTimings(long struct,
 @Nullable VkLatencyTimingsFrameReportNV.Buffer value)

Unsafe version of pTimings.