Package org.lwjgl.vulkan
Class VkSemaphoreSubmitInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSemaphoreSubmitInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkSemaphoreSubmitInfoKHR
public class VkSemaphoreSubmitInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure 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
- If the geometry shaders feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_GEOMETRY_SHADER_BIT - If the tessellation shaders feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_TESSELLATION_CONTROL_SHADER_BITorPIPELINE_STAGE_2_TESSELLATION_EVALUATION_SHADER_BIT - If the conditional rendering feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_CONDITIONAL_RENDERING_BIT_EXT - If the fragment density map feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_FRAGMENT_DENSITY_PROCESS_BIT_EXT - If the transform feedback feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_TRANSFORM_FEEDBACK_BIT_EXT - If the mesh shaders feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_MESH_SHADER_BIT_NV - If the task shaders feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_TASK_SHADER_BIT_NV - If the shading rate image feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_SHADING_RATE_IMAGE_BIT_NV - If the subpass shading feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_SUBPASS_SHADING_BIT_HUAWEI - If the invocation mask image feature is not enabled,
stageMaskmust not containPIPELINE_STAGE_2_INVOCATION_MASK_BIT_HUAWEI - If the
devicethatsemaphorewas created on is not a device group,deviceIndexmust be 0 - If the
devicethatsemaphorewas created on is a device group,deviceIndexmust be a valid device index
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFOpNextmust beNULLsemaphoremust be a validVkSemaphorehandlestageMaskmust be a valid combination ofVkPipelineStageFlagBits2values
See Also
Layout
struct VkSemaphoreSubmitInfo { VkStructureTypesType(); void const *pNext(); VkSemaphoresemaphore(); uint64_tvalue(); VkPipelineStageFlags2stageMask(); uint32_tdeviceIndex(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSemaphoreSubmitInfo.BufferAn array ofVkSemaphoreSubmitInfostructs.
-
Constructor Summary
Constructors Constructor Description VkSemaphoreSubmitInfo(java.nio.ByteBuffer container)Creates aVkSemaphoreSubmitInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSemaphoreSubmitInfocalloc()Returns a newVkSemaphoreSubmitInfoinstance allocated withmemCalloc.static VkSemaphoreSubmitInfo.Buffercalloc(int capacity)Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withmemCalloc.static VkSemaphoreSubmitInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreSubmitInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreSubmitInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSemaphoreSubmitInfocreate()Returns a newVkSemaphoreSubmitInfoinstance allocated withBufferUtils.static VkSemaphoreSubmitInfo.Buffercreate(int capacity)Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withBufferUtils.static VkSemaphoreSubmitInfocreate(long address)Returns a newVkSemaphoreSubmitInfoinstance for the specified memory address.static VkSemaphoreSubmitInfo.Buffercreate(long address, int capacity)Create aVkSemaphoreSubmitInfo.Bufferinstance at the specified memory.static VkSemaphoreSubmitInfocreateSafe(long address)static VkSemaphoreSubmitInfo.BuffercreateSafe(long address, int capacity)intdeviceIndex()the index of the device within a device group that executes the semaphore wait or signal operation.VkSemaphoreSubmitInfodeviceIndex(int value)Sets the specified value to thedeviceIndex()field.static VkSemaphoreSubmitInfomalloc()Returns a newVkSemaphoreSubmitInfoinstance allocated withmemAlloc.static VkSemaphoreSubmitInfo.Buffermalloc(int capacity)Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withmemAlloc.static VkSemaphoreSubmitInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkSemaphoreSubmitInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkSemaphoreSubmitInfoinstance allocated on the specifiedMemoryStack.static intndeviceIndex(long struct)Unsafe version ofdeviceIndex().static voidndeviceIndex(long struct, int value)Unsafe version ofdeviceIndex.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static longnsemaphore(long struct)Unsafe version ofsemaphore().static voidnsemaphore(long struct, long value)Unsafe version ofsemaphore.static longnstageMask(long struct)Unsafe version ofstageMask().static voidnstageMask(long struct, long value)Unsafe version ofstageMask.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static longnvalue(long struct)Unsafe version ofvalue().static voidnvalue(long struct, long value)Unsafe version ofvalue.longpNext()NULLor a pointer to a structure extending this structure.VkSemaphoreSubmitInfopNext(long value)Sets the specified value to thepNext()field.longsemaphore()aVkSemaphoreaffected by this operation.VkSemaphoreSubmitInfosemaphore(long value)Sets the specified value to thesemaphore()field.VkSemaphoreSubmitInfoset(int sType, long pNext, long semaphore, long value, long stageMask, int deviceIndex)Initializes this struct with the specified values.VkSemaphoreSubmitInfoset(VkSemaphoreSubmitInfo src)Copies the specified struct data to this struct.intsizeof()longstageMask()aVkPipelineStageFlags2mask 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.VkSemaphoreSubmitInfostageMask(long value)Sets the specified value to thestageMask()field.intsType()the type of this structure.VkSemaphoreSubmitInfosType(int value)Sets the specified value to thesType()field.VkSemaphoreSubmitInfosType$Default()Sets theSTRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFOvalue to thesType()field.longvalue()either the value used to signalsemaphoreor the value waited on bysemaphore, ifsemaphoreis a timeline semaphore.VkSemaphoreSubmitInfovalue(long value)Sets the specified value to thevalue()field.
-
-
-
Constructor Detail
-
VkSemaphoreSubmitInfo
public VkSemaphoreSubmitInfo(java.nio.ByteBuffer container)
Creates aVkSemaphoreSubmitInfoinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
semaphore
public long semaphore()
aVkSemaphoreaffected by this operation.
-
value
public long value()
either the value used to signalsemaphoreor the value waited on bysemaphore, ifsemaphoreis a timeline semaphore. Otherwise it is ignored.
-
stageMask
public long stageMask()
aVkPipelineStageFlags2mask 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.
-
deviceIndex
public int deviceIndex()
the index of the device within a device group that executes the semaphore wait or signal operation.
-
sType
public VkSemaphoreSubmitInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkSemaphoreSubmitInfo sType$Default()
Sets theSTRUCTURE_TYPE_SEMAPHORE_SUBMIT_INFOvalue to thesType()field.
-
pNext
public VkSemaphoreSubmitInfo pNext(long value)
Sets the specified value to thepNext()field.
-
semaphore
public VkSemaphoreSubmitInfo semaphore(long value)
Sets the specified value to thesemaphore()field.
-
value
public VkSemaphoreSubmitInfo value(long value)
Sets the specified value to thevalue()field.
-
stageMask
public VkSemaphoreSubmitInfo stageMask(long value)
Sets the specified value to thestageMask()field.
-
deviceIndex
public VkSemaphoreSubmitInfo deviceIndex(int value)
Sets the specified value to thedeviceIndex()field.
-
set
public VkSemaphoreSubmitInfo set(int sType, long pNext, long semaphore, long value, long stageMask, int deviceIndex)
Initializes this struct with the specified values.
-
set
public VkSemaphoreSubmitInfo set(VkSemaphoreSubmitInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSemaphoreSubmitInfo malloc()
Returns a newVkSemaphoreSubmitInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSemaphoreSubmitInfo calloc()
Returns a newVkSemaphoreSubmitInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSemaphoreSubmitInfo create()
Returns a newVkSemaphoreSubmitInfoinstance allocated withBufferUtils.
-
create
public static VkSemaphoreSubmitInfo create(long address)
Returns a newVkSemaphoreSubmitInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkSemaphoreSubmitInfo createSafe(long address)
-
malloc
public static VkSemaphoreSubmitInfo.Buffer malloc(int capacity)
Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSemaphoreSubmitInfo.Buffer calloc(int capacity)
Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreSubmitInfo.Buffer create(int capacity)
Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSemaphoreSubmitInfo.Buffer create(long address, int capacity)
Create aVkSemaphoreSubmitInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSemaphoreSubmitInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static VkSemaphoreSubmitInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreSubmitInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkSemaphoreSubmitInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreSubmitInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSemaphoreSubmitInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkSemaphoreSubmitInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSemaphoreSubmitInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nsemaphore
public static long nsemaphore(long struct)
Unsafe version ofsemaphore().
-
nvalue
public static long nvalue(long struct)
Unsafe version ofvalue().
-
nstageMask
public static long nstageMask(long struct)
Unsafe version ofstageMask().
-
ndeviceIndex
public static int ndeviceIndex(long struct)
Unsafe version ofdeviceIndex().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nsemaphore
public static void nsemaphore(long struct, long value)Unsafe version ofsemaphore.
-
nvalue
public static void nvalue(long struct, long value)Unsafe version ofvalue.
-
nstageMask
public static void nstageMask(long struct, long value)Unsafe version ofstageMask.
-
ndeviceIndex
public static void ndeviceIndex(long struct, int value)Unsafe version ofdeviceIndex.
-
-