Describes an allocation on the heap. More...

#include <allocation.h>

Public Member Functions
	Allocation ()
	Constructs a new zero-sized allocation. More...

	~Allocation ()
	Destroys the allocation. More...

uint8_t *	GetBuffer () const
	Gets the pointer to the start of the allocation. More...

Bytes	GetLength () const
	Gets the length of the allocation. More...

Bytes	GetReservedLength () const
	Gets the reserved length of the allocation. Calls to truncate may be ignored till the length exceeds the reserved length. More...

bool	Truncate (Bytes length, bool npot=true)
	Resize the underlying allocation to at least given number of bytes. More...

Static Public Member Functions
static uint32_t	NextPowerOfTwoSize (uint32_t x)
	Gets the next power of two size. More...

Detailed Description

Describes an allocation on the heap.

        Managing allocations through this utility makes it harder to
        miss allocation failures.

Definition at line 22 of file allocation.h.

Constructor & Destructor Documentation

◆ Allocation()

impeller::Allocation::Allocation ( )

default

Constructs a new zero-sized allocation.

◆ ~Allocation()

impeller::Allocation::~Allocation ( )

Destroys the allocation.

Definition at line 16 of file allocation.cc.

                         {
   ::free(buffer_);
 }

Member Function Documentation

◆ GetBuffer()

uint8_t * impeller::Allocation::GetBuffer ( ) const

Gets the pointer to the start of the allocation.

        This pointer is only valid till the next call to `Truncate`.

Returns: The pointer to the start of the allocation.

Definition at line 20 of file allocation.cc.

                                      {
   return buffer_;
 }

Referenced by impeller::ProcTableGLES::GetProgramInfoLogString(), and impeller::interop::testing::TEST_P().

◆ GetLength()

Bytes impeller::Allocation::GetLength ( ) const

Gets the length of the allocation.

Returns: The length.

Definition at line 24 of file allocation.cc.

                                   {
   return length_;
 }

◆ GetReservedLength()

Bytes impeller::Allocation::GetReservedLength ( ) const

Gets the reserved length of the allocation. Calls to truncate may be ignored till the length exceeds the reserved length.

Returns: The reserved length.

Definition at line 28 of file allocation.cc.

                                           {
   return reserved_;
 }

◆ NextPowerOfTwoSize()

uint32_t impeller::Allocation::NextPowerOfTwoSize ( uint32_t x )

static

Gets the next power of two size.

Parameters

[in] x The size.

Returns: The next power of two of x.

Definition at line 41 of file allocation.cc.

                                                   {
   if (x == 0) {
     return 1;
   }
  
   --x;
  
   x |= x >> 1;
   x |= x >> 2;
   x |= x >> 4;
   x |= x >> 8;
   x |= x >> 16;
  
   return x + 1;
 }

References x.

◆ Truncate()

bool impeller::Allocation::Truncate	(	Bytes	length,
		bool	npot = `true`
	)

Resize the underlying allocation to at least given number of bytes.

In case of failure, false is returned and the underlying allocation remains unchanged.

Warning: Pointers to buffers obtained via previous calls to GetBuffer may become invalid at this point.