Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineCacheCreateInfo

extends Struct<VkPipelineCacheCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying parameters of a newly created pipeline cache.
Valid Usage
Valid Usage (Implicit)
See Also

CreatePipelineCache

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
INITIALDATASIZE

The struct member offsets.

public static final int
PINITIALDATA

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPipelineCacheCreateInfo(long address, ByteBuffer container)

public
VkPipelineCacheCreateInfo(ByteBuffer container)

Creates a VkPipelineCacheCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineCacheCreateInfo
calloc()

Returns a new VkPipelineCacheCreateInfo instance allocated with memCalloc.

public static VkPipelineCacheCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memCalloc.

public static VkPipelineCacheCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineCacheCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPipelineCacheCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPipelineCacheCreateInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkPipelineCacheCreateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkPipelineCacheCreateInfo
create()

Returns a new VkPipelineCacheCreateInfo instance allocated with BufferUtils.

public static VkPipelineCacheCreateInfo
create(long address)

Returns a new VkPipelineCacheCreateInfo instance for the specified memory address.

public static VkPipelineCacheCreateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with BufferUtils.

public static VkPipelineCacheCreateInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkPipelineCacheCreateInfo.Buffer instance at the specified memory.

public static VkPipelineCacheCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkPipelineCacheCreateInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
flags()

a bitmask of VkPipelineCacheCreateFlagBits specifying the behavior of the pipeline cache.

public VkPipelineCacheCreateInfo
flags(int value)

Sets the specified value to the flags field.

public long
initialDataSize()

the number of bytes in pInitialData.

public static VkPipelineCacheCreateInfo
malloc()

Returns a new VkPipelineCacheCreateInfo instance allocated with memAlloc.

public static VkPipelineCacheCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memAlloc.

public static VkPipelineCacheCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineCacheCreateInfo instance allocated on the specified MemoryStack.

public static VkPipelineCacheCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the specified MemoryStack.

public static VkPipelineCacheCreateInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineCacheCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
ninitialDataSize(long struct)

Unsafe version of initialDataSize.

public static void
ninitialDataSize(long struct, long value)

Sets the specified value to the initialDataSize field of the specified struct.

public static ByteBuffer
npInitialData(long struct)

Unsafe version of pInitialData.

public static void
npInitialData(long struct, ByteBuffer value)

Unsafe version of pInitialData.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public ByteBuffer
pInitialData()

a pointer to previously retrieved pipeline cache data.

public VkPipelineCacheCreateInfo
pInitialData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pInitialData field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineCacheCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineCacheCreateInfo
set(int sType, long pNext, int flags, ByteBuffer pInitialData)

Initializes this struct with the specified values.

public VkPipelineCacheCreateInfo

Returns:

this struct
set
(VkPipelineCacheCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPipelineCacheCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkPipelineCacheCreateInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

INITIALDATASIZEback to summary
public static final int INITIALDATASIZE

The struct member offsets.

PINITIALDATAback to summary
public static final int PINITIALDATA

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPipelineCacheCreateInfoback to summary
protected VkPipelineCacheCreateInfo(long address, ByteBuffer container)
VkPipelineCacheCreateInfoback to summary
public VkPipelineCacheCreateInfo(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

callocback to summary
public static VkPipelineCacheCreateInfo calloc()

Returns a new VkPipelineCacheCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkPipelineCacheCreateInfo.Buffer calloc(int capacity)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineCacheCreateInfo calloc(MemoryStack stack)

Returns a new VkPipelineCacheCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPipelineCacheCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkPipelineCacheCreateInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineCacheCreateInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkPipelineCacheCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPipelineCacheCreateInfo create()

Returns a new VkPipelineCacheCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkPipelineCacheCreateInfo create(long address)

Returns a new VkPipelineCacheCreateInfo instance for the specified memory address.

createback to summary
public static VkPipelineCacheCreateInfo.Buffer create(int capacity)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkPipelineCacheCreateInfo.Buffer create(long address, int capacity)

Create a VkPipelineCacheCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineCacheCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPipelineCacheCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

a bitmask of VkPipelineCacheCreateFlagBits specifying the behavior of the pipeline cache.

Annotations
@NativeType:VkPipelineCacheCreateFlags
flagsback to summary
public VkPipelineCacheCreateInfo flags(int value)

Sets the specified value to the flags field.

initialDataSizeback to summary
public long initialDataSize()

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

Annotations
@NativeType:size_t
mallocback to summary
public static VkPipelineCacheCreateInfo malloc()

Returns a new VkPipelineCacheCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkPipelineCacheCreateInfo.Buffer malloc(int capacity)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineCacheCreateInfo malloc(MemoryStack stack)

Returns a new VkPipelineCacheCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPipelineCacheCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkPipelineCacheCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkPipelineCacheCreateInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineCacheCreateInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineCacheCreateInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineCacheCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

ninitialDataSizeback to summary
public static long ninitialDataSize(long struct)

Unsafe version of initialDataSize.

ninitialDataSizeback to summary
public static void ninitialDataSize(long struct, long value)

Sets the specified value to the initialDataSize field of the specified struct.

npInitialDataback to summary
public static ByteBuffer npInitialData(long struct)

Unsafe version of pInitialData.

Annotations
@Nullable
npInitialDataback to summary
public static void npInitialData(long struct, ByteBuffer value)

Unsafe version of pInitialData.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pInitialDataback to summary
public 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.

Annotations
@Nullable
@NativeType:void const *
pInitialDataback to summary
public VkPipelineCacheCreateInfo pInitialData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pInitialData field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineCacheCreateInfo pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPipelineCacheCreateInfo set(int sType, long pNext, int flags, ByteBuffer pInitialData)

Initializes this struct with the specified values.

setback to summary
public VkPipelineCacheCreateInfo set(VkPipelineCacheCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineCacheCreateInfo

the source struct

Returns:VkPipelineCacheCreateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineCacheCreateInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPipelineCacheCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkPipelineCacheCreateInfo.Buffer

extends StructBuffer<VkPipelineCacheCreateInfo, VkPipelineCacheCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPipelineCacheCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineCacheCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineCacheCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkPipelineCacheCreateInfo#flags field.
flags
()

public VkPipelineCacheCreateInfo.Buffer
flags(int value)

Sets the specified value to the VkPipelineCacheCreateInfo#flags field.

protected VkPipelineCacheCreateInfo
public long
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the VkPipelineCacheCreateInfo#pInitialData field.
pInitialData
()

public VkPipelineCacheCreateInfo.Buffer
pInitialData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkPipelineCacheCreateInfo#pInitialData field.

public long

Returns:

the value of the VkPipelineCacheCreateInfo#pNext field.
pNext
()

public VkPipelineCacheCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkPipelineCacheCreateInfo#pNext field.

protected VkPipelineCacheCreateInfo.Buffer
public int

Returns:

the value of the VkPipelineCacheCreateInfo#sType field.
sType
()

public VkPipelineCacheCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkPipelineCacheCreateInfo#sType field.

public VkPipelineCacheCreateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineCacheCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineCacheCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPipelineCacheCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public int flags()
Returns:int

the value of the VkPipelineCacheCreateInfo#flags field.

Annotations
@NativeType:VkPipelineCacheCreateFlags
flagsback to summary
public VkPipelineCacheCreateInfo.Buffer flags(int value)

Sets the specified value to the VkPipelineCacheCreateInfo#flags field.

getElementFactoryback to summary
protected VkPipelineCacheCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
initialDataSizeback to summary
public long initialDataSize()
Returns:long

the value of the VkPipelineCacheCreateInfo#initialDataSize field.

Annotations
@NativeType:size_t
pInitialDataback to summary
public ByteBuffer pInitialData()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the VkPipelineCacheCreateInfo#pInitialData field.

Annotations
@Nullable
@NativeType:void const *
pInitialDataback to summary
public VkPipelineCacheCreateInfo.Buffer pInitialData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the VkPipelineCacheCreateInfo#pInitialData field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineCacheCreateInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineCacheCreateInfo.Buffer pNext(long value)

Sets the specified value to the VkPipelineCacheCreateInfo#pNext field.

selfback to summary
protected VkPipelineCacheCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPipelineCacheCreateInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineCacheCreateInfo.Buffer sType(int value)

Sets the specified value to the VkPipelineCacheCreateInfo#sType field.

sType$Defaultback to summary
public VkPipelineCacheCreateInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO value to the VkPipelineCacheCreateInfo#sType field.