Flutter Impeller
blit_pass_mtl.h
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_BLIT_PASS_MTL_H_
6 #define FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_BLIT_PASS_MTL_H_
7 
8 #include <Metal/Metal.h>
9 
11 
12 namespace impeller {
13 
14 class BlitPassMTL final : public BlitPass {
15  public:
16  // |RenderPass|
17  ~BlitPassMTL() override;
18 
19  private:
20  friend class CommandBufferMTL;
21 
22  id<MTLBlitCommandEncoder> encoder_ = nil;
23  id<MTLCommandBuffer> buffer_ = nil;
24  id<MTLDevice> device_ = nil;
25  bool is_valid_ = false;
26  bool is_metal_trace_active_ = false;
27  // Many parts of the codebase will start writing to a render pass but
28  // never submit them. This boolean is used to track if a submit happened
29  // so that in the dtor we can always ensure the render pass is finished.
30  mutable bool did_finish_encoding_ = false;
31 
32  explicit BlitPassMTL(id<MTLCommandBuffer> buffer, id<MTLDevice> device);
33 
34  // |BlitPass|
35  bool IsValid() const override;
36 
37  // |BlitPass|
38  void OnSetLabel(std::string_view label) override;
39 
40  // |BlitPass|
41  bool EncodeCommands() const override;
42 
43  // |BlitPass|
44  bool ResizeTexture(const std::shared_ptr<Texture>& source,
45  const std::shared_ptr<Texture>& destination) override;
46 
47  // |BlitPass|
48  bool OnCopyTextureToTextureCommand(std::shared_ptr<Texture> source,
49  std::shared_ptr<Texture> destination,
50  IRect source_region,
51  IPoint destination_origin,
52  std::string_view label) override;
53 
54  // |BlitPass|
55  bool OnCopyTextureToBufferCommand(std::shared_ptr<Texture> source,
56  std::shared_ptr<DeviceBuffer> destination,
57  IRect source_region,
58  size_t destination_offset,
59  std::string_view label) override;
60  // |BlitPass|
61  bool OnCopyBufferToTextureCommand(BufferView source,
62  std::shared_ptr<Texture> destination,
63  IRect destination_region,
64  std::string_view label,
65  uint32_t mip_level,
66  uint32_t slice,
67  bool convert_to_read) override;
68 
69  // |BlitPass|
70  bool OnGenerateMipmapCommand(std::shared_ptr<Texture> texture,
71  std::string_view label) override;
72 
73  BlitPassMTL(const BlitPassMTL&) = delete;
74 
75  BlitPassMTL& operator=(const BlitPassMTL&) = delete;
76 };
77 
78 } // namespace impeller
79 
80 #endif // FLUTTER_IMPELLER_RENDERER_BACKEND_METAL_BLIT_PASS_MTL_H_
Blit passes encode blit into the underlying command buffer.
Definition: blit_pass.h:27