Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPerformanceCounterKHR

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

EnumeratePhysicalDeviceQueueFamilyPerformanceQueryCountersKHR

Layout


struct VkPerformanceCounterKHR {
    VkStructureType sType;
    void * pNext;
    VkPerformanceCounterUnitKHR unit;
    VkPerformanceCounterScopeKHR scope;
    VkPerformanceCounterStorageKHR storage;
    uint8_t uuid[VK_UUID_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
PNEXT

The struct member offsets.

public static final int
SCOPE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STORAGE

The struct member offsets.

public static final int
STYPE

The struct member offsets.

public static final int
UNIT

The struct member offsets.

public static final int
UUID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkPerformanceCounterKHR(long address, ByteBuffer container)

public
VkPerformanceCounterKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPerformanceCounterKHR
calloc()

Returns a new VkPerformanceCounterKHR instance allocated with memCalloc.

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

Returns a new VkPerformanceCounterKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPerformanceCounterKHR instance allocated with BufferUtils.

public static VkPerformanceCounterKHR
create(long address)

Returns a new VkPerformanceCounterKHR instance for the specified memory address.

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

Returns a new VkPerformanceCounterKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPerformanceCounterKHR.Buffer instance at the specified memory.

public static VkPerformanceCounterKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPerformanceCounterKHR
malloc()

Returns a new VkPerformanceCounterKHR instance allocated with memAlloc.

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

Returns a new VkPerformanceCounterKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPerformanceCounterKHR instance allocated on the specified MemoryStack.

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

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

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
nscope(long struct)

Unsafe version of scope.

public static int
nstorage(long struct)

Unsafe version of storage.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nunit(long struct)

Unsafe version of unit.

public static ByteBuffer
nuuid(long struct)

Unsafe version of uuid.

public static byte
nuuid(long struct, int index)

Unsafe version of uuid.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPerformanceCounterKHR
pNext(long value)

Sets the specified value to the pNext field.

public int
scope()

a VkPerformanceCounterScopeKHR specifying the scope that the counter belongs to.

public VkPerformanceCounterKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPerformanceCounterKHR

Returns:

this struct
set
(VkPerformanceCounterKHR
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
storage()

a VkPerformanceCounterStorageKHR specifying the storage type that the counter’s data uses.

public int
sType()

a VkStructureType value identifying this structure.

public VkPerformanceCounterKHR
sType(int value)

Sets the specified value to the sType field.

public VkPerformanceCounterKHR
public int
unit()

a VkPerformanceCounterUnitKHR specifying the unit that the counter data will record.

public ByteBuffer
uuid()

an array of size UUID_SIZE, containing 8-bit values that represent a universally unique identifier for the counter of the physical device.

public byte
uuid(int index)

an array of size UUID_SIZE, containing 8-bit values that represent a universally unique identifier for the counter of the physical device.

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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SCOPEback to summary
public static final int SCOPE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STORAGEback to summary
public static final int STORAGE

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

UNITback to summary
public static final int UNIT

The struct member offsets.

UUIDback to summary
public static final int UUID

The struct member offsets.

Constructor Detail

VkPerformanceCounterKHRback to summary
protected VkPerformanceCounterKHR(long address, ByteBuffer container)
VkPerformanceCounterKHRback to summary
public VkPerformanceCounterKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPerformanceCounterKHR calloc(MemoryStack stack)

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

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

createback to summary
protected VkPerformanceCounterKHR 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 VkPerformanceCounterKHR create()

Returns a new VkPerformanceCounterKHR instance allocated with BufferUtils.

createback to summary
public static VkPerformanceCounterKHR create(long address)

Returns a new VkPerformanceCounterKHR instance for the specified memory address.

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

Returns a new VkPerformanceCounterKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPerformanceCounterKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPerformanceCounterKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPerformanceCounterKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPerformanceCounterKHR malloc(MemoryStack stack)

Returns a new VkPerformanceCounterKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nscopeback to summary
public static int nscope(long struct)

Unsafe version of scope.

nstorageback to summary
public static int nstorage(long struct)

Unsafe version of storage.

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.

nunitback to summary
public static int nunit(long struct)

Unsafe version of unit.

nuuidback to summary
public static ByteBuffer nuuid(long struct)

Unsafe version of uuid.

nuuidback to summary
public static byte nuuid(long struct, int index)

Unsafe version of uuid.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

scopeback to summary
public int scope()

a VkPerformanceCounterScopeKHR specifying the scope that the counter belongs to.

Annotations
@NativeType:VkPerformanceCounterScopeKHR
setback to summary
public VkPerformanceCounterKHR set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkPerformanceCounterKHR set(VkPerformanceCounterKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPerformanceCounterKHR

the source struct

Returns:VkPerformanceCounterKHR

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
storageback to summary
public int storage()

a VkPerformanceCounterStorageKHR specifying the storage type that the counter’s data uses.

Annotations
@NativeType:VkPerformanceCounterStorageKHR
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPerformanceCounterKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_KHR value to the sType field.

unitback to summary
public int unit()

a VkPerformanceCounterUnitKHR specifying the unit that the counter data will record.

Annotations
@NativeType:VkPerformanceCounterUnitKHR
uuidback to summary
public ByteBuffer uuid()

an array of size UUID_SIZE, containing 8-bit values that represent a universally unique identifier for the counter of the physical device.

Annotations
@NativeType:uint8_t[VK_UUID_SIZE]
uuidback to summary
public byte uuid(int index)

an array of size UUID_SIZE, containing 8-bit values that represent a universally unique identifier for the counter of the physical device.

Annotations
@NativeType:uint8_t
org.lwjgl.vulkan back to summary

public Class VkPerformanceCounterKHR.Buffer

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

An array of VkPerformanceCounterKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPerformanceCounterKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPerformanceCounterKHR.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
protected VkPerformanceCounterKHR
public long

Returns:

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

public VkPerformanceCounterKHR.Buffer
pNext(long value)

Sets the specified value to the VkPerformanceCounterKHR#pNext field.

public int

Returns:

the value of the VkPerformanceCounterKHR#scope field.
scope
()

protected VkPerformanceCounterKHR.Buffer
public int

Returns:

the value of the VkPerformanceCounterKHR#storage field.
storage
()

public int

Returns:

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

public VkPerformanceCounterKHR.Buffer
sType(int value)

Sets the specified value to the VkPerformanceCounterKHR#sType field.

public VkPerformanceCounterKHR.Buffer
public int

Returns:

the value of the VkPerformanceCounterKHR#unit field.
unit
()

public ByteBuffer

Returns:

a ByteBuffer view of the VkPerformanceCounterKHR#uuid field.
uuid
()

public byte

Returns:

the value at the specified index of the VkPerformanceCounterKHR#uuid field.
uuid
(int index)

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPerformanceCounterKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkPerformanceCounterKHR getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkPerformanceCounterKHR#pNext field.

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

Sets the specified value to the VkPerformanceCounterKHR#pNext field.

scopeback to summary
public int scope()
Returns:int

the value of the VkPerformanceCounterKHR#scope field.

Annotations
@NativeType:VkPerformanceCounterScopeKHR
selfback to summary
protected VkPerformanceCounterKHR.Buffer self()

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

Annotations
@Override
storageback to summary
public int storage()
Returns:int

the value of the VkPerformanceCounterKHR#storage field.

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

the value of the VkPerformanceCounterKHR#sType field.

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

Sets the specified value to the VkPerformanceCounterKHR#sType field.

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

Sets the STRUCTURE_TYPE_PERFORMANCE_COUNTER_KHR value to the VkPerformanceCounterKHR#sType field.

unitback to summary
public int unit()
Returns:int

the value of the VkPerformanceCounterKHR#unit field.

Annotations
@NativeType:VkPerformanceCounterUnitKHR
uuidback to summary
public ByteBuffer uuid()
Returns:ByteBuffer

a ByteBuffer view of the VkPerformanceCounterKHR#uuid field.

Annotations
@NativeType:uint8_t[VK_UUID_SIZE]
uuidback to summary
public byte uuid(int index)
Returns:byte

the value at the specified index of the VkPerformanceCounterKHR#uuid field.

Annotations
@NativeType:uint8_t