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 std::weak_ptr< const Context > &	GetContext () const
const RenderTarget &	GetRenderTarget () const
ISize	GetRenderTargetSize () const
const Matrix &	GetOrthographicTransform () const
virtual bool	IsValid () const =0
void	SetLabel (std::string label)
void	ReserveCommands (size_t command_count)
	Reserve [command_count] commands in the HAL command buffer. More...
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...
SampleCount	GetSampleCount () const
	The sample count of the attached render target. More...
PixelFormat	GetRenderTargetPixelFormat () const
	The pixel format of the attached render target. More...
bool	HasStencilAttachment () const
	Whether the render target has an stencil attachment. More...

Protected Member Functions
	RenderPass (std::weak_ptr< const Context > context, const RenderTarget &target)
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 SampleCount	sample_count_
const PixelFormat	pixel_format_
const bool	has_stencil_attachment_
const ISize	render_target_size_
const RenderTarget	render_target_
std::shared_ptr< HostBuffer >	transients_buffer_
std::vector< Command >	commands_
const Matrix	orthographic_

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 29 of file render_pass.h.

Constructor & Destructor Documentation

~RenderPass()

impeller::RenderPass::~RenderPass ( )

virtual

Definition at line 24 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)),
      sample_count_(target.GetSampleCount()),
      pixel_format_(target.GetRenderTargetPixelFormat()),
      has_stencil_attachment_(target.GetStencilAttachment().has_value()),
      render_target_size_(target.GetRenderTargetSize()),
      render_target_(target),
      transients_buffer_(),
      orthographic_(Matrix::MakeOrthographic(render_target_size_)) {
  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 67 of file render_pass.cc.

                                             {
  if (!command.IsValid()) {
    VALIDATION_LOG << "Attempted to add an invalid command to the render pass.";
    return false;
  }
 
  if (command.scissor.has_value()) {
    auto target_rect = IRect::MakeSize(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_buffer.vertex_count == 0u ||
      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(), impeller::TRect< int64_t >::MakeSize(), render_target_, and VALIDATION_LOG.

Referenced by impeller::scene::EncodeCommand(), ImGui_ImplImpeller_RenderDrawData(), impeller::CheckerboardContents::Render(), impeller::RuntimeEffectContents::Render(), impeller::TiledTextureContents::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 93 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 78 of file render_pass.h.

{ return commands_; }

References commands_.

GetContext()

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

(

)

const

Definition at line 102 of file render_pass.cc.

                                                               {
  return context_;
}

References context_.

GetOrthographicTransform()

const Matrix & impeller::RenderPass::GetOrthographicTransform

(

)

const

Definition at line 51 of file render_pass.cc.

                                                         {
  return orthographic_;
}

References orthographic_.

Referenced by impeller::Geometry::ComputePositionGeometry(), impeller::Geometry::ComputePositionUVGeometry(), impeller::ComputeUVGeometryForRect(), impeller::VerticesGeometry::GetPositionBuffer(), impeller::VerticesGeometry::GetPositionColorBuffer(), impeller::VerticesGeometry::GetPositionUVBuffer(), impeller::ClipContents::Render(), impeller::SolidRRectBlurContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::AtlasContents::Render(), impeller::ClipRestoreContents::Render(), impeller::AtlasTextureContents::Render(), impeller::AtlasColorContents::Render(), and impeller::testing::TEST_P().

GetRenderTarget()

const RenderTarget & impeller::RenderPass::GetRenderTarget

(

)

const

Definition at line 43 of file render_pass.cc.

                                                      {
  return render_target_;
}

References render_target_.

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

GetRenderTargetPixelFormat()

PixelFormat impeller::RenderPass::GetRenderTargetPixelFormat

(

)

const

The pixel format of the attached render target.

Definition at line 35 of file render_pass.cc.

                                                         {
  return pixel_format_;
}

References pixel_format_.

Referenced by impeller::OptionsFromPass().

GetRenderTargetSize()

ISize impeller::RenderPass::GetRenderTargetSize

(

)

const

Definition at line 47 of file render_pass.cc.

                                            {
  return render_target_size_;
}

References render_target_size_.

Referenced by impeller::EncodeCommandsInReactor(), ImGui_ImplImpeller_RenderDrawData(), impeller::SceneContents::Render(), impeller::ClipContents::Render(), impeller::ClipRestoreContents::Render(), impeller::Entity::Render(), and impeller::testing::TEST_P().

GetSampleCount()

SampleCount impeller::RenderPass::GetSampleCount

(

)

const

The sample count of the attached render target.

Definition at line 31 of file render_pass.cc.

                                             {
  return sample_count_;
}

References sample_count_.

Referenced by impeller::OptionsFromPass().

GetTransientsBuffer()

HostBuffer & impeller::RenderPass::GetTransientsBuffer

(

)

Definition at line 55 of file render_pass.cc.

                                            {
  return *transients_buffer_;
}

References transients_buffer_.

Referenced by impeller::Geometry::ComputePositionGeometry(), impeller::Geometry::ComputePositionUVGeometry(), impeller::ComputeUVGeometryForRect(), impeller::scene::EncodeCommand(), ImGui_ImplImpeller_RenderDrawData(), impeller::CheckerboardContents::Render(), impeller::RuntimeEffectContents::Render(), impeller::TiledTextureContents::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().

HasStencilAttachment()

bool impeller::RenderPass::HasStencilAttachment

(

)

const

Whether the render target has an stencil attachment.

Definition at line 39 of file render_pass.cc.

                                            {
  return has_stencil_attachment_;
}

References has_stencil_attachment_.

Referenced by impeller::OptionsFromPass().

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().

ReserveCommands()

void impeller::RenderPass::ReserveCommands ( size_t  command_count )

inline

Reserve [command_count] commands in the HAL command buffer.

Note: this is not the native command buffer.

Definition at line 48 of file render_pass.h.

                                             {
    commands_.reserve(command_count);
  }

References commands_.

SetLabel()

void impeller::RenderPass::SetLabel

(

std::string

label

)

Definition at line 59 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 105 of file render_pass.h.

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

context_

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

protected

Definition at line 93 of file render_pass.h.

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

has_stencil_attachment_

const bool impeller::RenderPass::has_stencil_attachment_

protected

Definition at line 101 of file render_pass.h.

Referenced by HasStencilAttachment().

orthographic_

const Matrix impeller::RenderPass::orthographic_

protected

Definition at line 106 of file render_pass.h.

Referenced by GetOrthographicTransform().

pixel_format_

const PixelFormat impeller::RenderPass::pixel_format_

protected

Definition at line 100 of file render_pass.h.

Referenced by GetRenderTargetPixelFormat().

render_target_

const RenderTarget impeller::RenderPass::render_target_

protected

Definition at line 103 of file render_pass.h.

Referenced by AddCommand(), and GetRenderTarget().

render_target_size_

const ISize impeller::RenderPass::render_target_size_

protected

Definition at line 102 of file render_pass.h.

Referenced by GetRenderTargetSize().

sample_count_

const SampleCount impeller::RenderPass::sample_count_

protected

Definition at line 99 of file render_pass.h.

Referenced by GetSampleCount().

transients_buffer_

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

protected

Definition at line 104 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