Class VkDeviceQueueInfo2

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

    public class VkDeviceQueueInfo2
    extends Struct
    implements NativeResource
    Structure specifying the parameters used for device queue creation.
    Description

    The queue returned by vkGetDeviceQueue2 must have the same flags value from this structure as that used at device creation time in a VkDeviceQueueCreateInfo instance. If no matching flags were specified at device creation time then pQueue will return NULL_HANDLE.

    Valid Usage
    • queueFamilyIndex must be one of the queue family indices specified when device was created, via the VkDeviceQueueCreateInfo structure
    • queueIndex must be less than the number of queues created for the specified queue family index and VkDeviceQueueCreateFlags member flags equal to this flags value when device was created, via the queueCount member of the VkDeviceQueueCreateInfo structure
    Valid Usage (Implicit)
    See Also

    GetDeviceQueue2

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure. The pNext chain of VkDeviceQueueInfo2 is used to provide additional image parameters to vkGetDeviceQueue2.
    • flags – a VkDeviceQueueCreateFlags value indicating the flags used to create the device queue.
    • queueFamilyIndex – the index of the queue family to which the queue belongs.
    • queueIndex – the index within this queue family of the queue to retrieve.

    Layout

    
     struct VkDeviceQueueInfo2 {
         VkStructureType sType;
         void const * pNext;
         VkDeviceQueueCreateFlags flags;
         uint32_t queueFamilyIndex;
         uint32_t queueIndex;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, QUEUEFAMILYINDEX, QUEUEINDEX

        The struct member offsets.
    • Constructor Detail

      • VkDeviceQueueInfo2

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

        public int flags()
        Returns the value of the flags field.
      • queueFamilyIndex

        public int queueFamilyIndex()
        Returns the value of the queueFamilyIndex field.
      • queueIndex

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

        public VkDeviceQueueInfo2 sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkDeviceQueueInfo2 pNext​(long value)
        Sets the specified value to the pNext field.
      • flags

        public VkDeviceQueueInfo2 flags​(int value)
        Sets the specified value to the flags field.
      • queueFamilyIndex

        public VkDeviceQueueInfo2 queueFamilyIndex​(int value)
        Sets the specified value to the queueFamilyIndex field.
      • queueIndex

        public VkDeviceQueueInfo2 queueIndex​(int value)
        Sets the specified value to the queueIndex field.
      • set

        public VkDeviceQueueInfo2 set​(int sType,
                                      long pNext,
                                      int flags,
                                      int queueFamilyIndex,
                                      int queueIndex)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

        public static VkDeviceQueueInfo2 mallocStack()
        Returns a new VkDeviceQueueInfo2 instance allocated on the thread-local MemoryStack.
      • callocStack

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

        public static VkDeviceQueueInfo2 mallocStack​(MemoryStack stack)
        Returns a new VkDeviceQueueInfo2 instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkDeviceQueueInfo2 callocStack​(MemoryStack stack)
        Returns a new VkDeviceQueueInfo2 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().
      • nflags

        public static int nflags​(long struct)
        Unsafe version of flags().
      • nqueueFamilyIndex

        public static int nqueueFamilyIndex​(long struct)
        Unsafe version of queueFamilyIndex().
      • nqueueIndex

        public static int nqueueIndex​(long struct)
        Unsafe version of queueIndex().
      • 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.
      • nflags

        public static void nflags​(long struct,
                                  int value)
        Unsafe version of flags.
      • nqueueFamilyIndex

        public static void nqueueFamilyIndex​(long struct,
                                             int value)
        Unsafe version of queueFamilyIndex.
      • nqueueIndex

        public static void nqueueIndex​(long struct,
                                       int value)
        Unsafe version of queueIndex.