impeller::Attachment Struct Reference

#include <formats.h>

Inheritance diagram for impeller::Attachment:

Public Member Functions
bool	IsValid () const

Public Attributes
std::shared_ptr< Texture >	texture
std::shared_ptr< Texture >	resolve_texture
LoadAction	load_action = LoadAction::kDontCare
StoreAction	store_action = StoreAction::kStore

Detailed Description

Definition at line 656 of file formats.h.

Member Function Documentation

IsValid()

bool impeller::Attachment::IsValid

(

)

const

Definition at line 26 of file formats.cc.

                               {
  if (!texture || !texture->IsValid()) {
    VALIDATION_LOG << "Attachment has no texture.";
    return false;
  }
 
  if (StoreActionNeedsResolveTexture(store_action)) {
    if (!resolve_texture || !resolve_texture->IsValid()) {
      VALIDATION_LOG << "Store action needs resolve but no valid resolve "
                        "texture specified.";
      return false;
    }
  }
 
  if (resolve_texture) {
    if (store_action != StoreAction::kMultisampleResolve &&
        store_action != StoreAction::kStoreAndMultisampleResolve) {
      VALIDATION_LOG << "A resolve texture was specified, but the store action "
                        "doesn't include multisample resolve.";
      return false;
    }
 
    if (texture->GetTextureDescriptor().storage_mode ==
            StorageMode::kDeviceTransient &&
        store_action == StoreAction::kStoreAndMultisampleResolve) {
      VALIDATION_LOG
          << "The multisample texture cannot be transient when "
             "specifying the StoreAndMultisampleResolve StoreAction.";
    }
  }
 
  auto storage_mode = resolve_texture
                          ? resolve_texture->GetTextureDescriptor().storage_mode
                          : texture->GetTextureDescriptor().storage_mode;
 
  if (storage_mode == StorageMode::kDeviceTransient) {
    if (load_action == LoadAction::kLoad) {
      VALIDATION_LOG << "The LoadAction cannot be Load when attaching a device "
                        "transient " +
                            std::string(resolve_texture ? "resolve texture."
                                                        : "texture.");
      return false;
    }
    if (store_action != StoreAction::kDontCare) {
      VALIDATION_LOG << "The StoreAction must be DontCare when attaching a "
                        "device transient " +
                            std::string(resolve_texture ? "resolve texture."
                                                        : "texture.");
      return false;
    }
  }
 
  return true;
}

References impeller::kDeviceTransient, impeller::kDontCare, impeller::kLoad, impeller::kMultisampleResolve, impeller::kStoreAndMultisampleResolve, load_action, resolve_texture, store_action, impeller::StoreActionNeedsResolveTexture(), texture, and VALIDATION_LOG.

Referenced by impeller::RenderTarget::SetColorAttachment(), and impeller::testing::TEST_P().

Member Data Documentation

load_action

LoadAction impeller::Attachment::load_action = LoadAction::kDontCare

Definition at line 659 of file formats.h.

Referenced by impeller::AttachmentToString(), impeller::ConfigureAttachment(), impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::InlinePassContext::GetRenderPass(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), InternalFlutterGpu_RenderPass_SetColorAttachment(), InternalFlutterGpu_RenderPass_SetDepthStencilAttachment(), IsValid(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), impeller::Playground::OpenPlaygroundHere(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

resolve_texture

std::shared_ptr<Texture> impeller::Attachment::resolve_texture

Definition at line 658 of file formats.h.

Referenced by impeller::AttachmentToString(), impeller::ConfigureResolveTextureAttachment(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::RenderTargetCache::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::EntityPassTarget::Flip(), impeller::InlinePassContext::GetRenderPass(), impeller::GetVKClearValues(), InternalFlutterGpu_RenderPass_SetColorAttachment(), IsValid(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

store_action

StoreAction impeller::Attachment::store_action = StoreAction::kStore

Definition at line 660 of file formats.h.

Referenced by impeller::AttachmentToString(), impeller::ConfigureAttachment(), impeller::ConfigureResolveTextureAttachment(), impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::InlinePassContext::GetRenderPass(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), InternalFlutterGpu_RenderPass_SetColorAttachment(), InternalFlutterGpu_RenderPass_SetDepthStencilAttachment(), IsValid(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

texture

std::shared_ptr<Texture> impeller::Attachment::texture

Definition at line 657 of file formats.h.

Referenced by impeller::AttachmentToString(), impeller::ConfigureAttachment(), impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetCache::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::RenderTargetCache::CreateOffscreenMSAA(), impeller::testing::CreateTestCanvas(), impeller::EntityPassTarget::Flip(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), InternalFlutterGpu_RenderPass_SetColorAttachment(), InternalFlutterGpu_RenderPass_SetDepthStencilAttachment(), IsValid(), MakeRenderTargetFromBackingStoreImpeller(), MakeRenderTargetFromBackingStoreImpeller(), impeller::RenderTarget::SetupDepthStencilAttachments(), impeller::testing::TEST(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

---

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

• impeller/core/formats.h
• impeller/core/formats.cc