impeller::Allocator Class Reference

An object that allocates device memory. More...

#include <allocator.h>

Inheritance diagram for impeller::Allocator:

Public Member Functions
virtual	~Allocator ()
bool	IsValid () const
std::shared_ptr< DeviceBuffer >	CreateBuffer (const DeviceBufferDescriptor &desc)
std::shared_ptr< Texture >	CreateTexture (const TextureDescriptor &desc)
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 this value. More...
std::shared_ptr< DeviceBuffer >	CreateBufferWithCopy (const uint8_t *buffer, size_t length)
std::shared_ptr< DeviceBuffer >	CreateBufferWithCopy (const fml::Mapping &mapping)
virtual ISize	GetMaxTextureSizeSupported () const =0
virtual void	DebugTraceMemoryStatistics () const
	Write debug memory usage information to the dart timeline in debug and profile modes. More...

Protected Member Functions
	Allocator ()
virtual std::shared_ptr< DeviceBuffer >	OnCreateBuffer (const DeviceBufferDescriptor &desc)=0
virtual std::shared_ptr< Texture >	OnCreateTexture (const TextureDescriptor &desc)=0

Detailed Description

An object that allocates device memory.

Definition at line 22 of file allocator.h.

Constructor & Destructor Documentation

~Allocator()

impeller::Allocator::~Allocator ( )

virtualdefault

Allocator()

impeller::Allocator::Allocator ( )

protecteddefault

Member Function Documentation

CreateBuffer()

std::shared_ptr< DeviceBuffer > impeller::Allocator::CreateBuffer

(

const DeviceBufferDescriptor &

desc

)

Definition at line 44 of file allocator.cc.

                                        {
  return OnCreateBuffer(desc);
}

CreateBufferWithCopy() [1/2]

std::shared_ptr< DeviceBuffer > impeller::Allocator::CreateBufferWithCopy

(

const fml::Mapping &

mapping

)

Definition at line 39 of file allocator.cc.

                               {
  return CreateBufferWithCopy(mapping.GetMapping(), mapping.GetSize());
}

CreateBufferWithCopy() [2/2]

std::shared_ptr< DeviceBuffer > impeller::Allocator::CreateBufferWithCopy	(	const uint8_t *	buffer,
		size_t	length
	)

Definition at line 18 of file allocator.cc.

                   {
  DeviceBufferDescriptor desc;
  desc.size = length;
  desc.storage_mode = StorageMode::kHostVisible;
  auto new_buffer = CreateBuffer(desc);
 
  if (!new_buffer) {
    return nullptr;
  }
 
  auto entire_range = Range{0, length};
 
  if (!new_buffer->CopyHostBuffer(buffer, entire_range)) {
    return nullptr;
  }
 
  return new_buffer;
}

CreateTexture()

std::shared_ptr< Texture > impeller::Allocator::CreateTexture

(

const TextureDescriptor &

desc

)

Definition at line 49 of file allocator.cc.

                                   {
  const auto max_size = GetMaxTextureSizeSupported();
  if (desc.size.width > max_size.width || desc.size.height > max_size.height) {
    VALIDATION_LOG << "Requested texture size " << desc.size
                   << " exceeds maximum supported size of " << max_size;
    return nullptr;
  }
 
  if (desc.mip_count > desc.size.MipCount()) {
    VALIDATION_LOG << "Requested mip_count " << desc.mip_count
                   << " exceeds maximum supported for size " << desc.size;
    TextureDescriptor corrected_desc = desc;
    corrected_desc.mip_count = desc.size.MipCount();
    return OnCreateTexture(corrected_desc);
  }
 
  return OnCreateTexture(desc);
}

DebugTraceMemoryStatistics()

virtual void impeller::Allocator::DebugTraceMemoryStatistics ( ) const

inlinevirtual

Write debug memory usage information to the dart timeline in debug and profile modes.

This is only supported on the Vulkan backend.

Definition at line 51 of file allocator.h.

{};

GetMaxTextureSizeSupported()

virtual ISize impeller::Allocator::GetMaxTextureSizeSupported ( ) const

pure virtual

Implemented in impeller::testing::TestAllocator.

IsValid()

bool impeller::Allocator::IsValid

(

)

const

MinimumBytesPerRow()

uint16_t impeller::Allocator::MinimumBytesPerRow ( PixelFormat  format ) const

virtual

Minimum value for row_bytes on a Texture. The row bytes parameter of that method must be aligned to this value.

Definition at line 69 of file allocator.cc.

                                                               {
  return BytesPerPixelForPixelFormat(format);
}

OnCreateBuffer()

virtual std::shared_ptr< DeviceBuffer > impeller::Allocator::OnCreateBuffer ( const DeviceBufferDescriptor &  desc )

protectedpure virtual

Implemented in impeller::testing::TestAllocator.

OnCreateTexture()

virtual std::shared_ptr< Texture > impeller::Allocator::OnCreateTexture ( const TextureDescriptor &  desc )

protectedpure virtual

Implemented in impeller::testing::TestAllocator.

---

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

• impeller/core/allocator.h
• impeller/core/allocator.cc