Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSemaphoreWaitInfo

extends Struct<VkSemaphoreWaitInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSemaphoreWaitInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure containing information about the semaphore wait condition.
Valid Usage
Valid Usage (Implicit)
See Also

WaitSemaphores, WaitSemaphoresKHR

Layout


struct VkSemaphoreWaitInfo {
    VkStructureType sType;
    void const * pNext;
    VkSemaphoreWaitFlags flags;
    uint32_t semaphoreCount;
    VkSemaphore const * pSemaphores;
    uint64_t const * pValues;
}

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
PSEMAPHORES

The struct member offsets.

public static final int
PVALUES

The struct member offsets.

public static final int
SEMAPHORECOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkSemaphoreWaitInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSemaphoreWaitInfo
calloc()

Returns a new VkSemaphoreWaitInfo instance allocated with memCalloc.

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

Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSemaphoreWaitInfo instance allocated with BufferUtils.

public static VkSemaphoreWaitInfo
create(long address)

Returns a new VkSemaphoreWaitInfo instance for the specified memory address.

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

Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with BufferUtils.

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

Create a VkSemaphoreWaitInfo.Buffer instance at the specified memory.

public static VkSemaphoreWaitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkSemaphoreWaitFlagBits specifying additional parameters for the semaphore wait operation.

public VkSemaphoreWaitInfo
flags(int value)

Sets the specified value to the flags field.

public static VkSemaphoreWaitInfo
malloc()

Returns a new VkSemaphoreWaitInfo instance allocated with memAlloc.

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

Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkSemaphoreWaitInfo instance allocated on the specified MemoryStack.

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

Returns a new VkSemaphoreWaitInfo.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 LongBuffer
npSemaphores(long struct)

Unsafe version of pSemaphores.

public static void
npSemaphores(long struct, LongBuffer value)

Unsafe version of pSemaphores.

public static LongBuffer
npValues(long struct)

Unsafe version of pValues.

public static void
npValues(long struct, LongBuffer value)

Unsafe version of pValues.

public static int
nsemaphoreCount(long struct)

Unsafe version of semaphoreCount.

public static void
nsemaphoreCount(long struct, int value)

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

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSemaphoreWaitInfo
pNext(long value)

Sets the specified value to the pNext field.

public LongBuffer
pSemaphores()

a pointer to an array of semaphoreCount semaphore handles to wait on.

public VkSemaphoreWaitInfo
pSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the pSemaphores field.

public LongBuffer
pValues()

a pointer to an array of semaphoreCount timeline semaphore values.

public VkSemaphoreWaitInfo
pValues(LongBuffer value)

Sets the address of the specified LongBuffer to the pValues field.

public int
semaphoreCount()

the number of semaphores to wait on.

public VkSemaphoreWaitInfo
semaphoreCount(int value)

Sets the specified value to the semaphoreCount field.

public VkSemaphoreWaitInfo
set(int sType, long pNext, int flags, int semaphoreCount, LongBuffer pSemaphores, LongBuffer pValues)

Initializes this struct with the specified values.

public VkSemaphoreWaitInfo

Returns:

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

Sets the specified value to the sType field.

public VkSemaphoreWaitInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

PSEMAPHORESback to summary
public static final int PSEMAPHORES

The struct member offsets.

PVALUESback to summary
public static final int PVALUES

The struct member offsets.

SEMAPHORECOUNTback to summary
public static final int SEMAPHORECOUNT

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.

Constructor Detail

VkSemaphoreWaitInfoback to summary
protected VkSemaphoreWaitInfo(long address, ByteBuffer container)
VkSemaphoreWaitInfoback to summary
public VkSemaphoreWaitInfo(ByteBuffer container)

Creates a VkSemaphoreWaitInfo 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 VkSemaphoreWaitInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSemaphoreWaitInfo calloc(MemoryStack stack)

Returns a new VkSemaphoreWaitInfo 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 VkSemaphoreWaitInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkSemaphoreWaitInfo instance allocated with BufferUtils.

createback to summary
public static VkSemaphoreWaitInfo create(long address)

Returns a new VkSemaphoreWaitInfo instance for the specified memory address.

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

Returns a new VkSemaphoreWaitInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSemaphoreWaitInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSemaphoreWaitInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkSemaphoreWaitFlagBits specifying additional parameters for the semaphore wait operation.

Annotations
@NativeType:VkSemaphoreWaitFlags
flagsback to summary
public VkSemaphoreWaitInfo flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkSemaphoreWaitInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSemaphoreWaitInfo malloc(MemoryStack stack)

Returns a new VkSemaphoreWaitInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

npSemaphoresback to summary
public static LongBuffer npSemaphores(long struct)

Unsafe version of pSemaphores.

npSemaphoresback to summary
public static void npSemaphores(long struct, LongBuffer value)

Unsafe version of pSemaphores.

npValuesback to summary
public static LongBuffer npValues(long struct)

Unsafe version of pValues.

npValuesback to summary
public static void npValues(long struct, LongBuffer value)

Unsafe version of pValues.

nsemaphoreCountback to summary
public static int nsemaphoreCount(long struct)

Unsafe version of semaphoreCount.

nsemaphoreCountback to summary
public static void nsemaphoreCount(long struct, int value)

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

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pSemaphoresback to summary
public LongBuffer pSemaphores()

a pointer to an array of semaphoreCount semaphore handles to wait on.

Annotations
@NativeType:VkSemaphore const *
pSemaphoresback to summary
public VkSemaphoreWaitInfo pSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the pSemaphores field.

pValuesback to summary
public LongBuffer pValues()

a pointer to an array of semaphoreCount timeline semaphore values.

Annotations
@NativeType:uint64_t const *
pValuesback to summary
public VkSemaphoreWaitInfo pValues(LongBuffer value)

Sets the address of the specified LongBuffer to the pValues field.

semaphoreCountback to summary
public int semaphoreCount()

the number of semaphores to wait on.

Annotations
@NativeType:uint32_t
semaphoreCountback to summary
public VkSemaphoreWaitInfo semaphoreCount(int value)

Sets the specified value to the semaphoreCount field.

setback to summary
public VkSemaphoreWaitInfo set(int sType, long pNext, int flags, int semaphoreCount, LongBuffer pSemaphores, LongBuffer pValues)

Initializes this struct with the specified values.

setback to summary
public VkSemaphoreWaitInfo set(VkSemaphoreWaitInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkSemaphoreWaitInfo

the source struct

Returns:VkSemaphoreWaitInfo

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 VkSemaphoreWaitInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkSemaphoreWaitInfo.Buffer

extends StructBuffer<VkSemaphoreWaitInfo, VkSemaphoreWaitInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSemaphoreWaitInfoKHR.Buffer

An array of VkSemaphoreWaitInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkSemaphoreWaitInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSemaphoreWaitInfo.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 VkSemaphoreWaitInfo#flags field.
flags
()

public VkSemaphoreWaitInfo.Buffer
flags(int value)

Sets the specified value to the VkSemaphoreWaitInfo#flags field.

protected VkSemaphoreWaitInfo
public long

Returns:

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

public VkSemaphoreWaitInfo.Buffer
pNext(long value)

Sets the specified value to the VkSemaphoreWaitInfo#pNext field.

public LongBuffer

Returns:

a LongBuffer view of the data pointed to by the VkSemaphoreWaitInfo#pSemaphores field.
pSemaphores
()

public VkSemaphoreWaitInfo.Buffer
pSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSemaphoreWaitInfo#pSemaphores field.

public LongBuffer

Returns:

a LongBuffer view of the data pointed to by the VkSemaphoreWaitInfo#pValues field.
pValues
()

public VkSemaphoreWaitInfo.Buffer
pValues(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSemaphoreWaitInfo#pValues field.

protected VkSemaphoreWaitInfo.Buffer
public int

Returns:

the value of the VkSemaphoreWaitInfo#semaphoreCount field.
semaphoreCount
()

public VkSemaphoreWaitInfo.Buffer
semaphoreCount(int value)

Sets the specified value to the VkSemaphoreWaitInfo#semaphoreCount field.

public int

Returns:

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

public VkSemaphoreWaitInfo.Buffer
sType(int value)

Sets the specified value to the VkSemaphoreWaitInfo#sType field.

public VkSemaphoreWaitInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSemaphoreWaitInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSemaphoreWaitInfo.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 VkSemaphoreWaitInfo#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 VkSemaphoreWaitInfo#flags field.

Annotations
@NativeType:VkSemaphoreWaitFlags
flagsback to summary
public VkSemaphoreWaitInfo.Buffer flags(int value)

Sets the specified value to the VkSemaphoreWaitInfo#flags field.

getElementFactoryback to summary
protected VkSemaphoreWaitInfo getElementFactory()

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

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

the value of the VkSemaphoreWaitInfo#pNext field.

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

Sets the specified value to the VkSemaphoreWaitInfo#pNext field.

pSemaphoresback to summary
public LongBuffer pSemaphores()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkSemaphoreWaitInfo#pSemaphores field.

Annotations
@NativeType:VkSemaphore const *
pSemaphoresback to summary
public VkSemaphoreWaitInfo.Buffer pSemaphores(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSemaphoreWaitInfo#pSemaphores field.

pValuesback to summary
public LongBuffer pValues()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkSemaphoreWaitInfo#pValues field.

Annotations
@NativeType:uint64_t const *
pValuesback to summary
public VkSemaphoreWaitInfo.Buffer pValues(LongBuffer value)

Sets the address of the specified LongBuffer to the VkSemaphoreWaitInfo#pValues field.

selfback to summary
protected VkSemaphoreWaitInfo.Buffer self()

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

Annotations
@Override
semaphoreCountback to summary
public int semaphoreCount()
Returns:int

the value of the VkSemaphoreWaitInfo#semaphoreCount field.

Annotations
@NativeType:uint32_t
semaphoreCountback to summary
public VkSemaphoreWaitInfo.Buffer semaphoreCount(int value)

Sets the specified value to the VkSemaphoreWaitInfo#semaphoreCount field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkSemaphoreWaitInfo#sType field.

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

Sets the specified value to the VkSemaphoreWaitInfo#sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_WAIT_INFO value to the VkSemaphoreWaitInfo#sType field.