Vulkan.Core10.ImageView

vkCreateImageView - Create an image view from an existing image

Valid Usage

• device must support at least one queue family with one of the VK_QUEUE_VIDEO_ENCODE_BIT_KHR, VK_QUEUE_VIDEO_DECODE_BIT_KHR, QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT capabilities

• ImageViewCreateInfo::image must have been created from device

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid ImageViewCreateInfo structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pView must be a valid pointer to a ImageView handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR

• ERROR_OUT_OF_DEVICE_MEMORY

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, ImageView, ImageViewCreateInfo

A convenience wrapper to make a compatible pair of calls to createImageView and destroyImageView

To ensure that destroyImageView is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

vkDestroyImageView - Destroy an image view object

Valid Usage

• All submitted commands that refer to imageView must have completed execution

• If AllocationCallbacks were provided when imageView was created, a compatible set of callbacks must be provided here

• If no AllocationCallbacks were provided when imageView was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• If imageView is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to imageView must be externally synchronized

See Also

VK_VERSION_1_0, AllocationCallbacks, Device, ImageView

VkComponentMapping - Structure specifying a color component mapping

Valid Usage (Implicit)

See Also

VK_VERSION_1_0, AndroidHardwareBufferFormatProperties2ANDROID, AndroidHardwareBufferFormatPropertiesANDROID, BufferCollectionPropertiesFUCHSIA, ComponentSwizzle, ImageViewCreateInfo, VkNativeBufferFormatPropertiesOHOS, SamplerBorderColorComponentMappingCreateInfoEXT, SamplerYcbcrConversionCreateInfo, ScreenBufferFormatPropertiesQNX, VkVideoFormatPropertiesKHR

VkImageSubresourceRange - Structure specifying an image subresource range

Description

The number of mipmap levels and array layers must be a subset of the image subresources in the image. If an application wants to use all mip levels or layers in an image after the baseMipLevel or baseArrayLayer, it can set levelCount and layerCount to the special values REMAINING_MIP_LEVELS and REMAINING_ARRAY_LAYERS without knowing the exact number of mip levels or layers.

For cube and cube array image views, the layers of the image view starting at baseArrayLayer correspond to faces in the order +X, -X, +Y, -Y, +Z, -Z. For cube arrays, each set of six sequential layers is a single cube, so the number of cube maps in a cube map array view is layerCount / 6, and image array layer (baseArrayLayer + i) is face index (i mod 6) of cube i / 6. If the number of layers in the view, whether set explicitly in layerCount or implied by REMAINING_ARRAY_LAYERS, is not a multiple of 6, the last cube map in the array must not be accessed.

aspectMask must be only IMAGE_ASPECT_COLOR_BIT, IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT if format is a color, depth-only or stencil-only format, respectively, except if format is a multi-planar format. If using a depth/stencil format with both depth and stencil components, aspectMask must include at least one of IMAGE_ASPECT_DEPTH_BIT and IMAGE_ASPECT_STENCIL_BIT, and can include both.

When the ImageSubresourceRange structure is used to select a subset of the slices of a 3D image’s mip level in order to create a 2D or 2D array image view of a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT, baseArrayLayer and layerCount specify the first slice index and the number of slices to include in the created image view. Such an image view can be used as a framebuffer attachment that refers only to the specified range of slices of the selected mip level. If the maintenance9 feature is not enabled, any layout transitions performed on such an attachment view during a render pass instance still apply to the entire subresource referenced which includes all the slices of the selected mip level.

When using an image view of a depth/stencil image to populate a descriptor set (e.g. for sampling in the shader, or for use as an input attachment), the aspectMask must only include one bit, which selects whether the image view is used for depth reads (i.e. using a floating-point sampler or input attachment in the shader) or stencil reads (i.e. using an unsigned integer sampler or input attachment in the shader). When an image view of a depth/stencil image is used as a depth/stencil framebuffer attachment, the aspectMask is ignored and both depth and stencil image subresources are used.

When creating a ImageView, if sampler Y′CBCR conversion is enabled in the sampler, the aspectMask of a subresourceRange used by the ImageView must be IMAGE_ASPECT_COLOR_BIT.

When creating a ImageView, if sampler Y′CBCR conversion is not enabled in the sampler and the image format is multi-planar format, the image must have been created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the aspectMask of the ImageView’s subresourceRange must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or IMAGE_ASPECT_PLANE_2_BIT.

Valid Usage

• If levelCount is not REMAINING_MIP_LEVELS, it must be greater than 0

• If layerCount is not REMAINING_ARRAY_LAYERS, it must be greater than 0

• If aspectMask includes IMAGE_ASPECT_COLOR_BIT, then it must not include any of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT

• aspectMask must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i

Valid Usage (Implicit)

• aspectMask must be a valid combination of ImageAspectFlagBits values

• aspectMask must not be 0

See Also

VK_VERSION_1_0, HostImageLayoutTransitionInfo, ImageAspectFlags, ImageMemoryBarrier, ImageMemoryBarrier2, ImageViewCreateInfo, cmdClearColorImage, cmdClearDepthStencilImage

VkImageViewCreateInfo - Structure specifying parameters of a newly created image view

Description

Some of the image creation parameters are inherited by the view. In particular, image view creation inherits the implicit parameter usage specifying the allowed usages of the image view that, by default, takes the value of the corresponding usage parameter specified in ImageCreateInfo at image creation time. The implicit usage can be overridden by adding a ImageViewUsageCreateInfo structure to the pNext chain, but the view usage must be a subset of the image usage. If image has a depth-stencil format and was created with a ImageStencilUsageCreateInfo structure included in the pNext chain of ImageCreateInfo, the usage is calculated based on the subresource.aspectMask provided:

• If aspectMask includes only IMAGE_ASPECT_STENCIL_BIT, the implicit usage is equal to ImageStencilUsageCreateInfo::stencilUsage.

• If aspectMask includes only IMAGE_ASPECT_DEPTH_BIT, the implicit usage is equal to ImageCreateInfo::usage.

• If both aspects are included in aspectMask, the implicit usage is equal to the intersection of ImageCreateInfo::usage and ImageStencilUsageCreateInfo::stencilUsage.

If image is a 3D image, its Z range can be restricted to a subset by adding a ImageViewSlicedCreateInfoEXT to the pNext chain.

If image’s format is multi-planar and aspectMask is one of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT, the view format is the compatible format for the plane. Otherwise the view format is the format used to create image.

If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, format can be set to a format that is compatible with the view format. If the image was not created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, format must equal the view format.

When creating a single-plane view of a multi-planar image, width and height must be derived from the multi-planar image’s dimensions in the manner listed for plane compatibility for the plane.

Views of compatible formats will have the same mapping between texel coordinates and memory locations irrespective of the format, with only the interpretation of the bit pattern changing.

If image was created with a multi-planar format, and the image view’s aspectMask is one of IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or IMAGE_ASPECT_PLANE_2_BIT, the view’s aspect mask is considered to be equivalent to IMAGE_ASPECT_COLOR_BIT when used as a framebuffer attachment.

Values intended to be used with one view format may not be exactly preserved when written or read through a different format. For example, an integer value that happens to have the bit pattern of a floating-point denorm or NaN may be flushed or canonicalized when written or read through a view with a floating-point format. Similarly, a value written through a signed normalized format that has a bit pattern exactly equal to -2b may be changed to -2b + 1 as described in Conversion from Normalized Fixed-Point to Floating-Point.

If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, format must be compatible with the image’s format as described above; or must be an uncompressed format, in which case it must be size-compatible with the image’s format. In this case, the resulting image view’s texel dimensions equal the dimensions of the selected mip level divided by the compressed texel block size and rounded up.

The ComponentMapping components member describes a remapping from components of the image to components of the vector returned by shader image instructions. This remapping must be the identity swizzle for any ImageView used with a combined image sampler that enables sampler Y′CBCR conversion, input attachment descriptors, framebuffer attachments, and storage image descriptors.

Image views with formats that require YCBCR conversion or external formats must be created with a SamplerYcbcrConversionInfo structure in the pNext chain to be used with sampling. Any image view created with a SamplerYcbcrConversionInfo structure in the pNext chain must only be sampled using a sampler with an identically defined SamplerYcbcrConversion. When used in a video coding operation, the specified sampler Y′CBCR conversion has no effect.

Image Type and Image View Type Compatibility Requirements

Valid Usage

• If image was not created with IMAGE_CREATE_CUBE_COMPATIBLE_BIT then viewType must not be IMAGE_VIEW_TYPE_CUBE or IMAGE_VIEW_TYPE_CUBE_ARRAY

• If the imageCubeArray feature is not enabled, viewType must not be IMAGE_VIEW_TYPE_CUBE_ARRAY

• If image was created with IMAGE_TYPE_3D but without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set then viewType must not be IMAGE_VIEW_TYPE_2D_ARRAY

• If image was created with IMAGE_TYPE_3D but without IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set, then viewType must not be IMAGE_VIEW_TYPE_2D

• If image was created with IMAGE_TYPE_3D and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY then subresourceRange.levelCount must be 1

• If image was created with a samples value not equal to SAMPLE_COUNT_1_BIT then viewType must be either IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY

• image must have been created with a usage value containing at least one of the following:

  • IMAGE_USAGE_SAMPLED_BIT

  • IMAGE_USAGE_STORAGE_BIT

  • IMAGE_USAGE_COLOR_ATTACHMENT_BIT

  • IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT

  • IMAGE_USAGE_INPUT_ATTACHMENT_BIT

  • IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT

  • IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

  • IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT

  • VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR

  • VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR

  • VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR

  • VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR

  • IMAGE_USAGE_SAMPLE_WEIGHT_BIT_QCOM

  • IMAGE_USAGE_SAMPLE_BLOCK_MATCH_BIT_QCOM

  • VK_IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR

  • VK_IMAGE_USAGE_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR

• The format features of the resultant image view must contain at least one bit

• If usage contains IMAGE_USAGE_SAMPLED_BIT, then the format features of the resultant image view must contain FORMAT_FEATURE_SAMPLED_IMAGE_BIT

• If usage contains IMAGE_USAGE_STORAGE_BIT, then the image view’s format features must contain FORMAT_FEATURE_STORAGE_IMAGE_BIT

• If usage contains IMAGE_USAGE_COLOR_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV

• If usage contains IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT, then the image view’s format features must contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT

• If usage contains VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_VIDEO_DECODE_OUTPUT_BIT_KHR

• If usage contains VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_VIDEO_DECODE_DPB_BIT_KHR

• usage must not include VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR

• If usage contains VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR

• If usage contains VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR

• usage must not include VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR

• If usage contains VK_IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_2_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR

• If usage contains VK_IMAGE_USAGE_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR, then the image view’s format features must contain VK_FORMAT_FEATURE_2_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR

• If usage contains IMAGE_USAGE_INPUT_ATTACHMENT_BIT, and any of the following is true:

  • the externalFormatResolve feature is not enabled

  • the nullColorAttachmentWithExternalFormatResolve property is FALSE

  • image was created with an ExternalFormatANDROID::externalFormat value of 0

    then the image view’s format features must contain at least one of FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT or FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV

• subresourceRange.baseMipLevel must be less than the mipLevels specified in ImageCreateInfo when image was created

• If subresourceRange.levelCount is not REMAINING_MIP_LEVELS, subresourceRange.baseMipLevel + subresourceRange.levelCount must be less than or equal to the mipLevels specified in ImageCreateInfo when image was created

• If image was created with the IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT usage flag set, subresourceRange.levelCount must be 1

• If image is not a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set, or viewType is not IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange.baseArrayLayer must be less than the arrayLayers specified in ImageCreateInfo when image was created

• If subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, image is not a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT or IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT set, or viewType is not IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange.layerCount must be non-zero and subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the arrayLayers specified in ImageCreateInfo when image was created

• If image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange.baseArrayLayer must be less than the depth computed from baseMipLevel and extent.depth specified in ImageCreateInfo when image was created, according to the formula defined in Image Mip Level Sizing

• If subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, image is a 3D image created with IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT set, and viewType is IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY, subresourceRange.layerCount must be non-zero and subresourceRange.baseArrayLayer + subresourceRange.layerCount must be less than or equal to the depth computed from baseMipLevel and extent.depth specified in ImageCreateInfo when image was created, according to the formula defined in Image Mip Level Sizing

• If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, but without the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, and if the format of the image is not a multi-planar format, format must be compatible with the format used to create image, as defined in Format Compatibility Classes

• If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, format must be compatible with, or must be an uncompressed format that is size-compatible with, the format used to create image

• If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag and format is a non-compressed format, the levelCount member of subresourceRange must be 1

• If image was created with the IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT flag, the PhysicalDeviceMaintenance6Properties::blockTexelViewCompatibleMultipleLayers property is not TRUE, and format is a non-compressed format, then the layerCount member of subresourceRange must be 1

• If a ImageFormatListCreateInfo structure was included in the pNext chain of the ImageCreateInfo structure used when creating image and ImageFormatListCreateInfo::viewFormatCount is not zero then format must be one of the formats in ImageFormatListCreateInfo::pViewFormats

• If image was created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag, if the format of the image is a multi-planar format, and if subresourceRange.aspectMask is one of the multi-planar aspect mask bits, then format must be compatible with the Format for the plane of the image format indicated by subresourceRange.aspectMask, as defined in https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#formats-compatible-planes

• subresourceRange.aspectMask must only have at most 1 valid multi-planar aspect mask bit

• If image was not created with the IMAGE_CREATE_MUTABLE_FORMAT_BIT flag format must be identical to the format used to create image

• If the format of the image is a multi-planar format and subresourceRange.aspectMask is IMAGE_ASPECT_COLOR_BIT, format must be identical to the format used to create image

• If the image view’s format requires a sampler Y′CBCR conversion and usage contains IMAGE_USAGE_SAMPLED_BIT, then the pNext chain must include a SamplerYcbcrConversionInfo structure with a conversion value other than NULL_HANDLE

• If format has a _422 or _420 suffix then image must have been created with a width that is a multiple of 2

• If format has a _420 suffix then image must have been created with a height that is a multiple of 2

• If the pNext chain includes a SamplerYcbcrConversionInfo structure with a conversion value other than NULL_HANDLE, all members of components must have the identity swizzle

• If the pNext chain includes a SamplerYcbcrConversionInfo structure with a conversion value other than NULL_HANDLE, format must be the same used in SamplerYcbcrConversionCreateInfo::format

• If image is non-sparse then the image or each specified disjoint plane must be bound completely and contiguously to a single DeviceMemory object

• viewType must be compatible with the type of image as shown in the view type compatibility table

• If image has an Android external format, format must be FORMAT_UNDEFINED

• If image has an Android external format, the pNext chain must include a SamplerYcbcrConversionInfo structure with a conversion object created with the same external format as image

• If image has an Android external format, all members of components must be the identity swizzle

• If image has an QNX Screen external format, format must be FORMAT_UNDEFINED

• If image has an QNX Screen external format, the pNext chain must include a SamplerYcbcrConversionInfo structure with a conversion object created with the same external format as image

• If image has an QNX Screen external format, all members of components must be the identity swizzle

• If image was created with the IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR usage flag set, viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY

• If the shadingRateImage feature is enabled, and image was created with the IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV usage flag set, format must be FORMAT_R8_UINT

• If the attachmentFragmentShadingRate feature is not enabled, the usage for the image view must not contain IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

• If the usage for the image view includes IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, then the image view’s format features must contain FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

• If the usage for the image view includes IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, and layeredShadingRateAttachments is FALSE, subresourceRange.layerCount must be 1

• If the fragmentDensityMapDynamic feature is not enabled, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT

• If the fragmentDensityMapDeferred feature is not enabled, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT

• If flags contains IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, flags must not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT

• If image was created with flags containing IMAGE_CREATE_SUBSAMPLED_BIT_EXT and the IMAGE_USAGE_SAMPLED_BIT usage flag set, subresourceRange.layerCount must be less than or equal to ::maxSubsampledArrayLayers

• If the invocationMask feature is enabled, and image was created with the IMAGE_USAGE_INVOCATION_MASK_BIT_HUAWEI usage flag set, format must be FORMAT_R8_UINT

• If flags does not contain IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT, and image was created with the IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT usage flag set, its flags must not contain any of IMAGE_CREATE_PROTECTED_BIT, IMAGE_CREATE_SPARSE_BINDING_BIT, IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or IMAGE_CREATE_SPARSE_ALIASED_BIT

• If the pNext chain includes a ImageViewUsageCreateInfo structure, and image was not created with a ImageStencilUsageCreateInfo structure included in the pNext chain of ImageCreateInfo, its usage member must not include any bits that were not set in the usage member of the ImageCreateInfo structure used to create image

• If the pNext chain includes a ImageViewUsageCreateInfo structure, image was created with a ImageStencilUsageCreateInfo structure included in the pNext chain of ImageCreateInfo, and subresourceRange.aspectMask includes IMAGE_ASPECT_STENCIL_BIT, the usage member of the ImageViewUsageCreateInfo structure must not include any bits that were not set in the usage member of the ImageStencilUsageCreateInfo structure used to create image

• If the pNext chain includes a ImageViewUsageCreateInfo structure, image was created with a ImageStencilUsageCreateInfo structure included in the pNext chain of ImageCreateInfo, and subresourceRange.aspectMask includes bits other than IMAGE_ASPECT_STENCIL_BIT, the usage member of the ImageViewUsageCreateInfo structure must not include any bits that were not set in the usage member of the ImageCreateInfo structure used to create image

• If viewType is IMAGE_VIEW_TYPE_1D, IMAGE_VIEW_TYPE_2D, or IMAGE_VIEW_TYPE_3D; and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, then subresourceRange.layerCount must be 1

• If viewType is IMAGE_VIEW_TYPE_1D, IMAGE_VIEW_TYPE_2D, or IMAGE_VIEW_TYPE_3D; and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, then the remaining number of layers must be 1

• If viewType is IMAGE_VIEW_TYPE_CUBE and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.layerCount must be 6

• If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and subresourceRange.layerCount is not REMAINING_ARRAY_LAYERS, subresourceRange.layerCount must be a multiple of 6

• If viewType is IMAGE_VIEW_TYPE_CUBE and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, the remaining number of layers must be 6

• If viewType is IMAGE_VIEW_TYPE_CUBE_ARRAY and subresourceRange.layerCount is REMAINING_ARRAY_LAYERS, the remaining number of layers must be a multiple of 6

• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::imageViewFormatSwizzle is FALSE, all elements of components must have the identity swizzle

• If the VK_KHR_portability_subset extension is enabled, and PhysicalDevicePortabilitySubsetFeaturesKHR::imageViewFormatReinterpretation is FALSE, the Format in format must not contain a different number of components, or a different number of bits in each component, than the format of the Image in image

• If image was created with the VK_IMAGE_USAGE_VIDEO_DECODE_DST_BIT_KHR usage flag set, VK_IMAGE_USAGE_VIDEO_DECODE_SRC_BIT_KHR, or VK_IMAGE_USAGE_VIDEO_DECODE_DPB_BIT_KHR, then the viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY

• If image was created with the VK_IMAGE_USAGE_VIDEO_ENCODE_DST_BIT_KHR usage flag set, VK_IMAGE_USAGE_VIDEO_ENCODE_SRC_BIT_KHR, or VK_IMAGE_USAGE_VIDEO_ENCODE_DPB_BIT_KHR, then the viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY

• If image was created with the VK_IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR or VK_IMAGE_USAGE_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR usage flags set, then viewType must be IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY

• If flags includes IMAGE_VIEW_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT, the descriptorBufferCaptureReplay feature must be enabled

• If the pNext chain includes a OpaqueCaptureDescriptorDataCreateInfoEXT structure, flags must contain IMAGE_VIEW_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT

• If the pNext chain includes a ExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then textureSampleWeighted feature must be enabled

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then image must have been created with the IMAGE_USAGE_SAMPLE_WEIGHT_BIT_QCOM usage flag set

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then components must be COMPONENT_SWIZZLE_IDENTITY for all components

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then subresourceRange.aspectMask must be IMAGE_ASPECT_COLOR_BIT

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then subresourceRange.levelCount must be 1

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure, then viewType must be IMAGE_VIEW_TYPE_1D_ARRAY or IMAGE_VIEW_TYPE_2D_ARRAY

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and if viewType is IMAGE_VIEW_TYPE_1D_ARRAY, then image must have been created with imageType IMAGE_TYPE_1D

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and viewType is IMAGE_VIEW_TYPE_1D_ARRAY, then subresourceRange.layerCount must be equal to 2

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and viewType is IMAGE_VIEW_TYPE_1D_ARRAY, then image must have been created with width equal to or greater than ((numPhases times mathbin{max}left( mathbin{align}left(filterSize.width,4right), filterSize.heightright)))

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and if viewType is IMAGE_VIEW_TYPE_2D_ARRAY, then image must have been created with imageType IMAGE_TYPE_2D

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and viewType is IMAGE_VIEW_TYPE_2D_ARRAY, then subresourceRange.layerCount must be equal or greater than numPhases

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and viewType is IMAGE_VIEW_TYPE_2D_ARRAY, then image must have been created with width equal to or greater than filterSize.width

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure and viewType is IMAGE_VIEW_TYPE_2D_ARRAY, then image must have been created with height equal to or greater than filterSize.height

• If the pNext chain includes ImageViewSampleWeightCreateInfoQCOM structure then ImageViewSampleWeightCreateInfoQCOM::filterSize.height must be less than or equal to ::maxWeightFilterDimension.height

• subresourceRange.aspectMask must be valid for the format the image was created with

• If image was created with IMAGE_CREATE_ALIAS_SINGLE_LAYER_DESCRIPTOR_BIT_KHR, format must not be a multi-planar format

• If Vulkan 1.3 is not supported and the ycbcr2plane444Formats feature is not enabled, format must not be FORMAT_G8_B8R8_2PLANE_444_UNORM, FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16, FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16, or FORMAT_G16_B16R16_2PLANE_444_UNORM

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of ExportMetalObjectCreateInfoEXT, ImageViewASTCDecodeModeEXT, ImageViewMinLodCreateInfoEXT, ImageViewSampleWeightCreateInfoQCOM, ImageViewSlicedCreateInfoEXT, ImageViewUsageCreateInfo, OpaqueCaptureDescriptorDataCreateInfoEXT, or SamplerYcbcrConversionInfo

• The sType value of each structure in the pNext chain must be unique, with the exception of structures of type ExportMetalObjectCreateInfoEXT

• flags must be a valid combination of ImageViewCreateFlagBits values

• image must be a valid Image handle

• viewType must be a valid ImageViewType value

• format must be a valid Format value

• components must be a valid ComponentMapping structure

• subresourceRange must be a valid ImageSubresourceRange structure

See Also

VK_VERSION_1_0, ComponentMapping, Format, Image, ImageDescriptorInfoEXT, ImageSubresourceRange, ImageViewCreateFlags, ImageViewType, StructureType, createImageView

VkImageView - Opaque handle to an image view object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_VERSION_1_0, DescriptorImageInfo, ExportMetalTextureInfoEXT, FramebufferCreateInfo, ImageViewCaptureDescriptorDataInfoEXT, ImageViewHandleInfoNVX, RenderPassAttachmentBeginInfo, RenderingAttachmentInfo, RenderingFragmentDensityMapAttachmentInfoEXT, RenderingFragmentShadingRateAttachmentInfoKHR, VkVideoEncodeQuantizationMapInfoKHR, VkVideoPictureResourceInfoKHR, bindOpticalFlowSessionImageNV, cmdBindInvocationMaskHUAWEI, cmdBindShadingRateImageNV, createImageView, destroyImageView, getImageViewAddressNVX

VkImageViewType - Image view types

See Also

VK_VERSION_1_0, ImageViewCreateInfo, PhysicalDeviceImageViewImageFormatInfoEXT

VkComponentSwizzle - Specify how a component is swizzled

Description

• COMPONENT_SWIZZLE_IDENTITY specifies that the component is set to the identity swizzle.

• COMPONENT_SWIZZLE_ZERO specifies that the component is set to zero.

• COMPONENT_SWIZZLE_ONE specifies that the component is set to either 1 or 1.0, depending on whether the type of the image view format is integer or floating-point respectively, as determined by the Format Definition section for each Format.

• COMPONENT_SWIZZLE_R specifies that the component is set to the value of the R component of the image.

• COMPONENT_SWIZZLE_G specifies that the component is set to the value of the G component of the image.

• COMPONENT_SWIZZLE_B specifies that the component is set to the value of the B component of the image.

• COMPONENT_SWIZZLE_A specifies that the component is set to the value of the A component of the image.

Setting the identity swizzle on a component is equivalent to setting the identity mapping on that component. That is:

Component Mappings Equivalent To COMPONENT_SWIZZLE_IDENTITY

See Also

VK_VERSION_1_0, ComponentMapping

VkImageViewCreateFlagBits - Bitmask specifying additional parameters of an image view

Description

• IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT specifies that the fragment density map will be read by device during PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT

• IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT specifies that the fragment density map will be read by the host during endCommandBuffer for the primary command buffer that the render pass is recorded into

• IMAGE_VIEW_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT specifies that the image view can be used with descriptor buffers when capturing and replaying (e.g. for trace capture and replay), see OpaqueCaptureDescriptorDataCreateInfoEXT for more detail.

See Also

VK_VERSION_1_0, ImageViewCreateFlags