Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkShaderResourceUsageAMD

extends Struct<VkShaderResourceUsageAMD>
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Resource usage information about a particular shader within a pipeline.
See Also

VkShaderStatisticsInfoAMD

Layout


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

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
LDSSIZEPERLOCALWORKGROUP

The struct member offsets.

public static final int
LDSUSAGESIZEINBYTES

The struct member offsets.

public static final int
NUMUSEDSGPRS

The struct member offsets.

public static final int
NUMUSEDVGPRS

The struct member offsets.

public static final int
SCRATCHMEMUSAGEINBYTES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkShaderResourceUsageAMD(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected VkShaderResourceUsageAMD
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 VkShaderResourceUsageAMD
create(long address)

Returns a new VkShaderResourceUsageAMD instance for the specified memory address.

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

Create a VkShaderResourceUsageAMD.Buffer instance at the specified memory.

public static VkShaderResourceUsageAMD
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
ldsSizePerLocalWorkGroup()

the maximum local data store size per work group in bytes.

public long
ldsUsageSizeInBytes()

the LDS usage size in bytes per work group by this shader.

public static int
nldsSizePerLocalWorkGroup(long struct)

Unsafe version of ldsSizePerLocalWorkGroup.

public static long
nldsUsageSizeInBytes(long struct)

Unsafe version of ldsUsageSizeInBytes.

public static int
nnumUsedSgprs(long struct)

Unsafe version of numUsedSgprs.

public static int
nnumUsedVgprs(long struct)

Unsafe version of numUsedVgprs.

public static long
nscratchMemUsageInBytes(long struct)

Unsafe version of scratchMemUsageInBytes.

public int
numUsedSgprs()

the number of scalar instruction general-purpose registers used by this shader.

public int
numUsedVgprs()

the number of vector instruction general-purpose registers used by this shader.

public long
scratchMemUsageInBytes()

the scratch memory usage in bytes by this shader.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
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.

LDSSIZEPERLOCALWORKGROUPback to summary
public static final int LDSSIZEPERLOCALWORKGROUP

The struct member offsets.

LDSUSAGESIZEINBYTESback to summary
public static final int LDSUSAGESIZEINBYTES

The struct member offsets.

NUMUSEDSGPRSback to summary
public static final int NUMUSEDSGPRS

The struct member offsets.

NUMUSEDVGPRSback to summary
public static final int NUMUSEDVGPRS

The struct member offsets.

SCRATCHMEMUSAGEINBYTESback to summary
public static final int SCRATCHMEMUSAGEINBYTES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkShaderResourceUsageAMDback to summary
protected VkShaderResourceUsageAMD(long address, ByteBuffer container)
VkShaderResourceUsageAMDback to summary
public VkShaderResourceUsageAMD(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

createback to summary
protected VkShaderResourceUsageAMD 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 VkShaderResourceUsageAMD create(long address)

Returns a new VkShaderResourceUsageAMD instance for the specified memory address.

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

Create a VkShaderResourceUsageAMD.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkShaderResourceUsageAMD createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
ldsSizePerLocalWorkGroupback to summary
public int ldsSizePerLocalWorkGroup()

the maximum local data store size per work group in bytes.

Annotations
@NativeType:uint32_t
ldsUsageSizeInBytesback to summary
public long ldsUsageSizeInBytes()

the LDS usage size in bytes per work group by this shader.

Annotations
@NativeType:size_t
nldsSizePerLocalWorkGroupback to summary
public static int nldsSizePerLocalWorkGroup(long struct)

Unsafe version of ldsSizePerLocalWorkGroup.

nldsUsageSizeInBytesback to summary
public static long nldsUsageSizeInBytes(long struct)

Unsafe version of ldsUsageSizeInBytes.

nnumUsedSgprsback to summary
public static int nnumUsedSgprs(long struct)

Unsafe version of numUsedSgprs.

nnumUsedVgprsback to summary
public static int nnumUsedVgprs(long struct)

Unsafe version of numUsedVgprs.

nscratchMemUsageInBytesback to summary
public static long nscratchMemUsageInBytes(long struct)

Unsafe version of scratchMemUsageInBytes.

numUsedSgprsback to summary
public int numUsedSgprs()

the number of scalar instruction general-purpose registers used by this shader.

Annotations
@NativeType:uint32_t
numUsedVgprsback to summary
public int numUsedVgprs()

the number of vector instruction general-purpose registers used by this shader.

Annotations
@NativeType:uint32_t
scratchMemUsageInBytesback to summary
public long scratchMemUsageInBytes()

the scratch memory usage in bytes by this shader.

Annotations
@NativeType:size_t
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
org.lwjgl.vulkan back to summary

public Class VkShaderResourceUsageAMD.Buffer

extends StructBuffer<VkShaderResourceUsageAMD, VkShaderResourceUsageAMD.Buffer>
Class Inheritance

An array of VkShaderResourceUsageAMD structs.

Field Summary

Modifier and TypeField and Description
private static final VkShaderResourceUsageAMD

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkShaderResourceUsageAMD.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 VkShaderResourceUsageAMD
public int
public long
public int

Returns:

the value of the VkShaderResourceUsageAMD#numUsedSgprs field.
numUsedSgprs
()

public int

Returns:

the value of the VkShaderResourceUsageAMD#numUsedVgprs field.
numUsedVgprs
()

public long
protected VkShaderResourceUsageAMD.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkShaderResourceUsageAMD ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkShaderResourceUsageAMD.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 VkShaderResourceUsageAMD#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 VkShaderResourceUsageAMD getElementFactory()

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

Annotations
@Override
ldsSizePerLocalWorkGroupback to summary
public int ldsSizePerLocalWorkGroup()
Returns:int

the value of the VkShaderResourceUsageAMD#ldsSizePerLocalWorkGroup field.

Annotations
@NativeType:uint32_t
ldsUsageSizeInBytesback to summary
public long ldsUsageSizeInBytes()
Returns:long

the value of the VkShaderResourceUsageAMD#ldsUsageSizeInBytes field.

Annotations
@NativeType:size_t
numUsedSgprsback to summary
public int numUsedSgprs()
Returns:int

the value of the VkShaderResourceUsageAMD#numUsedSgprs field.

Annotations
@NativeType:uint32_t
numUsedVgprsback to summary
public int numUsedVgprs()
Returns:int

the value of the VkShaderResourceUsageAMD#numUsedVgprs field.

Annotations
@NativeType:uint32_t
scratchMemUsageInBytesback to summary
public long scratchMemUsageInBytes()
Returns:long

the value of the VkShaderResourceUsageAMD#scratchMemUsageInBytes field.

Annotations
@NativeType:size_t
selfback to summary
protected VkShaderResourceUsageAMD.Buffer self()

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

Annotations
@Override