Package org.lwjgl.vulkan

Class VkCalibratedTimestampInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCalibratedTimestampInfoKHR>

org.lwjgl.vulkan.VkCalibratedTimestampInfoKHR

All Implemented Interfaces:

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

Direct Known Subclasses:

VkCalibratedTimestampInfoEXT

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

Structure specifying the input parameters of a calibrated timestamp query.

Valid Usage

• timeDomain must be one of the VkTimeDomainKHR values returned by GetPhysicalDeviceCalibrateableTimeDomainsKHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CALIBRATED_TIMESTAMP_INFO_KHR
• pNext must be NULL
• timeDomain must be a valid VkTimeDomainKHR value

See Also

GetCalibratedTimestampsEXT, GetCalibratedTimestampsKHR

Layout

 struct VkCalibratedTimestampInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkTimeDomainKHR timeDomain();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkCalibratedTimestampInfoKHR	calloc()	Returns a new VkCalibratedTimestampInfoKHR instance allocated with memCalloc.
static VkCalibratedTimestampInfoKHR.Buffer	calloc(int capacity)	Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated with memCalloc.
static VkCalibratedTimestampInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCalibratedTimestampInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCalibratedTimestampInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCalibratedTimestampInfoKHR	create()	Returns a new VkCalibratedTimestampInfoKHR instance allocated with BufferUtils.
static VkCalibratedTimestampInfoKHR.Buffer	create(int capacity)	Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated with BufferUtils.
static VkCalibratedTimestampInfoKHR	create(long address)	Returns a new VkCalibratedTimestampInfoKHR instance for the specified memory address.
static VkCalibratedTimestampInfoKHR.Buffer	create(long address, int capacity)	Create a VkCalibratedTimestampInfoKHR.Buffer instance at the specified memory.
static @Nullable VkCalibratedTimestampInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCalibratedTimestampInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkCalibratedTimestampInfoKHR	malloc()	Returns a new VkCalibratedTimestampInfoKHR instance allocated with memAlloc.
static VkCalibratedTimestampInfoKHR.Buffer	malloc(int capacity)	Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated with memAlloc.
static VkCalibratedTimestampInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkCalibratedTimestampInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCalibratedTimestampInfoKHR 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 int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntimeDomain(long struct)	Unsafe version of timeDomain().
static void	ntimeDomain(long struct, int value)	Unsafe version of timeDomain.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkCalibratedTimestampInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkCalibratedTimestampInfoKHR	set(int sType, long pNext, int timeDomain)	Initializes this struct with the specified values.
VkCalibratedTimestampInfoKHR	set(VkCalibratedTimestampInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkCalibratedTimestampInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkCalibratedTimestampInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_CALIBRATED_TIMESTAMP_INFO_KHR value to the sType() field.
int	timeDomain()	a VkTimeDomainKHR value specifying the time domain from which the calibrated timestamp value should be returned.
VkCalibratedTimestampInfoKHR	timeDomain(int value)	Sets the specified value to the timeDomain() 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.

TIMEDOMAIN

public static final int TIMEDOMAIN

The struct member offsets.

Constructor Details

VkCalibratedTimestampInfoKHR

public VkCalibratedTimestampInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

timeDomain

public int timeDomain()

a VkTimeDomainKHR value specifying the time domain from which the calibrated timestamp value should be returned.

sType

public VkCalibratedTimestampInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCalibratedTimestampInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_CALIBRATED_TIMESTAMP_INFO_KHR value to the sType() field.

pNext

public VkCalibratedTimestampInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

timeDomain

public VkCalibratedTimestampInfoKHR timeDomain(int value)

Sets the specified value to the timeDomain() field.

set

public VkCalibratedTimestampInfoKHR set(int sType,
 long pNext,
 int timeDomain)

Initializes this struct with the specified values.

set

public VkCalibratedTimestampInfoKHR set(VkCalibratedTimestampInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkCalibratedTimestampInfoKHR malloc()

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

calloc

public static VkCalibratedTimestampInfoKHR calloc()

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

create

public static VkCalibratedTimestampInfoKHR create()

Returns a new VkCalibratedTimestampInfoKHR instance allocated with BufferUtils.

create

public static VkCalibratedTimestampInfoKHR create(long address)

Returns a new VkCalibratedTimestampInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkCalibratedTimestampInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkCalibratedTimestampInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkCalibratedTimestampInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkCalibratedTimestampInfoKHR.Buffer create(int capacity)

Returns a new VkCalibratedTimestampInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkCalibratedTimestampInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkCalibratedTimestampInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntimeDomain

public static int ntimeDomain(long struct)

Unsafe version of timeDomain().

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.

ntimeDomain

public static void ntimeDomain(long struct,
 int value)

Unsafe version of timeDomain.