Package org.lwjgl.vulkan

Class VkShaderResourceUsageAMD

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkShaderResourceUsageAMD

All Implemented Interfaces:

org.lwjgl.system.Pointer

public class VkShaderResourceUsageAMD
extends org.lwjgl.system.Struct

Resource usage information about a particular shader within a pipeline.

Member documentation

• numUsedVgprs – the number of vector instruction general-purpose registers used by this shader.
• numUsedSgprs – the number of scalar instruction general-purpose registers used by this shader.
• ldsSizePerLocalWorkGroup – the maximum local data store size per work group in bytes.
• ldsUsageSizeInBytes – the LDS usage size in bytes per work group by this shader.
• scratchMemUsageInBytes – the scratch memory usage in bytes by this shader.

Layout

 struct VkShaderResourceUsageAMD {
     uint32_t numUsedVgprs;
     uint32_t numUsedSgprs;
     uint32_t ldsSizePerLocalWorkGroup;
     size_t ldsUsageSizeInBytes;
     size_t scratchMemUsageInBytes;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkShaderResourceUsageAMD.Buffer	An array of VkShaderResourceUsageAMD structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	LDSSIZEPERLOCALWORKGROUP LDSUSAGESIZEINBYTES NUMUSEDSGPRS NUMUSEDVGPRS SCRATCHMEMUSAGEINBYTES	The struct member offsets.
static int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkShaderResourceUsageAMD	create(long address)	Returns a new VkShaderResourceUsageAMD instance for the specified memory address.
static VkShaderResourceUsageAMD.Buffer	create(long address, int capacity)	Create a VkShaderResourceUsageAMD.Buffer instance at the specified memory.
static VkShaderResourceUsageAMD	createSafe(long address)	Like create, but returns null if address is NULL.
static VkShaderResourceUsageAMD.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	ldsSizePerLocalWorkGroup()	Returns the value of the ldsSizePerLocalWorkGroup field.
long	ldsUsageSizeInBytes()	Returns the value of the ldsUsageSizeInBytes field.
static int	nldsSizePerLocalWorkGroup(long struct)	Unsafe version of ldsSizePerLocalWorkGroup().
static long	nldsUsageSizeInBytes(long struct)	Unsafe version of ldsUsageSizeInBytes().
static int	nnumUsedSgprs(long struct)	Unsafe version of numUsedSgprs().
static int	nnumUsedVgprs(long struct)	Unsafe version of numUsedVgprs().
static long	nscratchMemUsageInBytes(long struct)	Unsafe version of scratchMemUsageInBytes().
int	numUsedSgprs()	Returns the value of the numUsedSgprs field.
int	numUsedVgprs()	Returns the value of the numUsedVgprs field.
long	scratchMemUsageInBytes()	Returns the value of the scratchMemUsageInBytes field.
int	sizeof()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

NUMUSEDVGPRS, NUMUSEDSGPRS, LDSSIZEPERLOCALWORKGROUP, LDSUSAGESIZEINBYTES, SCRATCHMEMUSAGEINBYTES

The struct member offsets.

Constructor Detail

VkShaderResourceUsageAMD

public VkShaderResourceUsageAMD(java.nio.ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

numUsedVgprs

public int numUsedVgprs()

Returns the value of the numUsedVgprs field.

numUsedSgprs

public int numUsedSgprs()

Returns the value of the numUsedSgprs field.

ldsSizePerLocalWorkGroup

public int ldsSizePerLocalWorkGroup()

Returns the value of the ldsSizePerLocalWorkGroup field.

ldsUsageSizeInBytes

public long ldsUsageSizeInBytes()

Returns the value of the ldsUsageSizeInBytes field.

scratchMemUsageInBytes

public long scratchMemUsageInBytes()

Returns the value of the scratchMemUsageInBytes field.

create

public static VkShaderResourceUsageAMD create(long address)

Returns a new VkShaderResourceUsageAMD instance for the specified memory address.

createSafe

@Nullable
public static VkShaderResourceUsageAMD createSafe(long address)

Like create, but returns null if address is NULL.

create

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

Create a VkShaderResourceUsageAMD.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

nnumUsedVgprs

public static int nnumUsedVgprs(long struct)

Unsafe version of numUsedVgprs().

nnumUsedSgprs

public static int nnumUsedSgprs(long struct)

Unsafe version of numUsedSgprs().

nldsSizePerLocalWorkGroup

public static int nldsSizePerLocalWorkGroup(long struct)

Unsafe version of ldsSizePerLocalWorkGroup().

nldsUsageSizeInBytes

public static long nldsUsageSizeInBytes(long struct)

Unsafe version of ldsUsageSizeInBytes().

nscratchMemUsageInBytes

public static long nscratchMemUsageInBytes(long struct)

Unsafe version of scratchMemUsageInBytes().