render_pass_mtl.h

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_RENDER_PASS_MTL_H_
#define FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_RENDER_PASS_MTL_H_
 
#include <Metal/Metal.h>
 
#include "impeller/renderer/backend/metal/pass_bindings_cache_mtl.h"
#include "impeller/renderer/render_pass.h"
#include "impeller/renderer/render_target.h"
 
namespace impeller {
 
class RenderPassMTL final : public RenderPass {
 public:
  // |RenderPass|
  ~RenderPassMTL() override;
 
 private:
  friend class CommandBufferMTL;
 
  id<MTLCommandBuffer> buffer_ = nil;
  id<MTLRenderCommandEncoder> encoder_ = nil;
  MTLRenderPassDescriptor* desc_ = nil;
  std::string label_;
  bool is_metal_trace_active_ = false;
  bool is_valid_ = false;
  // Many parts of the codebase will start writing to a render pass but
  // never submit them. This boolean is used to track if a submit happened
  // so that in the dtor we can always ensure the render pass is finished.
  mutable bool did_finish_encoding_ = false;
 
  PassBindingsCacheMTL pass_bindings_;
 
  // Per-command state
  size_t instance_count_ = 1u;
  size_t base_vertex_ = 0u;
  size_t vertex_count_ = 0u;
  bool has_valid_pipeline_ = false;
  bool has_label_ = false;
  BufferView index_buffer_ = {};
  PrimitiveType primitive_type_ = {};
  MTLIndexType index_type_ = {};
 
  RenderPassMTL(std::shared_ptr<const Context> context,
                const RenderTarget& target,
                id<MTLCommandBuffer> buffer);
 
  // |RenderPass|
  bool IsValid() const override;
 
  // |RenderPass|
  void OnSetLabel(std::string_view label) override;
 
  // |RenderPass|
  bool OnEncodeCommands(const Context& context) const override;
 
  // |RenderPass|
  void SetPipeline(PipelineRef pipeline) override;
 
  // |RenderPass|
  void SetCommandLabel(std::string_view label) override;
 
  // |RenderPass|
  void SetStencilReference(uint32_t value) override;
 
  // |RenderPass|
  void SetBaseVertex(uint64_t value) override;
 
  // |RenderPass|
  void SetViewport(Viewport viewport) override;
 
  // |RenderPass|
  void SetScissor(IRect32 scissor) override;
 
  // |RenderPass|
  void SetElementCount(size_t count) override;
 
  // |RenderPass|
  void SetInstanceCount(size_t count) override;
 
  // |RenderPass|
  bool SetVertexBuffer(BufferView vertex_buffers[],
                       size_t vertex_buffer_count) override;
 
  // |RenderPass|
  bool SetIndexBuffer(BufferView index_buffer, IndexType index_type) override;
 
  // |RenderPass|
  fml::Status Draw() override;
 
  // |RenderPass|
  bool BindResource(ShaderStage stage,
                    DescriptorType type,
                    const ShaderUniformSlot& slot,
                    const ShaderMetadata* metadata,
                    BufferView view) override;
 
  // |RenderPass|
  bool BindResource(ShaderStage stage,
                    DescriptorType type,
                    const SampledImageSlot& slot,
                    const ShaderMetadata* metadata,
                    std::shared_ptr<const Texture> texture,
                    raw_ptr<const Sampler> sampler) override;
 
  // |RenderPass|
  bool BindDynamicResource(ShaderStage stage,
                           DescriptorType type,
                           const ShaderUniformSlot& slot,
                           std::unique_ptr<ShaderMetadata> metadata,
                           BufferView view) override;
 
  // |RenderPass|
  bool BindDynamicResource(ShaderStage stage,
                           DescriptorType type,
                           const SampledImageSlot& slot,
                           std::unique_ptr<ShaderMetadata> metadata,
                           std::shared_ptr<const Texture> texture,
                           raw_ptr<const Sampler> sampler) override;
 
  RenderPassMTL(const RenderPassMTL&) = delete;
 
  RenderPassMTL& operator=(const RenderPassMTL&) = delete;
};
 
}  // namespace impeller
 
#endif  // FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_RENDER_PASS_MTL_H_