Package org.lwjgl.vulkan

Class VkPerformanceCounterDescriptionKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPerformanceCounterDescriptionKHR>

org.lwjgl.vulkan.VkPerformanceCounterDescriptionKHR

All Implemented Interfaces:

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

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

Structure providing more detailed information about a counter.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_KHR
• pNext must be NULL

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPerformanceCounterDescriptionKHR.Buffer	An array of VkPerformanceCounterDescriptionKHR 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	CATEGORY	The struct member offsets.
static final int	DESCRIPTION	The struct member offsets.
static final int	FLAGS	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPerformanceCounterDescriptionKHR(ByteBuffer container)	Creates a VkPerformanceCounterDescriptionKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPerformanceCounterDescriptionKHR	calloc()	Returns a new VkPerformanceCounterDescriptionKHR instance allocated with memCalloc.
static VkPerformanceCounterDescriptionKHR.Buffer	calloc(int capacity)	Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with memCalloc.
static VkPerformanceCounterDescriptionKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPerformanceCounterDescriptionKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPerformanceCounterDescriptionKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
ByteBuffer	category()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.
String	categoryString()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the category of the counter.
static VkPerformanceCounterDescriptionKHR	create()	Returns a new VkPerformanceCounterDescriptionKHR instance allocated with BufferUtils.
static VkPerformanceCounterDescriptionKHR.Buffer	create(int capacity)	Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with BufferUtils.
static VkPerformanceCounterDescriptionKHR	create(long address)	Returns a new VkPerformanceCounterDescriptionKHR instance for the specified memory address.
static VkPerformanceCounterDescriptionKHR.Buffer	create(long address, int capacity)	Create a VkPerformanceCounterDescriptionKHR.Buffer instance at the specified memory.
static @Nullable VkPerformanceCounterDescriptionKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPerformanceCounterDescriptionKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	description()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.
String	descriptionString()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the description of the counter.
int	flags()	a bitmask of VkPerformanceCounterDescriptionFlagBitsKHR indicating the usage behavior for the counter.
static VkPerformanceCounterDescriptionKHR	malloc()	Returns a new VkPerformanceCounterDescriptionKHR instance allocated with memAlloc.
static VkPerformanceCounterDescriptionKHR.Buffer	malloc(int capacity)	Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with memAlloc.
static VkPerformanceCounterDescriptionKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated on the specified MemoryStack.
static VkPerformanceCounterDescriptionKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPerformanceCounterDescriptionKHR instance allocated on the specified MemoryStack.
ByteBuffer	name()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.
String	nameString()	an array of size MAX_DESCRIPTION_SIZE, containing a null-terminated UTF-8 string specifying the name of the counter.
static ByteBuffer	ncategory(long struct)	Unsafe version of category().
static String	ncategoryString(long struct)	Unsafe version of categoryString().
static ByteBuffer	ndescription(long struct)	Unsafe version of description().
static String	ndescriptionString(long struct)	Unsafe version of descriptionString().
static int	nflags(long struct)	Unsafe version of flags().
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPerformanceCounterDescriptionKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPerformanceCounterDescriptionKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPerformanceCounterDescriptionKHR	set(VkPerformanceCounterDescriptionKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPerformanceCounterDescriptionKHR	sType(int value)	Sets the specified value to the sType() field.
VkPerformanceCounterDescriptionKHR	sType$Default()	Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_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.

FLAGS

public static final int FLAGS

The struct member offsets.

NAME

public static final int NAME

The struct member offsets.

CATEGORY

public static final int CATEGORY

The struct member offsets.

DESCRIPTION

public static final int DESCRIPTION

The struct member offsets.

Constructor Details

VkPerformanceCounterDescriptionKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPerformanceCounterDescriptionKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

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

name

public ByteBuffer name()

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

nameString

public String nameString()

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

category

public ByteBuffer category()

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

categoryString

public String categoryString()

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

description

public ByteBuffer description()

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

descriptionString

public String descriptionString()

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

sType

public VkPerformanceCounterDescriptionKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPerformanceCounterDescriptionKHR sType$Default()

Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_DESCRIPTION_KHR value to the sType() field.

pNext

public VkPerformanceCounterDescriptionKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPerformanceCounterDescriptionKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPerformanceCounterDescriptionKHR set(VkPerformanceCounterDescriptionKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPerformanceCounterDescriptionKHR malloc()

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

calloc

public static VkPerformanceCounterDescriptionKHR calloc()

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

create

public static VkPerformanceCounterDescriptionKHR create()

Returns a new VkPerformanceCounterDescriptionKHR instance allocated with BufferUtils.

create

public static VkPerformanceCounterDescriptionKHR create(long address)

Returns a new VkPerformanceCounterDescriptionKHR instance for the specified memory address.

createSafe

public static @Nullable VkPerformanceCounterDescriptionKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPerformanceCounterDescriptionKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPerformanceCounterDescriptionKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPerformanceCounterDescriptionKHR.Buffer create(int capacity)

Returns a new VkPerformanceCounterDescriptionKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPerformanceCounterDescriptionKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPerformanceCounterDescriptionKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().

ncategory

public static ByteBuffer ncategory(long struct)

Unsafe version of category().

ncategoryString

public static String ncategoryString(long struct)

Unsafe version of categoryString().

ndescription

public static ByteBuffer ndescription(long struct)

Unsafe version of description().

ndescriptionString

public static String ndescriptionString(long struct)

Unsafe version of descriptionString().

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.