Class VkDeviceGroupSubmitInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    Direct Known Subclasses:
    VkDeviceGroupSubmitInfoKHR

    public class VkDeviceGroupSubmitInfo
    extends Struct
    implements NativeResource
    Structure indicating which physical devices execute semaphore operations and command buffers.
    Description

    If this structure is not present, semaphore operations and command buffers execute on device index zero.

    Valid Usage
    • waitSemaphoreCount must equal VkSubmitInfo::waitSemaphoreCount
    • commandBufferCount must equal VkSubmitInfo::commandBufferCount
    • signalSemaphoreCount must equal VkSubmitInfo::signalSemaphoreCount
    • All elements of pWaitSemaphoreDeviceIndices and pSignalSemaphoreDeviceIndices must be valid device indices
    • All elements of pCommandBufferDeviceMasks must be valid device masks
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO
    • If waitSemaphoreCount is not 0, pWaitSemaphoreDeviceIndices must be a valid pointer to an array of waitSemaphoreCount uint32_t values
    • If commandBufferCount is not 0, pCommandBufferDeviceMasks must be a valid pointer to an array of commandBufferCount uint32_t values
    • If signalSemaphoreCount is not 0, pSignalSemaphoreDeviceIndices must be a valid pointer to an array of signalSemaphoreCount uint32_t values

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • waitSemaphoreCount – the number of elements in the pWaitSemaphoreDeviceIndices array.
    • pWaitSemaphoreDeviceIndices – an array of device indices indicating which physical device executes the semaphore wait operation in the corresponding element of VkSubmitInfo::pWaitSemaphores.
    • commandBufferCount – the number of elements in the pCommandBufferDeviceMasks array.
    • pCommandBufferDeviceMasks – an array of device masks indicating which physical devices execute the command buffer in the corresponding element of VkSubmitInfo::pCommandBuffers. A physical device executes the command buffer if the corresponding bit is set in the mask.
    • signalSemaphoreCount – the number of elements in the pSignalSemaphoreDeviceIndices array.
    • pSignalSemaphoreDeviceIndices – an array of device indices indicating which physical device executes the semaphore signal operation in the corresponding element of VkSubmitInfo::pSignalSemaphores.

    Layout

    
     struct VkDeviceGroupSubmitInfo {
         VkStructureType sType;
         void const * pNext;
         uint32_t waitSemaphoreCount;
         uint32_t const * pWaitSemaphoreDeviceIndices;
         uint32_t commandBufferCount;
         uint32_t const * pCommandBufferDeviceMasks;
         uint32_t signalSemaphoreCount;
         uint32_t const * pSignalSemaphoreDeviceIndices;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, WAITSEMAPHORECOUNT, PWAITSEMAPHOREDEVICEINDICES, COMMANDBUFFERCOUNT, PCOMMANDBUFFERDEVICEMASKS, SIGNALSEMAPHORECOUNT, PSIGNALSEMAPHOREDEVICEINDICES

        The struct member offsets.
    • Constructor Detail

      • VkDeviceGroupSubmitInfo

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

        public int waitSemaphoreCount()
        Returns the value of the waitSemaphoreCount field.
      • pWaitSemaphoreDeviceIndices

        @Nullable
        public java.nio.IntBuffer pWaitSemaphoreDeviceIndices()
        Returns a IntBuffer view of the data pointed to by the pWaitSemaphoreDeviceIndices field.
      • commandBufferCount

        public int commandBufferCount()
        Returns the value of the commandBufferCount field.
      • pCommandBufferDeviceMasks

        @Nullable
        public java.nio.IntBuffer pCommandBufferDeviceMasks()
        Returns a IntBuffer view of the data pointed to by the pCommandBufferDeviceMasks field.
      • signalSemaphoreCount

        public int signalSemaphoreCount()
        Returns the value of the signalSemaphoreCount field.
      • pSignalSemaphoreDeviceIndices

        @Nullable
        public java.nio.IntBuffer pSignalSemaphoreDeviceIndices()
        Returns a IntBuffer view of the data pointed to by the pSignalSemaphoreDeviceIndices field.
      • pWaitSemaphoreDeviceIndices

        public VkDeviceGroupSubmitInfo pWaitSemaphoreDeviceIndices​(@Nullable
                                                                   java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pWaitSemaphoreDeviceIndices field.
      • pCommandBufferDeviceMasks

        public VkDeviceGroupSubmitInfo pCommandBufferDeviceMasks​(@Nullable
                                                                 java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pCommandBufferDeviceMasks field.
      • pSignalSemaphoreDeviceIndices

        public VkDeviceGroupSubmitInfo pSignalSemaphoreDeviceIndices​(@Nullable
                                                                     java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pSignalSemaphoreDeviceIndices field.
      • set

        public VkDeviceGroupSubmitInfo set​(int sType,
                                           long pNext,
                                           @Nullable
                                           java.nio.IntBuffer pWaitSemaphoreDeviceIndices,
                                           @Nullable
                                           java.nio.IntBuffer pCommandBufferDeviceMasks,
                                           @Nullable
                                           java.nio.IntBuffer pSignalSemaphoreDeviceIndices)
        Initializes this struct with the specified values.
      • nsType

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

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

        public static int nwaitSemaphoreCount​(long struct)
        Unsafe version of waitSemaphoreCount().
      • npWaitSemaphoreDeviceIndices

        @Nullable
        public static java.nio.IntBuffer npWaitSemaphoreDeviceIndices​(long struct)
        Unsafe version of pWaitSemaphoreDeviceIndices.
      • ncommandBufferCount

        public static int ncommandBufferCount​(long struct)
        Unsafe version of commandBufferCount().
      • npCommandBufferDeviceMasks

        @Nullable
        public static java.nio.IntBuffer npCommandBufferDeviceMasks​(long struct)
        Unsafe version of pCommandBufferDeviceMasks.
      • nsignalSemaphoreCount

        public static int nsignalSemaphoreCount​(long struct)
        Unsafe version of signalSemaphoreCount().
      • npSignalSemaphoreDeviceIndices

        @Nullable
        public static java.nio.IntBuffer npSignalSemaphoreDeviceIndices​(long struct)
      • 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.
      • nwaitSemaphoreCount

        public static void nwaitSemaphoreCount​(long struct,
                                               int value)
        Sets the specified value to the waitSemaphoreCount field of the specified struct.
      • npWaitSemaphoreDeviceIndices

        public static void npWaitSemaphoreDeviceIndices​(long struct,
                                                        @Nullable
                                                        java.nio.IntBuffer value)
        Unsafe version of pWaitSemaphoreDeviceIndices.
      • ncommandBufferCount

        public static void ncommandBufferCount​(long struct,
                                               int value)
        Sets the specified value to the commandBufferCount field of the specified struct.
      • npCommandBufferDeviceMasks

        public static void npCommandBufferDeviceMasks​(long struct,
                                                      @Nullable
                                                      java.nio.IntBuffer value)
        Unsafe version of pCommandBufferDeviceMasks.
      • nsignalSemaphoreCount

        public static void nsignalSemaphoreCount​(long struct,
                                                 int value)
        Sets the specified value to the signalSemaphoreCount field of the specified struct.
      • npSignalSemaphoreDeviceIndices

        public static void npSignalSemaphoreDeviceIndices​(long struct,
                                                          @Nullable
                                                          java.nio.IntBuffer value)
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array