Class VkImageSubresourceRange

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer


    public class VkImageSubresourceRange
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    Describes a range of mipmap levels, array layers, and aspects.

    Valid Usage
    • aspectMask must be a valid combination of VkImageAspectFlagBits values
    • aspectMask must not be 0
    • If levelCount is not REMAINING_MIP_LEVELS, baseMipLevel + levelCount must be less than or equal to the mipLevels specified in VkImageCreateInfo when the image was created
    • If layerCount is not REMAINING_ARRAY_LAYERS, baseArrayLayer + layerCount must be less than or equal to the arrayLayers specified in VkImageCreateInfo when the image was created

    Member documentation

    • aspectMask – a bitmask indicating which aspect(s) of the image are included in the view. One or more of:
      IMAGE_ASPECT_COLOR_BITIMAGE_ASPECT_DEPTH_BITIMAGE_ASPECT_METADATA_BIT
      IMAGE_ASPECT_STENCIL_BIT
    • baseMipLevel – the first mipmap level accessible to the view
    • levelCount – the number of mipmap levels (starting from baseMipLevel) accessible to the view
    • baseArrayLayer – the first array layer accessible to the view
    • layerCount – the number of array layers (starting from baseArrayLayer) accessible to the view

    Layout

    struct VkImageSubresourceRange {
        VkImageAspectFlags aspectMask;
        uint32_t baseMipLevel;
        uint32_t levelCount;
        uint32_t baseArrayLayer;
        uint32_t layerCount;
    }