#include <texture_contents.h>
Public Member Functions | |
TextureContents () | |
~TextureContents () override | |
void | SetLabel (std::string_view label) |
void | SetDestinationRect (Rect rect) |
void | SetTexture (std::shared_ptr< Texture > texture) |
std::shared_ptr< Texture > | GetTexture () const |
void | SetSamplerDescriptor (const SamplerDescriptor &desc) |
const SamplerDescriptor & | GetSamplerDescriptor () const |
void | SetSourceRect (const Rect &source_rect) |
const Rect & | GetSourceRect () const |
void | SetStrictSourceRect (bool strict) |
bool | GetStrictSourceRect () const |
void | SetOpacity (Scalar opacity) |
Scalar | GetOpacity () const |
void | SetStencilEnabled (bool enabled) |
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. More... | |
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, and blend mode. The result texture size is always the size of GetCoverage(entity) . More... | |
bool | Render (const ContentContext &renderer, const Entity &entity, RenderPass &pass) const override |
void | SetInheritedOpacity (Scalar opacity) override |
Inherit the provided opacity. More... | |
void | SetDeferApplyingOpacity (bool defer_applying_opacity) |
![]() | |
Contents () | |
virtual | ~Contents () |
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 Matrix &transform) 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... | |
std::optional< Size > | GetColorSourceSize () const |
Return the color source's intrinsic size, if available. More... | |
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. More... | |
virtual bool | ApplyColorFilter (const ColorFilterProc &color_filter_proc) |
If possible, applies a color filter to this contents inputs on the CPU. More... | |
Static Public Member Functions | |
static std::shared_ptr< TextureContents > | MakeRect (Rect destination) |
![]() | |
static std::shared_ptr< Contents > | MakeAnonymous (RenderProc render_proc, CoverageProc coverage_proc) |
Additional Inherited Members | |
![]() | |
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)> |
Represents the contents of a texture to be rendered.
This class encapsulates a texture along with parameters defining how it should be drawn, such as the source rectangle within the texture, the destination rectangle on the render target, opacity, and sampler settings. It's used by the rendering system to draw textured quads.
TiledTextureContents
for a tiled version. Definition at line 25 of file texture_contents.h.
|
default |
|
overridedefault |
|
overridevirtual |
Get the area of the render pass that will be affected when this contents is rendered.
During rendering, coverage coordinates count pixels from the top left corner of the framebuffer.
std::nullopt
result means that rendering this contents has no effect on the output color. Implements impeller::Contents.
Definition at line 66 of file texture_contents.cc.
References GetOpacity(), impeller::Entity::GetTransform(), and impeller::TRect< T >::TransformBounds().
Scalar impeller::TextureContents::GetOpacity | ( | ) | const |
Definition at line 62 of file texture_contents.cc.
Referenced by GetCoverage(), Render(), and RenderToSnapshot().
const SamplerDescriptor & impeller::TextureContents::GetSamplerDescriptor | ( | ) | const |
Definition at line 251 of file texture_contents.cc.
const Rect & impeller::TextureContents::GetSourceRect | ( | ) | const |
Definition at line 235 of file texture_contents.cc.
bool impeller::TextureContents::GetStrictSourceRect | ( | ) | const |
Definition at line 243 of file texture_contents.cc.
std::shared_ptr< Texture > impeller::TextureContents::GetTexture | ( | ) | const |
Definition at line 46 of file texture_contents.cc.
|
static |
A common case factory that marks the texture contents as having a destination rectangle.
In this situation, a subpass can be avoided when image filters are applied.
destination | The destination rectangle in the Entity's local coordinate space. |
Definition at line 28 of file texture_contents.cc.
Referenced by impeller::Canvas::DrawImageRect(), impeller::Entity::FromSnapshot(), impeller::Canvas::SaveLayer(), and impeller::testing::TEST_P().
|
overridevirtual |
Implements impeller::Contents.
Definition at line 106 of file texture_contents.cc.
References impeller::CreateVertexBuffer(), impeller::RenderPass::Draw(), impeller::TRect< T >::Expand(), impeller::ContentContext::GetContext(), impeller::TRect< T >::GetLeftBottom(), impeller::TRect< T >::GetLeftTop(), GetOpacity(), impeller::TRect< T >::GetRightBottom(), impeller::TRect< T >::GetRightTop(), impeller::Entity::GetShaderTransform(), impeller::ContentContext::GetTexturePipeline(), impeller::ContentContext::GetTextureStrictSrcPipeline(), impeller::ContentContext::GetTransientsBuffer(), impeller::SamplerDescriptor::height_address_mode, impeller::TRect< T >::IsEmpty(), impeller::kBase, impeller::kClampToEdge, impeller::ContentContextOptions::kIgnore, impeller::kSrc, impeller::kTextureExternalOES, impeller::kTriangleStrip, impeller::SamplerDescriptor::mag_filter, impeller::TRect< Scalar >::MakeSize(), impeller::SamplerDescriptor::min_filter, impeller::SamplerDescriptor::mip_filter, impeller::OptionsFromPassAndEntity(), impeller::TRect< T >::Project(), impeller::RenderPass::SetCommandLabel(), impeller::RenderPass::SetPipeline(), impeller::RenderPass::SetVertexBuffer(), and impeller::SamplerDescriptor::width_address_mode.
|
overridevirtual |
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)
.
Reimplemented from impeller::Contents.
Definition at line 73 of file texture_contents.cc.
References GetOpacity(), impeller::Entity::GetTransform(), impeller::kEhCloseEnough, impeller::Matrix::MakeScale(), impeller::TRect< Scalar >::MakeSize(), impeller::Matrix::MakeTranslation(), impeller::Contents::RenderToSnapshot(), and impeller::Snapshot::texture.
void impeller::TextureContents::SetDeferApplyingOpacity | ( | bool | defer_applying_opacity | ) |
Sets whether applying the opacity should be deferred.
When true, the opacity value (GetOpacity()
) might not be applied directly during rendering operations like RenderToSnapshot
. Instead, the opacity might be stored in the resulting Snapshot
to be applied later when the snapshot is drawn. This is typically used as an optimization when the texture covers its destination rectangle completely and has near-full opacity, allowing the original texture to be used directly in the snapshot.
defer_applying_opacity | True to defer applying opacity, false to apply it during rendering. |
Definition at line 255 of file texture_contents.cc.
void impeller::TextureContents::SetDestinationRect | ( | Rect | rect | ) |
Sets the destination rectangle within the current render target where the texture will be drawn.
The texture, potentially clipped by the source_rect_
, will be mapped to this rectangle. The coordinates are in the local coordinate space of the Entity.
rect | The destination rectangle in the Entity's local coordinate space. |
Definition at line 38 of file texture_contents.cc.
|
overridevirtual |
Inherit the provided opacity.
Use of this method is invalid if CanAcceptOpacity returns false.
Reimplemented from impeller::Contents.
Definition at line 58 of file texture_contents.cc.
void impeller::TextureContents::SetLabel | ( | std::string_view | label | ) |
Sets a debug label for this contents object.
This label is used for debugging purposes, for example, in graphics debuggers or logs.
label | The debug label string. |
Definition at line 34 of file texture_contents.cc.
void impeller::TextureContents::SetOpacity | ( | Scalar | opacity | ) |
Definition at line 50 of file texture_contents.cc.
void impeller::TextureContents::SetSamplerDescriptor | ( | const SamplerDescriptor & | desc | ) |
Definition at line 247 of file texture_contents.cc.
void impeller::TextureContents::SetSourceRect | ( | const Rect & | source_rect | ) |
Sets the source rectangle within the texture to sample from.
This rectangle defines the portion of the texture that will be mapped to the destination_rect_
. The coordinates are in the coordinate space of the texture (texels), with the top-left corner being (0, 0).
source_rect | The rectangle defining the area of the texture to use. |
Definition at line 231 of file texture_contents.cc.
void impeller::TextureContents::SetStencilEnabled | ( | bool | enabled | ) |
Definition at line 54 of file texture_contents.cc.
void impeller::TextureContents::SetStrictSourceRect | ( | bool | strict | ) |
Sets whether strict source rect sampling should be used.
When enabled, the texture coordinates are adjusted slightly (typically by half a texel) to ensure that linear filtering does not sample pixels outside the specified source_rect_
. This is useful for preventing edge artifacts when rendering sub-sections of a texture atlas.
strict | True to enable strict source rect sampling, false otherwise. |
Definition at line 239 of file texture_contents.cc.
void impeller::TextureContents::SetTexture | ( | std::shared_ptr< Texture > | texture | ) |
Definition at line 42 of file texture_contents.cc.