| Flutter Impeller |

Public Member Functions | List of all members
impeller::CheckerboardContents Class Referencefinal

`#include <checkerboard_contents.h>`

Inheritance diagram for impeller::CheckerboardContents:

## Public Member Functions
| CheckerboardContents ()
| ~CheckerboardContents () override
bool | Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
std::optional< Rect > | GetCoverage (const Entity &entity) const override
| Get the screen space bounding rectangle that this contents affects. More...
void | SetColor (Color color)
void | SetSquareSize (Scalar square_size)
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. More...
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()`. More...
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. More...
virtual StencilCoverage | GetStencilCoverage (const Entity &entity, const std::optional< Rect > &current_stencil_coverage) const
| Given the current screen space bounding rectangle of the stencil, return the expected stencil coverage after this draw call. This should only be implemented for contents that may write to the stencil buffer. More...
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, const std::string &label="Snapshot") const
| Render this contents to a snapshot, respecting the entity's transform, path, stencil depth, and blend mode. The result texture size is always the size of `GetCoverage(entity)`. More...
virtual bool | ShouldRender (const Entity &entity, const std::optional< Rect > &stencil_coverage) const
std::optional< Size > | GetColorSourceSize () const
| Return the color source's intrinsic size, if available. More...
void | SetColorSourceSize (Size size)
virtual bool | CanInheritOpacity (const Entity &entity) const
| Whether or not this contents can accept the opacity peephole optimization. More...
virtual void | SetInheritedOpacity (Scalar opacity)
| Inherit the provided opacity. More...
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. More...
virtual const FilterContents * | AsFilter () const
| Cast to a filter. Returns `nullptr` if this Contents is not a filter. More...
virtual bool | ApplyColorFilter (const ColorFilterProc &color_filter_proc)
| If possible, applies a color filter to this contents inputs on the CPU. More...

## 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)

## Detailed Description

A special Contents that renders a translucent checkerboard pattern with a random color over the entire pass texture. This is useful for visualizing offscreen textures.

Definition at line 15 of file checkerboard_contents.h.

## Constructor & Destructor Documentation

## ◆ CheckerboardContents()

impeller::CheckerboardContents::CheckerboardContents | ( |  | ) |
| default

## ◆ ~CheckerboardContents()

impeller::CheckerboardContents::~CheckerboardContents | ( |  | ) |
| override default

## Member Function Documentation

## ◆ GetCoverage()

std::optional< Rect > impeller::CheckerboardContents::GetCoverage | ( | const Entity & | entity | ) | const
| override virtual

Get the screen space bounding rectangle that this contents affects.

Implements impeller::Contents.

Definition at line 57 of file checkerboard_contents.cc.

58 {
59 return std::nullopt;
60 }

## ◆ Render()

bool impeller::CheckerboardContents::Render | ( | const ContentContext & | renderer,
|  | const Entity & | entity,
|  | RenderPass & | pass
| ) |  | const
| override virtual

Implements impeller::Contents.

Definition at line 20 of file checkerboard_contents.cc.

22 {
23 auto& host_buffer = pass.GetTransientsBuffer();
24
25 using VS = CheckerboardPipeline::VertexShader;
26 using FS = CheckerboardPipeline::FragmentShader;
27
28 Command cmd;
29 DEBUG_COMMAND_INFO(cmd, "Checkerboard");
30
31 auto options = OptionsFromPass(pass);
32 options.blend_mode = BlendMode::kSourceOver;
33 options.stencil_compare = CompareFunction::kAlways; // Ignore all clips.
34 options.stencil_operation = StencilOperation::kKeep;
35 options.primitive_type = PrimitiveType::kTriangleStrip;
36 cmd.pipeline = renderer.GetCheckerboardPipeline(options);
37
38 VertexBufferBuilder<typename VS::PerVertexData> vtx_builder;
39 vtx_builder.AddVertices({
40 {Point(-1, -1)},
41 {Point(1, -1)},
42 {Point(-1, 1)},
43 {Point(1, 1)},
44 });
45 cmd.BindVertices(vtx_builder.CreateVertexBuffer(host_buffer));
46
47 FS::FragInfo frag_info;
48 frag_info.color = color_;
49 frag_info.square_size = square_size_;
50 FS::BindFragInfo(cmd, host_buffer.EmplaceUniform(frag_info));
51
52 pass.AddCommand(std::move(cmd));
53
54 return true;
55 }

References impeller::RenderPass::AddCommand(), impeller::VertexBufferBuilder< VertexType_, IndexType_ >::AddVertices(), impeller::Command::BindVertices(), impeller::VertexBufferBuilder< VertexType_, IndexType_ >::CreateVertexBuffer(), DEBUG_COMMAND_INFO, impeller::RenderPass::GetTransientsBuffer(), impeller::kAlways, impeller::kKeep, impeller::kSourceOver, impeller::kTriangleStrip, impeller::OptionsFromPass(), and impeller::Command::pipeline.

## ◆ SetColor()

void impeller::CheckerboardContents::SetColor | ( | Color | color | ) |

Definition at line 62 of file checkerboard_contents.cc.

62 {
63 color_ = color;
64 }

## ◆ SetSquareSize()

void impeller::CheckerboardContents::SetSquareSize | ( | Scalar | square_size | ) |

Definition at line 66 of file checkerboard_contents.cc.

66 {
67 square_size_ = square_size;
68 }

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

- impeller/entity/contents/checkerboard_contents.h
- impeller/entity/contents/checkerboard_contents.cc

impeller::OptionsFromPass
ContentContextOptions OptionsFromPass(const RenderPass &pass)
Definition: contents.cc:20
DEBUG_COMMAND_INFO
#define DEBUG_COMMAND_INFO(obj, arg)
Definition: command.h:31
impeller::PrimitiveType::kTriangleStrip
@ kTriangleStrip
impeller::StencilOperation::kKeep
@ kKeep
Don't modify the current stencil value.
impeller::Point
TPoint< Scalar > Point
Definition: point.h:306
impeller::BlendMode::kSourceOver
@ kSourceOver
impeller::CompareFunction::kAlways
@ kAlways
Comparison test passes always passes.