Class VkD3D12FenceSubmitInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If the semaphore in VkSubmitInfo::pWaitSemaphores or VkSubmitInfo::pSignalSemaphores corresponding to an entry in pWaitSemaphoreValues or pSignalSemaphoreValues respectively does not currently have a payload referring to a Direct3D 12 fence, the implementation must ignore the value in the pWaitSemaphoreValues or pSignalSemaphoreValues entry.
Note
As the introduction of the external semaphore handle type EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT predates that of timeline semaphores, support for importing semaphore payloads from external handles of that type into semaphores created (implicitly or explicitly) with a VkSemaphoreType of SEMAPHORE_TYPE_BINARY is preserved for backwards compatibility. However, applications should prefer importing such handle types into semaphores created with a VkSemaphoreType of SEMAPHORE_TYPE_TIMELINE, and use the VkTimelineSemaphoreSubmitInfo structure instead of the VkD3D12FenceSubmitInfoKHR structure to specify the values to use when waiting for and signaling such semaphores.
Valid Usage
waitSemaphoreValuesCountmust be the same value asVkSubmitInfo::waitSemaphoreCount, where this structure is in thepNextchain of aVkSubmitInfostructuresignalSemaphoreValuesCountmust be the same value asVkSubmitInfo::signalSemaphoreCount, where this structure is in thepNextchain of aVkSubmitInfostructure
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR- If
waitSemaphoreValuesCountis not 0, andpWaitSemaphoreValuesis notNULL,pWaitSemaphoreValuesmust be a valid pointer to an array ofwaitSemaphoreValuesCountuint64_tvalues - If
signalSemaphoreValuesCountis not 0, andpSignalSemaphoreValuesis notNULL,pSignalSemaphoreValuesmust be a valid pointer to an array ofsignalSemaphoreValuesCountuint64_tvalues
Layout
struct VkD3D12FenceSubmitInfoKHR {
VkStructureType sType();
void const * pNext();
uint32_t waitSemaphoreValuesCount();
uint64_t const * pWaitSemaphoreValues();
uint32_t signalSemaphoreValuesCount();
uint64_t const * pSignalSemaphoreValues();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkD3D12FenceSubmitInfoKHR(ByteBuffer container) Creates aVkD3D12FenceSubmitInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkD3D12FenceSubmitInfoKHRcalloc()Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkD3D12FenceSubmitInfoKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkD3D12FenceSubmitInfoKHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkD3D12FenceSubmitInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkD3D12FenceSubmitInfoKHRcreate()Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withBufferUtils.static VkD3D12FenceSubmitInfoKHRcreate(long address) Returns a newVkD3D12FenceSubmitInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkD3D12FenceSubmitInfoKHR.Bufferinstance at the specified memory.static @Nullable VkD3D12FenceSubmitInfoKHRcreateSafe(long address) static @Nullable VkD3D12FenceSubmitInfoKHR.BuffercreateSafe(long address, int capacity) static VkD3D12FenceSubmitInfoKHRmalloc()Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkD3D12FenceSubmitInfoKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated on the specifiedMemoryStack.static VkD3D12FenceSubmitInfoKHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkD3D12FenceSubmitInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable LongBuffernpSignalSemaphoreValues(long struct) Unsafe version ofpSignalSemaphoreValues.static voidnpSignalSemaphoreValues(long struct, @Nullable LongBuffer value) Unsafe version ofpSignalSemaphoreValues.static @Nullable LongBuffernpWaitSemaphoreValues(long struct) Unsafe version ofpWaitSemaphoreValues.static voidnpWaitSemaphoreValues(long struct, @Nullable LongBuffer value) Unsafe version ofpWaitSemaphoreValues.static intnsignalSemaphoreValuesCount(long struct) Unsafe version ofsignalSemaphoreValuesCount().static voidnsignalSemaphoreValuesCount(long struct, int value) Sets the specified value to thesignalSemaphoreValuesCountfield of the specifiedstruct.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnwaitSemaphoreValuesCount(long struct) Unsafe version ofwaitSemaphoreValuesCount().static voidnwaitSemaphoreValuesCount(long struct, int value) Sets the specified value to thewaitSemaphoreValuesCountfield of the specifiedstruct.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable LongBuffera pointer to an array ofsignalSemaphoreValuesCountvalues for the corresponding semaphores inVkSubmitInfo::pSignalSemaphoresto set when signaled.pSignalSemaphoreValues(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepSignalSemaphoreValues()field.@Nullable LongBuffera pointer to an array ofwaitSemaphoreValuesCountvalues for the corresponding semaphores inVkSubmitInfo::pWaitSemaphoresto wait for.pWaitSemaphoreValues(@Nullable LongBuffer value) Sets the address of the specifiedLongBufferto thepWaitSemaphoreValues()field.set(int sType, long pNext, int waitSemaphoreValuesCount, @Nullable LongBuffer pWaitSemaphoreValues, int signalSemaphoreValuesCount, @Nullable LongBuffer pSignalSemaphoreValues) Initializes this struct with the specified values.Copies the specified struct data to this struct.intthe number of semaphore signal values specified inpSignalSemaphoreValues.signalSemaphoreValuesCount(int value) Sets the specified value to thesignalSemaphoreValuesCount()field.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHRvalue to thesType()field.intthe number of semaphore wait values specified inpWaitSemaphoreValues.waitSemaphoreValuesCount(int value) Sets the specified value to thewaitSemaphoreValuesCount()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
WAITSEMAPHOREVALUESCOUNT
public static final int WAITSEMAPHOREVALUESCOUNTThe struct member offsets. -
PWAITSEMAPHOREVALUES
public static final int PWAITSEMAPHOREVALUESThe struct member offsets. -
SIGNALSEMAPHOREVALUESCOUNT
public static final int SIGNALSEMAPHOREVALUESCOUNTThe struct member offsets. -
PSIGNALSEMAPHOREVALUES
public static final int PSIGNALSEMAPHOREVALUESThe struct member offsets.
-
-
Constructor Details
-
VkD3D12FenceSubmitInfoKHR
Creates aVkD3D12FenceSubmitInfoKHRinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkD3D12FenceSubmitInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
waitSemaphoreValuesCount
public int waitSemaphoreValuesCount()the number of semaphore wait values specified inpWaitSemaphoreValues. -
pWaitSemaphoreValues
a pointer to an array ofwaitSemaphoreValuesCountvalues for the corresponding semaphores inVkSubmitInfo::pWaitSemaphoresto wait for. -
signalSemaphoreValuesCount
public int signalSemaphoreValuesCount()the number of semaphore signal values specified inpSignalSemaphoreValues. -
pSignalSemaphoreValues
a pointer to an array ofsignalSemaphoreValuesCountvalues for the corresponding semaphores inVkSubmitInfo::pSignalSemaphoresto set when signaled. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
waitSemaphoreValuesCount
Sets the specified value to thewaitSemaphoreValuesCount()field. -
pWaitSemaphoreValues
Sets the address of the specifiedLongBufferto thepWaitSemaphoreValues()field. -
signalSemaphoreValuesCount
Sets the specified value to thesignalSemaphoreValuesCount()field. -
pSignalSemaphoreValues
Sets the address of the specifiedLongBufferto thepSignalSemaphoreValues()field. -
set
public VkD3D12FenceSubmitInfoKHR set(int sType, long pNext, int waitSemaphoreValuesCount, @Nullable LongBuffer pWaitSemaphoreValues, int signalSemaphoreValuesCount, @Nullable LongBuffer pSignalSemaphoreValues) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkD3D12FenceSubmitInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkD3D12FenceSubmitInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkD3D12FenceSubmitInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkD3D12FenceSubmitInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkD3D12FenceSubmitInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkD3D12FenceSubmitInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkD3D12FenceSubmitInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkD3D12FenceSubmitInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nwaitSemaphoreValuesCount
public static int nwaitSemaphoreValuesCount(long struct) Unsafe version ofwaitSemaphoreValuesCount(). -
npWaitSemaphoreValues
Unsafe version ofpWaitSemaphoreValues. -
nsignalSemaphoreValuesCount
public static int nsignalSemaphoreValuesCount(long struct) Unsafe version ofsignalSemaphoreValuesCount(). -
npSignalSemaphoreValues
Unsafe version ofpSignalSemaphoreValues. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nwaitSemaphoreValuesCount
public static void nwaitSemaphoreValuesCount(long struct, int value) Sets the specified value to thewaitSemaphoreValuesCountfield of the specifiedstruct. -
npWaitSemaphoreValues
Unsafe version ofpWaitSemaphoreValues. -
nsignalSemaphoreValuesCount
public static void nsignalSemaphoreValuesCount(long struct, int value) Sets the specified value to thesignalSemaphoreValuesCountfield of the specifiedstruct. -
npSignalSemaphoreValues
Unsafe version ofpSignalSemaphoreValues.
-