compute_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_COMPUTE_PASS_MTL_H_
#define FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_COMPUTE_PASS_MTL_H_
 
#include <Metal/Metal.h>
 
#include <array>
#include <cstdint>
 
#include "impeller/renderer/backend/metal/compute_pass_bindings_cache_mtl.h"
#include "impeller/renderer/compute_pass.h"
#include "impeller/renderer/pipeline_descriptor.h"
 
namespace impeller {
 
class ComputePassMTL final : public ComputePass {
 public:
  // |RenderPass|
  ~ComputePassMTL() override;
 
 private:
  friend class CommandBufferMTL;
 
  id<MTLCommandBuffer> buffer_ = nil;
  id<MTLComputeCommandEncoder> encoder_ = nil;
  ComputePassBindingsCacheMTL pass_bindings_cache_ =
      ComputePassBindingsCacheMTL();
  // The workgroup size of the currently bound pipeline. A dimension of 0 is
  // resolved to the device maximum at dispatch.
  std::array<uint32_t, 3> workgroup_size_ = {0u, 0u, 0u};
  bool is_valid_ = false;
  bool has_label_ = false;
 
  ComputePassMTL(std::shared_ptr<const Context> context,
                 id<MTLCommandBuffer> buffer);
 
  // |ComputePass|
  bool IsValid() const override;
 
  // |ComputePass|
  fml::Status Compute(std::array<uint32_t, 3> workgroup_count) override;
 
  // |ComputePass|
  void SetCommandLabel(std::string_view label) override;
 
  // |ComputePass|
  void OnSetLabel(const std::string& label) override;
 
  // |ComputePass|
  void SetPipeline(const std::shared_ptr<Pipeline<ComputePipelineDescriptor>>&
                       pipeline) override;
 
  // |ComputePass|
  bool BindResource(ShaderStage stage,
                    DescriptorType type,
                    const ShaderUniformSlot& slot,
                    const ShaderMetadata* metadata,
                    BufferView view) override;
 
  // |ComputePass|
  bool BindResource(ShaderStage stage,
                    DescriptorType type,
                    const SampledImageSlot& slot,
                    const ShaderMetadata* metadata,
                    std::shared_ptr<const Texture> texture,
                    raw_ptr<const Sampler> sampler) override;
 
  // |ComputePass|
  bool EncodeCommands() const override;
 
  // |ComputePass|
  void AddBufferMemoryBarrier() override;
 
  // |ComputePass|
  void AddTextureMemoryBarrier() override;
 
  ComputePassMTL(const ComputePassMTL&) = delete;
 
  ComputePassMTL& operator=(const ComputePassMTL&) = delete;
};
 
}  // namespace impeller
 
#endif  // FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_COMPUTE_PASS_MTL_H_