| Flutter Impeller |

texture_contents.h
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef FLUTTER_IMPELLER_ENTITY_CONTENTS_TEXTURE_CONTENTS_H_
6 #define FLUTTER_IMPELLER_ENTITY_CONTENTS_TEXTURE_CONTENTS_H_
7
8 #include <memory>
9
10 #include "impeller/core/sampler_descriptor.h"
11 #include "impeller/entity/contents/contents.h"
12
13 namespace impeller {
14
15 class Texture;
16
17 class TextureContents final : public Contents {
18 public:
19 TextureContents();
20
21 ~TextureContents() override;
22
23 /// @brief A common case factory that marks the texture contents as having a
24 /// destination rectangle. In this situation, a subpass can be avoided
25 /// when image filters are applied.
26 static std::shared_ptr<TextureContents> MakeRect(Rect destination);
27
28 void SetLabel(std::string_view label);
29
30 void SetDestinationRect(Rect rect);
31
32 void SetTexture(std::shared_ptr<Texture> texture);
33
34 std::shared_ptr<Texture> GetTexture() const;
35
36 void SetSamplerDescriptor(const SamplerDescriptor& desc);
37
38 const SamplerDescriptor& GetSamplerDescriptor() const;
39
40 void SetSourceRect(const Rect& source_rect);
41
42 const Rect& GetSourceRect() const;
43
44 void SetStrictSourceRect(bool strict);
45
46 bool GetStrictSourceRect() const;
47
48 void SetOpacity(Scalar opacity);
49
50 Scalar GetOpacity() const;
51
52 void SetStencilEnabled(bool enabled);
53
54 // |Contents|
55 std::optional<Rect> GetCoverage(const Entity& entity) const override;
56
57 // |Contents|
58 std::optional<Snapshot> RenderToSnapshot(
59 const ContentContext& renderer,
60 const Entity& entity,
61 std::optional<Rect> coverage_limit = std::nullopt,
62 const std::optional<SamplerDescriptor>& sampler_descriptor = std::nullopt,
63 bool msaa_enabled = true,
64 int32_t mip_count = 1,
65 std::string_view label = "Texture Snapshot") const override;
66
67 // |Contents|
68 bool Render(const ContentContext& renderer,
69 const Entity& entity,
70 RenderPass& pass) const override;
71
72 // |Contents|
73 void SetInheritedOpacity(Scalar opacity) override;
74
75 void SetDeferApplyingOpacity(bool defer_applying_opacity);
76
77 private:
78 std::string label_;
79
80 Rect destination_rect_;
81 bool stencil_enabled_ = true;
82
83 std::shared_ptr<Texture> texture_;
84 SamplerDescriptor sampler_descriptor_ = {};
85 Rect source_rect_;
86 bool strict_source_rect_enabled_ = false;
87 Scalar opacity_ = 1.0f;
88 Scalar inherited_opacity_ = 1.0f;
89 bool defer_applying_opacity_ = false;
90
91 TextureContents(const TextureContents&) = delete;
92
93 TextureContents& operator=(const TextureContents&) = delete;
94 };
95
96 } // namespace impeller
97
98 #endif // FLUTTER_IMPELLER_ENTITY_CONTENTS_TEXTURE_CONTENTS_H_
impeller::ContentContext
Definition: content_context.h:138
impeller::Contents
Definition: contents.h:31
impeller::Entity
Definition: entity.h:20
impeller::RenderPass
Render passes encode render commands directed as one specific render target into an underlying comman...
Definition: render_pass.h:30
impeller::TextureContents
Definition: texture_contents.h:17
impeller::TextureContents::GetTexture
std::shared_ptr< Texture > GetTexture() const
Definition: texture_contents.cc:46
impeller::TextureContents::SetSourceRect
void SetSourceRect(const Rect &source_rect)
Definition: texture_contents.cc:231
impeller::TextureContents::Render
bool Render(const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override
Definition: texture_contents.cc:106
impeller::TextureContents::SetSamplerDescriptor
void SetSamplerDescriptor(const SamplerDescriptor &desc)
Definition: texture_contents.cc:247
impeller::TextureContents::GetOpacity
Scalar GetOpacity() const
Definition: texture_contents.cc:62
impeller::TextureContents::SetStrictSourceRect
void SetStrictSourceRect(bool strict)
Definition: texture_contents.cc:239
impeller::TextureContents::SetDeferApplyingOpacity
void SetDeferApplyingOpacity(bool defer_applying_opacity)
Definition: texture_contents.cc:255
impeller::TextureContents::GetSamplerDescriptor
const SamplerDescriptor & GetSamplerDescriptor() const
Definition: texture_contents.cc:251
impeller::TextureContents::SetOpacity
void SetOpacity(Scalar opacity)
Definition: texture_contents.cc:50
impeller::TextureContents::RenderToSnapshot
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, std::string_view label="Texture Snapshot") const override
Render this contents to a snapshot, respecting the entity's transform, path, clip depth,...
Definition: texture_contents.cc:73
impeller::TextureContents::GetStrictSourceRect
bool GetStrictSourceRect() const
Definition: texture_contents.cc:243
impeller::TextureContents::MakeRect
static std::shared_ptr< TextureContents > MakeRect(Rect destination)
A common case factory that marks the texture contents as having a destination rectangle....
Definition: texture_contents.cc:28
impeller::TextureContents::GetSourceRect
const Rect & GetSourceRect() const
Definition: texture_contents.cc:235
impeller::TextureContents::SetInheritedOpacity
void SetInheritedOpacity(Scalar opacity) override
Inherit the provided opacity.
Definition: texture_contents.cc:58
impeller::TextureContents::TextureContents
TextureContents()
impeller::TextureContents::GetCoverage
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.
Definition: texture_contents.cc:66
impeller::TextureContents::SetTexture
void SetTexture(std::shared_ptr< Texture > texture)
Definition: texture_contents.cc:42
impeller::TextureContents::~TextureContents
~TextureContents() override
impeller::TextureContents::SetLabel
void SetLabel(std::string_view label)
Definition: texture_contents.cc:34
impeller::TextureContents::SetStencilEnabled
void SetStencilEnabled(bool enabled)
Definition: texture_contents.cc:54
impeller::TextureContents::SetDestinationRect
void SetDestinationRect(Rect rect)
Definition: texture_contents.cc:38
contents.h
impeller
Definition: allocation.cc:12
impeller::Scalar
float Scalar
Definition: scalar.h:18
sampler_descriptor.h
impeller::SamplerDescriptor
Definition: sampler_descriptor.h:14
impeller::TRect< Scalar >