Kohi Game Engine
dynamic_allocator.h
Go to the documentation of this file.
1 
12 #pragma once
13 
14 #include "defines.h"
15 
17 typedef struct dynamic_allocator {
19  void* memory;
20 } dynamic_allocator;
21 
32 KAPI b8 dynamic_allocator_create(u64 total_size, u64* memory_requirement, void* memory, dynamic_allocator* out_allocator);
33 
40 KAPI b8 dynamic_allocator_destroy(dynamic_allocator* allocator);
41 
49 KAPI void* dynamic_allocator_allocate(dynamic_allocator* allocator, u64 size);
50 
59 KAPI void* dynamic_allocator_allocate_aligned(dynamic_allocator* allocator, u64 size, u16 alignment);
60 
69 KAPI b8 dynamic_allocator_free(dynamic_allocator* allocator, void* block, u64 size);
70 
79 KAPI b8 dynamic_allocator_free_aligned(dynamic_allocator* allocator, void* block);
80 
90 KAPI b8 dynamic_allocator_get_size_alignment(void* block, u64* out_size, u16* out_alignment);
91 
98 KAPI u64 dynamic_allocator_free_space(dynamic_allocator* allocator);
99 
106 KAPI u64 dynamic_allocator_total_space(dynamic_allocator* allocator);
107 
109 KAPI u64 dynamic_allocator_header_size(void);
defines.h
This file contains global type definitions which are used throughout the entire engine and applicatio...
KAPI
#define KAPI
Import/export qualifier.
Definition: defines.h:177
b8
_Bool b8
8-bit boolean type
Definition: defines.h:58
u16
unsigned short u16
Unsigned 16-bit integer.
Definition: defines.h:22
u64
unsigned long long u64
Unsigned 64-bit integer.
Definition: defines.h:28
dynamic_allocator_free
KAPI b8 dynamic_allocator_free(dynamic_allocator *allocator, void *block, u64 size)
Frees the given block of memory.
dynamic_allocator
struct dynamic_allocator dynamic_allocator
The dynamic allocator structure.
dynamic_allocator_allocate
KAPI void * dynamic_allocator_allocate(dynamic_allocator *allocator, u64 size)
Allocates the given amount of memory from the provided allocator.
dynamic_allocator_allocate_aligned
KAPI void * dynamic_allocator_allocate_aligned(dynamic_allocator *allocator, u64 size, u16 alignment)
Allocates the given amount of aligned memory from the provided allocator.
dynamic_allocator_destroy
KAPI b8 dynamic_allocator_destroy(dynamic_allocator *allocator)
Destroys the given allocator.
dynamic_allocator_free_aligned
KAPI b8 dynamic_allocator_free_aligned(dynamic_allocator *allocator, void *block)
Frees the given block of aligned memory. Technically the same as calling dynamic_allocator_free,...
dynamic_allocator_create
KAPI b8 dynamic_allocator_create(u64 total_size, u64 *memory_requirement, void *memory, dynamic_allocator *out_allocator)
Creates a new dynamic allocator. Should be called twice; once to obtain the memory amount required (p...
dynamic_allocator_header_size
KAPI u64 dynamic_allocator_header_size(void)
dynamic_allocator_get_size_alignment
KAPI b8 dynamic_allocator_get_size_alignment(void *block, u64 *out_size, u16 *out_alignment)
Obtains the size and alignment of the given block of memory. Can fail if invalid data is passed.
dynamic_allocator_free_space
KAPI u64 dynamic_allocator_free_space(dynamic_allocator *allocator)
Obtains the amount of free space left in the provided allocator.
dynamic_allocator_total_space
KAPI u64 dynamic_allocator_total_space(dynamic_allocator *allocator)
Obtains the amount of total space originally available in the provided allocator.
dynamic_allocator
The dynamic allocator structure.
Definition: dynamic_allocator.h:17
dynamic_allocator::memory
void * memory
The allocated memory block for this allocator to use.
Definition: dynamic_allocator.h:19