Kohi Game Engine
linear_allocator.h
Go to the documentation of this file.
1 
18 #pragma once
19 
20 #include "defines.h"
21 
25 typedef struct linear_allocator {
27  u64 total_size;
29  u64 allocated;
31  void* memory;
36  b8 owns_memory;
37 } linear_allocator;
38 
47 KAPI void linear_allocator_create(u64 total_size, void* memory, linear_allocator* out_allocator);
48 
54 KAPI void linear_allocator_destroy(linear_allocator* allocator);
55 
63 KAPI void* linear_allocator_allocate(linear_allocator* allocator, u64 size);
64 
72 KAPI void linear_allocator_free_all(linear_allocator* allocator, b8 clear);
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:205
b8
_Bool b8
8-bit boolean type
Definition: defines.h:58
u64
unsigned long long u64
Unsigned 64-bit integer.
Definition: defines.h:28
linear_allocator_create
KAPI void linear_allocator_create(u64 total_size, void *memory, linear_allocator *out_allocator)
Creates a linear allocator of the given size.
linear_allocator
struct linear_allocator linear_allocator
The data structure for a linear allocator.
linear_allocator_free_all
KAPI void linear_allocator_free_all(linear_allocator *allocator, b8 clear)
Frees everything in the allocator, effectively moving its pointer back to the beginning....
linear_allocator_destroy
KAPI void linear_allocator_destroy(linear_allocator *allocator)
Destroys the given allocator. If the allocator owns its memory, it is freed at this time.
linear_allocator_allocate
KAPI void * linear_allocator_allocate(linear_allocator *allocator, u64 size)
Allocates the given amount from the allocator.
linear_allocator
The data structure for a linear allocator.
Definition: linear_allocator.h:25
linear_allocator::owns_memory
b8 owns_memory
Indicates if the allocator owns the memory (meaning it performed the allocation itself) or whether it...
Definition: linear_allocator.h:36
linear_allocator::memory
void * memory
The internal block of memory used by the allocator.
Definition: linear_allocator.h:31
linear_allocator::allocated
u64 allocated
The amount of memory currently allocated.
Definition: linear_allocator.h:29
linear_allocator::total_size
u64 total_size
The total size of memory in the allocator.
Definition: linear_allocator.h:27