VkShaderStatisticsInfoAMD (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkShaderStatisticsInfoAMD

All Implemented Interfaces:

org.lwjgl.system.Pointer
```
public class VkShaderStatisticsInfoAMD
extends org.lwjgl.system.Struct
```
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.

See Also

VkShaderResourceUsageAMD

Member documentation
- shaderStageMask – are the combination of logical shader stages contained within this shader.
- resourceUsage – a VkShaderResourceUsageAMD structure describing internal physical device resources used by this shader.
- numPhysicalVgprs – the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device.
- numPhysicalSgprs – the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device.
- numAvailableVgprs – the maximum limit of VGPRs made available to the shader compiler.
- numAvailableSgprs – the maximum limit of SGPRs made available to the shader compiler.
- computeWorkGroupSize[3] – the local workgroup size of this shader in { X, Y, Z } dimensions.
Layout
```
 struct VkShaderStatisticsInfoAMD {
     VkShaderStageFlags shaderStageMask;
     VkShaderResourceUsageAMD resourceUsage;
     uint32_t numPhysicalVgprs;
     uint32_t numPhysicalSgprs;
     uint32_t numAvailableVgprs;
     uint32_t numAvailableSgprs;
     uint32_t computeWorkGroupSize[3];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkShaderStatisticsInfoAMD.Buffer
An array of VkShaderStatisticsInfoAMD structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COMPUTEWORKGROUPSIZE` The struct member offsets.
`static int`	`NUMAVAILABLESGPRS` The struct member offsets.
`static int`	`NUMAVAILABLEVGPRS` The struct member offsets.
`static int`	`NUMPHYSICALSGPRS` The struct member offsets.
`static int`	`NUMPHYSICALVGPRS` The struct member offsets.
`static int`	`RESOURCEUSAGE` The struct member offsets.
`static int`	`SHADERSTAGEMASK` 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 and Description
`VkShaderStatisticsInfoAMD(java.nio.ByteBuffer container)` Creates a `VkShaderStatisticsInfoAMD` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.nio.IntBuffer`	`computeWorkGroupSize()` Returns a `IntBuffer` view of the `computeWorkGroupSize` field.
`int`	`computeWorkGroupSize(int index)` Returns the value at the specified index of the `computeWorkGroupSize` field.
`static VkShaderStatisticsInfoAMD`	`create(long address)` Returns a new `VkShaderStatisticsInfoAMD` instance for the specified memory address.
`static VkShaderStatisticsInfoAMD.Buffer`	`create(long address, int capacity)` Create a `VkShaderStatisticsInfoAMD.Buffer` instance at the specified memory.
`static VkShaderStatisticsInfoAMD`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkShaderStatisticsInfoAMD.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static java.nio.IntBuffer`	`ncomputeWorkGroupSize(long struct)` Unsafe version of `computeWorkGroupSize()`.
`static int`	`ncomputeWorkGroupSize(long struct, int index)` Unsafe version of `computeWorkGroupSize`.
`static int`	`nnumAvailableSgprs(long struct)` Unsafe version of `numAvailableSgprs()`.
`static int`	`nnumAvailableVgprs(long struct)` Unsafe version of `numAvailableVgprs()`.
`static int`	`nnumPhysicalSgprs(long struct)` Unsafe version of `numPhysicalSgprs()`.
`static int`	`nnumPhysicalVgprs(long struct)` Unsafe version of `numPhysicalVgprs()`.
`static VkShaderResourceUsageAMD`	`nresourceUsage(long struct)` Unsafe version of `resourceUsage()`.
`static int`	`nshaderStageMask(long struct)` Unsafe version of `shaderStageMask()`.
`int`	`numAvailableSgprs()` Returns the value of the `numAvailableSgprs` field.
`int`	`numAvailableVgprs()` Returns the value of the `numAvailableVgprs` field.
`int`	`numPhysicalSgprs()` Returns the value of the `numPhysicalSgprs` field.
`int`	`numPhysicalVgprs()` Returns the value of the `numPhysicalVgprs` field.
`VkShaderResourceUsageAMD`	`resourceUsage()` Returns a `VkShaderResourceUsageAMD` view of the `resourceUsage` field.
`int`	`shaderStageMask()` Returns the value of the `shaderStageMask` field.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - SHADERSTAGEMASK
```
public static final int SHADERSTAGEMASK
```
    The struct member offsets.
  - RESOURCEUSAGE
```
public static final int RESOURCEUSAGE
```
    The struct member offsets.
  - NUMPHYSICALVGPRS
```
public static final int NUMPHYSICALVGPRS
```
    The struct member offsets.
  - NUMPHYSICALSGPRS
```
public static final int NUMPHYSICALSGPRS
```
    The struct member offsets.
  - NUMAVAILABLEVGPRS
```
public static final int NUMAVAILABLEVGPRS
```
    The struct member offsets.
  - NUMAVAILABLESGPRS
```
public static final int NUMAVAILABLESGPRS
```
    The struct member offsets.
  - COMPUTEWORKGROUPSIZE
```
public static final int COMPUTEWORKGROUPSIZE
```
    The struct member offsets.
- Constructor Detail
  - VkShaderStatisticsInfoAMD
```
public VkShaderStatisticsInfoAMD(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - shaderStageMask
```
public int shaderStageMask()
```
    Returns the value of the shaderStageMask field.
  - resourceUsage
```
public VkShaderResourceUsageAMD resourceUsage()
```
    Returns a VkShaderResourceUsageAMD view of the resourceUsage field.
  - numPhysicalVgprs
```
public int numPhysicalVgprs()
```
    Returns the value of the numPhysicalVgprs field.
  - numPhysicalSgprs
```
public int numPhysicalSgprs()
```
    Returns the value of the numPhysicalSgprs field.
  - numAvailableVgprs
```
public int numAvailableVgprs()
```
    Returns the value of the numAvailableVgprs field.
  - numAvailableSgprs
```
public int numAvailableSgprs()
```
    Returns the value of the numAvailableSgprs field.
  - computeWorkGroupSize
```
public java.nio.IntBuffer computeWorkGroupSize()
```
    Returns a IntBuffer view of the computeWorkGroupSize field.
  - computeWorkGroupSize
```
public int computeWorkGroupSize(int index)
```
    Returns the value at the specified index of the computeWorkGroupSize field.
  - create
```
public static VkShaderStatisticsInfoAMD create(long address)
```
    Returns a new VkShaderStatisticsInfoAMD instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkShaderStatisticsInfoAMD createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - create
```
public static VkShaderStatisticsInfoAMD.Buffer create(long address,
                                                      int capacity)
```
    Create a VkShaderStatisticsInfoAMD.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkShaderStatisticsInfoAMD.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - nshaderStageMask
```
public static int nshaderStageMask(long struct)
```
    Unsafe version of shaderStageMask().
  - nresourceUsage
```
public static VkShaderResourceUsageAMD nresourceUsage(long struct)
```
    Unsafe version of resourceUsage().
  - nnumPhysicalVgprs
```
public static int nnumPhysicalVgprs(long struct)
```
    Unsafe version of numPhysicalVgprs().
  - nnumPhysicalSgprs
```
public static int nnumPhysicalSgprs(long struct)
```
    Unsafe version of numPhysicalSgprs().
  - nnumAvailableVgprs
```
public static int nnumAvailableVgprs(long struct)
```
    Unsafe version of numAvailableVgprs().
  - nnumAvailableSgprs
```
public static int nnumAvailableSgprs(long struct)
```
    Unsafe version of numAvailableSgprs().
  - ncomputeWorkGroupSize
```
public static java.nio.IntBuffer ncomputeWorkGroupSize(long struct)
```
    Unsafe version of computeWorkGroupSize().
  - ncomputeWorkGroupSize
```
public static int ncomputeWorkGroupSize(long struct,
                                        int index)
```
    Unsafe version of computeWorkGroupSize.

Class VkShaderStatisticsInfoAMD

Description

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Field Detail

SIZEOF

ALIGNOF

SHADERSTAGEMASK

RESOURCEUSAGE

NUMPHYSICALVGPRS

NUMPHYSICALSGPRS

NUMAVAILABLEVGPRS

NUMAVAILABLESGPRS

COMPUTEWORKGROUPSIZE

Constructor Detail

VkShaderStatisticsInfoAMD

Method Detail

sizeof

shaderStageMask

resourceUsage

numPhysicalVgprs

numPhysicalSgprs

numAvailableVgprs

numAvailableSgprs

computeWorkGroupSize

computeWorkGroupSize

create

createSafe

create

createSafe

nshaderStageMask

nresourceUsage

nnumPhysicalVgprs

nnumPhysicalSgprs

nnumAvailableVgprs

nnumAvailableSgprs

ncomputeWorkGroupSize

ncomputeWorkGroupSize