| Flutter Impeller |

allocator.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_CORE_ALLOCATOR_H_
6 #define FLUTTER_IMPELLER_CORE_ALLOCATOR_H_
7
8 #include "flutter/fml/mapping.h"
9 #include "impeller/core/device_buffer_descriptor.h"
10 #include "impeller/core/texture.h"
11 #include "impeller/core/texture_descriptor.h"
12 #include "impeller/geometry/size.h"
13
14 namespace impeller {
15
16 class Context;
17 class DeviceBuffer;
18
19 //------------------------------------------------------------------------------
20 /// @brief An object that allocates device memory.
21 ///
22 class Allocator {
23 public:
24 virtual ~Allocator();
25
26 bool IsValid() const;
27
28 std::shared_ptr<DeviceBuffer> CreateBuffer(
29 const DeviceBufferDescriptor& desc);
30
31 std::shared_ptr<Texture> CreateTexture(const TextureDescriptor& desc);
32
33 //------------------------------------------------------------------------------
34 /// @brief Minimum value for `row_bytes` on a Texture. The row
35 /// bytes parameter of that method must be aligned to this value.
36 ///
37 virtual uint16_t MinimumBytesPerRow(PixelFormat format) const;
38
39 std::shared_ptr<DeviceBuffer> CreateBufferWithCopy(const uint8_t* buffer,
40 size_t length);
41
42 std::shared_ptr<DeviceBuffer> CreateBufferWithCopy(
43 const fml::Mapping& mapping);
44
45 virtual ISize GetMaxTextureSizeSupported() const = 0;
46
47 /// @brief Write debug memory usage information to the dart timeline in debug
48 /// and profile modes.
49 ///
50 /// This is supported on both the Metal and Vulkan backends.
51 virtual void DebugTraceMemoryStatistics() const {};
52
53 // Visible for testing.
54 virtual size_t DebugGetHeapUsage() const { return 0; }
55
56 protected:
57 Allocator();
58
59 virtual std::shared_ptr<DeviceBuffer> OnCreateBuffer(
60 const DeviceBufferDescriptor& desc) = 0;
61
62 virtual std::shared_ptr<Texture> OnCreateTexture(
63 const TextureDescriptor& desc) = 0;
64
65 private:
66 Allocator(const Allocator&) = delete;
67
68 Allocator& operator=(const Allocator&) = delete;
69 };
70
71 } // namespace impeller
72
73 #endif // FLUTTER_IMPELLER_CORE_ALLOCATOR_H_
impeller::Allocator::IsValid
bool IsValid() const
impeller::Allocator::GetMaxTextureSizeSupported
virtual ISize GetMaxTextureSizeSupported() const =0
impeller::Allocator::OnCreateTexture
virtual std::shared_ptr< Texture > OnCreateTexture(const TextureDescriptor &desc)=0
impeller::DeviceBufferDescriptor
Definition: device_buffer_descriptor.h:14
texture_descriptor.h
impeller::Allocator::MinimumBytesPerRow
virtual uint16_t MinimumBytesPerRow(PixelFormat format) const
Minimum value for row_bytes on a Texture. The row bytes parameter of that method must be aligned to t...
Definition: allocator.cc:69
impeller::Allocator::~Allocator
virtual ~Allocator()
impeller::Allocator::CreateTexture
std::shared_ptr< Texture > CreateTexture(const TextureDescriptor &desc)
Definition: allocator.cc:49
impeller::Allocator::DebugGetHeapUsage
virtual size_t DebugGetHeapUsage() const
Definition: allocator.h:54
impeller::PixelFormat
PixelFormat
The Pixel formats supported by Impeller. The naming convention denotes the usage of the component,...
Definition: formats.h:99
impeller::TSize
Definition: size.h:19
impeller::Allocator::CreateBuffer
std::shared_ptr< DeviceBuffer > CreateBuffer(const DeviceBufferDescriptor &desc)
Definition: allocator.cc:44
impeller::Allocator
An object that allocates device memory.
Definition: allocator.h:22
impeller::Allocator::CreateBufferWithCopy
std::shared_ptr< DeviceBuffer > CreateBufferWithCopy(const uint8_t *buffer, size_t length)
Definition: allocator.cc:18
impeller::Allocator::Allocator
Allocator()
texture.h
device_buffer_descriptor.h
impeller::TextureDescriptor
A lightweight object that describes the attributes of a texture that can then used an allocator to cr...
Definition: texture_descriptor.h:38
impeller
Definition: aiks_blend_unittests.cc:18
impeller::Allocator::DebugTraceMemoryStatistics
virtual void DebugTraceMemoryStatistics() const
Write debug memory usage information to the dart timeline in debug and profile modes.
Definition: allocator.h:51
size.h
impeller::Allocator::OnCreateBuffer
virtual std::shared_ptr< DeviceBuffer > OnCreateBuffer(const DeviceBufferDescriptor &desc)=0