render_target_cache.h

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef FLUTTER_IMPELLER_ENTITY_RENDER_TARGET_CACHE_H_
#define FLUTTER_IMPELLER_ENTITY_RENDER_TARGET_CACHE_H_
 
#include <string_view>
 
#include "impeller/renderer/render_target.h"
 
namespace impeller {
 
/// @brief An implementation of the [RenderTargetAllocator] that caches all
///        allocated texture data for at least one frame.
///
///        Any textures unused after [keep_alive_frame_count] frames are
///        discarded.
class RenderTargetCache : public RenderTargetAllocator {
 public:
  explicit RenderTargetCache(std::shared_ptr<Allocator> allocator,
                             uint32_t keep_alive_frame_count = 4);
 
  ~RenderTargetCache() = default;
 
  // |RenderTargetAllocator|
  void Start() override;
 
  // |RenderTargetAllocator|
  void End() override;
 
  // |RenderTargetAllocator|
  void DisableCache() override;
 
  // |RenderTargetAllocator|
  void EnableCache() override;
 
  RenderTarget CreateOffscreen(
      const Context& context,
      ISize size,
      int mip_count,
      std::string_view label = "Offscreen",
      RenderTarget::AttachmentConfig color_attachment_config =
          RenderTarget::kDefaultColorAttachmentConfig,
      std::optional<RenderTarget::AttachmentConfig> stencil_attachment_config =
          RenderTarget::kDefaultStencilAttachmentConfig,
      const std::shared_ptr<Texture>& existing_color_texture = nullptr,
      const std::shared_ptr<Texture>& existing_depth_stencil_texture = nullptr,
      std::optional<PixelFormat> target_pixel_format = std::nullopt) override;
 
  RenderTarget CreateOffscreenMSAA(
      const Context& context,
      ISize size,
      int mip_count,
      std::string_view label = "Offscreen MSAA",
      RenderTarget::AttachmentConfigMSAA color_attachment_config =
          RenderTarget::kDefaultColorAttachmentConfigMSAA,
      std::optional<RenderTarget::AttachmentConfig> stencil_attachment_config =
          RenderTarget::kDefaultStencilAttachmentConfig,
      const std::shared_ptr<Texture>& existing_color_msaa_texture = nullptr,
      const std::shared_ptr<Texture>& existing_color_resolve_texture = nullptr,
      const std::shared_ptr<Texture>& existing_depth_stencil_texture = nullptr,
      std::optional<PixelFormat> target_pixel_format = std::nullopt) override;
 
  // visible for testing.
  size_t CachedTextureCount() const;
 
 private:
  struct RenderTargetData {
    bool used_this_frame;
    uint32_t keep_alive_frame_count;
    RenderTargetConfig config;
    RenderTarget render_target;
  };
 
  bool CacheEnabled() const;
 
  std::vector<RenderTargetData> render_target_data_;
  uint32_t keep_alive_frame_count_;
  uint32_t cache_disabled_count_ = 0;
 
  RenderTargetCache(const RenderTargetCache&) = delete;
 
  RenderTargetCache& operator=(const RenderTargetCache&) = delete;
 
 public:
  /// Visible for testing.
  std::vector<RenderTargetData>::const_iterator GetRenderTargetDataBegin()
      const {
    return render_target_data_.begin();
  }
 
  /// Visible for testing.
  std::vector<RenderTargetData>::const_iterator GetRenderTargetDataEnd() const {
    return render_target_data_.end();
  }
};
 
}  // namespace impeller
 
#endif  // FLUTTER_IMPELLER_ENTITY_RENDER_TARGET_CACHE_H_