Package org.lwjgl.vulkan

Class VkDrawIndirectCommand

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkDrawIndirectCommand
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying a indirect drawing command.
    Description

    The members of VkDrawIndirectCommand have the same meaning as the similarly named parameters of CmdDraw.

    Valid Usage
    • For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in Vertex Input Description
    • If the drawIndirectFirstInstance feature is not enabled, firstInstance must be 0
    See Also

    CmdDrawIndirect

    Layout

    
 struct VkDrawIndirectCommand {
     uint32_t vertexCount();
     uint32_t instanceCount();
     uint32_t firstVertex();
     uint32_t firstInstance();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • VERTEXCOUNT, INSTANCECOUNT, FIRSTVERTEX, FIRSTINSTANCE

        The struct member offsets.

    • Constructor Detail

      • VkDrawIndirectCommand

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

      • vertexCount

        public int vertexCount()
        the number of vertices to draw.

      • instanceCount

        public int instanceCount()
        the number of instances to draw.

      • firstVertex

        public int firstVertex()
        the index of the first vertex to draw.

      • firstInstance

        public int firstInstance()
        the instance ID of the first instance to draw.

      • set

        public VkDrawIndirectCommand set​(int vertexCount,
                                 int instanceCount,
                                 int firstVertex,
                                 int firstInstance)
        Initializes this struct with the specified values.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • malloc

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

      • calloc

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

      • nvertexCount

        public static int nvertexCount​(long struct)
        Unsafe version of vertexCount().

      • ninstanceCount

        public static int ninstanceCount​(long struct)
        Unsafe version of instanceCount().

      • nfirstVertex

        public static int nfirstVertex​(long struct)
        Unsafe version of firstVertex().

      • nfirstInstance

        public static int nfirstInstance​(long struct)
        Unsafe version of firstInstance().

      • nvertexCount

        public static void nvertexCount​(long struct,
                                int value)
        Unsafe version of vertexCount.

      • ninstanceCount

        public static void ninstanceCount​(long struct,
                                  int value)
        Unsafe version of instanceCount.

      • nfirstVertex

        public static void nfirstVertex​(long struct,
                                int value)
        Unsafe version of firstVertex.

      • nfirstInstance

        public static void nfirstInstance​(long struct,
                                  int value)
        Unsafe version of firstInstance.