Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_ANDROID_external_format_resolve

Description

Name

VK_ANDROID_external_format_resolve - device extension

VK_ANDROID_external_format_resolve

Name String: VK_ANDROID_external_format_resolve

Extension Type

Device extension

Registered Extension Number

469

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_ANDROID_external_memory_android_hardware_buffer

Special Use

OpenGL / ES support

Contact

Chris Forbes @chrisforbes%0A*Here describe the issue or question you have about the VK_ANDROID_external_format_resolve extension*

Extension Proposal

VK_ANDROID_external_format_resolve

Other Extension Metadata

Last Modified Date: 2023-05-03

IP Status

No known IP claims.

Contributors

Tobias Hector, AMD
Chris Forbes, Google
Jan-Harald Fredriksen, Arm
Shahbaz Youssefi, Google
Matthew Netsch, Qualcomm
Tony Zlatsinki, Nvidia
Daniel Koch, Nvidia
Jeff Leger, Qualcomm
Alex Walters, Imagination
Andrew Garrard, Imagination
Ralph Potter, Samsung
Ian Elliott, Google

Description

This extension enables rendering to Android Hardware Buffers with external formats which cannot be directly represented as renderable in Vulkan, including Y′CBCR formats.

New Structures

Extending AndroidHardwareBufferPropertiesANDROID:
- AndroidHardwareBufferFormatResolvePropertiesANDROID

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceExternalFormatResolveFeaturesANDROID
Extending PhysicalDeviceProperties2:
- PhysicalDeviceExternalFormatResolvePropertiesANDROID

New Enum Constants

ANDROID_EXTERNAL_FORMAT_RESOLVE_EXTENSION_NAME

If VK_KHR_dynamic_rendering is supported:

Extending ResolveModeFlagBits:
- RESOLVE_MODE_EXTERNAL_FORMAT_DOWNSAMPLE_ANDROID

Version History

Revision 1, 2023-05-34 (Tobias Hector)
- Initial version

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

data PhysicalDeviceExternalFormatResolveFeaturesANDROID = PhysicalDeviceExternalFormatResolveFeaturesANDROID {
- externalFormatResolve :: Bool
}
data PhysicalDeviceExternalFormatResolvePropertiesANDROID = PhysicalDeviceExternalFormatResolvePropertiesANDROID {
}
data AndroidHardwareBufferFormatResolvePropertiesANDROID = AndroidHardwareBufferFormatResolvePropertiesANDROID {
- colorAttachmentFormat :: Format
}
type ANDROID_EXTERNAL_FORMAT_RESOLVE_SPEC_VERSION = 1
pattern ANDROID_EXTERNAL_FORMAT_RESOLVE_SPEC_VERSION :: forall a. Integral a => a
type ANDROID_EXTERNAL_FORMAT_RESOLVE_EXTENSION_NAME = "VK_ANDROID_external_format_resolve"
pattern ANDROID_EXTERNAL_FORMAT_RESOLVE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #

VkPhysicalDeviceExternalFormatResolveFeaturesANDROID - Structure describing whether external format resolves are supported

Description

If the PhysicalDeviceExternalFormatResolveFeaturesANDROID 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. PhysicalDeviceExternalFormatResolveFeaturesANDROID can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Storable PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods sizeOf :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Int # alignment :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Int # peekElemOff :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Int -> IO PhysicalDeviceExternalFormatResolveFeaturesANDROID # pokeElemOff :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Int -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceExternalFormatResolveFeaturesANDROID # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO () # peek :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO PhysicalDeviceExternalFormatResolveFeaturesANDROID # poke :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO () #
Show PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods showsPrec :: Int -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> ShowS # show :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> String # showList :: [PhysicalDeviceExternalFormatResolveFeaturesANDROID] -> ShowS #
Eq PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods (==) :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Bool # (/=) :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> Bool #
FromCStruct PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods peekCStruct :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
ToCStruct PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods withCStruct :: PhysicalDeviceExternalFormatResolveFeaturesANDROID -> (Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceExternalFormatResolveFeaturesANDROID -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods zero :: PhysicalDeviceExternalFormatResolveFeaturesANDROID Source #

data PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #

VkPhysicalDeviceExternalFormatResolvePropertiesANDROID - Structure describing external format resolve supported by an implementation

Description

If the PhysicalDeviceExternalFormatResolvePropertiesANDROID structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

nullColorAttachmentWithExternalFormatResolve :: Bool
nullColorAttachmentWithExternalFormatResolve indicates that there must be no color attachment image when performing external format resolves if it is TRUE.
externalFormatResolveChromaOffsetX :: ChromaLocation
externalFormatResolveChromaOffsetX indicates the ChromaLocation that an implementation uses in the X axis for accesses to an external format image as a resolve attachment. This must be consistent between external format resolves and load operations from external format resolve attachments to color attachments when nullColorAttachmentWithExternalFormatResolve is TRUE.
externalFormatResolveChromaOffsetY :: ChromaLocation
externalFormatResolveChromaOffsetY indicates the ChromaLocation that an implementation uses in the Y axis for accesses to an external format image as a resolve attachment. This must be consistent between external format resolves and load operations from external format resolve attachments to color attachments when nullColorAttachmentWithExternalFormatResolve is TRUE.

Instances

Instances details

Storable PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods sizeOf :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Int # alignment :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Int # peekElemOff :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Int -> IO PhysicalDeviceExternalFormatResolvePropertiesANDROID # pokeElemOff :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Int -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceExternalFormatResolvePropertiesANDROID # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO () # peek :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO PhysicalDeviceExternalFormatResolvePropertiesANDROID # poke :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO () #
Show PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods showsPrec :: Int -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> ShowS # show :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> String # showList :: [PhysicalDeviceExternalFormatResolvePropertiesANDROID] -> ShowS #
Eq PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods (==) :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Bool # (/=) :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> Bool #
FromCStruct PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods peekCStruct :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
ToCStruct PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods withCStruct :: PhysicalDeviceExternalFormatResolvePropertiesANDROID -> (Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceExternalFormatResolvePropertiesANDROID -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods zero :: PhysicalDeviceExternalFormatResolvePropertiesANDROID Source #

data AndroidHardwareBufferFormatResolvePropertiesANDROID Source #

VkAndroidHardwareBufferFormatResolvePropertiesANDROID - Structure defining properties of resolves using an external format

Description

Any Android hardware buffer created with the GRALLOC_USAGE_HW_RENDER flag must be renderable in some way in Vulkan, either:

AndroidHardwareBufferFormatPropertiesANDROID::format must be a format that supports FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT in FormatProperties::optimalTilingFeatures; or
colorAttachmentFormat must be a format that supports FORMAT_FEATURE_COLOR_ATTACHMENT_BIT in FormatProperties::optimalTilingFeatures.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_ANDROID_HARDWARE_BUFFER_FORMAT_RESOLVE_PROPERTIES_ANDROID

colorAttachmentFormat :: Format
colorAttachmentFormat is a Format specifying the format of color attachment images that must be used for color attachments when resolving to the specified external format. If the implementation supports external format resolves for the specified external format, this value will be set to a color format supporting the FORMAT_FEATURE_COLOR_ATTACHMENT_BIT in FormatProperties::optimalTilingFeatures as returned by getPhysicalDeviceFormatProperties with format equal to colorAttachmentFormat If external format resolves are not supported, this value will be set to FORMAT_UNDEFINED.

Instances

Instances details

Storable AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods sizeOf :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> Int # alignment :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> Int # peekElemOff :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> Int -> IO AndroidHardwareBufferFormatResolvePropertiesANDROID # pokeElemOff :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> Int -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO () # peekByteOff :: Ptr b -> Int -> IO AndroidHardwareBufferFormatResolvePropertiesANDROID # pokeByteOff :: Ptr b -> Int -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO () # peek :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO AndroidHardwareBufferFormatResolvePropertiesANDROID # poke :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO () #
Show AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods showsPrec :: Int -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> ShowS # show :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> String # showList :: [AndroidHardwareBufferFormatResolvePropertiesANDROID] -> ShowS #
Eq AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods (==) :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> Bool # (/=) :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> Bool #
FromCStruct AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods peekCStruct :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
ToCStruct AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods withCStruct :: AndroidHardwareBufferFormatResolvePropertiesANDROID -> (Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO b) -> IO b Source # pokeCStruct :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO b -> IO b Source # withZeroCStruct :: (Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr AndroidHardwareBufferFormatResolvePropertiesANDROID -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero AndroidHardwareBufferFormatResolvePropertiesANDROID Source #
Instance details Defined in Vulkan.Extensions.VK_ANDROID_external_format_resolve Methods zero :: AndroidHardwareBufferFormatResolvePropertiesANDROID Source #

type ANDROID_EXTERNAL_FORMAT_RESOLVE_SPEC_VERSION = 1 Source #

pattern ANDROID_EXTERNAL_FORMAT_RESOLVE_SPEC_VERSION :: forall a. Integral a => a Source #

type ANDROID_EXTERNAL_FORMAT_RESOLVE_EXTENSION_NAME = "VK_ANDROID_external_format_resolve" Source #

pattern ANDROID_EXTERNAL_FORMAT_RESOLVE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

Name

VK_ANDROID_external_format_resolve

Other Extension Metadata

Description

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceExternalFormatResolveFeaturesANDROID
Fields externalFormatResolve :: Bool `externalFormatResolve` specifies whether external format resolves are supported.