tommyalloc.h File Reference

Allocator of fixed size blocks. More...

Go to the source code of this file.

Data Structures
struct	tommy_allocator_struct
	Allocator of fixed size blocks. More...

Typedefs
typedef struct tommy_allocator_struct	tommy_allocator
	Allocator of fixed size blocks. More...

Functions
TOMMY_API void	tommy_allocator_init (tommy_allocator *alloc, tommy_size_t block_size, tommy_size_t align_size)
	Initializes the allocator. More...
TOMMY_API void	tommy_allocator_done (tommy_allocator *alloc)
	Deinitializes the allocator. More...
TOMMY_API void *	tommy_allocator_alloc (tommy_allocator *alloc)
	Allocates a block. More...
TOMMY_API void	tommy_allocator_free (tommy_allocator *alloc, void *ptr)
	Deallocates a block. More...
TOMMY_API tommy_size_t	tommy_allocator_memory_usage (tommy_allocator *alloc)
	Gets the size of allocated memory. More...

Detailed Description

Allocator of fixed size blocks.

Typedef Documentation

tommy_allocator

typedef struct tommy_allocator_struct tommy_allocator

Allocator of fixed size blocks.

Function Documentation

tommy_allocator_init()

TOMMY_API void tommy_allocator_init	(	tommy_allocator *	alloc,
		tommy_size_t	block_size,
		tommy_size_t	align_size
	)

Initializes the allocator.

Parameters

alloc	Allocator to initialize.
block_size	Size of the block to allocate.
align_size	Minimum alignment requirement. No less than sizeof(void*).

tommy_allocator_done()

TOMMY_API void tommy_allocator_done

(

tommy_allocator *

alloc

)

Deinitializes the allocator.

It also releases all the allocated memory to the heap.

Parameters

alloc

Allocator to deinitialize.

tommy_allocator_alloc()

TOMMY_API void * tommy_allocator_alloc

(

tommy_allocator *

alloc

)

Allocates a block.

Parameters

alloc

Allocator to use.

tommy_allocator_free()

TOMMY_API void tommy_allocator_free	(	tommy_allocator *	alloc,
		void *	ptr
	)

Deallocates a block.

You must use the same allocator used in the tommy_allocator_alloc() call.

Parameters

alloc	Allocator to use.
ptr	Block to free.

tommy_allocator_memory_usage()

TOMMY_API tommy_size_t tommy_allocator_memory_usage

(

tommy_allocator *

alloc

)

Gets the size of allocated memory.

Parameters

alloc

Allocator to use.