#include <render_pass_mtl.h>

Inheritance diagram for impeller::RenderPassMTL:

Public Member Functions
	~RenderPassMTL () 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

void	SetLabel (std::string label)

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

Private Member Functions
void	ReserveCommands (size_t command_count) override
	Reserve [command_count] commands in the HAL command buffer.

bool	IsValid () const override

void	OnSetLabel (std::string label) override

bool	OnEncodeCommands (const Context &context) const override

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

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

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.

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

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

Friends
class	CommandBufferMTL

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.

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

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 17 of file render_pass_mtl.h.

Constructor & Destructor Documentation

◆ ~RenderPassMTL()

impeller::RenderPassMTL::~RenderPassMTL ( )

override

Definition at line 163 of file render_pass_mtl.mm.

                              {
  if (!did_finish_encoding_) {
    [encoder_ endEncoding];
    did_finish_encoding_ = true;
  }
}

Member Function Documentation

◆ BindResource() [1/3]

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

overrideprivatevirtual

Reimplemented from impeller::RenderPass.

Definition at line 387 of file render_pass_mtl.mm.

                                                 {
  return Bind(pass_bindings_, stage, slot.texture_index, sampler, *texture);
}

◆ BindResource() [2/3]

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

overrideprivatevirtual

Reimplemented from impeller::RenderPass.

Definition at line 368 of file render_pass_mtl.mm.

                                                  {
  return Bind(pass_bindings_, stage, slot.ext_res_0, view);
}

◆ BindResource() [3/3]

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

overrideprivatevirtual

Reimplemented from impeller::RenderPass.

Definition at line 377 of file render_pass_mtl.mm.

                     {
  return Bind(pass_bindings_, stage, slot.ext_res_0, view);
}

◆ Draw()

fml::Status impeller::RenderPassMTL::Draw ( )

overrideprivatevirtual

Record the currently pending command.

Reimplemented from impeller::RenderPass.

Definition at line 313 of file render_pass_mtl.mm.

                              {
  if (!has_valid_pipeline_) {
    return fml::Status(fml::StatusCode::kCancelled, "Invalid pipeline.");
  }
 
  if (!index_buffer_) {
    if (instance_count_ != 1u) {
      [encoder_ drawPrimitives:ToMTLPrimitiveType(primitive_type_)
                   vertexStart:base_vertex_
                   vertexCount:vertex_count_
                 instanceCount:instance_count_
                  baseInstance:0u];
    } else {
      [encoder_ drawPrimitives:ToMTLPrimitiveType(primitive_type_)
                   vertexStart:base_vertex_
                   vertexCount:vertex_count_];
    }
  } else {
    id<MTLBuffer> mtl_index_buffer =
        DeviceBufferMTL::Cast(*index_buffer_.buffer).GetMTLBuffer();
    if (instance_count_ != 1u) {
      [encoder_ drawIndexedPrimitives:ToMTLPrimitiveType(primitive_type_)
                           indexCount:vertex_count_
                            indexType:index_type_
                          indexBuffer:mtl_index_buffer
                    indexBufferOffset:index_buffer_.range.offset
                        instanceCount:instance_count_
                           baseVertex:base_vertex_
                         baseInstance:0u];
    } else {
      [encoder_ drawIndexedPrimitives:ToMTLPrimitiveType(primitive_type_)
                           indexCount:vertex_count_
                            indexType:index_type_
                          indexBuffer:mtl_index_buffer
                    indexBufferOffset:index_buffer_.range.offset];
    }
  }
 
#ifdef IMPELLER_DEBUG
  if (has_label_) {
    [encoder_ popDebugGroup];
  }
#endif  // IMPELLER_DEBUG
 
  vertex_count_ = 0u;
  base_vertex_ = 0u;
  instance_count_ = 1u;
  index_buffer_ = {};
  has_valid_pipeline_ = false;
  has_label_ = false;
 
  return fml::Status();
}

◆ IsValid()

bool impeller::RenderPassMTL::IsValid ( ) const

overrideprivatevirtual

Implements impeller::RenderPass.

Definition at line 170 of file render_pass_mtl.mm.

                                  {
  return is_valid_;
}

◆ OnEncodeCommands()

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

overrideprivatevirtual

Implements impeller::RenderPass.

Definition at line 183 of file render_pass_mtl.mm.

                                                                 {
  did_finish_encoding_ = true;
  [encoder_ endEncoding];
  return true;
}

◆ OnSetLabel()

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

overrideprivatevirtual

Implements impeller::RenderPass.

Definition at line 174 of file render_pass_mtl.mm.

                                              {
#ifdef IMPELLER_DEBUG
  if (label.empty()) {
    return;
  }
  encoder_.label = @(std::string(label).c_str());
#endif  // IMPELLER_DEBUG
}

◆ ReserveCommands()

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

inlineoverrideprivatevirtual

Reserve [command_count] commands in the HAL command buffer.

Note: this is not the native command buffer.

Reimplemented from impeller::RenderPass.

Definition at line 53 of file render_pass_mtl.h.

53{}

◆ SetBaseVertex()

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

overrideprivatevirtual

Reimplemented from impeller::RenderPass.

Definition at line 273 of file render_pass_mtl.mm.

                                                {
  base_vertex_ = value;
}

◆ SetCommandLabel()

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

overrideprivatevirtual

The debugging label to use for the command.

Reimplemented from impeller::RenderPass.

Definition at line 257 of file render_pass_mtl.mm.

                                                        {
#ifdef IMPELLER_DEBUG
  if (is_metal_trace_active_) {
    has_label_ = true;
    std::string label_copy(label);
    [encoder_ pushDebugGroup:@(label_copy.c_str())];
  }
#endif  // IMPELLER_DEBUG
}

◆ SetInstanceCount()

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

overrideprivatevirtual

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 288 of file render_pass_mtl.mm.

                                                 {
  instance_count_ = count;
}

◆ SetPipeline()

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

overrideprivatevirtual

The pipeline to use for this command.

Reimplemented from impeller::RenderPass.

Definition at line 237 of file render_pass_mtl.mm.

                                                                 {
  const PipelineDescriptor& pipeline_desc = pipeline->GetDescriptor();
  primitive_type_ = pipeline_desc.GetPrimitiveType();
  pass_bindings_.SetRenderPipelineState(
      PipelineMTL::Cast(*pipeline).GetMTLRenderPipelineState());
  pass_bindings_.SetDepthStencilState(
      PipelineMTL::Cast(*pipeline).GetMTLDepthStencilState());
 
  [encoder_ setFrontFacingWinding:pipeline_desc.GetWindingOrder() ==
                                          WindingOrder::kClockwise
                                      ? MTLWindingClockwise
                                      : MTLWindingCounterClockwise];
  [encoder_ setCullMode:ToMTLCullMode(pipeline_desc.GetCullMode())];
  [encoder_ setTriangleFillMode:ToMTLTriangleFillMode(
                                    pipeline_desc.GetPolygonMode())];
  has_valid_pipeline_ = true;
}

◆ SetScissor()

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

overrideprivatevirtual

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 283 of file render_pass_mtl.mm.

                                            {
  pass_bindings_.SetScissor(scissor);
}

◆ SetStencilReference()

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

overrideprivatevirtual

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 268 of file render_pass_mtl.mm.

                                                      {
  [encoder_ setStencilReferenceValue:value];
}

◆ SetVertexBuffer()

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

overrideprivatevirtual

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 293 of file render_pass_mtl.mm.

                                                       {
  if (buffer.index_type == IndexType::kUnknown) {
    return false;
  }
 
  if (!Bind(pass_bindings_, ShaderStage::kVertex,
            VertexDescriptor::kReservedVertexBufferIndex,
            buffer.vertex_buffer)) {
    return false;
  }
 
  vertex_count_ = buffer.vertex_count;
  if (buffer.index_type != IndexType::kNone) {
    index_type_ = ToMTLIndexType(buffer.index_type);
    index_buffer_ = std::move(buffer.index_buffer);
  }
  return true;
}

◆ SetViewport()

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

overrideprivatevirtual

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 278 of file render_pass_mtl.mm.

                                                 {
  pass_bindings_.SetViewport(viewport);
}

Friends And Related Symbol Documentation

◆ CommandBufferMTL

friend class CommandBufferMTL

friend

Definition at line 23 of file render_pass_mtl.h.

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

impeller/renderer/backend/metal/render_pass_mtl.h
impeller/renderer/backend/metal/render_pass_mtl.mm

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~RenderPassMTL()

Member Function Documentation

◆ BindResource() [1/3]

◆ BindResource() [2/3]

◆ BindResource() [3/3]

◆ Draw()

◆ IsValid()

◆ OnEncodeCommands()

◆ OnSetLabel()

◆ ReserveCommands()

◆ SetBaseVertex()

◆ SetCommandLabel()

◆ SetInstanceCount()

◆ SetPipeline()

◆ SetScissor()

◆ SetStencilReference()

◆ SetVertexBuffer()

◆ SetViewport()

Friends And Related Symbol Documentation

◆ CommandBufferMTL