Class VkCommandBufferAllocateInfo

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

    public class VkCommandBufferAllocateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying the allocation parameters for command buffer object.
    Valid Usage
    • commandBufferCount must be greater than 0
    Valid Usage (Implicit)
    See Also

    AllocateCommandBuffers

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • commandPool – the command pool from which the command buffers are allocated.
    • level – a VkCommandBufferLevel value specifying the command buffer level.
    • commandBufferCount – the number of command buffers to allocate from the pool.

    Layout

    
     struct VkCommandBufferAllocateInfo {
         VkStructureType sType;
         void const * pNext;
         VkCommandPool commandPool;
         VkCommandBufferLevel level;
         uint32_t commandBufferCount;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, COMMANDPOOL, LEVEL, COMMANDBUFFERCOUNT

        The struct member offsets.
    • Constructor Detail

      • VkCommandBufferAllocateInfo

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

        public long commandPool()
        Returns the value of the commandPool field.
      • level

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

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

        public VkCommandBufferAllocateInfo commandBufferCount​(int value)
        Sets the specified value to the commandBufferCount field.
      • set

        public VkCommandBufferAllocateInfo set​(int sType,
                                               long pNext,
                                               long commandPool,
                                               int level,
                                               int commandBufferCount)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

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

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

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

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

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

        public static long ncommandPool​(long struct)
        Unsafe version of commandPool().
      • nlevel

        public static int nlevel​(long struct)
        Unsafe version of level().
      • ncommandBufferCount

        public static int ncommandBufferCount​(long struct)
        Unsafe version of commandBufferCount().
      • 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.
      • ncommandPool

        public static void ncommandPool​(long struct,
                                        long value)
        Unsafe version of commandPool.
      • nlevel

        public static void nlevel​(long struct,
                                  int value)
        Unsafe version of level.
      • ncommandBufferCount

        public static void ncommandBufferCount​(long struct,
                                               int value)
        Unsafe version of commandBufferCount.