Class VkDeviceQueueInfo2

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

    public class VkDeviceQueueInfo2
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.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 structure. If no matching flags were specified at device creation time, then the handle returned in pQueue must be NULL.

    Valid Usage
    • queueFamilyIndex must be one of the queue family indices specified when device was created, via the VkDeviceQueueCreateInfo structure
    • flags must be equal to VkDeviceQueueCreateInfo::flags for a VkDeviceQueueCreateInfo structure for the queue family indicated by queueFamilyIndex when device was created
    • queueIndex must be less than VkDeviceQueueCreateInfo::queueCount for the corresponding queue family and flags indicated by queueFamilyIndex and flags when device was created
    Valid Usage (Implicit)
    See Also

    GetDeviceQueue2

    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()
        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. The pNext chain of VkDeviceQueueInfo2 can be used to provide additional device queue parameters to vkGetDeviceQueue2.
      • flags

        public int flags()
        a VkDeviceQueueCreateFlags value indicating the flags used to create the device queue.
      • queueFamilyIndex

        public int queueFamilyIndex()
        the index of the queue family to which the queue belongs.
      • queueIndex

        public int queueIndex()
        the index within this queue family of the queue to retrieve.
      • 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()
        Returns a new VkDeviceQueueInfo2 instance allocated with BufferUtils.
      • 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

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

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

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

        public static VkDeviceQueueInfo2 calloc​(org.lwjgl.system.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
      • malloc

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

        public static VkDeviceQueueInfo2.Buffer calloc​(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
        Returns a new VkDeviceQueueInfo2.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().
      • 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.