impeller::SurfaceVK Class Reference

#include <surface_vk.h>

Inheritance diagram for impeller::SurfaceVK:

Public Types
using	SwapCallback = std::function< bool(void)>

Public Member Functions
	~SurfaceVK () override
Public Member Functions inherited from impeller::Surface
	Surface ()
	Surface (const RenderTarget &target_desc)
virtual	~Surface ()
const ISize &	GetSize () const
bool	IsValid () const
const RenderTarget &	GetTargetRenderPassDescriptor () const

Static Public Member Functions
static std::unique_ptr< SurfaceVK >	WrapSwapchainImage (const std::shared_ptr< SwapchainTransientsVK > &transients, const std::shared_ptr< TextureSourceVK > &swapchain_image, SwapCallback swap_callback)
	Wrap the swapchain image in a Surface, which provides the additional configuration required for usage as on onscreen render target by Impeller.

Private Member Functions
bool	Present () const override

Detailed Description

Definition at line 17 of file surface_vk.h.

Member Typedef Documentation

SwapCallback

using impeller::SurfaceVK::SwapCallback = std::function<bool(void)>

Definition at line 19 of file surface_vk.h.

Constructor & Destructor Documentation

~SurfaceVK()

impeller::SurfaceVK::~SurfaceVK ( )

overridedefault

Member Function Documentation

Present()

bool impeller::SurfaceVK::Present ( ) const

overrideprivatevirtual

Reimplemented from impeller::Surface.

Definition at line 83 of file surface_vk.cc.

                              {
  return swap_callback_ ? swap_callback_() : false;
}

WrapSwapchainImage()

std::unique_ptr< SurfaceVK > impeller::SurfaceVK::WrapSwapchainImage ( const std::shared_ptr< SwapchainTransientsVK > &  transients, const std::shared_ptr< TextureSourceVK > &  swapchain_image, SwapCallback  swap_callback  )

static

Wrap the swapchain image in a Surface, which provides the additional configuration required for usage as on onscreen render target by Impeller.

This creates the associated MSAA and depth+stencil texture.

Definition at line 13 of file surface_vk.cc.

                                {
  if (!transients || !swapchain_image || !swap_callback) {
    return nullptr;
  }
 
  auto context = transients->GetContext().lock();
  if (!context) {
    return nullptr;
  }
 
  const auto enable_msaa = transients->IsMSAAEnabled();
 
  const auto swapchain_tex_desc = swapchain_image->GetTextureDescriptor();
 
  TextureDescriptor resolve_tex_desc;
  resolve_tex_desc.type = TextureType::kTexture2D;
  resolve_tex_desc.format = swapchain_tex_desc.format;
  resolve_tex_desc.size = swapchain_tex_desc.size;
  resolve_tex_desc.usage = TextureUsage::kRenderTarget;
  resolve_tex_desc.sample_count = SampleCount::kCount1;
  resolve_tex_desc.storage_mode = StorageMode::kDevicePrivate;
 
  std::shared_ptr<Texture> resolve_tex =
      std::make_shared<TextureVK>(context,         //
                                  swapchain_image  //
      );
 
  if (!resolve_tex) {
    return nullptr;
  }
  resolve_tex->SetLabel("ImpellerOnscreenResolve");
 
  ColorAttachment color0;
  color0.clear_color = Color::DarkSlateGray();
  color0.load_action = LoadAction::kClear;
  if (enable_msaa) {
    color0.texture = transients->GetMSAATexture();
    color0.store_action = StoreAction::kMultisampleResolve;
    color0.resolve_texture = resolve_tex;
  } else {
    color0.texture = resolve_tex;
    color0.store_action = StoreAction::kStore;
  }
 
  RenderTarget render_target_desc;
  render_target_desc.SetColorAttachment(color0, 0u);
  render_target_desc.SetupDepthStencilAttachments(
      /*context=*/*context,                            //
      /*allocator=*/*context->GetResourceAllocator(),  //
      /*size=*/swapchain_tex_desc.size,                //
      /*msaa=*/enable_msaa,                            //
      /*label=*/"Onscreen",                            //
      /*stencil_attachment_config=*/
      RenderTarget::kDefaultStencilAttachmentConfig,                  //
      /*depth_stencil_texture=*/transients->GetDepthStencilTexture()  //
  );
 
  // The constructor is private. So make_unique may not be used.
  return std::unique_ptr<SurfaceVK>(
      new SurfaceVK(render_target_desc, std::move(swap_callback)));
}

---

The documentation for this class was generated from the following files:

• impeller/renderer/backend/vulkan/swapchain/surface_vk.h
• impeller/renderer/backend/vulkan/swapchain/surface_vk.cc