Package org.lwjgl.vulkan

Class VkQueryPoolPerformanceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkQueryPoolPerformanceCreateInfoKHR>

org.lwjgl.vulkan.VkQueryPoolPerformanceCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created performance query pool.

Valid Usage

• queueFamilyIndex must be a valid queue family index of the device
• The performanceCounterQueryPools feature must be enabled
• Each element of pCounterIndices must be in the range of counters reported by vkEnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR for the queue family specified in queueFamilyIndex

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR
• pCounterIndices must be a valid pointer to an array of counterIndexCount uint32_t values
• counterIndexCount must be greater than 0

See Also

GetPhysicalDeviceQueueFamilyPerformanceQueryPassesKHR

Layout

 struct VkQueryPoolPerformanceCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t queueFamilyIndex();
     uint32_t counterIndexCount();
     uint32_t const * pCounterIndices();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkQueryPoolPerformanceCreateInfoKHR	calloc()	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated with memCalloc.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkQueryPoolPerformanceCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	counterIndexCount()	the length of the pCounterIndices array.
static VkQueryPoolPerformanceCreateInfoKHR	create()	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated with BufferUtils.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkQueryPoolPerformanceCreateInfoKHR	create(long address)	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance for the specified memory address.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkQueryPoolPerformanceCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkQueryPoolPerformanceCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkQueryPoolPerformanceCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkQueryPoolPerformanceCreateInfoKHR	malloc()	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated with memAlloc.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkQueryPoolPerformanceCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkQueryPoolPerformanceCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated on the specified MemoryStack.
static int	ncounterIndexCount(long struct)	Unsafe version of counterIndexCount().
static void	ncounterIndexCount(long struct, int value)	Sets the specified value to the counterIndexCount field of the specified struct.
static IntBuffer	npCounterIndices(long struct)	Unsafe version of pCounterIndices.
static void	npCounterIndices(long struct, IntBuffer value)	Unsafe version of pCounterIndices.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nqueueFamilyIndex(long struct)	Unsafe version of queueFamilyIndex().
static void	nqueueFamilyIndex(long struct, int value)	Unsafe version of queueFamilyIndex.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
IntBuffer	pCounterIndices()	a pointer to an array of indices into the EnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR::pCounters to enable in this performance query pool.
VkQueryPoolPerformanceCreateInfoKHR	pCounterIndices(IntBuffer value)	Sets the address of the specified IntBuffer to the pCounterIndices() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkQueryPoolPerformanceCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
int	queueFamilyIndex()	the queue family index to create this performance query pool for.
VkQueryPoolPerformanceCreateInfoKHR	queueFamilyIndex(int value)	Sets the specified value to the queueFamilyIndex() field.
VkQueryPoolPerformanceCreateInfoKHR	set(int sType, long pNext, int queueFamilyIndex, IntBuffer pCounterIndices)	Initializes this struct with the specified values.
VkQueryPoolPerformanceCreateInfoKHR	set(VkQueryPoolPerformanceCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkQueryPoolPerformanceCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkQueryPoolPerformanceCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

QUEUEFAMILYINDEX

public static final int QUEUEFAMILYINDEX

The struct member offsets.

COUNTERINDEXCOUNT

public static final int COUNTERINDEXCOUNT

The struct member offsets.

PCOUNTERINDICES

public static final int PCOUNTERINDICES

The struct member offsets.

Constructor Details

VkQueryPoolPerformanceCreateInfoKHR

public VkQueryPoolPerformanceCreateInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

queueFamilyIndex

public int queueFamilyIndex()

the queue family index to create this performance query pool for.

counterIndexCount

public int counterIndexCount()

the length of the pCounterIndices array.

pCounterIndices

public IntBuffer pCounterIndices()

a pointer to an array of indices into the EnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR::pCounters to enable in this performance query pool.

sType

public VkQueryPoolPerformanceCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkQueryPoolPerformanceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_QUERY_POOL_PERFORMANCE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkQueryPoolPerformanceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

queueFamilyIndex

public VkQueryPoolPerformanceCreateInfoKHR queueFamilyIndex(int value)

Sets the specified value to the queueFamilyIndex() field.

pCounterIndices

public VkQueryPoolPerformanceCreateInfoKHR pCounterIndices(IntBuffer value)

Sets the address of the specified IntBuffer to the pCounterIndices() field.

set

public VkQueryPoolPerformanceCreateInfoKHR set(int sType,
 long pNext,
 int queueFamilyIndex,
 IntBuffer pCounterIndices)

Initializes this struct with the specified values.

set

public VkQueryPoolPerformanceCreateInfoKHR set(VkQueryPoolPerformanceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkQueryPoolPerformanceCreateInfoKHR malloc()

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

calloc

public static VkQueryPoolPerformanceCreateInfoKHR calloc()

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

create

public static VkQueryPoolPerformanceCreateInfoKHR create()

Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated with BufferUtils.

create

public static VkQueryPoolPerformanceCreateInfoKHR create(long address)

Returns a new VkQueryPoolPerformanceCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkQueryPoolPerformanceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkQueryPoolPerformanceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkQueryPoolPerformanceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkQueryPoolPerformanceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkQueryPoolPerformanceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkQueryPoolPerformanceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkQueryPoolPerformanceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nqueueFamilyIndex

public static int nqueueFamilyIndex(long struct)

Unsafe version of queueFamilyIndex().

ncounterIndexCount

public static int ncounterIndexCount(long struct)

Unsafe version of counterIndexCount().

npCounterIndices

public static IntBuffer npCounterIndices(long struct)

Unsafe version of pCounterIndices.

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.

nqueueFamilyIndex

public static void nqueueFamilyIndex(long struct,
 int value)

Unsafe version of queueFamilyIndex.

ncounterIndexCount

public static void ncounterIndexCount(long struct,
 int value)

Sets the specified value to the counterIndexCount field of the specified struct.

npCounterIndices

public static void npCounterIndices(long struct,
 IntBuffer value)

Unsafe version of pCounterIndices.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate