Package org.lwjgl.vulkan

Class VkCooperativeMatrixPropertiesKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCooperativeMatrixPropertiesKHR>
org.lwjgl.vulkan.VkCooperativeMatrixPropertiesKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkCooperativeMatrixPropertiesKHR extends org.lwjgl.system.Struct<VkCooperativeMatrixPropertiesKHR> implements org.lwjgl.system.NativeResource
Structure specifying cooperative matrix properties.
Description

If some types are preferred over other types (e.g. for performance), they should appear earlier in the list enumerated by GetPhysicalDeviceCooperativeMatrixPropertiesKHR.

At least one entry in the list must have power of two values for all of MSize, KSize, and NSize.

If the cooperativeMatrixWorkgroupScope feature is not supported, scope must be SCOPE_SUBGROUP_KHR.

Valid Usage (Implicit)
See Also

GetPhysicalDeviceCooperativeMatrixPropertiesKHR

Layout


 struct VkCooperativeMatrixPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     uint32_t MSize();
     uint32_t NSize();
     uint32_t KSize();
     VkComponentTypeKHR AType();
     VkComponentTypeKHR BType();
     VkComponentTypeKHR CType();
     VkComponentTypeKHR ResultType();
     VkBool32 saturatingAccumulation();
     VkScopeKHR scope();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • MSIZE

      public static final int MSIZE
      The struct member offsets.

    • NSIZE

      public static final int NSIZE
      The struct member offsets.

    • KSIZE

      public static final int KSIZE
      The struct member offsets.

    • ATYPE

      public static final int ATYPE
      The struct member offsets.

    • BTYPE

      public static final int BTYPE
      The struct member offsets.

    • CTYPE

      public static final int CTYPE
      The struct member offsets.

    • RESULTTYPE

      public static final int RESULTTYPE
      The struct member offsets.

    • SATURATINGACCUMULATION

      public static final int SATURATINGACCUMULATION
      The struct member offsets.

    • SCOPE

      public static final int SCOPE
      The struct member offsets.

  • Constructor Details

    • VkCooperativeMatrixPropertiesKHR

      public VkCooperativeMatrixPropertiesKHR(ByteBuffer container)
      Creates a VkCooperativeMatrixPropertiesKHR 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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkCooperativeMatrixPropertiesKHR>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • MSize

      public int MSize()
      the number of rows in matrices A, C, and Result.

    • NSize

      public int NSize()
      the number of columns in matrices B, C, Result.

    • KSize

      public int KSize()
      the number of columns in matrix A and rows in matrix B.

    • AType

      public int AType()
      the component type of matrix A, of type VkComponentTypeKHR.

    • BType

      public int BType()
      the component type of matrix B, of type VkComponentTypeKHR.

    • CType

      public int CType()
      the component type of matrix C, of type VkComponentTypeKHR.

    • ResultType

      public int ResultType()
      the component type of matrix Result, of type VkComponentTypeKHR.

    • saturatingAccumulation

      public boolean saturatingAccumulation()
      indicates whether the SaturatingAccumulation operand to OpCooperativeMatrixMulAddKHR must be present or not. If it is TRUE, the SaturatingAccumulation operand must be present. If it is FALSE, the SaturatingAccumulation operand must not be present.

    • scope

      public int scope()
      the scope of all the matrix types, of type VkScopeKHR.

    • sType

      public VkCooperativeMatrixPropertiesKHR sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkCooperativeMatrixPropertiesKHR sType$Default()
      Sets the STRUCTURE_TYPE_COOPERATIVE_MATRIX_PROPERTIES_KHR value to the sType() field.

    • pNext

      public VkCooperativeMatrixPropertiesKHR pNext(long value)
      Sets the specified value to the pNext() field.

    • set

      public VkCooperativeMatrixPropertiesKHR set(int sType, long pNext)
      Initializes this struct with the specified values.

    • set

      public VkCooperativeMatrixPropertiesKHR set(VkCooperativeMatrixPropertiesKHR src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkCooperativeMatrixPropertiesKHR malloc()
      Returns a new VkCooperativeMatrixPropertiesKHR instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkCooperativeMatrixPropertiesKHR calloc()
      Returns a new VkCooperativeMatrixPropertiesKHR instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkCooperativeMatrixPropertiesKHR create()
      Returns a new VkCooperativeMatrixPropertiesKHR instance allocated with BufferUtils.

    • create

      public static VkCooperativeMatrixPropertiesKHR create(long address)
      Returns a new VkCooperativeMatrixPropertiesKHR instance for the specified memory address.

    • createSafe

      public static @Nullable VkCooperativeMatrixPropertiesKHR createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkCooperativeMatrixPropertiesKHR.Buffer malloc(int capacity)
      Returns a new VkCooperativeMatrixPropertiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkCooperativeMatrixPropertiesKHR.Buffer calloc(int capacity)
      Returns a new VkCooperativeMatrixPropertiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkCooperativeMatrixPropertiesKHR.Buffer create(int capacity)
      Returns a new VkCooperativeMatrixPropertiesKHR.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkCooperativeMatrixPropertiesKHR.Buffer create(long address, int capacity)
      Create a VkCooperativeMatrixPropertiesKHR.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkCooperativeMatrixPropertiesKHR.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkCooperativeMatrixPropertiesKHR malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkCooperativeMatrixPropertiesKHR instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkCooperativeMatrixPropertiesKHR calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkCooperativeMatrixPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkCooperativeMatrixPropertiesKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkCooperativeMatrixPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkCooperativeMatrixPropertiesKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkCooperativeMatrixPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nsType

      public static int nsType(long struct)
      Unsafe version of sType().

    • npNext

      public static long npNext(long struct)
      Unsafe version of pNext().

    • nMSize

      public static int nMSize(long struct)
      Unsafe version of MSize().

    • nNSize

      public static int nNSize(long struct)
      Unsafe version of NSize().

    • nKSize

      public static int nKSize(long struct)
      Unsafe version of KSize().

    • nAType

      public static int nAType(long struct)
      Unsafe version of AType().

    • nBType

      public static int nBType(long struct)
      Unsafe version of BType().

    • nCType

      public static int nCType(long struct)
      Unsafe version of CType().

    • nResultType

      public static int nResultType(long struct)
      Unsafe version of ResultType().

    • nsaturatingAccumulation

      public static int nsaturatingAccumulation(long struct)
      Unsafe version of saturatingAccumulation().

    • nscope

      public static int nscope(long struct)
      Unsafe version of scope().

    • nsType

      public static void nsType(long struct, int value)
      Unsafe version of sType.

    • npNext

      public static void npNext(long struct, long value)
      Unsafe version of pNext.