Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- createImageView :: forall a io. (Extendss ImageViewCreateInfo a, PokeChain a, MonadIO io) => Device -> ImageViewCreateInfo a -> ("allocator" ::: Maybe AllocationCallbacks) -> io ImageView
- withImageView :: forall a io r. (Extendss ImageViewCreateInfo a, PokeChain a, MonadIO io) => Device -> ImageViewCreateInfo a -> Maybe AllocationCallbacks -> (io ImageView -> (ImageView -> io ()) -> r) -> r
- destroyImageView :: forall io. MonadIO io => Device -> ImageView -> ("allocator" ::: Maybe AllocationCallbacks) -> io ()
- data ComponentMapping = ComponentMapping {}
- data ImageViewCreateInfo (es :: [Type]) = ImageViewCreateInfo {}
Documentation
createImageView :: forall a io. (Extendss ImageViewCreateInfo a, PokeChain a, MonadIO io) => Device -> ImageViewCreateInfo a -> ("allocator" ::: Maybe AllocationCallbacks) -> io ImageView Source #
vkCreateImageView - Create an image view from an existing image
Parameters
device
is the logical device that creates the image view.
pCreateInfo
is a pointer to aImageViewCreateInfo
structure containing parameters to be used to create the image view.pAllocator
controls host memory allocation as described in the Memory Allocation chapter.pView
is a pointer to aImageView
handle in which the resulting image view object is returned.
Valid Usage (Implicit)
device
must be a validDevice
handle
pCreateInfo
must be a valid pointer to a validImageViewCreateInfo
structure- If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure pView
must be a valid pointer to aImageView
handle
Return Codes
See Also
withImageView :: forall a io r. (Extendss ImageViewCreateInfo a, PokeChain a, MonadIO io) => Device -> ImageViewCreateInfo a -> Maybe AllocationCallbacks -> (io ImageView -> (ImageView -> io ()) -> r) -> r Source #
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 first argument.
To just extract the pair pass (,)
as the first argument.
destroyImageView :: forall io. MonadIO io => Device -> ImageView -> ("allocator" ::: Maybe AllocationCallbacks) -> io () Source #
vkDestroyImageView - Destroy an image view object
Parameters
device
is the logical device that destroys the image view.
imageView
is the image view to destroy.pAllocator
controls host memory allocation as described in the Memory Allocation chapter.
Valid Usage
- All submitted commands that refer to
imageView
must have completed execution
- If
AllocationCallbacks
were provided whenimageView
was created, a compatible set of callbacks must be provided here - If no
AllocationCallbacks
were provided whenimageView
was created,pAllocator
must beNULL
Valid Usage (Implicit)
device
must be a validDevice
handle
- If
imageView
is notNULL_HANDLE
,imageView
must be a validImageView
handle - If
pAllocator
is notNULL
,pAllocator
must be a valid pointer to a validAllocationCallbacks
structure - If
imageView
is a valid handle, it must have been created, allocated, or retrieved fromdevice
Host Synchronization
- Host access to
imageView
must be externally synchronized
See Also
data ComponentMapping Source #
VkComponentMapping - Structure specifying a color component mapping
Valid Usage (Implicit)
See Also
AndroidHardwareBufferFormatPropertiesANDROID
,
ComponentSwizzle
,
ImageViewCreateInfo
,
SamplerYcbcrConversionCreateInfo
ComponentMapping | |
|
Instances
data ImageViewCreateInfo (es :: [Type]) Source #
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. If the
image was 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 onlyIMAGE_ASPECT_STENCIL_BIT
, the implicitusage
is equal toImageStencilUsageCreateInfo
::stencilUsage
. - If
aspectMask
includes onlyIMAGE_ASPECT_DEPTH_BIT
, the implicitusage
is equal toImageCreateInfo
::usage
. - If both aspects are included in
aspectMask
, the implicitusage
is equal to the intersection ofImageCreateInfo
::usage
andImageStencilUsageCreateInfo
::stencilUsage
. The implicitusage
can be overriden by adding aImageViewUsageCreateInfo
structure to thepNext
chain.
If image
was created with the
IMAGE_CREATE_MUTABLE_FORMAT_BIT
flag, and if the format
of the image is not
multi-planar,
format
can be different from the image’s format, but if image
was
created without the
IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
flag and they are not equal they must be compatible. Image format
compatibility is defined in the
Format Compatibility Classes
section. 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.
Note
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, as defined for
copying data between images
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.
If the image view is to be used with a sampler which supports
sampler Y′CBCR conversion,
an identically defined object of type
SamplerYcbcrConversion
to that used to create
the sampler must be passed to createImageView
in a
SamplerYcbcrConversionInfo
included in the pNext
chain of ImageViewCreateInfo
. Conversely, if a
SamplerYcbcrConversion
object is passed to
createImageView
, an identically defined
SamplerYcbcrConversion
object must be used
when sampling the image.
If the image has a
multi-planar
format
and subresourceRange.aspectMask
is
IMAGE_ASPECT_COLOR_BIT
,
format
must be identical to the image format
, and the sampler to
be used with the image view must enable
sampler Y′CBCR conversion.
If image
was created with the
IMAGE_CREATE_MUTABLE_FORMAT_BIT
and the image has a
multi-planar
format
, and if subresourceRange.aspectMask
is
IMAGE_ASPECT_PLANE_0_BIT
,
IMAGE_ASPECT_PLANE_1_BIT
, or
IMAGE_ASPECT_PLANE_2_BIT
,
format
must be
compatible
with the corresponding plane of the image, and the sampler to be used
with the image view must not enable
sampler Y′CBCR conversion.
The width
and height
of the single-plane image view must be
derived from the multi-planar image’s dimensions in the manner listed
for
plane compatibility
for the plane.
Any view of an image plane will have the same mapping between texel coordinates and memory locations as used by the channels of the color aspect, subject to the formulae relating texel coordinates to lower-resolution planes as described in Chroma Reconstruction. That is, if an R or B plane has a reduced resolution relative to the G plane of the multi-planar image, the image view operates using the (uplane, vplane) unnormalized coordinates of the reduced-resolution plane, and these coordinates access the same memory locations as the (ucolor, vcolor) unnormalized coordinates of the color aspect for which chroma reconstruction operations operate on the same (uplane, vplane) or (iplane, jplane) coordinates.
Dim, Arrayed, MS | Image parameters | View parameters |
---|---|---|
imageType = ci.imageType
width = ci.extent.width
height = ci.extent.height
depth = ci.extent.depth
arrayLayers = ci.arrayLayers
samples = ci.samples
flags = ci.flags
where ci is the ImageCreateInfo used to create image . | baseArrayLayer , layerCount , and levelCount are members
of the subresourceRange member.
| |
__1D, 0, 0__ | imageType = IMAGE_TYPE_1D
width ≥ 1
height = 1
depth = 1
arrayLayers ≥ 1
samples = 1 | viewType =
IMAGE_VIEW_TYPE_1D
baseArrayLayer ≥ 0
layerCount = 1
|
__1D, 1, 0__ | imageType = IMAGE_TYPE_1D
width ≥ 1
height = 1
depth = 1
arrayLayers ≥ 1
samples = 1 | viewType =
IMAGE_VIEW_TYPE_1D_ARRAY
baseArrayLayer ≥ 0
layerCount ≥ 1
|
__2D, 0, 0__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height ≥ 1
depth = 1
arrayLayers ≥ 1
samples = 1 | viewType =
IMAGE_VIEW_TYPE_2D
baseArrayLayer ≥ 0
layerCount = 1
|
__2D, 1, 0__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height ≥ 1
depth = 1
arrayLayers ≥ 1
samples = 1 | viewType =
IMAGE_VIEW_TYPE_2D_ARRAY
baseArrayLayer ≥ 0
layerCount ≥ 1
|
__2D, 0, 1__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height ≥ 1
depth = 1
arrayLayers ≥ 1
samples > 1 | viewType =
IMAGE_VIEW_TYPE_2D
baseArrayLayer ≥ 0
layerCount = 1
|
__2D, 1, 1__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height ≥ 1
depth = 1
arrayLayers ≥ 1
samples > 1 | viewType =
IMAGE_VIEW_TYPE_2D_ARRAY
baseArrayLayer ≥ 0
layerCount ≥ 1
|
__CUBE, 0, 0__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height = width
depth = 1
arrayLayers ≥ 6
samples = 1
flags includes
IMAGE_CREATE_CUBE_COMPATIBLE_BIT | viewType =
IMAGE_VIEW_TYPE_CUBE
baseArrayLayer ≥ 0
layerCount = 6
|
__CUBE, 1, 0__ | imageType = IMAGE_TYPE_2D
width ≥ 1
height = width
depth = 1
N ≥ 1
arrayLayers ≥ 6 × N
samples = 1
flags includes
IMAGE_CREATE_CUBE_COMPATIBLE_BIT | viewType =
IMAGE_VIEW_TYPE_CUBE_ARRAY
baseArrayLayer ≥ 0
layerCount = 6 × N, N ≥ 1
|
__3D, 0, 0__ | imageType = IMAGE_TYPE_3D
width ≥ 1
height ≥ 1
depth ≥ 1
arrayLayers = 1
samples = 1 | viewType =
IMAGE_VIEW_TYPE_3D
baseArrayLayer = 0
layerCount = 1
|
__3D, 0, 0__ | imageType = IMAGE_TYPE_3D
width ≥ 1
height ≥ 1
depth ≥ 1
arrayLayers = 1
samples = 1
flags includes
IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
flags does not include
IMAGE_CREATE_SPARSE_BINDING_BIT ,
IMAGE_CREATE_SPARSE_RESIDENCY_BIT ,
and IMAGE_CREATE_SPARSE_ALIASED_BIT | viewType =
IMAGE_VIEW_TYPE_2D
levelCount = 1
baseArrayLayer ≥ 0
layerCount = 1
|
__3D, 0, 0__ | imageType = IMAGE_TYPE_3D
width ≥ 1
height ≥ 1
depth ≥ 1
arrayLayers = 1
samples = 1
flags includes
IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
flags does not include
IMAGE_CREATE_SPARSE_BINDING_BIT ,
IMAGE_CREATE_SPARSE_RESIDENCY_BIT ,
and IMAGE_CREATE_SPARSE_ALIASED_BIT | viewType =
IMAGE_VIEW_TYPE_2D_ARRAY
levelCount = 1
baseArrayLayer ≥ 0
layerCount ≥ 1
|
Image and image view parameter compatibility requirements
Valid Usage
- If
image
was not created withIMAGE_CREATE_CUBE_COMPATIBLE_BIT
thenviewType
must not beIMAGE_VIEW_TYPE_CUBE
orIMAGE_VIEW_TYPE_CUBE_ARRAY
- If the
image cubemap arrays
feature is not enabled,
viewType
must not beIMAGE_VIEW_TYPE_CUBE_ARRAY
- If
image
was created withIMAGE_TYPE_3D
but withoutIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
set thenviewType
must not beIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
image
must have been created with ausage
value containing at least one ofIMAGE_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_SHADING_RATE_IMAGE_BIT_NV
, orIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
- The format features of the resultant image view must contain at least one bit
- If
usage
containsIMAGE_USAGE_SAMPLED_BIT
, then the format features of the resultant image view must containFORMAT_FEATURE_SAMPLED_IMAGE_BIT
- If
usage
containsIMAGE_USAGE_STORAGE_BIT
, then the image view’s format features must containFORMAT_FEATURE_STORAGE_IMAGE_BIT
- If
usage
containsIMAGE_USAGE_COLOR_ATTACHMENT_BIT
, then the image view’s format features must containFORMAT_FEATURE_COLOR_ATTACHMENT_BIT
- If
usage
containsIMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
, then the image view’s format features must containFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If
usage
containsIMAGE_USAGE_INPUT_ATTACHMENT_BIT
, then the image view’s format features must contain at least one ofFORMAT_FEATURE_COLOR_ATTACHMENT_BIT
orFORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
subresourceRange.baseMipLevel
must be less than themipLevels
specified inImageCreateInfo
whenimage
was created- If
subresourceRange.levelCount
is notREMAINING_MIP_LEVELS
,subresourceRange.baseMipLevel
+subresourceRange.levelCount
must be less than or equal to themipLevels
specified inImageCreateInfo
whenimage
was created - If
image
was created withusage
containingIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
,subresourceRange.levelCount
must be1
- If
image
is not a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
set, orviewType
is notIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
,subresourceRange.baseArrayLayer
must be less than thearrayLayers
specified inImageCreateInfo
whenimage
was created - If
subresourceRange.layerCount
is notREMAINING_ARRAY_LAYERS
,image
is not a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
set, orviewType
is notIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
,subresourceRange.layerCount
must be non-zero andsubresourceRange.baseArrayLayer
+subresourceRange.layerCount
must be less than or equal to thearrayLayers
specified inImageCreateInfo
whenimage
was created - If
image
is a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
set, andviewType
isIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
,subresourceRange.baseArrayLayer
must be less than the depth computed frombaseMipLevel
andextent.depth
specified inImageCreateInfo
whenimage
was created, according to the formula defined in Image Miplevel Sizing - If
subresourceRange.layerCount
is notREMAINING_ARRAY_LAYERS
,image
is a 3D image created withIMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
set, andviewType
isIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
,subresourceRange.layerCount
must be non-zero andsubresourceRange.baseArrayLayer
+subresourceRange.layerCount
must be less than or equal to the depth computed frombaseMipLevel
andextent.depth
specified inImageCreateInfo
whenimage
was created, according to the formula defined in Image Miplevel Sizing - If
image
was created with theIMAGE_CREATE_MUTABLE_FORMAT_BIT
flag, but without theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
flag, and if theformat
of theimage
is not a multi-planar format,format
must be compatible with theformat
used to createimage
, as defined in Format Compatibility Classes - If
image
was created with theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
flag,format
must be compatible with, or must be an uncompressed format that is size-compatible with, theformat
used to createimage
- If
image
was created with theIMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT
flag, thelevelCount
andlayerCount
members ofsubresourceRange
must both be1
- If a
ImageFormatListCreateInfo
structure was included in thepNext
chain of theImageCreateInfo
structure used when creatingimage
and theviewFormatCount
field ofImageFormatListCreateInfo
is not zero thenformat
must be one of the formats inImageFormatListCreateInfo
::pViewFormats
- If
image
was created with theIMAGE_CREATE_MUTABLE_FORMAT_BIT
flag, if theformat
of theimage
is a multi-planar format, and ifsubresourceRange.aspectMask
is one ofIMAGE_ASPECT_PLANE_0_BIT
,IMAGE_ASPECT_PLANE_1_BIT
, orIMAGE_ASPECT_PLANE_2_BIT
, thenformat
must be compatible with theFormat
for the plane of theimage
format
indicated bysubresourceRange.aspectMask
, as defined in https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#formats-compatible-planes - If
image
was not created with theIMAGE_CREATE_MUTABLE_FORMAT_BIT
flag, or if theformat
of theimage
is a multi-planar format and ifsubresourceRange.aspectMask
isIMAGE_ASPECT_COLOR_BIT
,format
must be identical to theformat
used to createimage
- If the
pNext
chain includes aSamplerYcbcrConversionInfo
structure with aconversion
value other thanNULL_HANDLE
, all members ofcomponents
must have the valueCOMPONENT_SWIZZLE_IDENTITY
- If
image
is non-sparse then it must be bound completely and contiguously to a singleDeviceMemory
object subresourceRange
andviewType
must be compatible with the image, as described in the compatibility table- If
image
has an external format,format
must beFORMAT_UNDEFINED
- If
image
has an external format, thepNext
chain must include aSamplerYcbcrConversionInfo
structure with aconversion
object created with the same external format asimage
- If
image
has an external format, all members ofcomponents
must beCOMPONENT_SWIZZLE_IDENTITY
- If
image
was created withusage
containingIMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
,viewType
must beIMAGE_VIEW_TYPE_2D
orIMAGE_VIEW_TYPE_2D_ARRAY
- If
image
was created withusage
containingIMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
,format
must beFORMAT_R8_UINT
- If
dynamic fragment density map
feature is not enabled,
flags
must not containIMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT
- If
dynamic fragment density map
feature is not enabled and
image
was created withusage
containingIMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT
,flags
must not contain any ofIMAGE_CREATE_PROTECTED_BIT
,IMAGE_CREATE_SPARSE_BINDING_BIT
,IMAGE_CREATE_SPARSE_RESIDENCY_BIT
, orIMAGE_CREATE_SPARSE_ALIASED_BIT
- If the
pNext
chain includes aImageViewUsageCreateInfo
structure, andimage
was not created with aImageStencilUsageCreateInfo
structure included in thepNext
chain ofImageCreateInfo
, itsusage
member must not include any bits that were not set in theusage
member of theImageCreateInfo
structure used to createimage
- If the
pNext
chain includes aImageViewUsageCreateInfo
structure,image
was created with aImageStencilUsageCreateInfo
structure included in thepNext
chain ofImageCreateInfo
, andsubResourceRange.aspectMask
includesIMAGE_ASPECT_STENCIL_BIT
, theusage
member of theImageViewUsageCreateInfo
instance must not include any bits that were not set in theusage
member of theImageStencilUsageCreateInfo
structure used to createimage
- If the
pNext
chain includes aImageViewUsageCreateInfo
structure,image
was created with aImageStencilUsageCreateInfo
structure included in thepNext
chain ofImageCreateInfo
, andsubResourceRange.aspectMask
includes bits other thanIMAGE_ASPECT_STENCIL_BIT
, theusage
member of theImageViewUsageCreateInfo
structure must not include any bits that were not set in theusage
member of theImageCreateInfo
structure used to createimage
- If
viewType
isIMAGE_VIEW_TYPE_CUBE
andsubresourceRange.layerCount
is notREMAINING_ARRAY_LAYERS
,subresourceRange.layerCount
must be6
- If
viewType
isIMAGE_VIEW_TYPE_CUBE_ARRAY
andsubresourceRange.layerCount
is notREMAINING_ARRAY_LAYERS
,subresourceRange.layerCount
must be a multiple of6
- If
viewType
isIMAGE_VIEW_TYPE_CUBE
andsubresourceRange.layerCount
isREMAINING_ARRAY_LAYERS
, the remaining number of layers must be6
- If
viewType
isIMAGE_VIEW_TYPE_CUBE_ARRAY
andsubresourceRange.layerCount
isREMAINING_ARRAY_LAYERS
, the remaining number of layers must be a multiple of6
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofImageViewASTCDecodeModeEXT
,ImageViewUsageCreateInfo
, orSamplerYcbcrConversionInfo
- The
sType
value of each struct in thepNext
chain must be unique flags
must be a valid combination ofImageViewCreateFlagBits
valuesimage
must be a validImage
handleviewType
must be a validImageViewType
valueformat
must be a validFormat
valuecomponents
must be a validComponentMapping
structuresubresourceRange
must be a validImageSubresourceRange
structure
See Also
ComponentMapping
, Format
,
Image
,
ImageSubresourceRange
,
ImageViewCreateFlags
,
ImageViewType
,
StructureType
, createImageView
ImageViewCreateInfo | |
|