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::shared_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)

virtual void	ReserveCommands (size_t command_count)
	Reserve [command_count] commands in the HAL command buffer.

virtual void	SetPipeline (const std::shared_ptr< Pipeline< PipelineDescriptor > > &pipeline)
	The pipeline to use for this command.

virtual void	SetCommandLabel (std::string_view label)
	The debugging label to use for the command.

virtual void	SetStencilReference (uint32_t value)

virtual void	SetBaseVertex (uint64_t value)

virtual void	SetViewport (Viewport viewport)

virtual void	SetScissor (IRect scissor)

virtual void	SetInstanceCount (size_t count)

virtual bool	SetVertexBuffer (VertexBuffer buffer)
	Specify the vertex and index buffer to use for this command.

virtual fml::Status	Draw ()
	Record the currently pending command.

virtual bool	BindResource (ShaderStage stage, DescriptorType type, const ShaderUniformSlot &slot, const ShaderMetadata &metadata, BufferView view) override

virtual bool	BindResource (ShaderStage stage, DescriptorType type, const ShaderUniformSlot &slot, const std::shared_ptr< const ShaderMetadata > &metadata, BufferView view)

virtual bool	BindResource (ShaderStage stage, DescriptorType type, const SampledImageSlot &slot, const ShaderMetadata &metadata, std::shared_ptr< const Texture > texture, const std::unique_ptr< const Sampler > &sampler) override

bool	EncodeCommands () const
	Encode the recorded commands to the underlying command buffer.

virtual const std::vector< Command > &	GetCommands () const
	Accessor for the current Commands.

SampleCount	GetSampleCount () const
	The sample count of the attached render target.

PixelFormat	GetRenderTargetPixelFormat () const
	The pixel format of the attached render target.

bool	HasDepthAttachment () const
	Whether the render target has a depth attachment.

bool	HasStencilAttachment () const
	Whether the render target has an stencil attachment.

Public Member Functions inherited from impeller::ResourceBinder
virtual	~ResourceBinder ()=default

Protected Member Functions
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.

	RenderPass (std::shared_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::shared_ptr< const Context >	context_

const SampleCount	sample_count_

const PixelFormat	pixel_format_

const bool	has_depth_attachment_

const bool	has_stencil_attachment_

const ISize	render_target_size_

const RenderTarget	render_target_

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

Constructor & Destructor Documentation

◆ ~RenderPass()

impeller::RenderPass::~RenderPass ( )

virtual

Definition at line 21 of file render_pass.cc.

21{}

◆ RenderPass()

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

protected

Definition at line 10 of file render_pass.cc.

    : context_(std::move(context)),
      sample_count_(target.GetSampleCount()),
      pixel_format_(target.GetRenderTargetPixelFormat()),
      has_depth_attachment_(target.GetDepthAttachment().has_value()),
      has_stencil_attachment_(target.GetStencilAttachment().has_value()),
      render_target_size_(target.GetRenderTargetSize()),
      render_target_(target),
      orthographic_(Matrix::MakeOrthographic(render_target_size_)) {}

Member Function Documentation

◆ AddCommand()

bool impeller::RenderPass::AddCommand ( Command && command )

protected

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 58 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;
}

◆ BindResource() [1/3]

bool impeller::RenderPass::BindResource	(	ShaderStage	stage,
		DescriptorType	type,
		const SampledImageSlot &	slot,
		const ShaderMetadata &	metadata,
		std::shared_ptr< const Texture >	texture,
		const std::unique_ptr< const Sampler > &	sampler
	)

overridevirtual

Implements impeller::ResourceBinder.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 156 of file render_pass.cc.

                                                                           {
  return pending_.BindResource(stage, type, slot, metadata, std::move(texture),
                               sampler);
}

◆ BindResource() [2/3]

bool impeller::RenderPass::BindResource	(	ShaderStage	stage,
		DescriptorType	type,
		const ShaderUniformSlot &	slot,
		const ShaderMetadata &	metadata,
		BufferView	view
	)

overridevirtual

Implements impeller::ResourceBinder.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 138 of file render_pass.cc.

                                               {
  return pending_.BindResource(stage, type, slot, metadata, view);
}

◆ BindResource() [3/3]

bool impeller::RenderPass::BindResource	(	ShaderStage	stage,
		DescriptorType	type,
		const ShaderUniformSlot &	slot,
		const std::shared_ptr< const ShaderMetadata > &	metadata,
		BufferView	view
	)

virtual

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 146 of file render_pass.cc.

                     {
  return pending_.BindResource(stage, type, slot, metadata, std::move(view));
}

◆ Draw()

fml::Status impeller::RenderPass::Draw ( )

virtual

Record the currently pending command.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 127 of file render_pass.cc.

                           {
  auto result = AddCommand(std::move(pending_));
  pending_ = Command{};
  if (result) {
    return fml::Status();
  }
  return fml::Status(fml::StatusCode::kInvalidArgument,
                     "Failed to encode command");
}

◆ 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 84 of file render_pass.cc.

                                      {
  return OnEncodeCommands(*context_);
}

◆ GetCommands()

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

inlinevirtual

Accessor for the current Commands.

Visible for testing.

Reimplemented in impeller::RecordingRenderPass.

Definition at line 149 of file render_pass.h.

149{ return commands_; }

◆ GetContext()

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

Definition at line 88 of file render_pass.cc.

                                                                 {
  return context_;
}

◆ GetOrthographicTransform()

const Matrix & impeller::RenderPass::GetOrthographicTransform ( ) const

Definition at line 47 of file render_pass.cc.

                                                         {
  return orthographic_;
}

◆ GetRenderTarget()

const RenderTarget & impeller::RenderPass::GetRenderTarget ( ) const

Definition at line 39 of file render_pass.cc.

                                                      {
  return render_target_;
}

◆ GetRenderTargetPixelFormat()

PixelFormat impeller::RenderPass::GetRenderTargetPixelFormat ( ) const

The pixel format of the attached render target.

Definition at line 27 of file render_pass.cc.

                                                         {
  return pixel_format_;
}

◆ GetRenderTargetSize()

ISize impeller::RenderPass::GetRenderTargetSize ( ) const

Definition at line 43 of file render_pass.cc.

                                            {
  return render_target_size_;
}

◆ GetSampleCount()

SampleCount impeller::RenderPass::GetSampleCount ( ) const

The sample count of the attached render target.

Definition at line 23 of file render_pass.cc.

                                             {
  return sample_count_;
}

◆ HasDepthAttachment()

bool impeller::RenderPass::HasDepthAttachment ( ) const

Whether the render target has a depth attachment.

Definition at line 31 of file render_pass.cc.

                                          {
  return has_depth_attachment_;
}

◆ HasStencilAttachment()

bool impeller::RenderPass::HasStencilAttachment ( ) const

Whether the render target has an stencil attachment.

Definition at line 35 of file render_pass.cc.

                                            {
  return has_stencil_attachment_;
}

◆ IsValid()

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

pure virtual

Implemented in impeller::RecordingRenderPass, impeller::RenderPassGLES, impeller::RenderPassMTL, and impeller::RenderPassVK.

◆ OnEncodeCommands()

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

protectedpure virtual

Implemented in impeller::RecordingRenderPass, impeller::RenderPassGLES, impeller::RenderPassMTL, and impeller::RenderPassVK.

◆ OnSetLabel()

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

protectedpure virtual

Implemented in impeller::RecordingRenderPass, impeller::RenderPassGLES, impeller::RenderPassMTL, and impeller::RenderPassVK.

◆ ReserveCommands()

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

inlinevirtual

Reserve [command_count] commands in the HAL command buffer.

Note: this is not the native command buffer.

Reimplemented in impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 52 of file render_pass.h.

                                                     {
    commands_.reserve(command_count);
  }

◆ SetBaseVertex()

void impeller::RenderPass::SetBaseVertex ( uint64_t value )

virtual

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 107 of file render_pass.cc.

                                             {
  pending_.base_vertex = value;
}

◆ SetCommandLabel()

void impeller::RenderPass::SetCommandLabel ( std::string_view label )

virtual

The debugging label to use for the command.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 97 of file render_pass.cc.

                                                     {
#ifdef IMPELLER_DEBUG
  pending_.label = std::string(label);
#endif  // IMPELLER_DEBUG
}

◆ SetInstanceCount()

void impeller::RenderPass::SetInstanceCount ( size_t count )

virtual

The number of instances of the given set of vertices to render. Not all backends support rendering more than one instance at a time.

Warning: Setting this to more than one will limit the availability of backends to use with this command.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 119 of file render_pass.cc.

                                              {
  pending_.instance_count = count;
}

◆ SetLabel()

void impeller::RenderPass::SetLabel ( std::string label )

Definition at line 51 of file render_pass.cc.

                                         {
  if (label.empty()) {
    return;
  }
  OnSetLabel(std::move(label));
}

◆ SetPipeline()

void impeller::RenderPass::SetPipeline ( const std::shared_ptr< Pipeline< PipelineDescriptor > > & pipeline )

virtual

The pipeline to use for this command.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 92 of file render_pass.cc.

                                                                 {
  pending_.pipeline = pipeline;
}

◆ SetScissor()

void impeller::RenderPass::SetScissor ( IRect scissor )

virtual

The scissor rect to use for clipping writes to the render target. The scissor rect must lie entirely within the render target. If unset, no scissor is applied.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 115 of file render_pass.cc.

                                         {
  pending_.scissor = scissor;
}

◆ SetStencilReference()

void impeller::RenderPass::SetStencilReference ( uint32_t value )

virtual

The reference value to use in stenciling operations. Stencil configuration is part of pipeline setup and can be read from the pipelines descriptor.

See also: Pipeline; PipelineDescriptor

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 103 of file render_pass.cc.

                                                   {
  pending_.stencil_reference = value;
}

◆ SetVertexBuffer()

bool impeller::RenderPass::SetVertexBuffer ( VertexBuffer buffer )

virtual

Specify the vertex and index buffer to use for this command.

Parameters

[in] buffer The vertex and index buffer definition. If possible, this value should be moved and not copied.

Returns: returns if the binding was updated.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 123 of file render_pass.cc.

                                                    {
  return pending_.BindVertices(std::move(buffer));
}

◆ SetViewport()

void impeller::RenderPass::SetViewport ( Viewport viewport )

virtual

The viewport coordinates that the rasterizer linearly maps normalized device coordinates to. If unset, the viewport is the size of the render target with a zero origin, znear=0, and zfar=1.

Reimplemented in impeller::RecordingRenderPass, impeller::RenderPassMTL, and impeller::RenderPassVK.

Definition at line 111 of file render_pass.cc.

                                              {
  pending_.viewport = viewport;
}

Member Data Documentation

◆ commands_

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

protected

Definition at line 180 of file render_pass.h.

◆ context_

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

protected

Definition at line 168 of file render_pass.h.

◆ has_depth_attachment_

const bool impeller::RenderPass::has_depth_attachment_

protected

Definition at line 176 of file render_pass.h.

◆ has_stencil_attachment_

const bool impeller::RenderPass::has_stencil_attachment_

protected

Definition at line 177 of file render_pass.h.

◆ orthographic_

const Matrix impeller::RenderPass::orthographic_

protected

Definition at line 181 of file render_pass.h.

◆ pixel_format_

const PixelFormat impeller::RenderPass::pixel_format_

protected

Definition at line 175 of file render_pass.h.

◆ render_target_

const RenderTarget impeller::RenderPass::render_target_

protected

Definition at line 179 of file render_pass.h.

◆ render_target_size_

const ISize impeller::RenderPass::render_target_size_

protected

Definition at line 178 of file render_pass.h.

◆ sample_count_

const SampleCount impeller::RenderPass::sample_count_

protected

Definition at line 174 of file render_pass.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~RenderPass()

◆ RenderPass()

Member Function Documentation

◆ AddCommand()

◆ BindResource() [1/3]

◆ BindResource() [2/3]

◆ BindResource() [3/3]

◆ Draw()

◆ EncodeCommands()

◆ GetCommands()

◆ GetContext()

◆ GetOrthographicTransform()

◆ GetRenderTarget()

◆ GetRenderTargetPixelFormat()

◆ GetRenderTargetSize()

◆ GetSampleCount()

◆ HasDepthAttachment()

◆ HasStencilAttachment()

◆ IsValid()

◆ OnEncodeCommands()

◆ OnSetLabel()

◆ ReserveCommands()

◆ SetBaseVertex()

◆ SetCommandLabel()

◆ SetInstanceCount()

◆ SetLabel()

◆ SetPipeline()

◆ SetScissor()

◆ SetStencilReference()

◆ SetVertexBuffer()

◆ SetViewport()

Member Data Documentation

◆ commands_

◆ context_

◆ has_depth_attachment_

◆ has_stencil_attachment_

◆ orthographic_

◆ pixel_format_

◆ render_target_

◆ render_target_size_

◆ sample_count_