Package org.lwjgl.vulkan

Class VkPhysicalDeviceSparseProperties

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceSparseProperties>
org.lwjgl.vulkan.VkPhysicalDeviceSparseProperties
All Implemented Interfaces:
org.lwjgl.system.Pointer
public class VkPhysicalDeviceSparseProperties extends org.lwjgl.system.Struct<VkPhysicalDeviceSparseProperties>
Structure specifying physical device sparse memory properties.
See Also

VkPhysicalDeviceProperties

Layout


 struct VkPhysicalDeviceSparseProperties {
     VkBool32 residencyStandard2DBlockShape();
     VkBool32 residencyStandard2DMultisampleBlockShape();
     VkBool32 residencyStandard3DBlockShape();
     VkBool32 residencyAlignedMipSize();
     VkBool32 residencyNonResidentStrict();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • RESIDENCYSTANDARD2DBLOCKSHAPE

      public static final int RESIDENCYSTANDARD2DBLOCKSHAPE
      The struct member offsets.

    • RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE

      public static final int RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE
      The struct member offsets.

    • RESIDENCYSTANDARD3DBLOCKSHAPE

      public static final int RESIDENCYSTANDARD3DBLOCKSHAPE
      The struct member offsets.

    • RESIDENCYALIGNEDMIPSIZE

      public static final int RESIDENCYALIGNEDMIPSIZE
      The struct member offsets.

    • RESIDENCYNONRESIDENTSTRICT

      public static final int RESIDENCYNONRESIDENTSTRICT
      The struct member offsets.

  • Constructor Details

    • VkPhysicalDeviceSparseProperties

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

    • residencyStandard2DBlockShape

      public boolean residencyStandard2DBlockShape()
      TRUE if the physical device will access all single-sample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for single-sample 2D images is not required to match the standard sparse image block dimensions listed in the table.

    • residencyStandard2DMultisampleBlockShape

      public boolean residencyStandard2DMultisampleBlockShape()
      TRUE if the physical device will access all multisample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (MSAA) table. If this property is not supported, the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for multisample 2D images is not required to match the standard sparse image block dimensions listed in the table.

    • residencyStandard3DBlockShape

      public boolean residencyStandard3DBlockShape()
      TRUE if the physical device will access all 3D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported, the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for 3D images is not required to match the standard sparse image block dimensions listed in the table.

    • residencyAlignedMipSize

      public boolean residencyAlignedMipSize()
      TRUE if images with mip level dimensions that are not integer multiples of the corresponding dimensions of the sparse image block may be placed in the mip tail. If this property is not reported, only mip levels with dimensions smaller than the imageGranularity member of the VkSparseImageFormatProperties structure will be placed in the mip tail. If this property is reported the implementation is allowed to return SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT in the flags member of VkSparseImageFormatProperties, indicating that mip level dimensions that are not integer multiples of the corresponding dimensions of the sparse image block will be placed in the mip tail.

    • residencyNonResidentStrict

      public boolean residencyNonResidentStrict()
      specifies whether the physical device can consistently access non-resident regions of a resource. If this property is TRUE, access to non-resident regions of resources will be guaranteed to return values as if the resource was populated with 0; writes to non-resident regions will be discarded.

    • create

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

    • createSafe

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

    • create

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

    • createSafe

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

    • nresidencyStandard2DBlockShape

      public static int nresidencyStandard2DBlockShape(long struct)
      Unsafe version of residencyStandard2DBlockShape().

    • nresidencyStandard2DMultisampleBlockShape

      public static int nresidencyStandard2DMultisampleBlockShape(long struct)
      Unsafe version of residencyStandard2DMultisampleBlockShape().

    • nresidencyStandard3DBlockShape

      public static int nresidencyStandard3DBlockShape(long struct)
      Unsafe version of residencyStandard3DBlockShape().

    • nresidencyAlignedMipSize

      public static int nresidencyAlignedMipSize(long struct)
      Unsafe version of residencyAlignedMipSize().

    • nresidencyNonResidentStrict

      public static int nresidencyNonResidentStrict(long struct)
      Unsafe version of residencyNonResidentStrict().