Package org.lwjgl.vulkan

Class VkValidationCacheCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkValidationCacheCreateInfoEXT>

org.lwjgl.vulkan.VkValidationCacheCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkValidationCacheCreateInfoEXT
extends Struct<VkValidationCacheCreateInfoEXT>
implements NativeResource

Structure specifying parameters of a newly created validation cache.

Valid Usage

• If initialDataSize is not 0, it must be equal to the size of pInitialData, as returned by vkGetValidationCacheDataEXT when pInitialData was originally retrieved
• If initialDataSize is not 0, pInitialData must have been retrieved from a previous call to vkGetValidationCacheDataEXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT
• 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

CreateValidationCacheEXT

Layout

 struct VkValidationCacheCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkValidationCacheCreateFlagsEXT flags();
     size_t initialDataSize();
     void const * pInitialData();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkValidationCacheCreateInfoEXT.Buffer	An array of VkValidationCacheCreateInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	INITIALDATASIZE	The struct member offsets.
static final int	PINITIALDATA	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkValidationCacheCreateInfoEXT(ByteBuffer container)	Creates a VkValidationCacheCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkValidationCacheCreateInfoEXT	calloc()	Returns a new VkValidationCacheCreateInfoEXT instance allocated with memCalloc.
static VkValidationCacheCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkValidationCacheCreateInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkValidationCacheCreateInfoEXT	calloc(MemoryStack stack)	Returns a new VkValidationCacheCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkValidationCacheCreateInfoEXT	callocStack()	Deprecated.
static VkValidationCacheCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkValidationCacheCreateInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkValidationCacheCreateInfoEXT	callocStack(MemoryStack stack)	Deprecated.
static VkValidationCacheCreateInfoEXT	create()	Returns a new VkValidationCacheCreateInfoEXT instance allocated with BufferUtils.
static VkValidationCacheCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkValidationCacheCreateInfoEXT	create(long address)	Returns a new VkValidationCacheCreateInfoEXT instance for the specified memory address.
static VkValidationCacheCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkValidationCacheCreateInfoEXT.Buffer instance at the specified memory.
static VkValidationCacheCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkValidationCacheCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkValidationCacheCreateInfoEXT	flags(int value)	Sets the specified value to the flags() field.
long	initialDataSize()	the number of bytes in pInitialData.
static VkValidationCacheCreateInfoEXT	malloc()	Returns a new VkValidationCacheCreateInfoEXT instance allocated with memAlloc.
static VkValidationCacheCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkValidationCacheCreateInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkValidationCacheCreateInfoEXT	malloc(MemoryStack stack)	Returns a new VkValidationCacheCreateInfoEXT instance allocated on the specified MemoryStack.
static VkValidationCacheCreateInfoEXT	mallocStack()	Deprecated.
static VkValidationCacheCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkValidationCacheCreateInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkValidationCacheCreateInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
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 ByteBuffer	npInitialData(long struct)	Unsafe version of pInitialData.
static void	npInitialData(long struct, 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.
ByteBuffer	pInitialData()	a pointer to previously retrieved validation cache data.
VkValidationCacheCreateInfoEXT	pInitialData(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pInitialData() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkValidationCacheCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkValidationCacheCreateInfoEXT	set(int sType, long pNext, int flags, ByteBuffer pInitialData)	Initializes this struct with the specified values.
VkValidationCacheCreateInfoEXT	set(VkValidationCacheCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkValidationCacheCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkValidationCacheCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

VkValidationCacheCreateInfoEXT

public VkValidationCacheCreateInfoEXT(ByteBuffer container)

Creates a VkValidationCacheCreateInfoEXT 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkValidationCacheCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

initialDataSize

public long initialDataSize()

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

pInitialData

@Nullable
public ByteBuffer pInitialData()

a pointer to previously retrieved validation cache data. If the validation cache data is incompatible (as defined below) with the device, the validation cache will be initially empty. If initialDataSize is zero, pInitialData is ignored.

sType

public VkValidationCacheCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkValidationCacheCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_VALIDATION_CACHE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkValidationCacheCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkValidationCacheCreateInfoEXT flags(int value)

Sets the specified value to the flags() field.

pInitialData

public VkValidationCacheCreateInfoEXT pInitialData(@Nullable
 ByteBuffer value)

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

set

public VkValidationCacheCreateInfoEXT set(int sType,
 long pNext,
 int flags,
 @Nullable
 ByteBuffer pInitialData)

Initializes this struct with the specified values.

set

public VkValidationCacheCreateInfoEXT set(VkValidationCacheCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkValidationCacheCreateInfoEXT malloc()

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

calloc

public static VkValidationCacheCreateInfoEXT calloc()

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

create

public static VkValidationCacheCreateInfoEXT create()

Returns a new VkValidationCacheCreateInfoEXT instance allocated with BufferUtils.

create

public static VkValidationCacheCreateInfoEXT create(long address)

Returns a new VkValidationCacheCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkValidationCacheCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkValidationCacheCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkValidationCacheCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkValidationCacheCreateInfoEXT.Buffer create(int capacity)

Returns a new VkValidationCacheCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkValidationCacheCreateInfoEXT.Buffer create(long address,
 int capacity)

Create a VkValidationCacheCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkValidationCacheCreateInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkValidationCacheCreateInfoEXT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkValidationCacheCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkValidationCacheCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkValidationCacheCreateInfoEXT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkValidationCacheCreateInfoEXT.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkValidationCacheCreateInfoEXT.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

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 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
 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