VkPipelineCacheCreateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.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
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO
- pNext must be NULL
- flags must be 0
- If initialDataSize is not 0, pInitialData must be a valid pointer to an array of initialDataSize bytes
See Also

CreatePipelineCache

Member documentation
- sType – the type of this structure.
- pNext – NULL 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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPipelineCacheCreateInfo.Buffer
An array of VkPipelineCacheCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPipelineCacheCreateInfo.Buffer` An array of `VkPipelineCacheCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`INITIALDATASIZE` The struct member offsets.
`static int`	`PINITIALDATA` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkPipelineCacheCreateInfo(java.nio.ByteBuffer container)` Creates a `VkPipelineCacheCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPipelineCacheCreateInfo`	`calloc()` Returns a new `VkPipelineCacheCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineCacheCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineCacheCreateInfo`	`callocStack()` Returns a new `VkPipelineCacheCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCacheCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCacheCreateInfo.Buffer`	`callocStack(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.
`static VkPipelineCacheCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCacheCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineCacheCreateInfo`	`create()` Returns a new `VkPipelineCacheCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineCacheCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineCacheCreateInfo`	`create(long address)` Returns a new `VkPipelineCacheCreateInfo` instance for the specified memory address.
`static VkPipelineCacheCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkPipelineCacheCreateInfo.Buffer` instance at the specified memory.
`static VkPipelineCacheCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineCacheCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineCacheCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`long`	`initialDataSize()` Returns the value of the `initialDataSize` field.
`static VkPipelineCacheCreateInfo`	`malloc()` Returns a new `VkPipelineCacheCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineCacheCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineCacheCreateInfo`	`mallocStack()` Returns a new `VkPipelineCacheCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCacheCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineCacheCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCacheCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineCacheCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineCacheCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`ninitialDataSize(long struct)` Unsafe version of `initialDataSize()`.
`static void`	`ninitialDataSize(long struct, long value)` Sets the specified value to the `initialDataSize` field of the specified `struct`.
`static java.nio.ByteBuffer`	`npInitialData(long struct)` Unsafe version of `pInitialData`.
`static void`	`npInitialData(long struct, java.nio.ByteBuffer value)` Unsafe version of `pInitialData`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.ByteBuffer`	`pInitialData()` Returns a `ByteBuffer` view of the data pointed to by the `pInitialData` field.
`VkPipelineCacheCreateInfo`	`pInitialData(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `pInitialData` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineCacheCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPipelineCacheCreateInfo`	`set(int sType, long pNext, int flags, java.nio.ByteBuffer pInitialData)` Initializes this struct with the specified values.
`VkPipelineCacheCreateInfo`	`set(VkPipelineCacheCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineCacheCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - INITIALDATASIZE
```
public static final int INITIALDATASIZE
```
    The struct member offsets.
  - PINITIALDATA
```
public static final int 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()
```
    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.
  - sType
```
public VkPipelineCacheCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineCacheCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkPipelineCacheCreateInfo flags(int value)
```
    Sets the specified value to the flags 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.
  - set
```
public VkPipelineCacheCreateInfo set(VkPipelineCacheCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - 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.
  - createSafe
```
@Nullable
public static VkPipelineCacheCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineCacheCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineCacheCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCacheCreateInfo.Buffer create(int capacity)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineCacheCreateInfo.Buffer create(long address,
                                                      int capacity)
```
    Create a VkPipelineCacheCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPipelineCacheCreateInfo.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPipelineCacheCreateInfo mallocStack()
```
    Returns a new VkPipelineCacheCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineCacheCreateInfo callocStack()
```
    Returns a new VkPipelineCacheCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineCacheCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCacheCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineCacheCreateInfo callocStack(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
  - mallocStack
```
public static VkPipelineCacheCreateInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineCacheCreateInfo.Buffer mallocStack(int capacity,
                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineCacheCreateInfo.Buffer callocStack(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
  - 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

Class VkPipelineCacheCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

INITIALDATASIZE

PINITIALDATA

Constructor Detail

VkPipelineCacheCreateInfo

Method Detail

sizeof

sType

pNext

flags

initialDataSize

pInitialData

sType

pNext

flags

pInitialData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

ninitialDataSize

npInitialData

nsType

npNext

nflags

ninitialDataSize

npInitialData

validate

validate