Package org.lwjgl.vulkan
Class VkPipelineCacheCreateInfo
- 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 ofpInitialData
, as returned byvkGetPipelineCacheData
whenpInitialData
was originally retrieved - If
initialDataSize
is not 0,pInitialData
must have been retrieved from a previous call tovkGetPipelineCacheData
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO
pNext
must beNULL
flags
must be 0- If
initialDataSize
is not 0,pInitialData
must be a valid pointer to an array ofinitialDataSize
bytes
See Also
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 inpInitialData
. IfinitialDataSize
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. IfinitialDataSize
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 Description static class
VkPipelineCacheCreateInfo.Buffer
An array ofVkPipelineCacheCreateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
INITIALDATASIZE
PINITIALDATA
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineCacheCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineCacheCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineCacheCreateInfo
calloc()
Returns a newVkPipelineCacheCreateInfo
instance allocated withmemCalloc
.static VkPipelineCacheCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineCacheCreateInfo
callocStack()
Returns a newVkPipelineCacheCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineCacheCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineCacheCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineCacheCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineCacheCreateInfo
create()
Returns a newVkPipelineCacheCreateInfo
instance allocated withBufferUtils
.static VkPipelineCacheCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineCacheCreateInfo
create(long address)
Returns a newVkPipelineCacheCreateInfo
instance for the specified memory address.static VkPipelineCacheCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineCacheCreateInfo.Buffer
instance at the specified memory.static VkPipelineCacheCreateInfo
createSafe(long address)
static VkPipelineCacheCreateInfo.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkPipelineCacheCreateInfo
flags(int value)
Sets the specified value to theflags
field.long
initialDataSize()
Returns the value of theinitialDataSize
field.static VkPipelineCacheCreateInfo
malloc()
Returns a newVkPipelineCacheCreateInfo
instance allocated withmemAlloc
.static VkPipelineCacheCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineCacheCreateInfo
mallocStack()
Returns a newVkPipelineCacheCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineCacheCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineCacheCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineCacheCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static long
ninitialDataSize(long struct)
Unsafe version ofinitialDataSize()
.static void
ninitialDataSize(long struct, long value)
Sets the specified value to theinitialDataSize
field of the specifiedstruct
.static java.nio.ByteBuffer
npInitialData(long struct)
Unsafe version ofpInitialData
.static void
npInitialData(long struct, java.nio.ByteBuffer value)
Unsafe version ofpInitialData
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.java.nio.ByteBuffer
pInitialData()
Returns aByteBuffer
view of the data pointed to by thepInitialData
field.VkPipelineCacheCreateInfo
pInitialData(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepInitialData
field.long
pNext()
Returns the value of thepNext
field.VkPipelineCacheCreateInfo
pNext(long value)
Sets the specified value to thepNext
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 thesType
field.VkPipelineCacheCreateInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkPipelineCacheCreateInfo
public VkPipelineCacheCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineCacheCreateInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
initialDataSize
public long initialDataSize()
Returns the value of theinitialDataSize
field.
-
pInitialData
@Nullable public java.nio.ByteBuffer pInitialData()
Returns aByteBuffer
view of the data pointed to by thepInitialData
field.
-
sType
public VkPipelineCacheCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineCacheCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkPipelineCacheCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
pInitialData
public VkPipelineCacheCreateInfo pInitialData(@Nullable java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepInitialData
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 newVkPipelineCacheCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineCacheCreateInfo calloc()
Returns a newVkPipelineCacheCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineCacheCreateInfo create()
Returns a newVkPipelineCacheCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineCacheCreateInfo create(long address)
Returns a newVkPipelineCacheCreateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineCacheCreateInfo createSafe(long address)
-
malloc
public static VkPipelineCacheCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineCacheCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineCacheCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineCacheCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineCacheCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineCacheCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineCacheCreateInfo mallocStack()
Returns a newVkPipelineCacheCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineCacheCreateInfo callocStack()
Returns a newVkPipelineCacheCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineCacheCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineCacheCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo
instance allocated on the specifiedMemoryStack
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 newVkPipelineCacheCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
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 newVkPipelineCacheCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineCacheCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineCacheCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
@Nullable public static java.nio.ByteBuffer npInitialData(long struct)
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 theinitialDataSize
field of the specifiedstruct
.
-
npInitialData
public static void npInitialData(long struct, @Nullable java.nio.ByteBuffer value)
Unsafe version ofpInitialData
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-