Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Name

VK_EXT_multisampled_render_to_single_sampled - device extension

VK_EXT_multisampled_render_to_single_sampled

Name String

VK_EXT_multisampled_render_to_single_sampled

Extension Type

Device extension

Registered Extension Number

377

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_create_renderpass2 to be enabled for any device-level functionality
• Requires VK_KHR_depth_stencil_resolve to be enabled for any device-level functionality

Contact

• Shahbaz Youssefi @syoussefi%0A*Here describe the issue or question you have about the VK_EXT_multisampled_render_to_single_sampled extension*

Extension Proposal

VK_EXT_multisampled_render_to_single_sampled

Other Extension Metadata

Last Modified Date

2021-04-16

IP Status

No known IP claims.

Contributors

• Shahbaz Youssefi, Google
• Jan-Harald Fredriksen, Arm
• Jörg Wagner, Arm
• Matthew Netsch, Qualcomm Technologies, Inc.
• Jarred Davies, Imagination Technologies

Description

With careful usage of resolve attachments, multisampled image memory allocated with MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT, loadOp not equal to ATTACHMENT_LOAD_OP_LOAD and storeOp not equal to ATTACHMENT_STORE_OP_STORE, a Vulkan application is able to efficiently perform multisampled rendering without incurring any additional memory penalty on some implementations.

Under certain circumstances however, the application may not be able to complete its multisampled rendering within a single render pass; for example if it does partial rasterization from frame to frame, blending on an image from a previous frame, or in emulation of GL_EXT_multisampled_render_to_texture. In such cases, the application can use an initial subpass to effectively load single-sampled data from the next subpass’s resolve attachment and fill in the multisampled attachment which otherwise uses loadOp equal to ATTACHMENT_LOAD_OP_DONT_CARE. However, this is not always possible (for example for stencil in the absence of VK_EXT_shader_stencil_export) and has multiple drawbacks.

Some implementations are able to perform said operation efficiently in hardware, effectively loading a multisampled attachment from the contents of a single sampled one. Together with the ability to perform a resolve operation at the end of a subpass, these implementations are able to perform multisampled rendering on single-sampled attachments with no extra memory or bandwidth overhead. This extension exposes this capability by allowing a framebuffer and render pass to include single-sampled attachments while rendering is done with a specified number of samples.

New Structures

• Extending FormatProperties2:

  • SubpassResolvePerformanceQueryEXT

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

• Extending SubpassDescription2, RenderingInfo:

  • MultisampledRenderToSingleSampledInfoEXT

New Enum Constants

• EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_EXTENSION_NAME

• EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_SPEC_VERSION

• Extending ImageCreateFlagBits:

  • IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_INFO_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_FEATURES_EXT
  • STRUCTURE_TYPE_SUBPASS_RESOLVE_PERFORMANCE_QUERY_EXT

Issues

1) Could the multisampled attachment be initialized through some form of copy?

RESOLVED: No. Some implementations do not support copying between attachments in general, and find expressing this operation through a copy unnatural.

2) Another way to achieve this is by introducing a new loadOp to load the contents of the multisampled image from a single-sampled one. Why is this extension preferred?

RESOLVED: Using this extension simplifies the application, as it does not need to manage a secondary lazily-allocated image. Additionally, using this extension leaves less room for error; for example a single mistake in loadOp or storeOp would result in the lazily-allocated image to actually take up memory, and remain so until destruction.

3) There is no guarantee that multisampled data between two subpasses with the same number of samples will be retained as the implementation may be forced to split the render pass implicitly for various reasons. Should this extension require that every subpass that uses multisampled-render-to-single-sampled end in an implicit render pass split (which results in a resolve operation)?

RESOLVED: No. Not requiring this allows render passes with multiple multisampled-render-to-single-sampled subpasses to potentially execute more efficiently (though there is no guarantee).

Version History

• Revision 1, 2021-04-12 (Shahbaz Youssefi)

See Also

MultisampledRenderToSingleSampledInfoEXT, PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT, SubpassResolvePerformanceQueryEXT

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.

Documentation

data PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

VkPhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT - Structure describing whether multisampled rendering to single-sampled attachments is supported

Members

This structure describes the following features:

Description

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

Valid Usage (Implicit)

See Also

VK_EXT_multisampled_render_to_single_sampled, Bool32, StructureType

Constructors

PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Fields

• multisampledRenderToSingleSampled :: Bool

  multisampledRenderToSingleSampled indicates that the implementation supports multisampled rendering to single-sampled render pass attachments.

Instances

Storable PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

sizeOf :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Int

alignment :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Int -> IO PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Int -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

poke :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO ()

Show PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

showsPrec :: Int -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> ShowS

show :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> String

showList :: [PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT] -> ShowS

Eq PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

(==) :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Bool

(/=) :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> Bool

FromCStruct PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

peekCStruct :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

ToCStruct PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

withCStruct :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> (Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

zero :: PhysicalDeviceMultisampledRenderToSingleSampledFeaturesEXT

data SubpassResolvePerformanceQueryEXT

VkSubpassResolvePerformanceQueryEXT - Structure specifying the efficiency of subpass resolve for an attachment with a format

Description

If optimal is FALSE for a Format, using a subpass resolve operation on a multisampled attachment with this format can incur additional costs, including additional memory bandwidth usage and a higher memory footprint. If an attachment with such a format is used in a multisampled-render-to-single-sampled subpass, the additional memory and memory bandwidth usage can nullify the benefits of using the VK_EXT_multisampled_render_to_single_sampled extension.

Valid Usage (Implicit)

See Also

VK_EXT_multisampled_render_to_single_sampled, Bool32, StructureType

Constructors

SubpassResolvePerformanceQueryEXT

Fields

• optimal :: Bool

  optimal specifies that a subpass resolve operation is optimally performed.

Instances

Storable SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

sizeOf :: SubpassResolvePerformanceQueryEXT -> Int

alignment :: SubpassResolvePerformanceQueryEXT -> Int

peekElemOff :: Ptr SubpassResolvePerformanceQueryEXT -> Int -> IO SubpassResolvePerformanceQueryEXT

pokeElemOff :: Ptr SubpassResolvePerformanceQueryEXT -> Int -> SubpassResolvePerformanceQueryEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO SubpassResolvePerformanceQueryEXT

pokeByteOff :: Ptr b -> Int -> SubpassResolvePerformanceQueryEXT -> IO ()

peek :: Ptr SubpassResolvePerformanceQueryEXT -> IO SubpassResolvePerformanceQueryEXT

poke :: Ptr SubpassResolvePerformanceQueryEXT -> SubpassResolvePerformanceQueryEXT -> IO ()

Show SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

showsPrec :: Int -> SubpassResolvePerformanceQueryEXT -> ShowS

show :: SubpassResolvePerformanceQueryEXT -> String

showList :: [SubpassResolvePerformanceQueryEXT] -> ShowS

Eq SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

(==) :: SubpassResolvePerformanceQueryEXT -> SubpassResolvePerformanceQueryEXT -> Bool

(/=) :: SubpassResolvePerformanceQueryEXT -> SubpassResolvePerformanceQueryEXT -> Bool

FromCStruct SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

peekCStruct :: Ptr SubpassResolvePerformanceQueryEXT -> IO SubpassResolvePerformanceQueryEXT

ToCStruct SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

withCStruct :: SubpassResolvePerformanceQueryEXT -> (Ptr SubpassResolvePerformanceQueryEXT -> IO b) -> IO b

pokeCStruct :: Ptr SubpassResolvePerformanceQueryEXT -> SubpassResolvePerformanceQueryEXT -> IO b -> IO b

withZeroCStruct :: (Ptr SubpassResolvePerformanceQueryEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr SubpassResolvePerformanceQueryEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SubpassResolvePerformanceQueryEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

zero :: SubpassResolvePerformanceQueryEXT

data MultisampledRenderToSingleSampledInfoEXT

VkMultisampledRenderToSingleSampledInfoEXT - Structure containing info for multisampled rendering to single-sampled attachments in a subpass

Valid Usage

• The value of rasterizationSamples must not be SAMPLE_COUNT_1_BIT

• If added to the pNext chain of RenderingInfo, each imageView member of any element of RenderingInfo::pColorAttachments, RenderingInfo::pDepthAttachment, or RenderingInfo::pStencilAttachment that is not NULL_HANDLE must have a format that supports the sample count specified in rasterizationSamples

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_INFO_EXT

• rasterizationSamples must be a valid SampleCountFlagBits value

See Also

VK_EXT_multisampled_render_to_single_sampled, Bool32, SampleCountFlagBits, StructureType

Constructors

MultisampledRenderToSingleSampledInfoEXT

Fields

• multisampledRenderToSingleSampledEnable :: Bool

  multisampledRenderToSingleSampledEnable controls whether multisampled rendering to single-sampled attachments is performed as described below.

• rasterizationSamples :: SampleCountFlagBits

  rasterizationSamples is a VkSampleCountFlagBits specifying the number of samples used in rasterization.

Instances

Storable MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

sizeOf :: MultisampledRenderToSingleSampledInfoEXT -> Int

alignment :: MultisampledRenderToSingleSampledInfoEXT -> Int

peekElemOff :: Ptr MultisampledRenderToSingleSampledInfoEXT -> Int -> IO MultisampledRenderToSingleSampledInfoEXT

pokeElemOff :: Ptr MultisampledRenderToSingleSampledInfoEXT -> Int -> MultisampledRenderToSingleSampledInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO MultisampledRenderToSingleSampledInfoEXT

pokeByteOff :: Ptr b -> Int -> MultisampledRenderToSingleSampledInfoEXT -> IO ()

peek :: Ptr MultisampledRenderToSingleSampledInfoEXT -> IO MultisampledRenderToSingleSampledInfoEXT

poke :: Ptr MultisampledRenderToSingleSampledInfoEXT -> MultisampledRenderToSingleSampledInfoEXT -> IO ()

Show MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

showsPrec :: Int -> MultisampledRenderToSingleSampledInfoEXT -> ShowS

show :: MultisampledRenderToSingleSampledInfoEXT -> String

showList :: [MultisampledRenderToSingleSampledInfoEXT] -> ShowS

Eq MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

(==) :: MultisampledRenderToSingleSampledInfoEXT -> MultisampledRenderToSingleSampledInfoEXT -> Bool

(/=) :: MultisampledRenderToSingleSampledInfoEXT -> MultisampledRenderToSingleSampledInfoEXT -> Bool

FromCStruct MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

peekCStruct :: Ptr MultisampledRenderToSingleSampledInfoEXT -> IO MultisampledRenderToSingleSampledInfoEXT

ToCStruct MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

withCStruct :: MultisampledRenderToSingleSampledInfoEXT -> (Ptr MultisampledRenderToSingleSampledInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr MultisampledRenderToSingleSampledInfoEXT -> MultisampledRenderToSingleSampledInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr MultisampledRenderToSingleSampledInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr MultisampledRenderToSingleSampledInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MultisampledRenderToSingleSampledInfoEXT

Defined in Vulkan.Extensions.VK_EXT_multisampled_render_to_single_sampled

Methods

zero :: MultisampledRenderToSingleSampledInfoEXT

type EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_SPEC_VERSION = 1

pattern EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_SPEC_VERSION :: forall a. Integral a => a

type EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_EXTENSION_NAME = "VK_EXT_multisampled_render_to_single_sampled"

pattern EXT_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a