Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineExecutableStatisticKHR

extends Struct<VkPipelineExecutableStatisticKHR>
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 describing a compile time pipeline executable statistic.
Valid Usage (Implicit)
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 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
DESCRIPTION

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
NAME

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.

public static final int
VALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPipelineExecutableStatisticKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPipelineExecutableStatisticKHR
calloc()

Returns a new VkPipelineExecutableStatisticKHR instance allocated with memCalloc.

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

Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPipelineExecutableStatisticKHR
callocStack()

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

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

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

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

Returns a new VkPipelineExecutableStatisticKHR instance allocated with BufferUtils.

public static VkPipelineExecutableStatisticKHR
create(long address)

Returns a new VkPipelineExecutableStatisticKHR instance for the specified memory address.

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

Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPipelineExecutableStatisticKHR.Buffer instance at the specified memory.

public static VkPipelineExecutableStatisticKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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.

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.

public int
format()

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

public static VkPipelineExecutableStatisticKHR
malloc()

Returns a new VkPipelineExecutableStatisticKHR instance allocated with memAlloc.

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

Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPipelineExecutableStatisticKHR instance allocated on the specified MemoryStack.

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

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

public static VkPipelineExecutableStatisticKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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.

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.

public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public static int
nformat(long struct)

Unsafe version of format.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

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 static VkPipelineExecutableStatisticValueKHR
nvalue(long struct)

Unsafe version of value.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineExecutableStatisticKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineExecutableStatisticKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPipelineExecutableStatisticKHR

Returns:

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

Sets the specified value to the sType field.

public VkPipelineExecutableStatisticKHR
public VkPipelineExecutableStatisticValueKHR
value()

the value of this statistic.

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.

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

NAMEback to summary
public static final int NAME

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.

VALUEback to summary
public static final int VALUE

The struct member offsets.

Constructor Detail

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

callocback to summary
public static VkPipelineExecutableStatisticKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkPipelineExecutableStatisticKHR callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkPipelineExecutableStatisticKHR.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 VkPipelineExecutableStatisticKHR 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 VkPipelineExecutableStatisticKHR create()

Returns a new VkPipelineExecutableStatisticKHR instance allocated with BufferUtils.

createback to summary
public static VkPipelineExecutableStatisticKHR create(long address)

Returns a new VkPipelineExecutableStatisticKHR instance for the specified memory address.

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

Returns a new VkPipelineExecutableStatisticKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPipelineExecutableStatisticKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineExecutableStatisticKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptionback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
formatback to summary
public int format()

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

Annotations
@NativeType:VkPipelineExecutableStatisticFormatKHR
mallocback to summary
public static VkPipelineExecutableStatisticKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineExecutableStatisticKHR malloc(MemoryStack stack)

Returns a new VkPipelineExecutableStatisticKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nameback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
nameStringback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
ndescriptionback to summary
public static ByteBuffer ndescription(long struct)

Unsafe version of description.

ndescriptionStringback to summary
public static String ndescriptionString(long struct)

Unsafe version of descriptionString.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

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.

nvalueback to summary
public static VkPipelineExecutableStatisticValueKHR nvalue(long struct)

Unsafe version of value.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkPipelineExecutableStatisticKHR set(VkPipelineExecutableStatisticKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineExecutableStatisticKHR

the source struct

Returns:VkPipelineExecutableStatisticKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR value to the sType field.

valueback to summary
public VkPipelineExecutableStatisticValueKHR value()

the value of this statistic.

org.lwjgl.vulkan back to summary

public Class VkPipelineExecutableStatisticKHR.Buffer

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

An array of VkPipelineExecutableStatisticKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineExecutableStatisticKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineExecutableStatisticKHR.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
public ByteBuffer
public String

Returns:

the null-terminated string stored in the VkPipelineExecutableStatisticKHR#description field.
descriptionString
()

public int

Returns:

the value of the VkPipelineExecutableStatisticKHR#format field.
format
()

protected VkPipelineExecutableStatisticKHR
public ByteBuffer
name()

public String

Returns:

the null-terminated string stored in the VkPipelineExecutableStatisticKHR#name field.
nameString
()

public long

Returns:

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

public VkPipelineExecutableStatisticKHR.Buffer
pNext(long value)

Sets the specified value to the VkPipelineExecutableStatisticKHR#pNext field.

protected VkPipelineExecutableStatisticKHR.Buffer
public int

Returns:

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

public VkPipelineExecutableStatisticKHR.Buffer
sType(int value)

Sets the specified value to the VkPipelineExecutableStatisticKHR#sType field.

public VkPipelineExecutableStatisticKHR.Buffer
public VkPipelineExecutableStatisticValueKHR
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineExecutableStatisticKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineExecutableStatisticKHR.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 VkPipelineExecutableStatisticKHR#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

descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the VkPipelineExecutableStatisticKHR#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()
Returns:String

the null-terminated string stored in the VkPipelineExecutableStatisticKHR#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
formatback to summary
public int format()
Returns:int

the value of the VkPipelineExecutableStatisticKHR#format field.

Annotations
@NativeType:VkPipelineExecutableStatisticFormatKHR
getElementFactoryback to summary
protected VkPipelineExecutableStatisticKHR getElementFactory()

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

Annotations
@Override
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the VkPipelineExecutableStatisticKHR#name field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the VkPipelineExecutableStatisticKHR#name field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineExecutableStatisticKHR#pNext field.

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

Sets the specified value to the VkPipelineExecutableStatisticKHR#pNext field.

selfback to summary
protected VkPipelineExecutableStatisticKHR.Buffer self()

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

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

the value of the VkPipelineExecutableStatisticKHR#sType field.

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

Sets the specified value to the VkPipelineExecutableStatisticKHR#sType field.

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

Sets the STRUCTURE_TYPE_PIPELINE_EXECUTABLE_STATISTIC_KHR value to the VkPipelineExecutableStatisticKHR#sType field.

valueback to summary
public VkPipelineExecutableStatisticValueKHR value()
Returns:VkPipelineExecutableStatisticValueKHR

a VkPipelineExecutableStatisticValueKHR view of the VkPipelineExecutableStatisticKHR#value field.