VkImageAlignmentControlCreateInfoMESA(3)

Name

VkImageAlignmentControlCreateInfoMESA - Specify image alignment

C Specification

If the pNext list of VkImageCreateInfo includes a VkImageAlignmentControlCreateInfoMESA structure, then that structure describes desired alignment for this image.

The VkImageAlignmentControlCreateInfoMESA structure is defined as:

// Provided by VK_MESA_image_alignment_control
typedef struct VkImageAlignmentControlCreateInfoMESA {
    VkStructureType    sType;
    const void*        pNext;
    uint32_t           maximumRequestedAlignment;
} VkImageAlignmentControlCreateInfoMESA;

Members

  • sType is a VkStructureType value identifying this structure.

  • pNext is NULL or a pointer to a structure extending this structure.

  • maximumRequestedAlignment specifies the maximum alignment for the image.

Description

If maximumRequestedAlignment is not 0, the implementation should choose an image memory layout that requires an alignment no larger than maximumRequestedAlignment as reported in VkMemoryRequirements::alignment. If such a layout does not exist for the given image creation parameters, the implementation should return the smallest alignment which is supported in VkMemoryRequirements.

If an implementation needs to disable image compression for maximumRequestedAlignment to be honored - where a larger alignment would enable image compression - the implementation should not use maximumRequestedAlignment, and should return the smallest alignment which does not compromise compression. If the imageCompressionControl feature is enabled, the application can chain a VkImageCompressionControlEXT with VK_IMAGE_COMPRESSION_DISABLED_EXT. In this case, image compression considerations should not apply when implementation decides alignment.

Valid Usage

  • VUID-VkImageAlignmentControlCreateInfoMESA-maximumRequestedAlignment-09655
    If maximumRequestedAlignment is not 0, maximumRequestedAlignment must be a power of two

  • VUID-VkImageAlignmentControlCreateInfoMESA-maximumRequestedAlignment-09656
    If maximumRequestedAlignment is not 0, the bitwise-and of maximumRequestedAlignment and supportedImageAlignmentMask must be non-zero

  • VUID-VkImageAlignmentControlCreateInfoMESA-imageAlignmentControl-09657
    imageAlignmentControl must be enabled

Valid Usage (Implicit)

  • VUID-VkImageAlignmentControlCreateInfoMESA-sType-sType
    sType must be VK_STRUCTURE_TYPE_IMAGE_ALIGNMENT_CONTROL_CREATE_INFO_MESA

See Also

VK_MESA_image_alignment_control, VkStructureType

Document Notes

For more information, see the Vulkan Specification.

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.