Package org.lwjgl.vulkan

Class VkDeviceGroupSubmitInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDeviceGroupSubmitInfo>
org.lwjgl.vulkan.VkDeviceGroupSubmitInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkDeviceGroupSubmitInfoKHR
public class VkDeviceGroupSubmitInfo extends org.lwjgl.system.Struct<VkDeviceGroupSubmitInfo> implements org.lwjgl.system.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

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 Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • WAITSEMAPHORECOUNT

      public static final int WAITSEMAPHORECOUNT
      The struct member offsets.

    • PWAITSEMAPHOREDEVICEINDICES

      public static final int PWAITSEMAPHOREDEVICEINDICES
      The struct member offsets.

    • COMMANDBUFFERCOUNT

      public static final int COMMANDBUFFERCOUNT
      The struct member offsets.

    • PCOMMANDBUFFERDEVICEMASKS

      public static final int PCOMMANDBUFFERDEVICEMASKS
      The struct member offsets.

    • SIGNALSEMAPHORECOUNT

      public static final int SIGNALSEMAPHORECOUNT
      The struct member offsets.

    • PSIGNALSEMAPHOREDEVICEINDICES

      public static final int PSIGNALSEMAPHOREDEVICEINDICES
      The struct member offsets.

  • Constructor Details

    • VkDeviceGroupSubmitInfo

      public VkDeviceGroupSubmitInfo(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 Details

    • sizeof

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

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

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

    • waitSemaphoreCount

      public int waitSemaphoreCount()
      the number of elements in the pWaitSemaphoreDeviceIndices array.

    • pWaitSemaphoreDeviceIndices

      public @Nullable IntBuffer pWaitSemaphoreDeviceIndices()
      a pointer to an array of waitSemaphoreCount device indices indicating which physical device executes the semaphore wait operation in the corresponding element of VkSubmitInfo::pWaitSemaphores.

    • commandBufferCount

      public int commandBufferCount()
      the number of elements in the pCommandBufferDeviceMasks array.

    • pCommandBufferDeviceMasks

      public @Nullable IntBuffer pCommandBufferDeviceMasks()
      a pointer to an array of commandBufferCount 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

      public int signalSemaphoreCount()
      the number of elements in the pSignalSemaphoreDeviceIndices array.

    • pSignalSemaphoreDeviceIndices

      public @Nullable IntBuffer pSignalSemaphoreDeviceIndices()
      a pointer to an array of signalSemaphoreCount device indices indicating which physical device executes the semaphore signal operation in the corresponding element of VkSubmitInfo::pSignalSemaphores.

    • sType

      public VkDeviceGroupSubmitInfo sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkDeviceGroupSubmitInfo sType$Default()
      Sets the STRUCTURE_TYPE_DEVICE_GROUP_SUBMIT_INFO value to the sType() field.

    • pNext

      public VkDeviceGroupSubmitInfo pNext(long value)
      Sets the specified value to the pNext() field.

    • pWaitSemaphoreDeviceIndices

      public VkDeviceGroupSubmitInfo pWaitSemaphoreDeviceIndices(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pWaitSemaphoreDeviceIndices() field.

    • pCommandBufferDeviceMasks

      public VkDeviceGroupSubmitInfo pCommandBufferDeviceMasks(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pCommandBufferDeviceMasks() field.

    • pSignalSemaphoreDeviceIndices

      public VkDeviceGroupSubmitInfo pSignalSemaphoreDeviceIndices(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pSignalSemaphoreDeviceIndices() field.

    • set

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

    • set

      public VkDeviceGroupSubmitInfo set(VkDeviceGroupSubmitInfo src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

      public static @Nullable VkDeviceGroupSubmitInfo createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkDeviceGroupSubmitInfo.Buffer malloc(int capacity)
      Returns a new VkDeviceGroupSubmitInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkDeviceGroupSubmitInfo.Buffer calloc(int capacity)
      Returns a new VkDeviceGroupSubmitInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkDeviceGroupSubmitInfo.Buffer create(int capacity)
      Returns a new VkDeviceGroupSubmitInfo.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkDeviceGroupSubmitInfo.Buffer create(long address, int capacity)
      Create a VkDeviceGroupSubmitInfo.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkDeviceGroupSubmitInfo.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static VkDeviceGroupSubmitInfo mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDeviceGroupSubmitInfo callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDeviceGroupSubmitInfo mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDeviceGroupSubmitInfo callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDeviceGroupSubmitInfo.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDeviceGroupSubmitInfo.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDeviceGroupSubmitInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDeviceGroupSubmitInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

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

    • malloc

      public static VkDeviceGroupSubmitInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkDeviceGroupSubmitInfo.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkDeviceGroupSubmitInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkDeviceGroupSubmitInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      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().

    • nwaitSemaphoreCount

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

    • npWaitSemaphoreDeviceIndices

      public static @Nullable IntBuffer npWaitSemaphoreDeviceIndices(long struct)
      Unsafe version of pWaitSemaphoreDeviceIndices.

    • ncommandBufferCount

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

    • npCommandBufferDeviceMasks

      public static @Nullable IntBuffer npCommandBufferDeviceMasks(long struct)
      Unsafe version of pCommandBufferDeviceMasks.

    • nsignalSemaphoreCount

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

    • npSignalSemaphoreDeviceIndices

      public static @Nullable IntBuffer npSignalSemaphoreDeviceIndices(long struct)
      Unsafe version of pSignalSemaphoreDeviceIndices.

    • 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 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 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 IntBuffer value)
      Unsafe version of pSignalSemaphoreDeviceIndices.

    • validate

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