Class VkCommandPoolCreateInfo

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

    public class VkCommandPoolCreateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying parameters of a newly created command pool.
    Valid Usage (Implicit)
    See Also

    CreateCommandPool

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – a bitmask of VkCommandPoolCreateFlagBits indicating usage behavior for the pool and command buffers allocated from it.
    • queueFamilyIndex – designates a queue family as described in section Queue Family Properties. All command buffers allocated from this command pool must be submitted on queues from the same queue family.

    Layout

    
     struct VkCommandPoolCreateInfo {
         VkStructureType sType;
         void const * pNext;
         VkCommandPoolCreateFlags flags;
         uint32_t queueFamilyIndex;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

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

        The struct member offsets.
    • Constructor Detail

      • VkCommandPoolCreateInfo

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

        public VkCommandPoolCreateInfo queueFamilyIndex​(int value)
        Sets the specified value to the queueFamilyIndex field.
      • set

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

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

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

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

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

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

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

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

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

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

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