Package org.lwjgl.vulkan

Class VkPipelineBinaryKeysAndDataKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineBinaryKeysAndDataKHR>

org.lwjgl.vulkan.VkPipelineBinaryKeysAndDataKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineBinaryKeysAndDataKHR
extends org.lwjgl.system.Struct<VkPipelineBinaryKeysAndDataKHR>
implements org.lwjgl.system.NativeResource

Structure specifying arrays of key and data pairs.

Valid Usage (Implicit)

• pPipelineBinaryKeys must be a valid pointer to an array of binaryCount valid VkPipelineBinaryKeyKHR structures
• pPipelineBinaryData must be a valid pointer to an array of binaryCount valid VkPipelineBinaryDataKHR structures
• binaryCount must be greater than 0

See Also

VkPipelineBinaryCreateInfoKHR, VkPipelineBinaryDataKHR, VkPipelineBinaryKeyKHR

Layout

 struct VkPipelineBinaryKeysAndDataKHR {
     uint32_t binaryCount();
     VkPipelineBinaryKeyKHR const * pPipelineBinaryKeys();
     VkPipelineBinaryDataKHR const * pPipelineBinaryData();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BINARYCOUNT	The struct member offsets.
static final int	PPIPELINEBINARYDATA	The struct member offsets.
static final int	PPIPELINEBINARYKEYS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPipelineBinaryKeysAndDataKHR(ByteBuffer container)	Creates a VkPipelineBinaryKeysAndDataKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	binaryCount()	the size of the pPipelineBinaryKeys and pPipelineBinaryData arrays
VkPipelineBinaryKeysAndDataKHR	binaryCount(int value)	Sets the specified value to the binaryCount() field.
static VkPipelineBinaryKeysAndDataKHR	calloc()	Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated with memCalloc.
static VkPipelineBinaryKeysAndDataKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated with memCalloc.
static VkPipelineBinaryKeysAndDataKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineBinaryKeysAndDataKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineBinaryKeysAndDataKHR	create()	Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated with BufferUtils.
static VkPipelineBinaryKeysAndDataKHR.Buffer	create(int capacity)	Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated with BufferUtils.
static VkPipelineBinaryKeysAndDataKHR	create(long address)	Returns a new VkPipelineBinaryKeysAndDataKHR instance for the specified memory address.
static VkPipelineBinaryKeysAndDataKHR.Buffer	create(long address, int capacity)	Create a VkPipelineBinaryKeysAndDataKHR.Buffer instance at the specified memory.
static @Nullable VkPipelineBinaryKeysAndDataKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineBinaryKeysAndDataKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineBinaryKeysAndDataKHR	malloc()	Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated with memAlloc.
static VkPipelineBinaryKeysAndDataKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated with memAlloc.
static VkPipelineBinaryKeysAndDataKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineBinaryKeysAndDataKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated on the specified MemoryStack.
static int	nbinaryCount(long struct)	Unsafe version of binaryCount().
static void	nbinaryCount(long struct, int value)	Sets the specified value to the binaryCount field of the specified struct.
static VkPipelineBinaryDataKHR.Buffer	npPipelineBinaryData(long struct)	Unsafe version of pPipelineBinaryData().
static void	npPipelineBinaryData(long struct, VkPipelineBinaryDataKHR.Buffer value)	Unsafe version of pPipelineBinaryData.
static VkPipelineBinaryKeyKHR.Buffer	npPipelineBinaryKeys(long struct)	Unsafe version of pPipelineBinaryKeys().
static void	npPipelineBinaryKeys(long struct, VkPipelineBinaryKeyKHR.Buffer value)	Unsafe version of pPipelineBinaryKeys.
VkPipelineBinaryDataKHR.Buffer	pPipelineBinaryData()	a pointer to an array of VkPipelineBinaryDataKHR structures containing the pipeline binary data
VkPipelineBinaryKeysAndDataKHR	pPipelineBinaryData(VkPipelineBinaryDataKHR.Buffer value)	Sets the address of the specified VkPipelineBinaryDataKHR.Buffer to the pPipelineBinaryData() field.
VkPipelineBinaryKeyKHR.Buffer	pPipelineBinaryKeys()	a pointer to an array of VkPipelineBinaryKeyKHR structures containing the pipeline binary keys
VkPipelineBinaryKeysAndDataKHR	pPipelineBinaryKeys(VkPipelineBinaryKeyKHR.Buffer value)	Sets the address of the specified VkPipelineBinaryKeyKHR.Buffer to the pPipelineBinaryKeys() field.
VkPipelineBinaryKeysAndDataKHR	set(int binaryCount, VkPipelineBinaryKeyKHR.Buffer pPipelineBinaryKeys, VkPipelineBinaryDataKHR.Buffer pPipelineBinaryData)	Initializes this struct with the specified values.
VkPipelineBinaryKeysAndDataKHR	set(VkPipelineBinaryKeysAndDataKHR src)	Copies the specified struct data to this struct.
int	sizeof()
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, 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.

BINARYCOUNT

public static final int BINARYCOUNT

The struct member offsets.

PPIPELINEBINARYKEYS

public static final int PPIPELINEBINARYKEYS

The struct member offsets.

PPIPELINEBINARYDATA

public static final int PPIPELINEBINARYDATA

The struct member offsets.

Constructor Details

VkPipelineBinaryKeysAndDataKHR

public VkPipelineBinaryKeysAndDataKHR(ByteBuffer container)

Creates a VkPipelineBinaryKeysAndDataKHR 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineBinaryKeysAndDataKHR>

binaryCount

public int binaryCount()

the size of the pPipelineBinaryKeys and pPipelineBinaryData arrays

pPipelineBinaryKeys

public VkPipelineBinaryKeyKHR.Buffer pPipelineBinaryKeys()

a pointer to an array of VkPipelineBinaryKeyKHR structures containing the pipeline binary keys

pPipelineBinaryData

public VkPipelineBinaryDataKHR.Buffer pPipelineBinaryData()

a pointer to an array of VkPipelineBinaryDataKHR structures containing the pipeline binary data

binaryCount

public VkPipelineBinaryKeysAndDataKHR binaryCount(int value)

Sets the specified value to the binaryCount() field.

pPipelineBinaryKeys

public VkPipelineBinaryKeysAndDataKHR pPipelineBinaryKeys(VkPipelineBinaryKeyKHR.Buffer value)

Sets the address of the specified VkPipelineBinaryKeyKHR.Buffer to the pPipelineBinaryKeys() field.

pPipelineBinaryData

public VkPipelineBinaryKeysAndDataKHR pPipelineBinaryData(VkPipelineBinaryDataKHR.Buffer value)

Sets the address of the specified VkPipelineBinaryDataKHR.Buffer to the pPipelineBinaryData() field.

set

public VkPipelineBinaryKeysAndDataKHR set(int binaryCount,
 VkPipelineBinaryKeyKHR.Buffer pPipelineBinaryKeys,
 VkPipelineBinaryDataKHR.Buffer pPipelineBinaryData)

Initializes this struct with the specified values.

set

public VkPipelineBinaryKeysAndDataKHR set(VkPipelineBinaryKeysAndDataKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineBinaryKeysAndDataKHR malloc()

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

calloc

public static VkPipelineBinaryKeysAndDataKHR calloc()

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

create

public static VkPipelineBinaryKeysAndDataKHR create()

Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated with BufferUtils.

create

public static VkPipelineBinaryKeysAndDataKHR create(long address)

Returns a new VkPipelineBinaryKeysAndDataKHR instance for the specified memory address.

createSafe

public static @Nullable VkPipelineBinaryKeysAndDataKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineBinaryKeysAndDataKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineBinaryKeysAndDataKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineBinaryKeysAndDataKHR.Buffer create(int capacity)

Returns a new VkPipelineBinaryKeysAndDataKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineBinaryKeysAndDataKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPipelineBinaryKeysAndDataKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineBinaryKeysAndDataKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineBinaryKeysAndDataKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineBinaryKeysAndDataKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineBinaryKeysAndDataKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineBinaryKeysAndDataKHR.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

nbinaryCount

public static int nbinaryCount(long struct)

Unsafe version of binaryCount().

npPipelineBinaryKeys

public static VkPipelineBinaryKeyKHR.Buffer npPipelineBinaryKeys(long struct)

Unsafe version of pPipelineBinaryKeys().

npPipelineBinaryData

public static VkPipelineBinaryDataKHR.Buffer npPipelineBinaryData(long struct)

Unsafe version of pPipelineBinaryData().

nbinaryCount

public static void nbinaryCount(long struct,
 int value)

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

npPipelineBinaryKeys

public static void npPipelineBinaryKeys(long struct,
 VkPipelineBinaryKeyKHR.Buffer value)

Unsafe version of pPipelineBinaryKeys.

npPipelineBinaryData

public static void npPipelineBinaryData(long struct,
 VkPipelineBinaryDataKHR.Buffer value)

Unsafe version of pPipelineBinaryData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate