Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAcquireProfilingLockInfoKHR

extends Struct<VkAcquireProfilingLockInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters to acquire the profiling lock.
Valid Usage (Implicit)

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

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
TIMEOUT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkAcquireProfilingLockInfoKHR(long address, ByteBuffer container)

public
VkAcquireProfilingLockInfoKHR(ByteBuffer container)

Creates a VkAcquireProfilingLockInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkAcquireProfilingLockInfoKHR
calloc()

Returns a new VkAcquireProfilingLockInfoKHR instance allocated with memCalloc.

public static VkAcquireProfilingLockInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with memCalloc.

public static VkAcquireProfilingLockInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkAcquireProfilingLockInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkAcquireProfilingLockInfoKHR
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 VkAcquireProfilingLockInfoKHR
create()

Returns a new VkAcquireProfilingLockInfoKHR instance allocated with BufferUtils.

public static VkAcquireProfilingLockInfoKHR
create(long address)

Returns a new VkAcquireProfilingLockInfoKHR instance for the specified memory address.

public static VkAcquireProfilingLockInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkAcquireProfilingLockInfoKHR.Buffer instance at the specified memory.

public static VkAcquireProfilingLockInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkAcquireProfilingLockInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkAcquireProfilingLockInfoKHR
malloc()

Returns a new VkAcquireProfilingLockInfoKHR instance allocated with memAlloc.

public static VkAcquireProfilingLockInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with memAlloc.

public static VkAcquireProfilingLockInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkAcquireProfilingLockInfoKHR instance allocated on the specified MemoryStack.

public static VkAcquireProfilingLockInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static long
ntimeout(long struct)

Unsafe version of timeout.

public static void
ntimeout(long struct, long value)

Unsafe version of timeout.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkAcquireProfilingLockInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkAcquireProfilingLockInfoKHR

Returns:

this struct
set
(VkAcquireProfilingLockInfoKHR
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 VkAcquireProfilingLockInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkAcquireProfilingLockInfoKHR
public long
timeout()

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

public VkAcquireProfilingLockInfoKHR
timeout(long value)

Sets the specified value to the timeout field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

TIMEOUTback to summary
public static final int TIMEOUT

The struct member offsets.

Constructor Detail

VkAcquireProfilingLockInfoKHRback to summary
protected VkAcquireProfilingLockInfoKHR(long address, ByteBuffer container)
VkAcquireProfilingLockInfoKHRback to summary
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 Detail

callocback to summary
public static VkAcquireProfilingLockInfoKHR calloc()

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

callocback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAcquireProfilingLockInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkAcquireProfilingLockInfoKHR 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
createback to summary
public static VkAcquireProfilingLockInfoKHR create()

Returns a new VkAcquireProfilingLockInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkAcquireProfilingLockInfoKHR create(long address)

Returns a new VkAcquireProfilingLockInfoKHR instance for the specified memory address.

createback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer create(int capacity)

Returns a new VkAcquireProfilingLockInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAcquireProfilingLockInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAcquireProfilingLockInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkAcquireProfilingLockFlagsKHR
flagsback to summary
public VkAcquireProfilingLockInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkAcquireProfilingLockInfoKHR malloc()

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

mallocback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAcquireProfilingLockInfoKHR malloc(MemoryStack stack)

Returns a new VkAcquireProfilingLockInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkAcquireProfilingLockInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

ntimeoutback to summary
public static long ntimeout(long struct)

Unsafe version of timeout.

ntimeoutback to summary
public static void ntimeout(long struct, long value)

Unsafe version of timeout.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkAcquireProfilingLockInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkAcquireProfilingLockInfoKHR set(VkAcquireProfilingLockInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkAcquireProfilingLockInfoKHR

the source struct

Returns:VkAcquireProfilingLockInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAcquireProfilingLockInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkAcquireProfilingLockInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR value to the sType field.

timeoutback to summary
public long timeout()

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

Annotations
@NativeType:uint64_t
timeoutback to summary
public VkAcquireProfilingLockInfoKHR timeout(long value)

Sets the specified value to the timeout field.

org.lwjgl.vulkan back to summary

public Class VkAcquireProfilingLockInfoKHR.Buffer

extends StructBuffer<VkAcquireProfilingLockInfoKHR, VkAcquireProfilingLockInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkAcquireProfilingLockInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkAcquireProfilingLockInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAcquireProfilingLockInfoKHR.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 TypeMethod and Description
public int

Returns:

the value of the VkAcquireProfilingLockInfoKHR#flags field.
flags
()

public VkAcquireProfilingLockInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#flags field.

protected VkAcquireProfilingLockInfoKHR
public long

Returns:

the value of the VkAcquireProfilingLockInfoKHR#pNext field.
pNext
()

public VkAcquireProfilingLockInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#pNext field.

protected VkAcquireProfilingLockInfoKHR.Buffer
public int

Returns:

the value of the VkAcquireProfilingLockInfoKHR#sType field.
sType
()

public VkAcquireProfilingLockInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#sType field.

public VkAcquireProfilingLockInfoKHR.Buffer
public long

Returns:

the value of the VkAcquireProfilingLockInfoKHR#timeout field.
timeout
()

public VkAcquireProfilingLockInfoKHR.Buffer
timeout(long value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#timeout field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAcquireProfilingLockInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkAcquireProfilingLockInfoKHR.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 VkAcquireProfilingLockInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public int flags()
Returns:int

the value of the VkAcquireProfilingLockInfoKHR#flags field.

Annotations
@NativeType:VkAcquireProfilingLockFlagsKHR
flagsback to summary
public VkAcquireProfilingLockInfoKHR.Buffer flags(int value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#flags field.

getElementFactoryback to summary
protected VkAcquireProfilingLockInfoKHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkAcquireProfilingLockInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkAcquireProfilingLockInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#pNext field.

selfback to summary
protected VkAcquireProfilingLockInfoKHR.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkAcquireProfilingLockInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAcquireProfilingLockInfoKHR.Buffer sType(int value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#sType field.

sType$Defaultback to summary
public VkAcquireProfilingLockInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_ACQUIRE_PROFILING_LOCK_INFO_KHR value to the VkAcquireProfilingLockInfoKHR#sType field.

timeoutback to summary
public long timeout()
Returns:long

the value of the VkAcquireProfilingLockInfoKHR#timeout field.

Annotations
@NativeType:uint64_t
timeoutback to summary
public VkAcquireProfilingLockInfoKHR.Buffer timeout(long value)

Sets the specified value to the VkAcquireProfilingLockInfoKHR#timeout field.