impeller::RenderPass Class Reference

Render passes encode render commands directed as one specific render target into an underlying command buffer. More...

#include <render_pass.h>

Inheritance diagram for impeller::RenderPass:

Public Member Functions
virtual	~RenderPass ()
const RenderTarget &	GetRenderTarget () const
ISize	GetRenderTargetSize () const
virtual bool	IsValid () const =0
void	SetLabel (std::string label)
HostBuffer &	GetTransientsBuffer ()
bool	AddCommand (Command &&command)
	Record a command for subsequent encoding to the underlying command buffer. No work is encoded into the command buffer at this time. More...
bool	EncodeCommands () const
	Encode the recorded commands to the underlying command buffer. More...
const std::vector< Command > &	GetCommands () const
	Accessor for the current Commands. More...

Protected Member Functions
	RenderPass (std::weak_ptr< const Context > context, const RenderTarget &target)
const std::weak_ptr< const Context > &	GetContext () const
virtual void	OnSetLabel (std::string label)=0
virtual bool	OnEncodeCommands (const Context &context) const =0

Protected Attributes
const std::weak_ptr< const Context >	context_
const RenderTarget	render_target_
std::shared_ptr< HostBuffer >	transients_buffer_
std::vector< Command >	commands_

Detailed Description

Render passes encode render commands directed as one specific render target into an underlying command buffer.

Render passes can be obtained from the command buffer in which the pass is meant to encode commands into.

See also

CommandBuffer

Definition at line 27 of file render_pass.h.

Constructor & Destructor Documentation

~RenderPass()

impeller::RenderPass::~RenderPass ( )

virtual

Definition at line 19 of file render_pass.cc.

                        {
  auto strong_context = context_.lock();
  if (strong_context) {
    strong_context->GetHostBufferPool().Recycle(transients_buffer_);
  }
}

References context_, and transients_buffer_.

RenderPass()

impeller::RenderPass::RenderPass ( std::weak_ptr< const Context >  context, const RenderTarget &  target  )

protected

Definition at line 9 of file render_pass.cc.

    : context_(std::move(context)),
      render_target_(target),
      transients_buffer_() {
  auto strong_context = context_.lock();
  FML_DCHECK(strong_context);
  transients_buffer_ = strong_context->GetHostBufferPool().Grab();
}

References context_, and transients_buffer_.

Member Function Documentation

AddCommand()

bool impeller::RenderPass::AddCommand

(

Command &&

command

)

Record a command for subsequent encoding to the underlying command buffer. No work is encoded into the command buffer at this time.

Parameters

[in]

command

The command

Returns

If the command was valid for subsequent commitment.

Definition at line 46 of file render_pass.cc.

                                             {
  if (!command) {
    VALIDATION_LOG << "Attempted to add an invalid command to the render pass.";
    return false;
  }
 
  if (command.scissor.has_value()) {
    auto target_rect = IRect({}, render_target_.GetRenderTargetSize());
    if (!target_rect.Contains(command.scissor.value())) {
      VALIDATION_LOG << "Cannot apply a scissor that lies outside the bounds "
                        "of the render target.";
      return false;
    }
  }
 
  if (command.vertex_count == 0u) {
    // Essentially a no-op. Don't record the command but this is not necessary
    // an error either.
    return true;
  }
 
  if (command.instance_count == 0u) {
    // Essentially a no-op. Don't record the command but this is not necessary
    // an error either.
    return true;
  }
 
  commands_.emplace_back(std::move(command));
  return true;
}

References commands_, impeller::RenderTarget::GetRenderTargetSize(), render_target_, and VALIDATION_LOG.

Referenced by impeller::scene::EncodeCommand(), ImGui_ImplImpeller_RenderDrawData(), impeller::CheckerboardContents::Render(), impeller::TiledTextureContents::Render(), impeller::RuntimeEffectContents::Render(), impeller::ClipContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::SolidColorContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesColorContents::Render(), impeller::AtlasContents::Render(), impeller::ClipRestoreContents::Render(), impeller::VerticesUVContents::Render(), impeller::AtlasTextureContents::Render(), impeller::AtlasColorContents::Render(), and impeller::testing::TEST_P().

EncodeCommands()

bool impeller::RenderPass::EncodeCommands

(

)

const

Encode the recorded commands to the underlying command buffer.

Returns

If the commands were encoded to the underlying command buffer.

Definition at line 77 of file render_pass.cc.

                                      {
  auto context = context_.lock();
  // The context could have been collected in the meantime.
  if (!context) {
    return false;
  }
  return OnEncodeCommands(*context);
}

References context_, and OnEncodeCommands().

GetCommands()

const std::vector<Command>& impeller::RenderPass::GetCommands ( ) const

inline

Accessor for the current Commands.

Visible for testing.

Definition at line 65 of file render_pass.h.

{ return commands_; }

References commands_.

GetContext()

const std::weak_ptr< const Context > & impeller::RenderPass::GetContext ( ) const

protected

Definition at line 86 of file render_pass.cc.

                                                               {
  return context_;
}

References context_.

GetRenderTarget()

const RenderTarget & impeller::RenderPass::GetRenderTarget

(

)

const

Definition at line 26 of file render_pass.cc.

                                                      {
  return render_target_;
}

References render_target_.

Referenced by impeller::EncodeCommandsInReactor(), impeller::scene::Material::GetContextOptions(), and impeller::OptionsFromPass().

GetRenderTargetSize()

ISize impeller::RenderPass::GetRenderTargetSize

(

)

const

Definition at line 30 of file render_pass.cc.

                                            {
  return render_target_.GetRenderTargetSize();
}

References impeller::RenderTarget::GetRenderTargetSize(), and render_target_.

Referenced by impeller::ComputeUVGeometryForRect(), impeller::EncodeCommandsInReactor(), impeller::VerticesGeometry::GetPositionBuffer(), impeller::VerticesGeometry::GetPositionColorBuffer(), impeller::VerticesGeometry::GetPositionUVBuffer(), ImGui_ImplImpeller_RenderDrawData(), impeller::SceneContents::Render(), impeller::ClipContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::AtlasContents::Render(), impeller::ClipRestoreContents::Render(), impeller::Entity::Render(), impeller::AtlasTextureContents::Render(), impeller::AtlasColorContents::Render(), and impeller::testing::TEST_P().

GetTransientsBuffer()

HostBuffer & impeller::RenderPass::GetTransientsBuffer

(

)

Definition at line 34 of file render_pass.cc.

                                            {
  return *transients_buffer_;
}

References transients_buffer_.

Referenced by impeller::ComputeUVGeometryForRect(), impeller::scene::EncodeCommand(), ImGui_ImplImpeller_RenderDrawData(), impeller::CheckerboardContents::Render(), impeller::TiledTextureContents::Render(), impeller::RuntimeEffectContents::Render(), impeller::ClipContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::SolidColorContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesColorContents::Render(), impeller::AtlasContents::Render(), impeller::ClipRestoreContents::Render(), impeller::VerticesUVContents::Render(), impeller::AtlasTextureContents::Render(), impeller::AtlasColorContents::Render(), and impeller::testing::TEST_P().

IsValid()

virtual bool impeller::RenderPass::IsValid ( ) const

pure virtual

OnEncodeCommands()

virtual bool impeller::RenderPass::OnEncodeCommands ( const Context &  context ) const

protectedpure virtual

Referenced by EncodeCommands().

OnSetLabel()

virtual void impeller::RenderPass::OnSetLabel ( std::string  label )

protectedpure virtual

Referenced by SetLabel().

SetLabel()

void impeller::RenderPass::SetLabel

(

std::string

label

)

Definition at line 38 of file render_pass.cc.

                                         {
  if (label.empty()) {
    return;
  }
  transients_buffer_->SetLabel(SPrintF("%s Transients", label.c_str()));
  OnSetLabel(std::move(label));
}

References OnSetLabel(), impeller::SPrintF(), and transients_buffer_.

Member Data Documentation

commands_

std::vector<Command> impeller::RenderPass::commands_

protected

Definition at line 71 of file render_pass.h.

Referenced by AddCommand(), impeller::EncodeCommandsInReactor(), and GetCommands().

context_

const std::weak_ptr<const Context> impeller::RenderPass::context_

protected

Definition at line 68 of file render_pass.h.

Referenced by EncodeCommands(), GetContext(), RenderPass(), and ~RenderPass().

render_target_

const RenderTarget impeller::RenderPass::render_target_

protected

Definition at line 69 of file render_pass.h.

Referenced by AddCommand(), GetRenderTarget(), and GetRenderTargetSize().

transients_buffer_

std::shared_ptr<HostBuffer> impeller::RenderPass::transients_buffer_

protected

Definition at line 70 of file render_pass.h.

Referenced by GetTransientsBuffer(), RenderPass(), SetLabel(), and ~RenderPass().

---

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

• impeller/renderer/render_pass.h
• impeller/renderer/render_pass.cc