#include <scene_contents.h>

Inheritance diagram for impeller::SceneContents:

Public Member Functions
	SceneContents ()

	~SceneContents () override

void	SetCameraTransform (Matrix matrix)

void	SetNode (std::shared_ptr< scene::Node > node)

bool	Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override

Public Member Functions inherited from impeller::ColorSourceContents
	ColorSourceContents ()

	~ColorSourceContents () override

void	SetGeometry (std::shared_ptr< Geometry > geometry)
	Set the geometry that this contents will use to render.

const std::shared_ptr< Geometry > &	GetGeometry () const
	Get the geometry that this contents will use to render.

void	SetEffectTransform (Matrix matrix)
	Set the effect transform for this color source.

const Matrix &	GetInverseEffectTransform () const
	Set the inverted effect transform for this color source.

void	SetOpacityFactor (Scalar opacity)
	Set the opacity factor for this color source.

Scalar	GetOpacityFactor () const
	Get the opacity factor for this color source.

virtual bool	IsSolidColor () const

std::optional< Rect >	GetCoverage (const Entity &entity) const override
	Get the area of the render pass that will be affected when this contents is rendered.

bool	CanInheritOpacity (const Entity &entity) const override
	Whether or not this contents can accept the opacity peephole optimization.

void	SetInheritedOpacity (Scalar opacity) override
	Inherit the provided opacity.

Public Member Functions inherited from impeller::Contents
	Contents ()

virtual	~Contents ()

virtual void	PopulateGlyphAtlas (const std::shared_ptr< LazyGlyphAtlas > &lazy_glyph_atlas, Scalar scale)
	Add any text data to the specified lazy atlas. The scale parameter must be used again later when drawing the text.

void	SetCoverageHint (std::optional< Rect > coverage_hint)
	Hint that specifies the coverage area of this Contents that will actually be used during rendering. This is for optimization purposes only and can not be relied on as a clip. May optionally affect the result of `GetCoverage()`.

const std::optional< Rect > &	GetCoverageHint () const

virtual bool	IsOpaque () const
	Whether this Contents only emits opaque source colors from the fragment stage. This value does not account for any entity properties (e.g. the blend mode), clips/visibility culling, or inherited opacity.

virtual ClipCoverage	GetClipCoverage (const Entity &entity, const std::optional< Rect > &current_clip_coverage) const
	Given the current pass space bounding rectangle of the clip buffer, return the expected clip coverage after this draw call. This should only be implemented for contents that may write to the clip buffer.

virtual std::optional< Snapshot >	RenderToSnapshot (const ContentContext &renderer, const Entity &entity, std::optional< Rect > coverage_limit=std::nullopt, const std::optional< SamplerDescriptor > &sampler_descriptor=std::nullopt, bool msaa_enabled=true, int32_t mip_count=1, const std::string &label="Snapshot") const
	Render this contents to a snapshot, respecting the entity's transform, path, clip depth, and blend mode. The result texture size is always the size of `GetCoverage(entity)`.

virtual bool	ShouldRender (const Entity &entity, const std::optional< Rect > clip_coverage) const

std::optional< Size >	GetColorSourceSize () const
	Return the color source's intrinsic size, if available.

void	SetColorSourceSize (Size size)

virtual std::optional< Color >	AsBackgroundColor (const Entity &entity, ISize target_size) const
	Returns a color if this Contents will flood the given `target_size` with a color. This output color is the "Source" color that will be used for the Entity's blend operation.

virtual const FilterContents *	AsFilter () const
	Cast to a filter. Returns `nullptr` if this Contents is not a filter.

virtual bool	ApplyColorFilter (const ColorFilterProc &color_filter_proc)
	If possible, applies a color filter to this contents inputs on the CPU.

Additional Inherited Members
Public Types inherited from impeller::Contents
using	ColorFilterProc = std::function< Color(Color)>

using	RenderProc = std::function< bool(const ContentContext &renderer, const Entity &entity, RenderPass &pass)>

using	CoverageProc = std::function< std::optional< Rect >(const Entity &entity)>

Static Public Member Functions inherited from impeller::Contents
static std::shared_ptr< Contents >	MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc)

Protected Types inherited from impeller::ColorSourceContents
using	BindFragmentCallback = std::function< bool(RenderPass &pass)>

using	PipelineBuilderMethod = std::shared_ptr< Pipeline< PipelineDescriptor > >(impeller::ContentContext::*)(ContentContextOptions) const

using	PipelineBuilderCallback = std::function< std::shared_ptr< Pipeline< PipelineDescriptor > >(ContentContextOptions)>

Protected Member Functions inherited from impeller::ColorSourceContents
template<typename VertexShaderT >
bool	DrawGeometry (const ContentContext &renderer, const Entity &entity, RenderPass &pass, const PipelineBuilderCallback &pipeline_callback, typename VertexShaderT::FrameInfo frame_info, const BindFragmentCallback &bind_fragment_callback) const

Detailed Description

Definition at line 22 of file scene_contents.h.

Constructor & Destructor Documentation

◆ SceneContents()

impeller::SceneContents::SceneContents ( )

default

◆ ~SceneContents()

impeller::SceneContents::~SceneContents ( )

overridedefault

Member Function Documentation

◆ Render()

bool impeller::SceneContents::Render	(	const ContentContext &	renderer,
		const Entity &	entity,
		RenderPass &	pass
	)		const

overridevirtual

Implements impeller::Contents.

Definition at line 29 of file scene_contents.cc.

                                                   {
  if (!node_) {
    return true;
  }
 
  auto coverage = GetCoverage(entity);
  if (!coverage.has_value()) {
    return true;
  }
 
  // This happens for CoverGeometry (DrawPaint). In this situation,
  // Draw the scene to the full layer.
  if (coverage.value().IsMaximum()) {
    coverage = Rect::MakeSize(pass.GetRenderTargetSize());
  }
 
  RenderTarget subpass_target;
  if (renderer.GetContext()->GetCapabilities()->SupportsOffscreenMSAA()) {
    subpass_target = renderer.GetRenderTargetCache()->CreateOffscreenMSAA(
        *renderer.GetContext(),             // context
        ISize(coverage.value().GetSize()),  // size
        /*mip_count=*/1,
        "SceneContents",  // label
        RenderTarget::AttachmentConfigMSAA{
            .storage_mode = StorageMode::kDeviceTransient,
            .resolve_storage_mode = StorageMode::kDevicePrivate,
            .load_action = LoadAction::kClear,
            .store_action = StoreAction::kMultisampleResolve,
        },  // color_attachment_config
        RenderTarget::AttachmentConfig{
            .storage_mode = StorageMode::kDeviceTransient,
            .load_action = LoadAction::kDontCare,
            .store_action = StoreAction::kDontCare,
        }  // stencil_attachment_config
    );
  } else {
    subpass_target = renderer.GetRenderTargetCache()->CreateOffscreen(
        *renderer.GetContext(),             // context
        ISize(coverage.value().GetSize()),  // size
        /*mip_count=*/1,
        "SceneContents",  // label
        RenderTarget::AttachmentConfig{
            .storage_mode = StorageMode::kDevicePrivate,
            .load_action = LoadAction::kClear,
            .store_action = StoreAction::kStore,
        },  // color_attachment_config
        RenderTarget::AttachmentConfig{
            .storage_mode = StorageMode::kDeviceTransient,
            .load_action = LoadAction::kClear,
            .store_action = StoreAction::kDontCare,
        }  // stencil_attachment_config
    );
  }
 
  if (!subpass_target.IsValid()) {
    return false;
  }
 
  scene::Scene scene(renderer.GetSceneContext());
  scene.GetRoot().AddChild(node_);
 
  if (!scene.Render(subpass_target, camera_transform_)) {
    return false;
  }
 
  // Render the texture to the pass.
  TiledTextureContents contents;
  contents.SetGeometry(GetGeometry());
  contents.SetTexture(subpass_target.GetRenderTargetTexture());
  contents.SetEffectTransform(
      Matrix::MakeScale(1 / entity.GetTransform().GetScale()));
  return contents.Render(renderer, entity, pass);
}

◆ SetCameraTransform()

void impeller::SceneContents::SetCameraTransform ( Matrix matrix )

Definition at line 21 of file scene_contents.cc.

                                                    {
  camera_transform_ = matrix;
}

◆ SetNode()

void impeller::SceneContents::SetNode ( std::shared_ptr< scene::Node > node )

Definition at line 25 of file scene_contents.cc.

                                                         {
  node_ = std::move(node);
}

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

impeller/entity/contents/scene_contents.h
impeller/entity/contents/scene_contents.cc

Public Member Functions

Additional Inherited Members