Package org.lwjgl.vulkan

Class VkAcquireProfilingLockInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAcquireProfilingLockInfoKHR>

org.lwjgl.vulkan.VkAcquireProfilingLockInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters to acquire the profiling lock.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR
• pNext must be NULL
• flags must be 0

If timeout is 0, vkAcquireProfilingLockKHR will not block while attempting to acquire the profiling lock. If timeout is UINT64_MAX, the function will not return until the profiling lock was acquired.

See Also

AcquireProfilingLockKHR

Layout

 struct VkAcquireProfilingLockInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkAcquireProfilingLockFlagsKHR flags();
     uint64_t timeout();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAcquireProfilingLockInfoKHR.Buffer	An array of VkAcquireProfilingLockInfoKHR 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	FLAGS	The struct member offsets.
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	TIMEOUT	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
VkAcquireProfilingLockInfoKHR(ByteBuffer container)	Creates a VkAcquireProfilingLockInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAcquireProfilingLockInfoKHR	calloc()	Returns a new VkAcquireProfilingLockInfoKHR instance allocated with memCalloc.
static VkAcquireProfilingLockInfoKHR.Buffer	calloc(int capacity)	Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with memCalloc.
static VkAcquireProfilingLockInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAcquireProfilingLockInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAcquireProfilingLockInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAcquireProfilingLockInfoKHR	create()	Returns a new VkAcquireProfilingLockInfoKHR instance allocated with BufferUtils.
static VkAcquireProfilingLockInfoKHR.Buffer	create(int capacity)	Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with BufferUtils.
static VkAcquireProfilingLockInfoKHR	create(long address)	Returns a new VkAcquireProfilingLockInfoKHR instance for the specified memory address.
static VkAcquireProfilingLockInfoKHR.Buffer	create(long address, int capacity)	Create a VkAcquireProfilingLockInfoKHR.Buffer instance at the specified memory.
static @Nullable VkAcquireProfilingLockInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAcquireProfilingLockInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkAcquireProfilingLockInfoKHR	flags(int value)	Sets the specified value to the flags() field.
static VkAcquireProfilingLockInfoKHR	malloc()	Returns a new VkAcquireProfilingLockInfoKHR instance allocated with memAlloc.
static VkAcquireProfilingLockInfoKHR.Buffer	malloc(int capacity)	Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with memAlloc.
static VkAcquireProfilingLockInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkAcquireProfilingLockInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAcquireProfilingLockInfoKHR instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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 long	ntimeout(long struct)	Unsafe version of timeout().
static void	ntimeout(long struct, long value)	Unsafe version of timeout.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAcquireProfilingLockInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkAcquireProfilingLockInfoKHR	set(int sType, long pNext, int flags, long timeout)	Initializes this struct with the specified values.
VkAcquireProfilingLockInfoKHR	set(VkAcquireProfilingLockInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkAcquireProfilingLockInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkAcquireProfilingLockInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR value to the sType() field.
long	timeout()	indicates how long the function waits, in nanoseconds, if the profiling lock is not available.
VkAcquireProfilingLockInfoKHR	timeout(long value)	Sets the specified value to the timeout() 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.

FLAGS

public static final int FLAGS

The struct member offsets.

TIMEOUT

public static final int TIMEOUT

The struct member offsets.

Constructor Details

VkAcquireProfilingLockInfoKHR

public VkAcquireProfilingLockInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

timeout

public long timeout()

indicates how long the function waits, in nanoseconds, if the profiling lock is not available.

sType

public VkAcquireProfilingLockInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAcquireProfilingLockInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR value to the sType() field.

pNext

public VkAcquireProfilingLockInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkAcquireProfilingLockInfoKHR flags(int value)

Sets the specified value to the flags() field.

timeout

public VkAcquireProfilingLockInfoKHR timeout(long value)

Sets the specified value to the timeout() field.

set

public VkAcquireProfilingLockInfoKHR set(int sType,
 long pNext,
 int flags,
 long timeout)

Initializes this struct with the specified values.

set

public VkAcquireProfilingLockInfoKHR set(VkAcquireProfilingLockInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAcquireProfilingLockInfoKHR malloc()

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

calloc

public static VkAcquireProfilingLockInfoKHR calloc()

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

create

public static VkAcquireProfilingLockInfoKHR create()

Returns a new VkAcquireProfilingLockInfoKHR instance allocated with BufferUtils.

create

public static VkAcquireProfilingLockInfoKHR create(long address)

Returns a new VkAcquireProfilingLockInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkAcquireProfilingLockInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAcquireProfilingLockInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAcquireProfilingLockInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAcquireProfilingLockInfoKHR.Buffer create(int capacity)

Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAcquireProfilingLockInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkAcquireProfilingLockInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

ntimeout

public static long ntimeout(long struct)

Unsafe version of timeout().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ntimeout

public static void ntimeout(long struct,
 long value)

Unsafe version of timeout.