Statistical information about a particular shader within a pipeline.

Description

Some implementations may merge multiple logical shader stages together in a single shader. In such cases, shaderStageMask will contain a bitmask of all of the stages that are active within that shader. Consequently, if specifying those stages as input to GetShaderInfoAMD, the same output information may be returned for all such shader stage queries.

The number of available VGPRs and SGPRs (numAvailableVgprs and numAvailableSgprs respectively) are the shader-addressable subset of physical registers that is given as a limit to the compiler for register assignment. These values may further be limited by implementations due to performance optimizations where register pressure is a bottleneck.

Layout


struct VkShaderStatisticsInfoAMD {
    VkShaderStageFlags shaderStageMask;
    VkShaderResourceUsageAMD resourceUsage;
    uint32_t numPhysicalVgprs;
    uint32_t numPhysicalSgprs;
    uint32_t numAvailableVgprs;
    uint32_t numAvailableSgprs;
    uint32_t computeWorkGroupSize[3];
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkShaderStatisticsInfoAMD.Buffer An array of `VkShaderStatisticsInfoAMD` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COMPUTEWORKGROUPSIZE The struct member offsets.
public static final int	NUMAVAILABLESGPRS The struct member offsets.
public static final int	NUMAVAILABLEVGPRS The struct member offsets.
public static final int	NUMPHYSICALSGPRS The struct member offsets.
public static final int	NUMPHYSICALVGPRS The struct member offsets.
public static final int	RESOURCEUSAGE The struct member offsets.
public static final int	SHADERSTAGEMASK The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkShaderStatisticsInfoAMD(long address, ByteBuffer container)
public	VkShaderStatisticsInfoAMD(ByteBuffer container) Creates a `VkShaderStatisticsInfoAMD` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public IntBuffer	computeWorkGroupSize() the local workgroup size of this shader in { X, Y, Z } dimensions.
public int	computeWorkGroupSize(int index) the local workgroup size of this shader in { X, Y, Z } dimensions.
protected VkShaderStatisticsInfoAMD	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 VkShaderStatisticsInfoAMD	create(long address) Returns a new `VkShaderStatisticsInfoAMD` instance for the specified memory address.
public static VkShaderStatisticsInfoAMD.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkShaderStatisticsInfoAMD.Buffer` instance at the specified memory.
public static VkShaderStatisticsInfoAMD	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkShaderStatisticsInfoAMD.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static IntBuffer	ncomputeWorkGroupSize(long struct) Unsafe version of `computeWorkGroupSize`.
public static int	ncomputeWorkGroupSize(long struct, int index) Unsafe version of `computeWorkGroupSize`.
public static int	nnumAvailableSgprs(long struct) Unsafe version of `numAvailableSgprs`.
public static int	nnumAvailableVgprs(long struct) Unsafe version of `numAvailableVgprs`.
public static int	nnumPhysicalSgprs(long struct) Unsafe version of `numPhysicalSgprs`.
public static int	nnumPhysicalVgprs(long struct) Unsafe version of `numPhysicalVgprs`.
public static VkShaderResourceUsageAMD	nresourceUsage(long struct) Unsafe version of `resourceUsage`.
public static int	nshaderStageMask(long struct) Unsafe version of `shaderStageMask`.
public int	numAvailableSgprs() the maximum limit of SGPRs made available to the shader compiler.
public int	numAvailableVgprs() the maximum limit of VGPRs made available to the shader compiler.
public int	numPhysicalSgprs() the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device.
public int	numPhysicalVgprs() the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device.
public VkShaderResourceUsageAMD	resourceUsage() a `VkShaderResourceUsageAMD` structure describing internal physical device resources used by this shader.
public int	shaderStageMask() are the combination of logical shader stages contained within this shader.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COMPUTEWORKGROUPSIZE	back to summary
public static final int COMPUTEWORKGROUPSIZE The struct member offsets.

NUMAVAILABLESGPRS	back to summary
public static final int NUMAVAILABLESGPRS The struct member offsets.

NUMAVAILABLEVGPRS	back to summary
public static final int NUMAVAILABLEVGPRS The struct member offsets.

NUMPHYSICALSGPRS	back to summary
public static final int NUMPHYSICALSGPRS The struct member offsets.

NUMPHYSICALVGPRS	back to summary
public static final int NUMPHYSICALVGPRS The struct member offsets.

RESOURCEUSAGE	back to summary
public static final int RESOURCEUSAGE The struct member offsets.

SHADERSTAGEMASK	back to summary
public static final int SHADERSTAGEMASK The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkShaderStatisticsInfoAMD	back to summary
protected VkShaderStatisticsInfoAMD(long address, ByteBuffer container)

VkShaderStatisticsInfoAMD back to summary

VkShaderStatisticsInfoAMD	back to summary
public VkShaderStatisticsInfoAMD(ByteBuffer container) Creates a `VkShaderStatisticsInfoAMD` 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.

public VkShaderStatisticsInfoAMD(ByteBuffer container)

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

computeWorkGroupSize	back to summary
public IntBuffer computeWorkGroupSize() the local workgroup size of this shader in { X, Y, Z } dimensions. Annotations @NativeType:uint32_t[3]

computeWorkGroupSize

back to summary

public IntBuffer computeWorkGroupSize()

the local workgroup size of this shader in { X, Y, Z } dimensions.

Annotations

@NativeType:uint32_t[3]

computeWorkGroupSize	back to summary
public int computeWorkGroupSize(int index) the local workgroup size of this shader in { X, Y, Z } dimensions. Annotations @NativeType:uint32_t

computeWorkGroupSize

back to summary

public int computeWorkGroupSize(int index)

the local workgroup size of this shader in { X, Y, Z } dimensions.

Annotations

@NativeType:uint32_t

create back to summary

create	back to summary
protected VkShaderStatisticsInfoAMD 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

protected VkShaderStatisticsInfoAMD 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

create	back to summary
public static VkShaderStatisticsInfoAMD create(long address) Returns a new `VkShaderStatisticsInfoAMD` instance for the specified memory address.

create back to summary

create	back to summary
public static VkShaderStatisticsInfoAMD.Buffer create(long address, int capacity) Create a `VkShaderStatisticsInfoAMD.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkShaderStatisticsInfoAMD.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkShaderStatisticsInfoAMD createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkShaderStatisticsInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkShaderStatisticsInfoAMD.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

ncomputeWorkGroupSize	back to summary
public static IntBuffer ncomputeWorkGroupSize(long struct) Unsafe version of `computeWorkGroupSize`.

ncomputeWorkGroupSize	back to summary
public static int ncomputeWorkGroupSize(long struct, int index) Unsafe version of `computeWorkGroupSize`.

nnumAvailableSgprs	back to summary
public static int nnumAvailableSgprs(long struct) Unsafe version of `numAvailableSgprs`.

nnumAvailableVgprs	back to summary
public static int nnumAvailableVgprs(long struct) Unsafe version of `numAvailableVgprs`.

nnumPhysicalSgprs	back to summary
public static int nnumPhysicalSgprs(long struct) Unsafe version of `numPhysicalSgprs`.

nnumPhysicalVgprs	back to summary
public static int nnumPhysicalVgprs(long struct) Unsafe version of `numPhysicalVgprs`.

nresourceUsage	back to summary
public static VkShaderResourceUsageAMD nresourceUsage(long struct) Unsafe version of `resourceUsage`.

nshaderStageMask	back to summary
public static int nshaderStageMask(long struct) Unsafe version of `shaderStageMask`.

numAvailableSgprs	back to summary
public int numAvailableSgprs() the maximum limit of SGPRs made available to the shader compiler. Annotations @NativeType:uint32_t

numAvailableSgprs

back to summary

public int numAvailableSgprs()

the maximum limit of SGPRs made available to the shader compiler.

Annotations

@NativeType:uint32_t

numAvailableVgprs	back to summary
public int numAvailableVgprs() the maximum limit of VGPRs made available to the shader compiler. Annotations @NativeType:uint32_t

numAvailableVgprs

back to summary

public int numAvailableVgprs()

the maximum limit of VGPRs made available to the shader compiler.

Annotations

@NativeType:uint32_t

numPhysicalSgprs	back to summary
public int numPhysicalSgprs() the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device. Annotations @NativeType:uint32_t

numPhysicalSgprs

back to summary

public int numPhysicalSgprs()

the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device.

Annotations

@NativeType:uint32_t

numPhysicalVgprs	back to summary
public int numPhysicalVgprs() the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device. Annotations @NativeType:uint32_t

numPhysicalVgprs

back to summary

public int numPhysicalVgprs()

the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device.

Annotations

@NativeType:uint32_t

resourceUsage	back to summary
public VkShaderResourceUsageAMD resourceUsage() a `VkShaderResourceUsageAMD` structure describing internal physical device resources used by this shader.

shaderStageMask	back to summary
public int shaderStageMask() are the combination of logical shader stages contained within this shader. Annotations @NativeType:VkShaderStageFlags

shaderStageMask

back to summary

public int shaderStageMask()

are the combination of logical shader stages contained within this shader.

Annotations

@NativeType:VkShaderStageFlags

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

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 VkShaderStatisticsInfoAMD.Buffer

Class Inheritance

extends StructBuffer<VkShaderStatisticsInfoAMD, VkShaderStatisticsInfoAMD.Buffer>

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkShaderStatisticsInfoAMD.Buffer

An array of VkShaderStatisticsInfoAMD structs.

Field Summary

Modifier and Type	Field and Description
private static final VkShaderStatisticsInfoAMD	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkShaderStatisticsInfoAMD.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 Type	Method and Description
public IntBuffer	Returns: a `IntBuffer` view of the `VkShaderStatisticsInfoAMD#computeWorkGroupSize` field. computeWorkGroupSize()
public int	Returns: the value at the specified index of the `VkShaderStatisticsInfoAMD#computeWorkGroupSize` field. computeWorkGroupSize(int index)
protected VkShaderStatisticsInfoAMD	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkShaderStatisticsInfoAMD#numAvailableSgprs` field. numAvailableSgprs()
public int	Returns: the value of the `VkShaderStatisticsInfoAMD#numAvailableVgprs` field. numAvailableVgprs()
public int	Returns: the value of the `VkShaderStatisticsInfoAMD#numPhysicalSgprs` field. numPhysicalSgprs()
public int	Returns: the value of the `VkShaderStatisticsInfoAMD#numPhysicalVgprs` field. numPhysicalVgprs()
public VkShaderResourceUsageAMD	Returns: a `VkShaderResourceUsageAMD` view of the `VkShaderStatisticsInfoAMD#resourceUsage` field. resourceUsage()
protected VkShaderStatisticsInfoAMD.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkShaderStatisticsInfoAMD#shaderStageMask` field. shaderStageMask()

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkShaderStatisticsInfoAMD ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkShaderStatisticsInfoAMD.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 `VkShaderStatisticsInfoAMD#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkShaderStatisticsInfoAMD.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 VkShaderStatisticsInfoAMD#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

computeWorkGroupSize	back to summary
public IntBuffer computeWorkGroupSize() Returns:IntBuffer a `IntBuffer` view of the `VkShaderStatisticsInfoAMD#computeWorkGroupSize` field. Annotations @NativeType:uint32_t[3]

computeWorkGroupSize	back to summary
public int computeWorkGroupSize(int index) Returns:int the value at the specified index of the `VkShaderStatisticsInfoAMD#computeWorkGroupSize` field. Annotations @NativeType:uint32_t

getElementFactory	back to summary
protected VkShaderStatisticsInfoAMD getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkShaderStatisticsInfoAMD getElementFactory()

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

Annotations

@Override

numAvailableSgprs	back to summary
public int numAvailableSgprs() Returns:int the value of the `VkShaderStatisticsInfoAMD#numAvailableSgprs` field. Annotations @NativeType:uint32_t

numAvailableVgprs	back to summary
public int numAvailableVgprs() Returns:int the value of the `VkShaderStatisticsInfoAMD#numAvailableVgprs` field. Annotations @NativeType:uint32_t

numPhysicalSgprs	back to summary
public int numPhysicalSgprs() Returns:int the value of the `VkShaderStatisticsInfoAMD#numPhysicalSgprs` field. Annotations @NativeType:uint32_t

numPhysicalVgprs	back to summary
public int numPhysicalVgprs() Returns:int the value of the `VkShaderStatisticsInfoAMD#numPhysicalVgprs` field. Annotations @NativeType:uint32_t

resourceUsage	back to summary
public VkShaderResourceUsageAMD resourceUsage() Returns:VkShaderResourceUsageAMD a `VkShaderResourceUsageAMD` view of the `VkShaderStatisticsInfoAMD#resourceUsage` field.

self

back to summary

protected VkShaderStatisticsInfoAMD.Buffer self()

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

Annotations

@Override

shaderStageMask	back to summary
public int shaderStageMask() Returns:int the value of the `VkShaderStatisticsInfoAMD#shaderStageMask` field. Annotations @NativeType:VkShaderStageFlags

public Class VkShaderStatisticsInfoAMD

Description

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkShaderStatisticsInfoAMD.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail