org.lwjgl.vulkan.VkShaderStatisticsInfoAMD Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* 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, {@code shaderStageMask} will contain a bitmask of all of the stages that are active within that shader. Consequently, if specifying those stages as input to {@link AMDShaderInfo#vkGetShaderInfoAMD GetShaderInfoAMD}, the same output information may be returned for all such shader stage queries.
*
* The number of available VGPRs and SGPRs ({@code numAvailableVgprs} and {@code 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
*
* {@link VkShaderResourceUsageAMD}
*
* Layout
*
*
* struct VkShaderStatisticsInfoAMD {
* VkShaderStageFlags {@link #shaderStageMask};
* {@link VkShaderResourceUsageAMD VkShaderResourceUsageAMD} {@link #resourceUsage};
* uint32_t {@link #numPhysicalVgprs};
* uint32_t {@link #numPhysicalSgprs};
* uint32_t {@link #numAvailableVgprs};
* uint32_t {@link #numAvailableSgprs};
* uint32_t {@link #computeWorkGroupSize}[3];
* }
*/
public class VkShaderStatisticsInfoAMD extends Struct {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
SHADERSTAGEMASK,
RESOURCEUSAGE,
NUMPHYSICALVGPRS,
NUMPHYSICALSGPRS,
NUMAVAILABLEVGPRS,
NUMAVAILABLESGPRS,
COMPUTEWORKGROUPSIZE;
static {
Layout layout = __struct(
__member(4),
__member(VkShaderResourceUsageAMD.SIZEOF, VkShaderResourceUsageAMD.ALIGNOF),
__member(4),
__member(4),
__member(4),
__member(4),
__array(4, 3)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
SHADERSTAGEMASK = layout.offsetof(0);
RESOURCEUSAGE = layout.offsetof(1);
NUMPHYSICALVGPRS = layout.offsetof(2);
NUMPHYSICALSGPRS = layout.offsetof(3);
NUMAVAILABLEVGPRS = layout.offsetof(4);
NUMAVAILABLESGPRS = layout.offsetof(5);
COMPUTEWORKGROUPSIZE = layout.offsetof(6);
}
/**
* Creates a {@code VkShaderStatisticsInfoAMD} instance at the current position of the specified {@link 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) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** are the combination of logical shader stages contained within this shader. */
@NativeType("VkShaderStageFlags")
public int shaderStageMask() { return nshaderStageMask(address()); }
/** a {@link VkShaderResourceUsageAMD} structure describing internal physical device resources used by this shader. */
public VkShaderResourceUsageAMD resourceUsage() { return nresourceUsage(address()); }
/** the maximum number of vector instruction general-purpose registers (VGPRs) available to the physical device. */
@NativeType("uint32_t")
public int numPhysicalVgprs() { return nnumPhysicalVgprs(address()); }
/** the maximum number of scalar instruction general-purpose registers (SGPRs) available to the physical device. */
@NativeType("uint32_t")
public int numPhysicalSgprs() { return nnumPhysicalSgprs(address()); }
/** the maximum limit of VGPRs made available to the shader compiler. */
@NativeType("uint32_t")
public int numAvailableVgprs() { return nnumAvailableVgprs(address()); }
/** the maximum limit of SGPRs made available to the shader compiler. */
@NativeType("uint32_t")
public int numAvailableSgprs() { return nnumAvailableSgprs(address()); }
/** the local workgroup size of this shader in { X, Y, Z } dimensions. */
@NativeType("uint32_t[3]")
public IntBuffer computeWorkGroupSize() { return ncomputeWorkGroupSize(address()); }
/** the local workgroup size of this shader in { X, Y, Z } dimensions. */
@NativeType("uint32_t")
public int computeWorkGroupSize(int index) { return ncomputeWorkGroupSize(address(), index); }
// -----------------------------------
/** Returns a new {@code VkShaderStatisticsInfoAMD} instance for the specified memory address. */
public static VkShaderStatisticsInfoAMD create(long address) {
return wrap(VkShaderStatisticsInfoAMD.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkShaderStatisticsInfoAMD createSafe(long address) {
return address == NULL ? null : wrap(VkShaderStatisticsInfoAMD.class, address);
}
/**
* Create a {@link VkShaderStatisticsInfoAMD.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkShaderStatisticsInfoAMD.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkShaderStatisticsInfoAMD.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Unsafe version of {@link #shaderStageMask}. */
public static int nshaderStageMask(long struct) { return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.SHADERSTAGEMASK); }
/** Unsafe version of {@link #resourceUsage}. */
public static VkShaderResourceUsageAMD nresourceUsage(long struct) { return VkShaderResourceUsageAMD.create(struct + VkShaderStatisticsInfoAMD.RESOURCEUSAGE); }
/** Unsafe version of {@link #numPhysicalVgprs}. */
public static int nnumPhysicalVgprs(long struct) { return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.NUMPHYSICALVGPRS); }
/** Unsafe version of {@link #numPhysicalSgprs}. */
public static int nnumPhysicalSgprs(long struct) { return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.NUMPHYSICALSGPRS); }
/** Unsafe version of {@link #numAvailableVgprs}. */
public static int nnumAvailableVgprs(long struct) { return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.NUMAVAILABLEVGPRS); }
/** Unsafe version of {@link #numAvailableSgprs}. */
public static int nnumAvailableSgprs(long struct) { return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.NUMAVAILABLESGPRS); }
/** Unsafe version of {@link #computeWorkGroupSize}. */
public static IntBuffer ncomputeWorkGroupSize(long struct) { return memIntBuffer(struct + VkShaderStatisticsInfoAMD.COMPUTEWORKGROUPSIZE, 3); }
/** Unsafe version of {@link #computeWorkGroupSize(int) computeWorkGroupSize}. */
public static int ncomputeWorkGroupSize(long struct, int index) {
return UNSAFE.getInt(null, struct + VkShaderStatisticsInfoAMD.COMPUTEWORKGROUPSIZE + check(index, 3) * 4);
}
// -----------------------------------
/** An array of {@link VkShaderStatisticsInfoAMD} structs. */
public static class Buffer extends StructBuffer {
private static final VkShaderStatisticsInfoAMD ELEMENT_FACTORY = VkShaderStatisticsInfoAMD.create(-1L);
/**
* Creates a new {@code 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 {@link VkShaderStatisticsInfoAMD#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected VkShaderStatisticsInfoAMD getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkShaderStatisticsInfoAMD#shaderStageMask} field. */
@NativeType("VkShaderStageFlags")
public int shaderStageMask() { return VkShaderStatisticsInfoAMD.nshaderStageMask(address()); }
/** @return a {@link VkShaderResourceUsageAMD} view of the {@link VkShaderStatisticsInfoAMD#resourceUsage} field. */
public VkShaderResourceUsageAMD resourceUsage() { return VkShaderStatisticsInfoAMD.nresourceUsage(address()); }
/** @return the value of the {@link VkShaderStatisticsInfoAMD#numPhysicalVgprs} field. */
@NativeType("uint32_t")
public int numPhysicalVgprs() { return VkShaderStatisticsInfoAMD.nnumPhysicalVgprs(address()); }
/** @return the value of the {@link VkShaderStatisticsInfoAMD#numPhysicalSgprs} field. */
@NativeType("uint32_t")
public int numPhysicalSgprs() { return VkShaderStatisticsInfoAMD.nnumPhysicalSgprs(address()); }
/** @return the value of the {@link VkShaderStatisticsInfoAMD#numAvailableVgprs} field. */
@NativeType("uint32_t")
public int numAvailableVgprs() { return VkShaderStatisticsInfoAMD.nnumAvailableVgprs(address()); }
/** @return the value of the {@link VkShaderStatisticsInfoAMD#numAvailableSgprs} field. */
@NativeType("uint32_t")
public int numAvailableSgprs() { return VkShaderStatisticsInfoAMD.nnumAvailableSgprs(address()); }
/** @return a {@link IntBuffer} view of the {@link VkShaderStatisticsInfoAMD#computeWorkGroupSize} field. */
@NativeType("uint32_t[3]")
public IntBuffer computeWorkGroupSize() { return VkShaderStatisticsInfoAMD.ncomputeWorkGroupSize(address()); }
/** @return the value at the specified index of the {@link VkShaderStatisticsInfoAMD#computeWorkGroupSize} field. */
@NativeType("uint32_t")
public int computeWorkGroupSize(int index) { return VkShaderStatisticsInfoAMD.ncomputeWorkGroupSize(address(), index); }
}
}