Package org.lwjgl.vulkan
Class VkPipelineCacheCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineCacheCreateInfo>
org.lwjgl.vulkan.VkPipelineCacheCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineCacheCreateInfo
extends org.lwjgl.system.Struct<VkPipelineCacheCreateInfo>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created pipeline cache.
Valid Usage
- If
initialDataSizeis not 0, it must be equal to the size ofpInitialData, as returned byvkGetPipelineCacheDatawhenpInitialDatawas originally retrieved - If
initialDataSizeis not 0,pInitialDatamust have been retrieved from a previous call tovkGetPipelineCacheData - If the
pipelineCreationCacheControlfeature is not enabled,flagsmust not includePIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFOpNextmust beNULLflagsmust be a valid combination ofVkPipelineCacheCreateFlagBitsvalues- If
initialDataSizeis not 0,pInitialDatamust be a valid pointer to an array ofinitialDataSizebytes
See Also
Layout
struct VkPipelineCacheCreateInfo {
VkStructureType sType();
void const * pNext();
VkPipelineCacheCreateFlags flags();
size_t initialDataSize();
void const * pInitialData();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPipelineCacheCreateInfo(ByteBuffer container) Creates aVkPipelineCacheCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkPipelineCacheCreateInfocalloc()Returns a newVkPipelineCacheCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineCacheCreateInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineCacheCreateInfoDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkPipelineCacheCreateInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkPipelineCacheCreateInfocreate()Returns a newVkPipelineCacheCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineCacheCreateInfocreate(long address) Returns a newVkPipelineCacheCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineCacheCreateInfo.Bufferinstance at the specified memory.static @Nullable VkPipelineCacheCreateInfocreateSafe(long address) static @Nullable VkPipelineCacheCreateInfo.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkPipelineCacheCreateFlagBitsspecifying the behavior of the pipeline cache.flags(int value) Sets the specified value to theflags()field.longthe number of bytes inpInitialData.static VkPipelineCacheCreateInfomalloc()Returns a newVkPipelineCacheCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineCacheCreateInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfoinstance allocated on the specifiedMemoryStack.static VkPipelineCacheCreateInfoDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkPipelineCacheCreateInfomallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longninitialDataSize(long struct) Unsafe version ofinitialDataSize().static voidninitialDataSize(long struct, long value) Sets the specified value to theinitialDataSizefield of the specifiedstruct.static @Nullable ByteBuffernpInitialData(long struct) Unsafe version ofpInitialData.static voidnpInitialData(long struct, @Nullable ByteBuffer value) Unsafe version ofpInitialData.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.@Nullable ByteBuffera pointer to previously retrieved pipeline cache data.pInitialData(@Nullable ByteBuffer value) Sets the address of the specifiedByteBufferto thepInitialData()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int flags, @Nullable ByteBuffer pInitialData) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
INITIALDATASIZE
public static final int INITIALDATASIZEThe struct member offsets. -
PINITIALDATA
public static final int PINITIALDATAThe struct member offsets.
-
-
Constructor Details
-
VkPipelineCacheCreateInfo
Creates aVkPipelineCacheCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineCacheCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkPipelineCacheCreateFlagBitsspecifying the behavior of the pipeline cache. -
initialDataSize
public long initialDataSize()the number of bytes inpInitialData. IfinitialDataSizeis 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. IfinitialDataSizeis zero,pInitialDatais ignored. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
pInitialData
Sets the address of the specifiedByteBufferto thepInitialData()field. -
set
public VkPipelineCacheCreateInfo set(int sType, long pNext, int flags, @Nullable ByteBuffer pInitialData) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineCacheCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineCacheCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineCacheCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkPipelineCacheCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineCacheCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineCacheCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineCacheCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineCacheCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineCacheCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineCacheCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineCacheCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ninitialDataSize
public static long ninitialDataSize(long struct) Unsafe version ofinitialDataSize(). -
npInitialData
Unsafe version ofpInitialData. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ninitialDataSize
public static void ninitialDataSize(long struct, long value) Sets the specified value to theinitialDataSizefield of the specifiedstruct. -
npInitialData
Unsafe version ofpInitialData. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-