Package org.lwjgl.vulkan

Class VkD3D12FenceSubmitInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkD3D12FenceSubmitInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying values for Direct3D 12 fence-backed semaphores.
    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
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR
    • If waitSemaphoreValuesCount is not 0, and pWaitSemaphoreValues is not NULL, pWaitSemaphoreValues must be a valid pointer to an array of waitSemaphoreValuesCount uint64_t values
    • If signalSemaphoreValuesCount is not 0, and pSignalSemaphoreValues is not NULL, pSignalSemaphoreValues must be a valid pointer to an array of signalSemaphoreValuesCount uint64_t values

    Layout

    
 struct VkD3D12FenceSubmitInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t waitSemaphoreValuesCount();
     uint64_t const * pWaitSemaphoreValues();
     uint32_t signalSemaphoreValuesCount();
     uint64_t const * pSignalSemaphoreValues();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, WAITSEMAPHOREVALUESCOUNT, PWAITSEMAPHOREVALUES, SIGNALSEMAPHOREVALUESCOUNT, PSIGNALSEMAPHOREVALUES

        The struct member offsets.

    • Constructor Detail

      • VkD3D12FenceSubmitInfoKHR

        public VkD3D12FenceSubmitInfoKHR​(java.nio.ByteBuffer container)
        Creates a VkD3D12FenceSubmitInfoKHR 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • sType

        public int sType()
        the type of this structure.

      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.

      • waitSemaphoreValuesCount

        public int waitSemaphoreValuesCount()
        the number of semaphore wait values specified in pWaitSemaphoreValues.

      • pWaitSemaphoreValues

        @Nullable
public java.nio.LongBuffer pWaitSemaphoreValues()
        a pointer to an array of waitSemaphoreValuesCount values for the corresponding semaphores in VkSubmitInfo::pWaitSemaphores to wait for.

      • signalSemaphoreValuesCount

        public int signalSemaphoreValuesCount()
        the number of semaphore signal values specified in pSignalSemaphoreValues.

      • pSignalSemaphoreValues

        @Nullable
public java.nio.LongBuffer pSignalSemaphoreValues()
        a pointer to an array of signalSemaphoreValuesCount values for the corresponding semaphores in VkSubmitInfo::pSignalSemaphores to set when signaled.

      • set

        public VkD3D12FenceSubmitInfoKHR set​(int sType,
                                     long pNext,
                                     int waitSemaphoreValuesCount,
                                     @Nullable
                                     java.nio.LongBuffer pWaitSemaphoreValues,
                                     int signalSemaphoreValuesCount,
                                     @Nullable
                                     java.nio.LongBuffer pSignalSemaphoreValues)
        Initializes this struct with the specified values.

      • malloc

        public static VkD3D12FenceSubmitInfoKHR malloc()
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkD3D12FenceSubmitInfoKHR calloc()
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkD3D12FenceSubmitInfoKHR create()
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated with BufferUtils.

      • create

        public static VkD3D12FenceSubmitInfoKHR create​(long address)
        Returns a new VkD3D12FenceSubmitInfoKHR instance for the specified memory address.

      • malloc

        public static VkD3D12FenceSubmitInfoKHR malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkD3D12FenceSubmitInfoKHR calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkD3D12FenceSubmitInfoKHR.Buffer calloc​(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
        Returns a new VkD3D12FenceSubmitInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().

      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().

      • nwaitSemaphoreValuesCount

        public static int nwaitSemaphoreValuesCount​(long struct)
        Unsafe version of waitSemaphoreValuesCount().

      • npWaitSemaphoreValues

        @Nullable
public static java.nio.LongBuffer npWaitSemaphoreValues​(long struct)
        Unsafe version of pWaitSemaphoreValues.

      • nsignalSemaphoreValuesCount

        public static int nsignalSemaphoreValuesCount​(long struct)
        Unsafe version of signalSemaphoreValuesCount().

      • npSignalSemaphoreValues

        @Nullable
public static java.nio.LongBuffer npSignalSemaphoreValues​(long struct)
        Unsafe version of pSignalSemaphoreValues.

      • nsType

        public static void nsType​(long struct,
                          int value)
        Unsafe version of sType.

      • npNext

        public static void npNext​(long struct,
                          long value)
        Unsafe version of pNext.

      • nwaitSemaphoreValuesCount

        public static void nwaitSemaphoreValuesCount​(long struct,
                                             int value)
        Sets the specified value to the waitSemaphoreValuesCount field of the specified struct.

      • npWaitSemaphoreValues

        public static void npWaitSemaphoreValues​(long struct,
                                         @Nullable
                                         java.nio.LongBuffer value)
        Unsafe version of pWaitSemaphoreValues.

      • nsignalSemaphoreValuesCount

        public static void nsignalSemaphoreValuesCount​(long struct,
                                               int value)
        Sets the specified value to the signalSemaphoreValuesCount field of the specified struct.

      • npSignalSemaphoreValues

        public static void npSignalSemaphoreValues​(long struct,
                                           @Nullable
                                           java.nio.LongBuffer value)
        Unsafe version of pSignalSemaphoreValues.