Class VkComputePipelineCreateInfo

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

    public class VkComputePipelineCreateInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying parameters of a newly created compute pipeline.
    Description

    The parameters basePipelineHandle and basePipelineIndex are described in more detail in Pipeline Derivatives.

    stage points to a structure of type VkPipelineShaderStageCreateInfo.

    Valid Usage
    Valid Usage (Implicit)
    See Also

    VkPipelineShaderStageCreateInfo, CreateComputePipelines

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – a bitmask of VkPipelineCreateFlagBits specifying how the pipeline will be generated.
    • stage – a VkPipelineShaderStageCreateInfo describing the compute shader.
    • layout – the description of binding locations used by both the pipeline and descriptor sets used with the pipeline.
    • basePipelineHandle – a pipeline to derive from
    • basePipelineIndex – an index into the pCreateInfos parameter to use as a pipeline to derive from

    Layout

    
     struct VkComputePipelineCreateInfo {
         VkStructureType sType;
         void const * pNext;
         VkPipelineCreateFlags flags;
         VkPipelineShaderStageCreateInfo stage;
         VkPipelineLayout layout;
         VkPipeline basePipelineHandle;
         int32_t basePipelineIndex;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, STAGE, LAYOUT, BASEPIPELINEHANDLE, BASEPIPELINEINDEX

        The struct member offsets.
    • Constructor Detail

      • VkComputePipelineCreateInfo

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

        public long layout()
        Returns the value of the layout field.
      • basePipelineHandle

        public long basePipelineHandle()
        Returns the value of the basePipelineHandle field.
      • basePipelineIndex

        public int basePipelineIndex()
        Returns the value of the basePipelineIndex field.
      • basePipelineHandle

        public VkComputePipelineCreateInfo basePipelineHandle​(long value)
        Sets the specified value to the basePipelineHandle field.
      • basePipelineIndex

        public VkComputePipelineCreateInfo basePipelineIndex​(int value)
        Sets the specified value to the basePipelineIndex field.
      • malloc

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

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

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

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

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

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

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

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

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

        public static long nlayout​(long struct)
        Unsafe version of layout().
      • nbasePipelineHandle

        public static long nbasePipelineHandle​(long struct)
        Unsafe version of basePipelineHandle().
      • nbasePipelineIndex

        public static int nbasePipelineIndex​(long struct)
        Unsafe version of basePipelineIndex().
      • 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.
      • nlayout

        public static void nlayout​(long struct,
                                   long value)
        Unsafe version of layout.
      • nbasePipelineHandle

        public static void nbasePipelineHandle​(long struct,
                                               long value)
        Unsafe version of basePipelineHandle.
      • nbasePipelineIndex

        public static void nbasePipelineIndex​(long struct,
                                              int value)
        Unsafe version of basePipelineIndex.
      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array