Class VkPipelineCacheCreateInfo

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

    public class VkPipelineCacheCreateInfo
    extends Struct
    implements 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
    Valid Usage (Implicit)
    See Also

    CreatePipelineCache

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – reserved for future use.
    • initialDataSize – the number of bytes in pInitialData. If initialDataSize is zero, the pipeline cache will initially be empty.
    • 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.

    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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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.
      • initialDataSize

        public long initialDataSize()
        Returns the value of the initialDataSize field.
      • pInitialData

        @Nullable
        public java.nio.ByteBuffer pInitialData()
        Returns a ByteBuffer view of the data pointed to by the pInitialData field.
      • pInitialData

        public VkPipelineCacheCreateInfo pInitialData​(@Nullable
                                                      java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the pInitialData field.
      • 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​(long address)
        Returns a new VkPipelineCacheCreateInfo instance for the specified memory address.
      • callocStack

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

        public static VkPipelineCacheCreateInfo callocStack​(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
      • 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
      • 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