Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineLibraryCreateInfoKHR

extends Struct<VkPipelineLibraryCreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying pipeline libraries to use when creating a pipeline.
Valid Usage
Valid Usage (Implicit)
See Also

VkExecutionGraphPipelineCreateInfoAMDX, VkRayTracingPipelineCreateInfoKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LIBRARYCOUNT

The struct member offsets.

public static final int
PLIBRARIES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPipelineLibraryCreateInfoKHR(long address, ByteBuffer container)

public
VkPipelineLibraryCreateInfoKHR(ByteBuffer container)

Creates a VkPipelineLibraryCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineLibraryCreateInfoKHR
calloc()

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with memCalloc.

public static VkPipelineLibraryCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with memCalloc.

public static VkPipelineLibraryCreateInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkPipelineLibraryCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkPipelineLibraryCreateInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkPipelineLibraryCreateInfoKHR
create()

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with BufferUtils.

public static VkPipelineLibraryCreateInfoKHR
create(long address)

Returns a new VkPipelineLibraryCreateInfoKHR instance for the specified memory address.

public static VkPipelineLibraryCreateInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPipelineLibraryCreateInfoKHR.Buffer instance at the specified memory.

public static VkPipelineLibraryCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
libraryCount()

the number of pipeline libraries in pLibraries.

public static VkPipelineLibraryCreateInfoKHR
malloc()

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with memAlloc.

public static VkPipelineLibraryCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with memAlloc.

public static VkPipelineLibraryCreateInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated on the specified MemoryStack.

public static VkPipelineLibraryCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static int
nlibraryCount(long struct)

Unsafe version of libraryCount.

public static void
nlibraryCount(long struct, int value)

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

public static LongBuffer
npLibraries(long struct)

Unsafe version of pLibraries.

public static void
npLibraries(long struct, LongBuffer value)

Unsafe version of pLibraries.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public LongBuffer
pLibraries()

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

public VkPipelineLibraryCreateInfoKHR
pLibraries(LongBuffer value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineLibraryCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkPipelineLibraryCreateInfoKHR

Returns:

this struct
set
(VkPipelineLibraryCreateInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPipelineLibraryCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkPipelineLibraryCreateInfoKHR
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

LIBRARYCOUNTback to summary
public static final int LIBRARYCOUNT

The struct member offsets.

PLIBRARIESback to summary
public static final int PLIBRARIES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPipelineLibraryCreateInfoKHRback to summary
protected VkPipelineLibraryCreateInfoKHR(long address, ByteBuffer container)
VkPipelineLibraryCreateInfoKHRback to summary
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 Detail

callocback to summary
public static VkPipelineLibraryCreateInfoKHR calloc()

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

callocback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineLibraryCreateInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkPipelineLibraryCreateInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPipelineLibraryCreateInfoKHR create()

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkPipelineLibraryCreateInfoKHR create(long address)

Returns a new VkPipelineLibraryCreateInfoKHR instance for the specified memory address.

createback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineLibraryCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPipelineLibraryCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineLibraryCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
libraryCountback to summary
public int libraryCount()

the number of pipeline libraries in pLibraries.

Annotations
@NativeType:uint32_t
mallocback to summary
public static VkPipelineLibraryCreateInfoKHR malloc()

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

mallocback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineLibraryCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkPipelineLibraryCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPipelineLibraryCreateInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nlibraryCountback to summary
public static int nlibraryCount(long struct)

Unsafe version of libraryCount.

nlibraryCountback to summary
public static void nlibraryCount(long struct, int value)

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

npLibrariesback to summary
public static LongBuffer npLibraries(long struct)

Unsafe version of pLibraries.

Annotations
@Nullable
npLibrariesback to summary
public static void npLibraries(long struct, LongBuffer value)

Unsafe version of pLibraries.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pLibrariesback to summary
public LongBuffer pLibraries()

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

Annotations
@Nullable
@NativeType:VkPipeline const *
pLibrariesback to summary
public VkPipelineLibraryCreateInfoKHR pLibraries(LongBuffer value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineLibraryCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPipelineLibraryCreateInfoKHR set(int sType, long pNext, LongBuffer pLibraries)

Initializes this struct with the specified values.

setback to summary
public VkPipelineLibraryCreateInfoKHR set(VkPipelineLibraryCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineLibraryCreateInfoKHR

the source struct

Returns:VkPipelineLibraryCreateInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineLibraryCreateInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPipelineLibraryCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkPipelineLibraryCreateInfoKHR.Buffer

extends StructBuffer<VkPipelineLibraryCreateInfoKHR, VkPipelineLibraryCreateInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPipelineLibraryCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineLibraryCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineLibraryCreateInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkPipelineLibraryCreateInfoKHR
public int
public LongBuffer

Returns:

a LongBuffer view of the data pointed to by the VkPipelineLibraryCreateInfoKHR#pLibraries field.
pLibraries
()

public VkPipelineLibraryCreateInfoKHR.Buffer
pLibraries(LongBuffer value)

Sets the address of the specified LongBuffer to the VkPipelineLibraryCreateInfoKHR#pLibraries field.

public long

Returns:

the value of the VkPipelineLibraryCreateInfoKHR#pNext field.
pNext
()

public VkPipelineLibraryCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkPipelineLibraryCreateInfoKHR#pNext field.

protected VkPipelineLibraryCreateInfoKHR.Buffer
public int

Returns:

the value of the VkPipelineLibraryCreateInfoKHR#sType field.
sType
()

public VkPipelineLibraryCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkPipelineLibraryCreateInfoKHR#sType field.

public VkPipelineLibraryCreateInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineLibraryCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineLibraryCreateInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPipelineLibraryCreateInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkPipelineLibraryCreateInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
libraryCountback to summary
public int libraryCount()
Returns:int

the value of the VkPipelineLibraryCreateInfoKHR#libraryCount field.

Annotations
@NativeType:uint32_t
pLibrariesback to summary
public LongBuffer pLibraries()
Returns:LongBuffer

a LongBuffer view of the data pointed to by the VkPipelineLibraryCreateInfoKHR#pLibraries field.

Annotations
@Nullable
@NativeType:VkPipeline const *
pLibrariesback to summary
public VkPipelineLibraryCreateInfoKHR.Buffer pLibraries(LongBuffer value)

Sets the address of the specified LongBuffer to the VkPipelineLibraryCreateInfoKHR#pLibraries field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineLibraryCreateInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineLibraryCreateInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkPipelineLibraryCreateInfoKHR#pNext field.

selfback to summary
protected VkPipelineLibraryCreateInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPipelineLibraryCreateInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineLibraryCreateInfoKHR.Buffer sType(int value)

Sets the specified value to the VkPipelineLibraryCreateInfoKHR#sType field.

sType$Defaultback to summary
public VkPipelineLibraryCreateInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR value to the VkPipelineLibraryCreateInfoKHR#sType field.