Class VkD3D12FenceSubmitInfoKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkD3D12FenceSubmitInfoKHR
    extends Struct
    implements 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.

    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

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • waitSemaphoreValuesCount – the number of semaphore wait values specified in pWaitSemaphoreValues.
    • pWaitSemaphoreValues – an array of length waitSemaphoreValuesCount containing values for the corresponding semaphores in VkSubmitInfo::pWaitSemaphores to wait for.
    • signalSemaphoreValuesCount – the number of semaphore signal values specified in pSignalSemaphoreValues.
    • pSignalSemaphoreValues – an array of length signalSemaphoreValuesCount containing values for the corresponding semaphores in VkSubmitInfo::pSignalSemaphores to set when signaled.

    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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • waitSemaphoreValuesCount

        public int waitSemaphoreValuesCount()
        Returns the value of the waitSemaphoreValuesCount field.
      • pWaitSemaphoreValues

        @Nullable
        public java.nio.LongBuffer pWaitSemaphoreValues()
        Returns a LongBuffer view of the data pointed to by the pWaitSemaphoreValues field.
      • signalSemaphoreValuesCount

        public int signalSemaphoreValuesCount()
        Returns the value of the signalSemaphoreValuesCount field.
      • pSignalSemaphoreValues

        @Nullable
        public java.nio.LongBuffer pSignalSemaphoreValues()
        Returns a LongBuffer view of the data pointed to by the pSignalSemaphoreValues field.
      • waitSemaphoreValuesCount

        public VkD3D12FenceSubmitInfoKHR waitSemaphoreValuesCount​(int value)
        Sets the specified value to the waitSemaphoreValuesCount field.
      • pWaitSemaphoreValues

        public VkD3D12FenceSubmitInfoKHR pWaitSemaphoreValues​(@Nullable
                                                              java.nio.LongBuffer value)
        Sets the address of the specified LongBuffer to the pWaitSemaphoreValues field.
      • signalSemaphoreValuesCount

        public VkD3D12FenceSubmitInfoKHR signalSemaphoreValuesCount​(int value)
        Sets the specified value to the signalSemaphoreValuesCount field.
      • pSignalSemaphoreValues

        public VkD3D12FenceSubmitInfoKHR pSignalSemaphoreValues​(@Nullable
                                                                java.nio.LongBuffer value)
        Sets the address of the specified LongBuffer to the pSignalSemaphoreValues field.
      • 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​(long address)
        Returns a new VkD3D12FenceSubmitInfoKHR instance for the specified memory address.
      • callocStack

        public static VkD3D12FenceSubmitInfoKHR callocStack()
        Returns a new VkD3D12FenceSubmitInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • callocStack

        public static VkD3D12FenceSubmitInfoKHR callocStack​(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
      • 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.