Package org.lwjgl.vulkan

Class VkPipelineExecutableInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineExecutableInfoKHR>

org.lwjgl.vulkan.VkPipelineExecutableInfoKHR

All Implemented Interfaces:

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

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

Structure describing a pipeline executable to query for associated statistics or internal representations.

Valid Usage

• executableIndex must be less than the number of pipeline executables associated with pipeline as returned in the pExecutableCount parameter of vkGetPipelineExecutablePropertiesKHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR
• pNext must be NULL
• pipeline must be a valid VkPipeline handle

See Also

GetPipelineExecutableInternalRepresentationsKHR, GetPipelineExecutableStatisticsKHR

Layout

 struct VkPipelineExecutableInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkPipeline pipeline();
     uint32_t executableIndex();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineExecutableInfoKHR	calloc()	Returns a new VkPipelineExecutableInfoKHR instance allocated with memCalloc.
static VkPipelineExecutableInfoKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated with memCalloc.
static VkPipelineExecutableInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineExecutableInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineExecutableInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineExecutableInfoKHR	callocStack()	Deprecated.
static VkPipelineExecutableInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineExecutableInfoKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineExecutableInfoKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineExecutableInfoKHR	create()	Returns a new VkPipelineExecutableInfoKHR instance allocated with BufferUtils.
static VkPipelineExecutableInfoKHR.Buffer	create(int capacity)	Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated with BufferUtils.
static VkPipelineExecutableInfoKHR	create(long address)	Returns a new VkPipelineExecutableInfoKHR instance for the specified memory address.
static VkPipelineExecutableInfoKHR.Buffer	create(long address, int capacity)	Create a VkPipelineExecutableInfoKHR.Buffer instance at the specified memory.
static @Nullable VkPipelineExecutableInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineExecutableInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	executableIndex()	the index of the pipeline executable to query in the array of executable properties returned by GetPipelineExecutablePropertiesKHR.
VkPipelineExecutableInfoKHR	executableIndex(int value)	Sets the specified value to the executableIndex() field.
static VkPipelineExecutableInfoKHR	malloc()	Returns a new VkPipelineExecutableInfoKHR instance allocated with memAlloc.
static VkPipelineExecutableInfoKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated with memAlloc.
static VkPipelineExecutableInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineExecutableInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineExecutableInfoKHR instance allocated on the specified MemoryStack.
static VkPipelineExecutableInfoKHR	mallocStack()	Deprecated.
static VkPipelineExecutableInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineExecutableInfoKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPipelineExecutableInfoKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nexecutableIndex(long struct)	Unsafe version of executableIndex().
static void	nexecutableIndex(long struct, int value)	Unsafe version of executableIndex.
static long	npipeline(long struct)	Unsafe version of pipeline().
static void	npipeline(long struct, long value)	Unsafe version of pipeline.
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.
long	pipeline()	the pipeline to query.
VkPipelineExecutableInfoKHR	pipeline(long value)	Sets the specified value to the pipeline() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineExecutableInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineExecutableInfoKHR	set(int sType, long pNext, long pipeline, int executableIndex)	Initializes this struct with the specified values.
VkPipelineExecutableInfoKHR	set(VkPipelineExecutableInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineExecutableInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineExecutableInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_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.

PIPELINE

public static final int PIPELINE

The struct member offsets.

EXECUTABLEINDEX

public static final int EXECUTABLEINDEX

The struct member offsets.

Constructor Details

VkPipelineExecutableInfoKHR

public VkPipelineExecutableInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pipeline

public long pipeline()

the pipeline to query.

executableIndex

public int executableIndex()

the index of the pipeline executable to query in the array of executable properties returned by GetPipelineExecutablePropertiesKHR.

sType

public VkPipelineExecutableInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineExecutableInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INFO_KHR value to the sType() field.

pNext

public VkPipelineExecutableInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pipeline

public VkPipelineExecutableInfoKHR pipeline(long value)

Sets the specified value to the pipeline() field.

executableIndex

public VkPipelineExecutableInfoKHR executableIndex(int value)

Sets the specified value to the executableIndex() field.

set

public VkPipelineExecutableInfoKHR set(int sType,
 long pNext,
 long pipeline,
 int executableIndex)

Initializes this struct with the specified values.

set

public VkPipelineExecutableInfoKHR set(VkPipelineExecutableInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineExecutableInfoKHR malloc()

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

calloc

public static VkPipelineExecutableInfoKHR calloc()

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

create

public static VkPipelineExecutableInfoKHR create()

Returns a new VkPipelineExecutableInfoKHR instance allocated with BufferUtils.

create

public static VkPipelineExecutableInfoKHR create(long address)

Returns a new VkPipelineExecutableInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkPipelineExecutableInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineExecutableInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineExecutableInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineExecutableInfoKHR.Buffer create(int capacity)

Returns a new VkPipelineExecutableInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineExecutableInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineExecutableInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableInfoKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineExecutableInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineExecutableInfoKHR.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableInfoKHR.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineExecutableInfoKHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableInfoKHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

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

Returns a new VkPipelineExecutableInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npipeline

public static long npipeline(long struct)

Unsafe version of pipeline().

nexecutableIndex

public static int nexecutableIndex(long struct)

Unsafe version of executableIndex().

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.

npipeline

public static void npipeline(long struct,
 long value)

Unsafe version of pipeline.

nexecutableIndex

public static void nexecutableIndex(long struct,
 int value)

Unsafe version of executableIndex.