Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPerformanceCounterDescriptionKHR

extends Struct<VkPerformanceCounterDescriptionKHR>
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 providing more detailed information about a counter.
Valid Usage (Implicit)
See Also

EnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR

Layout


struct VkPerformanceCounterDescriptionKHR {
    VkStructureType sType;
    void * pNext;
    VkPerformanceCounterDescriptionFlagsKHR flags;
    char name[VK_MAX_DESCRIPTION_SIZE];
    char category[VK_MAX_DESCRIPTION_SIZE];
    char description[VK_MAX_DESCRIPTION_SIZE];
}

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
CATEGORY

The struct member offsets.

public static final int
DESCRIPTION

The struct member offsets.

public static final int
FLAGS

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPerformanceCounterDescriptionKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPerformanceCounterDescriptionKHR
calloc()

Returns a new VkPerformanceCounterDescriptionKHR instance allocated with memCalloc.

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

Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public ByteBuffer
category()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.

public String
categoryString()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.

protected VkPerformanceCounterDescriptionKHR
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 VkPerformanceCounterDescriptionKHR
create()

Returns a new VkPerformanceCounterDescriptionKHR instance allocated with BufferUtils.

public static VkPerformanceCounterDescriptionKHR
create(long address)

Returns a new VkPerformanceCounterDescriptionKHR instance for the specified memory address.

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

Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPerformanceCounterDescriptionKHR.Buffer instance at the specified memory.

public static VkPerformanceCounterDescriptionKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
description()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.

public String
descriptionString()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.

public int
flags()

a bitmask of VkPerformanceCounterDescriptionFlagBitsKHR indicating the usage behavior for the counter.

public static VkPerformanceCounterDescriptionKHR
malloc()

Returns a new VkPerformanceCounterDescriptionKHR instance allocated with memAlloc.

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

Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPerformanceCounterDescriptionKHR instance allocated on the specified MemoryStack.

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

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

public ByteBuffer
name()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.

public String
nameString()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.

public static ByteBuffer
ncategory(long struct)

Unsafe version of category.

public static String
ncategoryString(long struct)

Unsafe version of categoryString.

public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public static int
nflags(long struct)

Unsafe version of flags.

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

NULL or a pointer to a structure extending this structure.

public VkPerformanceCounterDescriptionKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkPerformanceCounterDescriptionKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPerformanceCounterDescriptionKHR

Returns:

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

Sets the specified value to the sType field.

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

CATEGORYback to summary
public static final int CATEGORY

The struct member offsets.

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

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.

Constructor Detail

VkPerformanceCounterDescriptionKHRback to summary
protected VkPerformanceCounterDescriptionKHR(long address, ByteBuffer container)
VkPerformanceCounterDescriptionKHRback to summary
public VkPerformanceCounterDescriptionKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPerformanceCounterDescriptionKHR calloc(MemoryStack stack)

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

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

categoryback to summary
public ByteBuffer category()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
categoryStringback to summary
public String categoryString()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
createback to summary
protected VkPerformanceCounterDescriptionKHR 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 VkPerformanceCounterDescriptionKHR create()

Returns a new VkPerformanceCounterDescriptionKHR instance allocated with BufferUtils.

createback to summary
public static VkPerformanceCounterDescriptionKHR create(long address)

Returns a new VkPerformanceCounterDescriptionKHR instance for the specified memory address.

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

Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPerformanceCounterDescriptionKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPerformanceCounterDescriptionKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPerformanceCounterDescriptionKHR.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 size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.

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

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
flagsback to summary
public int flags()

a bitmask of VkPerformanceCounterDescriptionFlagBitsKHR indicating the usage behavior for the counter.

Annotations
@NativeType:VkPerformanceCounterDescriptionFlagsKHR
mallocback to summary
public static VkPerformanceCounterDescriptionKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPerformanceCounterDescriptionKHR malloc(MemoryStack stack)

Returns a new VkPerformanceCounterDescriptionKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nameback to summary
public ByteBuffer name()

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.

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

an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.

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

Unsafe version of category.

ncategoryStringback to summary
public static String ncategoryString(long struct)

Unsafe version of categoryString.

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.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkPerformanceCounterDescriptionKHR set(VkPerformanceCounterDescriptionKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPerformanceCounterDescriptionKHR

the source struct

Returns:VkPerformanceCounterDescriptionKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPerformanceCounterDescriptionKHR.Buffer

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

An array of VkPerformanceCounterDescriptionKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPerformanceCounterDescriptionKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPerformanceCounterDescriptionKHR.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 VkPerformanceCounterDescriptionKHR#category field.
categoryString
()

public ByteBuffer
public String

Returns:

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

public int

Returns:

the value of the VkPerformanceCounterDescriptionKHR#flags field.
flags
()

protected VkPerformanceCounterDescriptionKHR
public ByteBuffer
public String

Returns:

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

public long

Returns:

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

public VkPerformanceCounterDescriptionKHR.Buffer
pNext(long value)

Sets the specified value to the VkPerformanceCounterDescriptionKHR#pNext field.

protected VkPerformanceCounterDescriptionKHR.Buffer
public int

Returns:

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

public VkPerformanceCounterDescriptionKHR.Buffer
sType(int value)

Sets the specified value to the VkPerformanceCounterDescriptionKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPerformanceCounterDescriptionKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

categoryback to summary
public ByteBuffer category()
Returns:ByteBuffer

a ByteBuffer view of the VkPerformanceCounterDescriptionKHR#category field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
categoryStringback to summary
public String categoryString()
Returns:String

the null-terminated string stored in the VkPerformanceCounterDescriptionKHR#category field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the VkPerformanceCounterDescriptionKHR#description field.

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

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

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
flagsback to summary
public int flags()
Returns:int

the value of the VkPerformanceCounterDescriptionKHR#flags field.

Annotations
@NativeType:VkPerformanceCounterDescriptionFlagsKHR
getElementFactoryback to summary
protected VkPerformanceCounterDescriptionKHR getElementFactory()

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

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

a ByteBuffer view of the VkPerformanceCounterDescriptionKHR#name field.

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

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

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

the value of the VkPerformanceCounterDescriptionKHR#pNext field.

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

Sets the specified value to the VkPerformanceCounterDescriptionKHR#pNext field.

selfback to summary
protected VkPerformanceCounterDescriptionKHR.Buffer self()

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

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

the value of the VkPerformanceCounterDescriptionKHR#sType field.

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

Sets the specified value to the VkPerformanceCounterDescriptionKHR#sType field.

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

Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_KHR value to the VkPerformanceCounterDescriptionKHR#sType field.