Package org.lwjgl.vulkan

Class VkPipelineBinaryHandlesInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineBinaryHandlesInfoKHR>

org.lwjgl.vulkan.VkPipelineBinaryHandlesInfoKHR

All Implemented Interfaces:

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

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

Structure containing newly created pipeline binaries.

Description

If pPipelineBinaries is NULL, the number of binaries that would be created is returned in pipelineBinaryCount. Otherwise, pipelineBinaryCount must be the number of entries in the pPipelineBinaries array, and on return from CreatePipelineBinariesKHR pipelineBinaryCount is overwritten with the number of handles actually written to pPipelineBinaries. If the value of pipelineBinaryCount is less than the number of binaries that would have been created, at most pipelineBinaryCount handles will be written to pPipelineBinaries and INCOMPLETE will be returned instead of SUCCESS, to indicate that pPipelineBinaries was not large enough to create all the binaries.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR
• pNext must be NULL
• If pipelineBinaryCount is not 0, and pPipelineBinaries is not NULL, pPipelineBinaries must be a valid pointer to an array of pipelineBinaryCount VkPipelineBinaryKHR handles

See Also

CreatePipelineBinariesKHR

Layout

 struct VkPipelineBinaryHandlesInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t pipelineBinaryCount();
     VkPipelineBinaryKHR * pPipelineBinaries();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineBinaryHandlesInfoKHR.Buffer	An array of VkPipelineBinaryHandlesInfoKHR 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	PIPELINEBINARYCOUNT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PPIPELINEBINARIES	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
VkPipelineBinaryHandlesInfoKHR(ByteBuffer container)	Creates a VkPipelineBinaryHandlesInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineBinaryHandlesInfoKHR	calloc()	Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated with memCalloc.
static VkPipelineBinaryHandlesInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated with memCalloc.
static VkPipelineBinaryHandlesInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineBinaryHandlesInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineBinaryHandlesInfoKHR	create()	Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated with BufferUtils.
static VkPipelineBinaryHandlesInfoKHR.Buffer	create(int capacity)	Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated with BufferUtils.
static VkPipelineBinaryHandlesInfoKHR	create(long address)	Returns a new VkPipelineBinaryHandlesInfoKHR instance for the specified memory address.
static VkPipelineBinaryHandlesInfoKHR.Buffer	create(long address, int capacity)	Create a VkPipelineBinaryHandlesInfoKHR.Buffer instance at the specified memory.
static @Nullable VkPipelineBinaryHandlesInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineBinaryHandlesInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineBinaryHandlesInfoKHR	malloc()	Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated with memAlloc.
static VkPipelineBinaryHandlesInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated with memAlloc.
static VkPipelineBinaryHandlesInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineBinaryHandlesInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated on the specified MemoryStack.
static int	npipelineBinaryCount(long struct)	Unsafe version of pipelineBinaryCount().
static void	npipelineBinaryCount(long struct, int value)	Sets the specified value to the pipelineBinaryCount field of the specified struct.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable LongBuffer	npPipelineBinaries(long struct)	Unsafe version of pPipelineBinaries.
static void	npPipelineBinaries(long struct, @Nullable LongBuffer value)	Unsafe version of pPipelineBinaries.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
int	pipelineBinaryCount()	the number of binaries associated with this pipeline or the number of entries in the pPipelineBinaries array.
VkPipelineBinaryHandlesInfoKHR	pipelineBinaryCount(int value)	Sets the specified value to the pipelineBinaryCount() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineBinaryHandlesInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable LongBuffer	pPipelineBinaries()	NULL or a pointer to an array of VkPipelineBinaryKHR handles in which the resulting pipeline binaries are returned.
VkPipelineBinaryHandlesInfoKHR	pPipelineBinaries(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pPipelineBinaries() field.
VkPipelineBinaryHandlesInfoKHR	set(int sType, long pNext, int pipelineBinaryCount, @Nullable LongBuffer pPipelineBinaries)	Initializes this struct with the specified values.
VkPipelineBinaryHandlesInfoKHR	set(VkPipelineBinaryHandlesInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineBinaryHandlesInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineBinaryHandlesInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

PIPELINEBINARYCOUNT

public static final int PIPELINEBINARYCOUNT

The struct member offsets.

PPIPELINEBINARIES

public static final int PPIPELINEBINARIES

The struct member offsets.

Constructor Details

VkPipelineBinaryHandlesInfoKHR

public VkPipelineBinaryHandlesInfoKHR(ByteBuffer container)

Creates a VkPipelineBinaryHandlesInfoKHR 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<VkPipelineBinaryHandlesInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pipelineBinaryCount

public int pipelineBinaryCount()

the number of binaries associated with this pipeline or the number of entries in the pPipelineBinaries array.

pPipelineBinaries

public @Nullable LongBuffer pPipelineBinaries()

NULL or a pointer to an array of VkPipelineBinaryKHR handles in which the resulting pipeline binaries are returned.

sType

public VkPipelineBinaryHandlesInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineBinaryHandlesInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_BINARY_HANDLES_INFO_KHR value to the sType() field.

pNext

public VkPipelineBinaryHandlesInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pipelineBinaryCount

public VkPipelineBinaryHandlesInfoKHR pipelineBinaryCount(int value)

Sets the specified value to the pipelineBinaryCount() field.

pPipelineBinaries

public VkPipelineBinaryHandlesInfoKHR pPipelineBinaries(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pPipelineBinaries() field.

set

public VkPipelineBinaryHandlesInfoKHR set(int sType,
 long pNext,
 int pipelineBinaryCount,
 @Nullable LongBuffer pPipelineBinaries)

Initializes this struct with the specified values.

set

public VkPipelineBinaryHandlesInfoKHR set(VkPipelineBinaryHandlesInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineBinaryHandlesInfoKHR malloc()

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

calloc

public static VkPipelineBinaryHandlesInfoKHR calloc()

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

create

public static VkPipelineBinaryHandlesInfoKHR create()

Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated with BufferUtils.

create

public static VkPipelineBinaryHandlesInfoKHR create(long address)

Returns a new VkPipelineBinaryHandlesInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkPipelineBinaryHandlesInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineBinaryHandlesInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineBinaryHandlesInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineBinaryHandlesInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineBinaryHandlesInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineBinaryHandlesInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineBinaryHandlesInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkPipelineBinaryHandlesInfoKHR.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().

npipelineBinaryCount

public static int npipelineBinaryCount(long struct)

Unsafe version of pipelineBinaryCount().

npPipelineBinaries

public static @Nullable LongBuffer npPipelineBinaries(long struct)

Unsafe version of pPipelineBinaries.

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.

npipelineBinaryCount

public static void npipelineBinaryCount(long struct,
 int value)

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

npPipelineBinaries

public static void npPipelineBinaries(long struct,
 @Nullable LongBuffer value)

Unsafe version of pPipelineBinaries.