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::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_view label)
virtual void	SetPipeline (PipelineRef pipeline)
	The pipeline to use for this command.
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 (IRect32 scissor)
virtual void	SetElementCount (size_t count)
virtual void	SetInstanceCount (size_t count)
virtual bool	SetVertexBuffer (VertexBuffer buffer)
	Specify the vertex and index buffer to use for this command.
bool	SetVertexBuffer (BufferView vertex_buffer)
	Specify a vertex buffer to use for this command.
bool	SetVertexBuffer (std::vector< BufferView > vertex_buffers)
	Specify a set of vertex buffers to use for this command.
virtual bool	SetVertexBuffer (BufferView vertex_buffers[], size_t vertex_buffer_count)
	Specify a set of vertex buffers to use for this command.
virtual bool	SetIndexBuffer (BufferView index_buffer, IndexType index_type)
	Specify an index buffer to use for this command. To unset the index buffer, pass IndexType::kNone to index_type.
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 SampledImageSlot &slot, const ShaderMetadata *metadata, std::shared_ptr< const Texture > texture, raw_ptr< const Sampler >) override
virtual bool	BindDynamicResource (ShaderStage stage, DescriptorType type, const SampledImageSlot &slot, std::unique_ptr< ShaderMetadata > metadata, std::shared_ptr< const Texture > texture, raw_ptr< const Sampler >)
	Bind with dynamically generated shader metadata.
virtual bool	BindDynamicResource (ShaderStage stage, DescriptorType type, const ShaderUniformSlot &slot, std::unique_ptr< ShaderMetadata > metadata, BufferView view)
	Bind with dynamically generated shader metadata.
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_view label)=0
virtual bool	OnEncodeCommands (const Context &context) const =0

Static Protected Member Functions
static bool	ValidateVertexBuffers (const BufferView vertex_buffers[], size_t vertex_buffer_count)
static bool	ValidateIndexBuffer (const BufferView &index_buffer, IndexType index_type)

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_
std::vector< BufferView >	vertex_buffers_
std::vector< BufferResource >	bound_buffers_
std::vector< TextureAndSampler >	bound_textures_
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 30 of file render_pass.h.

Constructor & Destructor Documentation

~RenderPass()

impeller::RenderPass::~RenderPass ( )

virtual

Definition at line 25 of file render_pass.cc.

{}

RenderPass()

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

protected

Definition at line 14 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 62 of file render_pass.cc.

                                             {
  if (!command.IsValid()) {
    VALIDATION_LOG << "Attempted to add an invalid command to the render pass.";
    return false;
  }
 
  if (command.element_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_, and VALIDATION_LOG.

Referenced by Draw().

BindDynamicResource() [1/2]

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

virtual

Bind with dynamically generated shader metadata.

Definition at line 270 of file render_pass.cc.

  {
  if (!sampler) {
    return false;
  }
  if (!texture || !texture->IsValid()) {
    return false;
  }
  TextureResource resource =
      TextureResource::MakeDynamic(std::move(metadata), std::move(texture));
  return BindTexture(stage, slot, std::move(resource), sampler);
}

References impeller::Resource< std::shared_ptr< const Texture > >::MakeDynamic(), and texture.

Referenced by impeller::RuntimeEffectContents::Render().

BindDynamicResource() [2/2]

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

virtual

Bind with dynamically generated shader metadata.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 255 of file render_pass.cc.

                                                      {
  FML_DCHECK(slot.ext_res_0 != VertexDescriptor::kReservedVertexBufferIndex);
  if (!view) {
    return false;
  }
  BufferResource resouce =
      BufferResource::MakeDynamic(std::move(metadata), std::move(view));
 
  return BindBuffer(stage, slot, std::move(resouce));
}

References impeller::ShaderUniformSlot::ext_res_0, FML_DCHECK, impeller::VertexDescriptor::kReservedVertexBufferIndex, impeller::Resource< BufferView >::MakeDynamic(), and view.

BindResource() [1/2]

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

overridevirtual

Implements impeller::ResourceBinder.

Definition at line 239 of file render_pass.cc.

                                                              {
  if (!sampler) {
    return false;
  }
  if (!texture || !texture->IsValid()) {
    return false;
  }
  TextureResource resource = TextureResource(metadata, std::move(texture));
  return BindTexture(stage, slot, std::move(resource), sampler);
}

References texture.

BindResource() [2/2]

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

overridevirtual

Implements impeller::ResourceBinder.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 225 of file render_pass.cc.

                                               {
  FML_DCHECK(slot.ext_res_0 != VertexDescriptor::kReservedVertexBufferIndex);
  if (!view) {
    return false;
  }
  BufferResource resouce = BufferResource(metadata, std::move(view));
  return BindBuffer(stage, slot, std::move(resouce));
}

References impeller::ShaderUniformSlot::ext_res_0, FML_DCHECK, impeller::VertexDescriptor::kReservedVertexBufferIndex, and view.

Referenced by impeller::RuntimeEffectContents::Render().

Draw()

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

virtual

Record the currently pending command.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 208 of file render_pass.cc.

                           {
  pending_.bound_buffers.offset = bound_buffers_start_.value_or(0u);
  pending_.bound_textures.offset = bound_textures_start_.value_or(0u);
  pending_.vertex_buffers.offset = vertex_buffers_start_.value_or(0u);
  auto result = AddCommand(std::move(pending_));
  pending_ = Command{};
  bound_textures_start_ = std::nullopt;
  bound_buffers_start_ = std::nullopt;
  vertex_buffers_start_ = std::nullopt;
  if (result) {
    return fml::Status();
  }
  return fml::Status(fml::StatusCode::kInvalidArgument,
                     "Failed to encode command");
}

References AddCommand(), impeller::Command::bound_buffers, impeller::Command::bound_textures, fml::kInvalidArgument, impeller::Range::offset, and impeller::Command::vertex_buffers.

Referenced by impeller::ColorSourceContents::DrawGeometry(), ImGui_ImplImpeller_RenderDrawData(), impeller::AtlasContents::Render(), impeller::ColorFilterAtlasContents::Render(), impeller::SolidRRectLikeBlurContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesSimpleBlendContents::Render(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), 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 78 of file render_pass.cc.

                                      {
  return OnEncodeCommands(*context_);
}

References context_, and OnEncodeCommands().

GetCommands()

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

inlinevirtual

Accessor for the current Commands.

Visible for testing.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 217 of file render_pass.h.

{ return commands_; }

References commands_.

Referenced by impeller::testing::TEST_P().

GetContext()

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

(

)

const

Definition at line 82 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::Entity::GetShaderTransform(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), 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_.

GetRenderTargetPixelFormat()

PixelFormat impeller::RenderPass::GetRenderTargetPixelFormat

(

)

const

The pixel format of the attached render target.

Definition at line 31 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 ImGui_ImplImpeller_RenderDrawData(), impeller::Entity::Render(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), and impeller::testing::TEST_P().

GetSampleCount()

SampleCount impeller::RenderPass::GetSampleCount

(

)

const

The sample count of the attached render target.

Definition at line 27 of file render_pass.cc.

                                             {
  return sample_count_;
}

References sample_count_.

Referenced by impeller::OptionsFromPass().

HasDepthAttachment()

bool impeller::RenderPass::HasDepthAttachment

(

)

const

Whether the render target has a depth attachment.

Definition at line 35 of file render_pass.cc.

                                          {
  return has_depth_attachment_;
}

References has_depth_attachment_.

Referenced by impeller::OptionsFromPass().

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

Implemented in impeller::testing::RecordingRenderPass.

OnEncodeCommands()

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

protectedpure virtual

Implemented in impeller::testing::RecordingRenderPass.

Referenced by EncodeCommands().

OnSetLabel()

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

protectedpure virtual

Implemented in impeller::testing::RecordingRenderPass.

Referenced by SetLabel().

SetBaseVertex()

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

virtual

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 107 of file render_pass.cc.

                                             {
  pending_.base_vertex = value;
}

References impeller::Command::base_vertex, and value.

Referenced by ImGui_ImplImpeller_RenderDrawData().

SetCommandLabel()

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

virtual

The debugging label to use for the command.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 97 of file render_pass.cc.

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

Referenced by impeller::ColorSourceContents::DrawGeometry(), ImGui_ImplImpeller_RenderDrawData(), impeller::AtlasContents::Render(), impeller::ColorFilterAtlasContents::Render(), impeller::SolidColorContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::TiledTextureContents::Render(), impeller::VerticesSimpleBlendContents::Render(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), impeller::SolidRRectBlurContents::SetPassInfo(), and impeller::testing::TEST_P().

SetElementCount()

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

virtual

The number of elements to draw. When only a vertex buffer is set, this is the vertex count. When an index buffer is set, this is the index count.

Definition at line 119 of file render_pass.cc.

                                             {
  pending_.element_count = count;
}

References impeller::Command::element_count.

Referenced by impeller::TextContents::Render(), and SetVertexBuffer().

SetIndexBuffer()

bool impeller::RenderPass::SetIndexBuffer ( BufferView  index_buffer, IndexType  index_type  )

virtual

Specify an index buffer to use for this command. To unset the index buffer, pass IndexType::kNone to index_type.

Parameters

[in]	index_buffer	The buffer view to use for sourcing indices. When an index buffer is bound, the vertex_count set via SetVertexBuffer is used as the number of indices to draw.
[in]	index_type	The size of each index in the index buffer. Pass IndexType::kNone to unset the index buffer.

Returns

Returns false if the index buffer view is invalid.

Definition at line 164 of file render_pass.cc.

                                                                             {
  if (!ValidateIndexBuffer(index_buffer, index_type)) {
    return false;
  }
 
  pending_.index_buffer = std::move(index_buffer);
  pending_.index_type = index_type;
  return true;
}

References impeller::Command::index_buffer, impeller::Command::index_type, and ValidateIndexBuffer().

Referenced by impeller::TextContents::Render(), and SetVertexBuffer().

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::testing::RecordingRenderPass.

Definition at line 123 of file render_pass.cc.

                                              {
  pending_.instance_count = count;
}

References impeller::Command::instance_count.

Referenced by impeller::testing::TEST_P().

SetLabel()

void impeller::RenderPass::SetLabel

(

std::string_view

label

)

Definition at line 55 of file render_pass.cc.

                                              {
  if (label.empty()) {
    return;
  }
  OnSetLabel(label);
}

References OnSetLabel().

SetPipeline() [1/2]

void impeller::RenderPass::SetPipeline

(

const std::shared_ptr< Pipeline< PipelineDescriptor > > &

pipeline

)

The pipeline to use for this command.

Definition at line 92 of file render_pass.cc.

                                                                 {
  SetPipeline(PipelineRef(pipeline));
}

References SetPipeline().

SetPipeline() [2/2]

void impeller::RenderPass::SetPipeline ( PipelineRef  pipeline )

virtual

The pipeline to use for this command.

Reimplemented in impeller::testing::RecordingRenderPass.

Definition at line 86 of file render_pass.cc.

                                                 {
  // On debug this makes a difference, but not on release builds.
  // NOLINTNEXTLINE(performance-move-const-arg)
  pending_.pipeline = std::move(pipeline);
}

References impeller::Command::pipeline.

Referenced by impeller::ColorSourceContents::DrawGeometry(), ImGui_ImplImpeller_RenderDrawData(), impeller::AtlasContents::Render(), impeller::ColorFilterAtlasContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesSimpleBlendContents::Render(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), impeller::SolidRRectBlurContents::SetPassInfo(), SetPipeline(), and impeller::testing::TEST_P().

SetScissor()

void impeller::RenderPass::SetScissor ( IRect32  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::testing::RecordingRenderPass.

Definition at line 115 of file render_pass.cc.

                                           {
  pending_.scissor = scissor;
}

References impeller::Command::scissor.

Referenced by ImGui_ImplImpeller_RenderDrawData().

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::testing::RecordingRenderPass.

Definition at line 103 of file render_pass.cc.

                                                   {
  pending_.stencil_reference = value;
}

References impeller::Command::stencil_reference, and value.

Referenced by impeller::ColorSourceContents::DrawGeometry(), impeller::ClipContents::Render(), and impeller::RenderClipRestore().

SetVertexBuffer() [1/4]

bool impeller::RenderPass::SetVertexBuffer

(

BufferView

vertex_buffer

)

Specify a vertex buffer to use for this command.

Parameters

[in]

vertex_buffer

The buffer view to use for sourcing vertices.

Returns

Returns false if the given buffer view is invalid.

Definition at line 139 of file render_pass.cc.

                                                         {
  return SetVertexBuffer(&vertex_buffer, 1);
}

References SetVertexBuffer().

SetVertexBuffer() [2/4]

bool impeller::RenderPass::SetVertexBuffer ( BufferView  vertex_buffers[], size_t  vertex_buffer_count  )

virtual

Specify a set of vertex buffers to use for this command.

Warning

This method takes ownership of each buffer view in the vector. Attempting to use the given buffer views after this call is invalid.

Parameters

[in]	vertex_buffers	Pointer to an array of vertex buffers to be copied. The maximum number of vertex buffers is 16.
[in]	vertex_buffer_count	The number of vertex buffers to copy from the array (max 16).

Returns

Returns false if any of the given buffer views are invalid.

Definition at line 147 of file render_pass.cc.

                                                             {
  if (!ValidateVertexBuffers(vertex_buffers, vertex_buffer_count)) {
    return false;
  }
 
  if (!vertex_buffers_start_.has_value()) {
    vertex_buffers_start_ = vertex_buffers_.size();
  }
 
  pending_.vertex_buffers.length += vertex_buffer_count;
  for (size_t i = 0; i < vertex_buffer_count; i++) {
    vertex_buffers_.push_back(vertex_buffers[i]);
  }
  return true;
}

References i, impeller::Range::length, ValidateVertexBuffers(), impeller::Command::vertex_buffers, and vertex_buffers_.

SetVertexBuffer() [3/4]

bool impeller::RenderPass::SetVertexBuffer

(

std::vector< BufferView >

vertex_buffers

)

Specify a set of vertex buffers to use for this command.

Warning

This method takes ownership of each buffer view in the vector. Attempting to use the given buffer views after this call is invalid.

Parameters

[in]

vertex_buffers

The array of vertex buffer views to use. The maximum number of vertex buffers is 16.

Returns

Returns false if any of the given buffer views are invalid.

Definition at line 143 of file render_pass.cc.

                                                                     {
  return SetVertexBuffer(vertex_buffers.data(), vertex_buffers.size());
}

References SetVertexBuffer().

SetVertexBuffer() [4/4]

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::testing::RecordingRenderPass.

Definition at line 127 of file render_pass.cc.

                                                    {
  if (!SetVertexBuffer(&buffer.vertex_buffer, 1u)) {
    return false;
  }
  if (!SetIndexBuffer(buffer.index_buffer, buffer.index_type)) {
    return false;
  }
  SetElementCount(buffer.vertex_count);
 
  return true;
}

References SetElementCount(), SetIndexBuffer(), and SetVertexBuffer().

Referenced by impeller::ColorSourceContents::DrawGeometry(), ImGui_ImplImpeller_RenderDrawData(), impeller::AtlasContents::Render(), impeller::ColorFilterAtlasContents::Render(), impeller::SolidRRectLikeBlurContents::Render(), impeller::TextContents::Render(), impeller::TextureContents::Render(), impeller::VerticesSimpleBlendContents::Render(), impeller::ClipContents::Render(), impeller::RenderClipRestore(), SetVertexBuffer(), SetVertexBuffer(), SetVertexBuffer(), and impeller::testing::TEST_P().

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::testing::RecordingRenderPass.

Definition at line 111 of file render_pass.cc.

                                              {
  pending_.viewport = viewport;
}

References impeller::Command::viewport.

Referenced by ImGui_ImplImpeller_RenderDrawData().

ValidateIndexBuffer()

bool impeller::RenderPass::ValidateIndexBuffer ( const BufferView &  index_buffer, IndexType  index_type  )

staticprotected

Definition at line 193 of file render_pass.cc.

                                                           {
  if (index_type == IndexType::kUnknown) {
    VALIDATION_LOG << "Cannot bind an index buffer with an unknown index type.";
    return false;
  }
 
  if (index_type != IndexType::kNone && !index_buffer) {
    VALIDATION_LOG << "Attempted to bind an invalid index buffer.";
    return false;
  }
 
  return true;
}

References impeller::kNone, impeller::kUnknown, and VALIDATION_LOG.

Referenced by SetIndexBuffer().

ValidateVertexBuffers()

bool impeller::RenderPass::ValidateVertexBuffers ( const BufferView  vertex_buffers[], size_t  vertex_buffer_count  )

staticprotected

Definition at line 174 of file render_pass.cc.

                                                                   {
  if (vertex_buffer_count > kMaxVertexBuffers) {
    VALIDATION_LOG << "Attempted to bind " << vertex_buffer_count
                   << " vertex buffers, but the maximum is "
                   << kMaxVertexBuffers << ".";
    return false;
  }
 
  for (size_t i = 0; i < vertex_buffer_count; i++) {
    if (!vertex_buffers[i]) {
      VALIDATION_LOG << "Attempted to bind an invalid vertex buffer.";
      return false;
    }
  }
 
  return true;
}

References i, impeller::kMaxVertexBuffers, and VALIDATION_LOG.

Referenced by SetVertexBuffer().

Member Data Documentation

bound_buffers_

std::vector<BufferResource> impeller::RenderPass::bound_buffers_

protected

Definition at line 250 of file render_pass.h.

bound_textures_

std::vector<TextureAndSampler> impeller::RenderPass::bound_textures_

protected

Definition at line 251 of file render_pass.h.

commands_

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

protected

Definition at line 248 of file render_pass.h.

Referenced by AddCommand(), and GetCommands().

context_

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

protected

Definition at line 236 of file render_pass.h.

Referenced by EncodeCommands(), and GetContext().

has_depth_attachment_

const bool impeller::RenderPass::has_depth_attachment_

protected

Definition at line 244 of file render_pass.h.

Referenced by HasDepthAttachment().

has_stencil_attachment_

const bool impeller::RenderPass::has_stencil_attachment_

protected

Definition at line 245 of file render_pass.h.

Referenced by HasStencilAttachment().

orthographic_

const Matrix impeller::RenderPass::orthographic_

protected

Definition at line 252 of file render_pass.h.

Referenced by GetOrthographicTransform().

pixel_format_

const PixelFormat impeller::RenderPass::pixel_format_

protected

Definition at line 243 of file render_pass.h.

Referenced by GetRenderTargetPixelFormat().

render_target_

const RenderTarget impeller::RenderPass::render_target_

protected

Definition at line 247 of file render_pass.h.

Referenced by GetRenderTarget().

render_target_size_

const ISize impeller::RenderPass::render_target_size_

protected

Definition at line 246 of file render_pass.h.

Referenced by GetRenderTargetSize().

sample_count_

const SampleCount impeller::RenderPass::sample_count_

protected

Definition at line 242 of file render_pass.h.

Referenced by GetSampleCount().

vertex_buffers_

std::vector<BufferView> impeller::RenderPass::vertex_buffers_

protected

Definition at line 249 of file render_pass.h.

Referenced by SetVertexBuffer().

---

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

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