vkCreateSamplerYcbcrConversion - Create a new Y′CBCR conversion

Description

The interpretation of the configured sampler Y′CBCR conversion is described in more detail in the description of sampler Y′CBCR conversion in the Image Operations chapter.

Valid Usage

• The samplerYcbcrConversion feature must be enabled

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid SamplerYcbcrConversionCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pYcbcrConversion must be a valid pointer to a SamplerYcbcrConversion handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_DEVICE_MEMORY
• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN
• ERROR_VALIDATION_FAILED

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, AllocationCallbacks, Device, SamplerYcbcrConversion, SamplerYcbcrConversionCreateInfo

A convenience wrapper to make a compatible pair of calls to createSamplerYcbcrConversion and destroySamplerYcbcrConversion

To ensure that destroySamplerYcbcrConversion 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.

vkDestroySamplerYcbcrConversion - Destroy a created Y′CBCR conversion

Valid Usage (Implicit)

• device must be a valid Device handle

• If ycbcrConversion is not NULL_HANDLE, ycbcrConversion must be a valid SamplerYcbcrConversion handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If ycbcrConversion is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to ycbcrConversion must be externally synchronized

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, AllocationCallbacks, Device, SamplerYcbcrConversion

VkSamplerYcbcrConversionInfo - Structure specifying Y′CBCR conversion to a sampler or image view

Valid Usage (Implicit)

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, SamplerYcbcrConversion, StructureType

VkSamplerYcbcrConversionCreateInfo - Structure specifying the parameters of the newly created conversion

Description

Setting forceExplicitReconstruction to TRUE may have a performance penalty on implementations where explicit reconstruction is not the default mode of operation.

If format supports FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT the forceExplicitReconstruction value behaves as if it were TRUE.

If the pNext chain includes a ExternalFormatANDROID structure with non-zero externalFormat member, the sampler Y′CBCR conversion object represents an external format conversion, and format must be FORMAT_UNDEFINED. Such conversions must only be used to sample image views with a matching external format. When creating an external format conversion, the value of components is ignored.

Valid Usage

• If an external format conversion is being created, format must be FORMAT_UNDEFINED

• If an external format conversion is not being created, format must represent unsigned normalized values (i.e. the format must be a UNORM format)
• The potential format features of the sampler Y′CBCR conversion must support FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT
• If the potential format features of the sampler Y′CBCR conversion do not support FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT, xChromaOffset and yChromaOffset must not be CHROMA_LOCATION_COSITED_EVEN if the corresponding components are downsampled
• If the potential format features of the sampler Y′CBCR conversion do not support FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT, xChromaOffset and yChromaOffset must not be CHROMA_LOCATION_MIDPOINT if the corresponding components are downsampled
• If the format has a _422 or _420 suffix, then components.g must be the identity swizzle
• If the format has a _422 or _420 suffix, then components.a must be the identity swizzle, COMPONENT_SWIZZLE_ONE, or COMPONENT_SWIZZLE_ZERO
• If the format has a _422 or _420 suffix, then components.r must be the identity swizzle or COMPONENT_SWIZZLE_B
• If the format has a _422 or _420 suffix, then components.b must be the identity swizzle or COMPONENT_SWIZZLE_R
• If the format has a _422 or _420 suffix, and if either components.r or components.b is the identity swizzle, both values must be the identity swizzle
• If ycbcrModel is not SAMPLER_YCBCR_MODEL_CONVERSION_RGB_IDENTITY, then components.r, components.g, and components.b must correspond to components of the format; that is, components.r, components.g, and components.b must not be COMPONENT_SWIZZLE_ZERO or COMPONENT_SWIZZLE_ONE, and must not correspond to a component containing zero or one as a consequence of component substitution
• If ycbcrRange is SAMPLER_YCBCR_RANGE_ITU_NARROW, then the R, G, and B components obtained by applying the component swizzle to format must each have a bit-depth greater than or equal to 8
• If the potential format features of the sampler Y′CBCR conversion do not support FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT forceExplicitReconstruction must be FALSE
• If the potential format features of the sampler Y′CBCR conversion do not support FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT, chromaFilter must not be FILTER_LINEAR
• If the pNext chain includes a SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM structure, and if the ycbcrDegamma feature is not enabled, then SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM::enableYDegamma must be FALSE
• If the pNext chain includes a SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM structure, and if the ycbcrDegamma feature is not enabled, then SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM::enableCbCrDegamma must be FALSE
• If the pNext chain includes a SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM structure, format must be a format with 8-bit R, G, and B components

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_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 ExternalFormatANDROID, VkExternalFormatOHOS, ExternalFormatQNX, or SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM
• The sType value of each structure in the pNext chain must be unique
• format must be a valid Format value
• ycbcrModel must be a valid SamplerYcbcrModelConversion value
• ycbcrRange must be a valid SamplerYcbcrRange value
• components must be a valid ComponentMapping structure
• xChromaOffset must be a valid ChromaLocation value
• yChromaOffset must be a valid ChromaLocation value
• chromaFilter must be a valid Filter value

If chromaFilter is FILTER_NEAREST, chroma samples are reconstructed to luma component resolution using nearest-neighbour sampling. Otherwise, chroma samples are reconstructed using interpolation. More details can be found in the description of sampler Y′CBCR conversion in the Image Operations chapter.

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, Bool32, ChromaLocation, ComponentMapping, Filter, Format, SamplerYcbcrModelConversion, SamplerYcbcrRange, StructureType, createSamplerYcbcrConversion, createSamplerYcbcrConversion

VkBindImagePlaneMemoryInfo - Structure specifying how to bind an image plane to memory

Valid Usage

• If the image’s tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid multi-planar aspect mask bit

• If the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then planeAspect must be a single valid memory plane for the image (that is, aspectMask must specify a plane index that is less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier)

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO

• planeAspect must be a valid ImageAspectFlagBits value

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, ImageAspectFlagBits, StructureType

VkImagePlaneMemoryRequirementsInfo - Structure specifying image plane for memory requirements

Valid Usage

• If the image’s tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid multi-planar aspect mask bit

• If the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then planeAspect must be a single valid memory plane for the image (that is, aspectMask must specify a plane index that is less than the DrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and ImageDrmFormatModifierPropertiesEXT::drmFormatModifier)

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFO

• planeAspect must be a valid ImageAspectFlagBits value

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, ImageAspectFlagBits, StructureType

VkPhysicalDeviceSamplerYcbcrConversionFeatures - Structure describing Y′CBCR conversion features that can be supported by an implementation

Members

This structure describes the following feature:

Description

If the PhysicalDeviceSamplerYcbcrConversionFeatures structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceSamplerYcbcrConversionFeatures, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

See Also

VK_KHR_sampler_ycbcr_conversion, VK_VERSION_1_1, Bool32, StructureType