Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSemaphoreSubmitInfo

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

Structure specifying a semaphore signal or wait operation.
Description

Whether this structure defines a semaphore wait or signal operation is defined by how it is used.

Valid Usage
Valid Usage (Implicit)
See Also

VkSubmitInfo2

Layout


struct VkSemaphoreSubmitInfo {
    VkStructureType sType;
    void const * pNext;
    VkSemaphore semaphore;
    uint64_t value;
    VkPipelineStageFlags2 stageMask;
    uint32_t deviceIndex;
}

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
DEVICEINDEX

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SEMAPHORE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STAGEMASK

The struct member offsets.

public static final int
STYPE

The struct member offsets.

public static final int
VALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkSemaphoreSubmitInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSemaphoreSubmitInfo
calloc()

Returns a new VkSemaphoreSubmitInfo instance allocated with memCalloc.

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

Returns a new VkSemaphoreSubmitInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSemaphoreSubmitInfo instance allocated with BufferUtils.

public static VkSemaphoreSubmitInfo
create(long address)

Returns a new VkSemaphoreSubmitInfo instance for the specified memory address.

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

Returns a new VkSemaphoreSubmitInfo.Buffer instance allocated with BufferUtils.

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

Create a VkSemaphoreSubmitInfo.Buffer instance at the specified memory.

public static VkSemaphoreSubmitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
deviceIndex()

the index of the device within a device group that executes the semaphore wait or signal operation.

public VkSemaphoreSubmitInfo
deviceIndex(int value)

Sets the specified value to the deviceIndex field.

public static VkSemaphoreSubmitInfo
malloc()

Returns a new VkSemaphoreSubmitInfo instance allocated with memAlloc.

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

Returns a new VkSemaphoreSubmitInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkSemaphoreSubmitInfo instance allocated on the specified MemoryStack.

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

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

public static int
ndeviceIndex(long struct)

Unsafe version of deviceIndex.

public static void
ndeviceIndex(long struct, int value)

Unsafe version of deviceIndex.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsemaphore(long struct)

Unsafe version of semaphore.

public static void
nsemaphore(long struct, long value)

Unsafe version of semaphore.

public static long
nstageMask(long struct)

Unsafe version of stageMask.

public static void
nstageMask(long struct, long value)

Unsafe version of stageMask.

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
nvalue(long struct)

Unsafe version of value.

public static void
nvalue(long struct, long value)

Unsafe version of value.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSemaphoreSubmitInfo
pNext(long value)

Sets the specified value to the pNext field.

public long
semaphore()

a VkSemaphore affected by this operation.

public VkSemaphoreSubmitInfo
semaphore(long value)

Sets the specified value to the semaphore field.

public VkSemaphoreSubmitInfo
set(int sType, long pNext, long semaphore, long value, long stageMask, int deviceIndex)

Initializes this struct with the specified values.

public VkSemaphoreSubmitInfo

Returns:

this struct
set
(VkSemaphoreSubmitInfo
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 long
stageMask()

a VkPipelineStageFlags2 mask of pipeline stages which limit the first synchronization scope of a semaphore signal operation, or second synchronization scope of a semaphore wait operation as described in the semaphore wait operation and semaphore signal operation sections of the synchronization chapter.

public VkSemaphoreSubmitInfo
stageMask(long value)

Sets the specified value to the stageMask field.

public int
sType()

a VkStructureType value identifying this structure.

public VkSemaphoreSubmitInfo
sType(int value)

Sets the specified value to the sType field.

public VkSemaphoreSubmitInfo
public long
value()

either the value used to signal semaphore or the value waited on by semaphore, if semaphore is a timeline semaphore.

public VkSemaphoreSubmitInfo
value(long value)

Sets the specified value to the value 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.

DEVICEINDEXback to summary
public static final int DEVICEINDEX

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SEMAPHOREback to summary
public static final int SEMAPHORE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STAGEMASKback to summary
public static final int STAGEMASK

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

VALUEback to summary
public static final int VALUE

The struct member offsets.

Constructor Detail

VkSemaphoreSubmitInfoback to summary
protected VkSemaphoreSubmitInfo(long address, ByteBuffer container)
VkSemaphoreSubmitInfoback to summary
public VkSemaphoreSubmitInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSemaphoreSubmitInfo calloc(MemoryStack stack)

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

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

Returns a new VkSemaphoreSubmitInfo instance allocated with BufferUtils.

createback to summary
public static VkSemaphoreSubmitInfo create(long address)

Returns a new VkSemaphoreSubmitInfo instance for the specified memory address.

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

Returns a new VkSemaphoreSubmitInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSemaphoreSubmitInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSemaphoreSubmitInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceIndexback to summary
public int deviceIndex()

the index of the device within a device group that executes the semaphore wait or signal operation.

Annotations
@NativeType:uint32_t
deviceIndexback to summary
public VkSemaphoreSubmitInfo deviceIndex(int value)

Sets the specified value to the deviceIndex field.

mallocback to summary
public static VkSemaphoreSubmitInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSemaphoreSubmitInfo malloc(MemoryStack stack)

Returns a new VkSemaphoreSubmitInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndeviceIndexback to summary
public static int ndeviceIndex(long struct)

Unsafe version of deviceIndex.

ndeviceIndexback to summary
public static void ndeviceIndex(long struct, int value)

Unsafe version of deviceIndex.

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.

nsemaphoreback to summary
public static long nsemaphore(long struct)

Unsafe version of semaphore.

nsemaphoreback to summary
public static void nsemaphore(long struct, long value)

Unsafe version of semaphore.

nstageMaskback to summary
public static long nstageMask(long struct)

Unsafe version of stageMask.

nstageMaskback to summary
public static void nstageMask(long struct, long value)

Unsafe version of stageMask.

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.

nvalueback to summary
public static long nvalue(long struct)

Unsafe version of value.

nvalueback to summary
public static void nvalue(long struct, long value)

Unsafe version of value.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

semaphoreback to summary
public long semaphore()

a VkSemaphore affected by this operation.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkSemaphoreSubmitInfo semaphore(long value)

Sets the specified value to the semaphore field.

setback to summary
public VkSemaphoreSubmitInfo set(int sType, long pNext, long semaphore, long value, long stageMask, int deviceIndex)

Initializes this struct with the specified values.

setback to summary
public VkSemaphoreSubmitInfo set(VkSemaphoreSubmitInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkSemaphoreSubmitInfo

the source struct

Returns:VkSemaphoreSubmitInfo

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
stageMaskback to summary
public long stageMask()

a VkPipelineStageFlags2 mask of pipeline stages which limit the first synchronization scope of a semaphore signal operation, or second synchronization scope of a semaphore wait operation as described in the semaphore wait operation and semaphore signal operation sections of the synchronization chapter.

Annotations
@NativeType:VkPipelineStageFlags2
stageMaskback to summary
public VkSemaphoreSubmitInfo stageMask(long value)

Sets the specified value to the stageMask field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO value to the sType field.

valueback to summary
public long value()

either the value used to signal semaphore or the value waited on by semaphore, if semaphore is a timeline semaphore. Otherwise it is ignored.

Annotations
@NativeType:uint64_t
valueback to summary
public VkSemaphoreSubmitInfo value(long value)

Sets the specified value to the value field.

org.lwjgl.vulkan back to summary

public Class VkSemaphoreSubmitInfo.Buffer

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

An array of VkSemaphoreSubmitInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkSemaphoreSubmitInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public VkSemaphoreSubmitInfo.Buffer
deviceIndex(int value)

Sets the specified value to the VkSemaphoreSubmitInfo#deviceIndex field.

protected VkSemaphoreSubmitInfo
public long

Returns:

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

public VkSemaphoreSubmitInfo.Buffer
pNext(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#pNext field.

protected VkSemaphoreSubmitInfo.Buffer
public long

Returns:

the value of the VkSemaphoreSubmitInfo#semaphore field.
semaphore
()

public VkSemaphoreSubmitInfo.Buffer
semaphore(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#semaphore field.

public long

Returns:

the value of the VkSemaphoreSubmitInfo#stageMask field.
stageMask
()

public VkSemaphoreSubmitInfo.Buffer
stageMask(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#stageMask field.

public int

Returns:

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

public VkSemaphoreSubmitInfo.Buffer
sType(int value)

Sets the specified value to the VkSemaphoreSubmitInfo#sType field.

public VkSemaphoreSubmitInfo.Buffer
public long

Returns:

the value of the VkSemaphoreSubmitInfo#value field.
value
()

public VkSemaphoreSubmitInfo.Buffer
value(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#value field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSemaphoreSubmitInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSemaphoreSubmitInfo.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 VkSemaphoreSubmitInfo#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

deviceIndexback to summary
public int deviceIndex()
Returns:int

the value of the VkSemaphoreSubmitInfo#deviceIndex field.

Annotations
@NativeType:uint32_t
deviceIndexback to summary
public VkSemaphoreSubmitInfo.Buffer deviceIndex(int value)

Sets the specified value to the VkSemaphoreSubmitInfo#deviceIndex field.

getElementFactoryback to summary
protected VkSemaphoreSubmitInfo getElementFactory()

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

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

the value of the VkSemaphoreSubmitInfo#pNext field.

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

Sets the specified value to the VkSemaphoreSubmitInfo#pNext field.

selfback to summary
protected VkSemaphoreSubmitInfo.Buffer self()

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

Annotations
@Override
semaphoreback to summary
public long semaphore()
Returns:long

the value of the VkSemaphoreSubmitInfo#semaphore field.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkSemaphoreSubmitInfo.Buffer semaphore(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#semaphore field.

stageMaskback to summary
public long stageMask()
Returns:long

the value of the VkSemaphoreSubmitInfo#stageMask field.

Annotations
@NativeType:VkPipelineStageFlags2
stageMaskback to summary
public VkSemaphoreSubmitInfo.Buffer stageMask(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#stageMask field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkSemaphoreSubmitInfo#sType field.

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

Sets the specified value to the VkSemaphoreSubmitInfo#sType field.

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

Sets the STRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFO value to the VkSemaphoreSubmitInfo#sType field.

valueback to summary
public long value()
Returns:long

the value of the VkSemaphoreSubmitInfo#value field.

Annotations
@NativeType:uint64_t
valueback to summary
public VkSemaphoreSubmitInfo.Buffer value(long value)

Sets the specified value to the VkSemaphoreSubmitInfo#value field.