Package org.lwjgl.vulkan

Class VkPipelineExecutableStatisticKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineExecutableStatisticKHR>

org.lwjgl.vulkan.VkPipelineExecutableStatisticKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPipelineExecutableStatisticKHR
extends Struct<VkPipelineExecutableStatisticKHR>
implements NativeResource

Structure describing a compile time pipeline executable statistic.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR
• pNext must be NULL

See Also

VkPipelineExecutableStatisticValueKHR, GetPipelineExecutableStatisticsKHR

Layout

 struct VkPipelineExecutableStatisticKHR {
     VkStructureType sType();
     void * pNext();
     char name()[VK_MAX_DESCRIPTION_SIZE];
     char description()[VK_MAX_DESCRIPTION_SIZE];
     VkPipelineExecutableStatisticFormatKHR format();
     VkPipelineExecutableStatisticValueKHR value();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineExecutableStatisticKHR.Buffer	An array of VkPipelineExecutableStatisticKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DESCRIPTION	The struct member offsets.
static final int	FORMAT	The struct member offsets.
static final int	NAME	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.
static final int	VALUE	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
VkPipelineExecutableStatisticKHR(ByteBuffer container)	Creates a VkPipelineExecutableStatisticKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineExecutableStatisticKHR	calloc()	Returns a new VkPipelineExecutableStatisticKHR instance allocated with memCalloc.
static VkPipelineExecutableStatisticKHR.Buffer	calloc(int capacity)	Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with memCalloc.
static VkPipelineExecutableStatisticKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineExecutableStatisticKHR	calloc(MemoryStack stack)	Returns a new VkPipelineExecutableStatisticKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineExecutableStatisticKHR	callocStack()	Deprecated.
static VkPipelineExecutableStatisticKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkPipelineExecutableStatisticKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPipelineExecutableStatisticKHR	callocStack(MemoryStack stack)	Deprecated.
static VkPipelineExecutableStatisticKHR	create()	Returns a new VkPipelineExecutableStatisticKHR instance allocated with BufferUtils.
static VkPipelineExecutableStatisticKHR.Buffer	create(int capacity)	Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with BufferUtils.
static VkPipelineExecutableStatisticKHR	create(long address)	Returns a new VkPipelineExecutableStatisticKHR instance for the specified memory address.
static VkPipelineExecutableStatisticKHR.Buffer	create(long address, int capacity)	Create a VkPipelineExecutableStatisticKHR.Buffer instance at the specified memory.
static VkPipelineExecutableStatisticKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPipelineExecutableStatisticKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	description()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this statistic.
String	descriptionString()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this statistic.
int	format()	a VkPipelineExecutableStatisticFormatKHR value specifying the format of the data found in value.
static VkPipelineExecutableStatisticKHR	malloc()	Returns a new VkPipelineExecutableStatisticKHR instance allocated with memAlloc.
static VkPipelineExecutableStatisticKHR.Buffer	malloc(int capacity)	Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with memAlloc.
static VkPipelineExecutableStatisticKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated on the specified MemoryStack.
static VkPipelineExecutableStatisticKHR	malloc(MemoryStack stack)	Returns a new VkPipelineExecutableStatisticKHR instance allocated on the specified MemoryStack.
static VkPipelineExecutableStatisticKHR	mallocStack()	Deprecated.
static VkPipelineExecutableStatisticKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkPipelineExecutableStatisticKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPipelineExecutableStatisticKHR	mallocStack(MemoryStack stack)	Deprecated.
ByteBuffer	name()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this statistic.
String	nameString()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this statistic.
static ByteBuffer	ndescription(long struct)	Unsafe version of description().
static String	ndescriptionString(long struct)	Unsafe version of descriptionString().
static int	nformat(long struct)	Unsafe version of format().
static ByteBuffer	nname(long struct)	Unsafe version of name().
static String	nnameString(long struct)	Unsafe version of nameString().
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.
static VkPipelineExecutableStatisticValueKHR	nvalue(long struct)	Unsafe version of value().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineExecutableStatisticKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineExecutableStatisticKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPipelineExecutableStatisticKHR	set(VkPipelineExecutableStatisticKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkPipelineExecutableStatisticKHR	sType(int value)	Sets the specified value to the sType() field.
VkPipelineExecutableStatisticKHR	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR value to the sType() field.
VkPipelineExecutableStatisticValueKHR	value()	the value of this statistic.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

NAME

public static final int NAME

The struct member offsets.

DESCRIPTION

public static final int DESCRIPTION

The struct member offsets.

FORMAT

public static final int FORMAT

The struct member offsets.

VALUE

public static final int VALUE

The struct member offsets.

Constructor Details

VkPipelineExecutableStatisticKHR

public VkPipelineExecutableStatisticKHR(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPipelineExecutableStatisticKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

name

public ByteBuffer name()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this statistic.

nameString

public String nameString()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a short human readable name for this statistic.

description

public ByteBuffer description()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this statistic.

descriptionString

public String descriptionString()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description for this statistic.

format

public int format()

a VkPipelineExecutableStatisticFormatKHR value specifying the format of the data found in value.

value

public VkPipelineExecutableStatisticValueKHR value()

the value of this statistic.

sType

public VkPipelineExecutableStatisticKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineExecutableStatisticKHR sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR value to the sType() field.

pNext

public VkPipelineExecutableStatisticKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPipelineExecutableStatisticKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPipelineExecutableStatisticKHR set(VkPipelineExecutableStatisticKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineExecutableStatisticKHR malloc()

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

calloc

public static VkPipelineExecutableStatisticKHR calloc()

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

create

public static VkPipelineExecutableStatisticKHR create()

Returns a new VkPipelineExecutableStatisticKHR instance allocated with BufferUtils.

create

public static VkPipelineExecutableStatisticKHR create(long address)

Returns a new VkPipelineExecutableStatisticKHR instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineExecutableStatisticKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineExecutableStatisticKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineExecutableStatisticKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineExecutableStatisticKHR.Buffer create(int capacity)

Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineExecutableStatisticKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineExecutableStatisticKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkPipelineExecutableStatisticKHR malloc(MemoryStack stack)

Returns a new VkPipelineExecutableStatisticKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineExecutableStatisticKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineExecutableStatisticKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineExecutableStatisticKHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

ndescription

public static ByteBuffer ndescription(long struct)

Unsafe version of description().

ndescriptionString

public static String ndescriptionString(long struct)

Unsafe version of descriptionString().

nformat

public static int nformat(long struct)

Unsafe version of format().

nvalue

public static VkPipelineExecutableStatisticValueKHR nvalue(long struct)

Unsafe version of value().

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.