#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

uint32_t	mip_level = 0

uint32_t	slice = 0

Detailed Description

Definition at line 908 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;
  }
 
  const TextureDescriptor& desc = texture->GetTextureDescriptor();
  if (mip_level >= desc.mip_count) {
    VALIDATION_LOG << "Attachment mip_level " << mip_level
                   << " is out of range; the texture has " << desc.mip_count
                   << " mip levels.";
    return false;
  }
  const uint32_t slice_count = desc.type == TextureType::kTextureCube ? 6u : 1u;
  if (slice >= slice_count) {
    VALIDATION_LOG << "Attachment slice " << slice
                   << " is out of range for the texture type.";
    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, impeller::kTextureCube, load_action, impeller::TextureDescriptor::mip_count, mip_level, resolve_texture, slice, store_action, impeller::StoreActionNeedsResolveTexture(), texture, impeller::TextureDescriptor::type, and VALIDATION_LOG.

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

Member Data Documentation

◆ load_action

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

Definition at line 911 of file formats.h.

◆ mip_level

uint32_t impeller::Attachment::mip_level = 0

Definition at line 915 of file formats.h.

Referenced by impeller::ConfigureAttachment(), InternalFlutterGpu_RenderPass_SetColorAttachment(), InternalFlutterGpu_RenderPass_SetDepthStencilAttachment(), IsValid(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

◆ resolve_texture

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

Definition at line 910 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().

◆ slice

uint32_t impeller::Attachment::slice = 0

Definition at line 918 of file formats.h.

Referenced by impeller::ConfigureAttachment(), InternalFlutterGpu_RenderPass_SetColorAttachment(), InternalFlutterGpu_RenderPass_SetDepthStencilAttachment(), IsValid(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

◆ store_action

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

Definition at line 912 of file formats.h.

◆ texture

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

Definition at line 909 of file formats.h.

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

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

Public Member Functions

Public Attributes