Class VkPhysicalDeviceSparseProperties

  • All Implemented Interfaces:
    Pointer

    public class VkPhysicalDeviceSparseProperties
    extends Struct
    Structure specifying physical device sparse memory properties.

    Member documentation

    • residencyStandard2DBlockShapeTRUE 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.
    • residencyStandard2DMultisampleBlockShapeTRUE 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.
    • residencyStandard3DBlockShapeTRUE 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.
    • residencyAlignedMipSizeTRUE 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 – 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 were populated with 0; writes to non-resident regions will be discarded.

    Layout

    
     struct VkPhysicalDeviceSparseProperties {
         VkBool32 residencyStandard2DBlockShape;
         VkBool32 residencyStandard2DMultisampleBlockShape;
         VkBool32 residencyStandard3DBlockShape;
         VkBool32 residencyAlignedMipSize;
         VkBool32 residencyNonResidentStrict;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • RESIDENCYSTANDARD2DBLOCKSHAPE, RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE, RESIDENCYSTANDARD3DBLOCKSHAPE, RESIDENCYALIGNEDMIPSIZE, RESIDENCYNONRESIDENTSTRICT

        The struct member offsets.
    • Constructor Detail

      • VkPhysicalDeviceSparseProperties

        public VkPhysicalDeviceSparseProperties​(java.nio.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 Detail

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • residencyStandard2DBlockShape

        public boolean residencyStandard2DBlockShape()
        Returns the value of the residencyStandard2DBlockShape field.
      • residencyStandard2DMultisampleBlockShape

        public boolean residencyStandard2DMultisampleBlockShape()
        Returns the value of the residencyStandard2DMultisampleBlockShape field.
      • residencyStandard3DBlockShape

        public boolean residencyStandard3DBlockShape()
        Returns the value of the residencyStandard3DBlockShape field.
      • residencyAlignedMipSize

        public boolean residencyAlignedMipSize()
        Returns the value of the residencyAlignedMipSize field.
      • residencyNonResidentStrict

        public boolean residencyNonResidentStrict()
        Returns the value of the residencyNonResidentStrict field.
      • nresidencyAlignedMipSize

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

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