Package org.lwjgl.vulkan

Class VkPipelineLibraryCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineLibraryCreateInfoKHR>

org.lwjgl.vulkan.VkPipelineLibraryCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifying pipeline libraries to use when creating a pipeline.

Valid Usage

• Each element of pLibraries must have been created with PIPELINE_CREATE_LIBRARY_BIT_KHR
• If any library in pLibraries was created with a shader stage with VkPipelineShaderStageModuleIdentifierCreateInfoEXT and identifierSize not equal to 0, the pipeline must be created with the PIPELINE_CREATE_FAIL_ON_PIPELINE_COMPILE_REQUIRED_BIT flag set
• If any element of pLibraries was created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT, all elements must have been created with PIPELINE_CREATE_DESCRIPTOR_BUFFER_BIT_EXT
• If pipeline is being created with PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT, every element of pLibraries must have been created with PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT
• If pipeline is being created without PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT, every element of pLibraries must have been created without PIPELINE_CREATE_NO_PROTECTED_ACCESS_BIT
• If pipeline is being created with PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT, every element of pLibraries must have been created with PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT
• If pipeline is being created without PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT, every element of pLibraries must have been created without PIPELINE_CREATE_PROTECTED_ACCESS_ONLY_BIT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR
• If libraryCount is not 0, pLibraries must be a valid pointer to an array of libraryCount valid VkPipeline handles

See Also

VkExecutionGraphPipelineCreateInfoAMDX, VkRayTracingPipelineCreateInfoKHR

Layout

 struct VkPipelineLibraryCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t libraryCount();
     VkPipeline const * pLibraries();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineLibraryCreateInfoKHR	calloc()	Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with memCalloc.
static VkPipelineLibraryCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkPipelineLibraryCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineLibraryCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineLibraryCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineLibraryCreateInfoKHR	create()	Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with BufferUtils.
static VkPipelineLibraryCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkPipelineLibraryCreateInfoKHR	create(long address)	Returns a new VkPipelineLibraryCreateInfoKHR instance for the specified memory address.
static VkPipelineLibraryCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkPipelineLibraryCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkPipelineLibraryCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineLibraryCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	libraryCount()	the number of pipeline libraries in pLibraries.
static VkPipelineLibraryCreateInfoKHR	malloc()	Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with memAlloc.
static VkPipelineLibraryCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkPipelineLibraryCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineLibraryCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineLibraryCreateInfoKHR instance allocated on the specified MemoryStack.
static int	nlibraryCount(long struct)	Unsafe version of libraryCount().
static void	nlibraryCount(long struct, int value)	Sets the specified value to the libraryCount field of the specified struct.
static @Nullable LongBuffer	npLibraries(long struct)	Unsafe version of pLibraries.
static void	npLibraries(long struct, @Nullable LongBuffer value)	Unsafe version of pLibraries.
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.
@Nullable LongBuffer	pLibraries()	a pointer to an array of VkPipeline structures specifying pipeline libraries to use when creating a pipeline.
VkPipelineLibraryCreateInfoKHR	pLibraries(@Nullable LongBuffer value)	Sets the address of the specified LongBuffer to the pLibraries() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineLibraryCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineLibraryCreateInfoKHR	set(int sType, long pNext, @Nullable LongBuffer pLibraries)	Initializes this struct with the specified values.
VkPipelineLibraryCreateInfoKHR	set(VkPipelineLibraryCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineLibraryCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineLibraryCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR 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, 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.

LIBRARYCOUNT

public static final int LIBRARYCOUNT

The struct member offsets.

PLIBRARIES

public static final int PLIBRARIES

The struct member offsets.

Constructor Details

VkPipelineLibraryCreateInfoKHR

public VkPipelineLibraryCreateInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

libraryCount

public int libraryCount()

the number of pipeline libraries in pLibraries.

pLibraries

public @Nullable LongBuffer pLibraries()

a pointer to an array of VkPipeline structures specifying pipeline libraries to use when creating a pipeline.

sType

public VkPipelineLibraryCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineLibraryCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR value to the sType() field.

pNext

public VkPipelineLibraryCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pLibraries

public VkPipelineLibraryCreateInfoKHR pLibraries(@Nullable LongBuffer value)

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

set

public VkPipelineLibraryCreateInfoKHR set(int sType,
 long pNext,
 @Nullable LongBuffer pLibraries)

Initializes this struct with the specified values.

set

public VkPipelineLibraryCreateInfoKHR set(VkPipelineLibraryCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineLibraryCreateInfoKHR malloc()

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

calloc

public static VkPipelineLibraryCreateInfoKHR calloc()

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

create

public static VkPipelineLibraryCreateInfoKHR create()

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with BufferUtils.

create

public static VkPipelineLibraryCreateInfoKHR create(long address)

Returns a new VkPipelineLibraryCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkPipelineLibraryCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineLibraryCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineLibraryCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineLibraryCreateInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineLibraryCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlibraryCount

public static int nlibraryCount(long struct)

Unsafe version of libraryCount().

npLibraries

public static @Nullable LongBuffer npLibraries(long struct)

Unsafe version of pLibraries.

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.

nlibraryCount

public static void nlibraryCount(long struct,
 int value)

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

npLibraries

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

Unsafe version of pLibraries.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate