#include <recording_render_pass.h>

Inheritance diagram for impeller::RecordingRenderPass:

Public Member Functions
	RecordingRenderPass (std::shared_ptr< RenderPass > delegate, const std::shared_ptr< const Context > &context, const RenderTarget &render_target)

	~RecordingRenderPass ()=default

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

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

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

void	SetStencilReference (uint32_t value) override

void	SetBaseVertex (uint64_t value) override

void	SetViewport (Viewport viewport) override

void	SetScissor (IRect scissor) override

void	SetInstanceCount (size_t count) override

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

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

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

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

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

void	OnSetLabel (std::string label) override

bool	OnEncodeCommands (const Context &context) const override

bool	IsValid () const override

Public Member Functions inherited from impeller::RenderPass
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. More...

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

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

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. More...

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

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. More...

virtual 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	HasDepthAttachment () const
	Whether the render target has a depth attachment. More...

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

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

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

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)=0

Additional Inherited Members
Protected Member Functions inherited from impeller::RenderPass
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...

	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 inherited from impeller::RenderPass
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

Definition at line 12 of file recording_render_pass.h.

Constructor & Destructor Documentation

◆ RecordingRenderPass()

impeller::RecordingRenderPass::RecordingRenderPass	(	std::shared_ptr< RenderPass >	delegate,
		const std::shared_ptr< const Context > &	context,
		const RenderTarget &	render_target
	)

explicit

Definition at line 11 of file recording_render_pass.cc.

15 : RenderPass(context, render_target), delegate_(std::move(delegate)) {}

impeller::RenderPass::RenderPass

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

Definition: render_pass.cc:10

◆ ~RecordingRenderPass()

impeller::RecordingRenderPass::~RecordingRenderPass ( )

default

Member Function Documentation

◆ BindResource() [1/3]

bool impeller::RecordingRenderPass::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

Reimplemented from impeller::RenderPass.

Definition at line 135 of file recording_render_pass.cc.

                                                 {
  pending_.BindResource(stage, type, slot, metadata, texture, sampler);
  if (delegate_) {
    return delegate_->BindResource(stage, type, slot, metadata, texture,
                                   sampler);
  }
  return true;
}

◆ BindResource() [2/3]

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

overridevirtual

Reimplemented from impeller::RenderPass.

Definition at line 108 of file recording_render_pass.cc.

                                                        {
  pending_.BindResource(stage, type, slot, metadata, view);
  if (delegate_) {
    return delegate_->BindResource(stage, type, slot, metadata, view);
  }
  return true;
}

◆ BindResource() [3/3]

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

overridevirtual

Reimplemented from impeller::RenderPass.

Definition at line 121 of file recording_render_pass.cc.

                     {
  pending_.BindResource(stage, type, slot, metadata, view);
  if (delegate_) {
    return delegate_->BindResource(stage, type, slot, metadata, view);
  }
  return true;
}

◆ Draw()

fml::Status impeller::RecordingRenderPass::Draw ( )

overridevirtual

Record the currently pending command.

Reimplemented from impeller::RenderPass.

Definition at line 85 of file recording_render_pass.cc.

                                    {
  commands_.emplace_back(std::move(pending_));
  pending_ = {};
  if (delegate_) {
    return delegate_->Draw();
  }
  return fml::Status();
}

◆ GetCommands()

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

inlineoverridevirtual

Accessor for the current Commands.

Visible for testing.

Reimplemented from impeller::RenderPass.

Definition at line 20 of file recording_render_pass.h.

20{ return commands_; }

◆ IsValid()

bool impeller::RecordingRenderPass::IsValid ( ) const

inlineoverridevirtual

Implements impeller::RenderPass.

Definition at line 77 of file recording_render_pass.h.

77{ return true; }

◆ OnEncodeCommands()

bool impeller::RecordingRenderPass::OnEncodeCommands ( const Context & context ) const

overridevirtual

Implements impeller::RenderPass.

Definition at line 100 of file recording_render_pass.cc.

                                                                       {
  if (delegate_) {
    return delegate_->EncodeCommands();
  }
  return true;
}

◆ OnSetLabel()

void impeller::RecordingRenderPass::OnSetLabel ( std::string label )

overridevirtual

Implements impeller::RenderPass.

Definition at line 95 of file recording_render_pass.cc.

                                                    {
  return;
}

◆ SetBaseVertex()

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

overridevirtual

Reimplemented from impeller::RenderPass.

Definition at line 44 of file recording_render_pass.cc.

                                                      {
  pending_.base_vertex = value;
  if (delegate_) {
    delegate_->SetBaseVertex(value);
  }
}

◆ SetCommandLabel()

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

overridevirtual

The debugging label to use for the command.

Reimplemented from impeller::RenderPass.

Definition at line 26 of file recording_render_pass.cc.

                                                              {
#ifdef IMPELLER_DEBUG
  pending_.label = std::string(label);
#endif  // IMPELLER_DEBUG
  if (delegate_) {
    delegate_->SetCommandLabel(label);
  }
}

◆ SetInstanceCount()

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

overridevirtual

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 from impeller::RenderPass.

Definition at line 68 of file recording_render_pass.cc.

                                                       {
  pending_.instance_count = count;
  if (delegate_) {
    delegate_->SetInstanceCount(count);
  }
}

◆ SetPipeline()

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

overridevirtual

The pipeline to use for this command.

Reimplemented from impeller::RenderPass.

Definition at line 18 of file recording_render_pass.cc.

                                                                 {
  pending_.pipeline = pipeline;
  if (delegate_) {
    delegate_->SetPipeline(pipeline);
  }
}

◆ SetScissor()

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

overridevirtual

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 from impeller::RenderPass.

Definition at line 60 of file recording_render_pass.cc.

                                                  {
  pending_.scissor = scissor;
  if (delegate_) {
    delegate_->SetScissor(scissor);
  }
}

◆ SetStencilReference()

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

overridevirtual

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 from impeller::RenderPass.

Definition at line 36 of file recording_render_pass.cc.

                                                            {
  pending_.stencil_reference = value;
  if (delegate_) {
    delegate_->SetStencilReference(value);
  }
}

◆ SetVertexBuffer()

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

overridevirtual

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 from impeller::RenderPass.

Definition at line 76 of file recording_render_pass.cc.

                                                             {
  pending_.vertex_buffer = buffer;
  if (delegate_) {
    return delegate_->SetVertexBuffer(buffer);
  }
  return true;
}

◆ SetViewport()

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

overridevirtual

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 from impeller::RenderPass.

Definition at line 52 of file recording_render_pass.cc.

                                                       {
  pending_.viewport = viewport;
  if (delegate_) {
    delegate_->SetViewport(viewport);
  }
}

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

impeller/entity/contents/test/recording_render_pass.h
impeller/entity/contents/test/recording_render_pass.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RecordingRenderPass()

◆ ~RecordingRenderPass()

Member Function Documentation

◆ BindResource() [1/3]

◆ BindResource() [2/3]

◆ BindResource() [3/3]

◆ Draw()

◆ GetCommands()

◆ IsValid()

◆ OnEncodeCommands()

◆ OnSetLabel()

◆ SetBaseVertex()

◆ SetCommandLabel()

◆ SetInstanceCount()

◆ SetPipeline()

◆ SetScissor()

◆ SetStencilReference()

◆ SetVertexBuffer()

◆ SetViewport()