Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineInfoKHR

extends Struct<VkPipelineInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPipelineInfoEXT
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing a pipeline.
Valid Usage (Implicit)
See Also

GetPipelineExecutablePropertiesKHR, GetPipelinePropertiesEXT

Layout


struct VkPipelineInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkPipeline pipeline;
}

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
PIPELINE

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
VkPipelineInfoKHR(long address, ByteBuffer container)

public
VkPipelineInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineInfoKHR
calloc()

Returns a new VkPipelineInfoKHR instance allocated with memCalloc.

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

Returns a new VkPipelineInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPipelineInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkPipelineInfoKHR
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 VkPipelineInfoKHR
create()

Returns a new VkPipelineInfoKHR instance allocated with BufferUtils.

public static VkPipelineInfoKHR
create(long address)

Returns a new VkPipelineInfoKHR instance for the specified memory address.

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

Returns a new VkPipelineInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPipelineInfoKHR.Buffer instance at the specified memory.

public static VkPipelineInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPipelineInfoKHR
malloc()

Returns a new VkPipelineInfoKHR instance allocated with memAlloc.

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

Returns a new VkPipelineInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPipelineInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkPipelineInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPipelineInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npipeline(long struct)

Unsafe version of pipeline.

public static void
npipeline(long struct, long value)

Unsafe version of pipeline.

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 long
pipeline()

a VkPipeline handle.

public VkPipelineInfoKHR
pipeline(long value)

Sets the specified value to the pipeline field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineInfoKHR
set(int sType, long pNext, long pipeline)

Initializes this struct with the specified values.

public VkPipelineInfoKHR

Returns:

this struct
set
(VkPipelineInfoKHR
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 VkPipelineInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkPipelineInfoKHR
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.

PIPELINEback to summary
public static final int PIPELINE

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

VkPipelineInfoKHRback to summary
protected VkPipelineInfoKHR(long address, ByteBuffer container)
VkPipelineInfoKHRback to summary
public VkPipelineInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineInfoKHR calloc(MemoryStack stack)

Returns a new VkPipelineInfoKHR 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 VkPipelineInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

callocStackback to summary
public static VkPipelineInfoKHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineInfoKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineInfoKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkPipelineInfoKHR 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 VkPipelineInfoKHR create()

Returns a new VkPipelineInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkPipelineInfoKHR create(long address)

Returns a new VkPipelineInfoKHR instance for the specified memory address.

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

Returns a new VkPipelineInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPipelineInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPipelineInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineInfoKHR malloc(MemoryStack stack)

Returns a new VkPipelineInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkPipelineInfoKHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineInfoKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineInfoKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkPipelineInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npipelineback to summary
public static long npipeline(long struct)

Unsafe version of pipeline.

npipelineback to summary
public static void npipeline(long struct, long value)

Unsafe version of pipeline.

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.

pipelineback to summary
public long pipeline()

a VkPipeline handle.

Annotations
@NativeType:VkPipeline
pipelineback to summary
public VkPipelineInfoKHR pipeline(long value)

Sets the specified value to the pipeline 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 VkPipelineInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPipelineInfoKHR set(int sType, long pNext, long pipeline)

Initializes this struct with the specified values.

setback to summary
public VkPipelineInfoKHR set(VkPipelineInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineInfoKHR

the source struct

Returns:VkPipelineInfoKHR

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 VkPipelineInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPipelineInfoKHR.Buffer

extends StructBuffer<VkPipelineInfoKHR, VkPipelineInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPipelineInfoEXT.Buffer

An array of VkPipelineInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineInfoKHR.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 VkPipelineInfoKHR
public long

Returns:

the value of the VkPipelineInfoKHR#pipeline field.
pipeline
()

public VkPipelineInfoKHR.Buffer
pipeline(long value)

Sets the specified value to the VkPipelineInfoKHR#pipeline field.

public long

Returns:

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

public VkPipelineInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkPipelineInfoKHR#pNext field.

protected VkPipelineInfoKHR.Buffer
public int

Returns:

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

public VkPipelineInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkPipelineInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineInfoKHR.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 VkPipelineInfoKHR#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 VkPipelineInfoKHR getElementFactory()

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

Annotations
@Override
pipelineback to summary
public long pipeline()
Returns:long

the value of the VkPipelineInfoKHR#pipeline field.

Annotations
@NativeType:VkPipeline
pipelineback to summary
public VkPipelineInfoKHR.Buffer pipeline(long value)

Sets the specified value to the VkPipelineInfoKHR#pipeline field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineInfoKHR#pNext field.

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

Sets the specified value to the VkPipelineInfoKHR#pNext field.

selfback to summary
protected VkPipelineInfoKHR.Buffer self()

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

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

the value of the VkPipelineInfoKHR#sType field.

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

Sets the specified value to the VkPipelineInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_INFO_KHR value to the VkPipelineInfoKHR#sType field.