Package org.lwjgl.vulkan

Class VkPipelineCacheCreateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkPipelineCacheCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying parameters of a newly created pipeline cache.
    Valid Usage
    • If initialDataSize is not 0, it must be equal to the size of pInitialData, as returned by vkGetPipelineCacheData when pInitialData was originally retrieved
    • If initialDataSize is not 0, pInitialData must have been retrieved from a previous call to vkGetPipelineCacheData
    • If the pipelineCreationCacheControl feature is not enabled, flags must not include PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO
    • pNext must be NULL
    • flags must be a valid combination of VkPipelineCacheCreateFlagBits values
    • If initialDataSize is not 0, pInitialData must be a valid pointer to an array of initialDataSize bytes
    See Also

    CreatePipelineCache

    Layout

    
 struct VkPipelineCacheCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkPipelineCacheCreateFlags flags();
     size_t initialDataSize();
     void const * pInitialData();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, FLAGS, INITIALDATASIZE, PINITIALDATA

        The struct member offsets.

    • Constructor Detail

      • VkPipelineCacheCreateInfo

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

      • flags

        public int flags()
        a bitmask of VkPipelineCacheCreateFlagBits specifying the behavior of the pipeline cache.

      • initialDataSize

        public long initialDataSize()
        the number of bytes in pInitialData. If initialDataSize is zero, the pipeline cache will initially be empty.

      • pInitialData

        @Nullable
public java.nio.ByteBuffer pInitialData()
        a pointer to previously retrieved pipeline cache data. If the pipeline cache data is incompatible (as defined below) with the device, the pipeline cache will be initially empty. If initialDataSize is zero, pInitialData is ignored.

      • set

        public VkPipelineCacheCreateInfo set​(int sType,
                                     long pNext,
                                     int flags,
                                     @Nullable
                                     java.nio.ByteBuffer pInitialData)
        Initializes this struct with the specified values.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • malloc

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

      • calloc

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

      • calloc

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

      • ninitialDataSize

        public static long ninitialDataSize​(long struct)
        Unsafe version of initialDataSize().

      • npInitialData

        @Nullable
public static java.nio.ByteBuffer npInitialData​(long struct)
        Unsafe version of pInitialData.

      • 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.

      • ninitialDataSize

        public static void ninitialDataSize​(long struct,
                                    long value)
        Sets the specified value to the initialDataSize field of the specified struct.

      • npInitialData

        public static void npInitialData​(long struct,
                                 @Nullable
                                 java.nio.ByteBuffer value)
        Unsafe version of pInitialData.

      • validate

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