Kohi Game Engine
ring_queue.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include "defines.h"
4 
9 typedef struct ring_queue {
11  u32 length;
13  u32 stride;
15  u32 capacity;
17  void* block;
19  b8 owns_memory;
21  i32 head;
23  i32 tail;
24 } ring_queue;
25 
37 KAPI b8 ring_queue_create(u32 stride, u32 capacity, void* memory, ring_queue* out_queue);
38 
45 KAPI void ring_queue_destroy(ring_queue* queue);
46 
54 KAPI b8 ring_queue_enqueue(ring_queue* queue, void* value);
55 
63 KAPI b8 ring_queue_dequeue(ring_queue* queue, void* out_value);
64 
72 KAPI b8 ring_queue_peek(const ring_queue* queue, void* out_value);
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
u32
unsigned int u32
Unsigned 32-bit integer.
Definition: defines.h:25
b8
_Bool b8
8-bit boolean type
Definition: defines.h:58
i32
signed int i32
Signed 32-bit integer.
Definition: defines.h:39
ring_queue_peek
KAPI b8 ring_queue_peek(const ring_queue *queue, void *out_value)
Attempts to retrieve, but not remove, the next value in the queue, if not empty.
ring_queue
struct ring_queue ring_queue
Represents a ring queue of a particular size. Does not resize dynamically. Naturally,...
ring_queue_create
KAPI b8 ring_queue_create(u32 stride, u32 capacity, void *memory, ring_queue *out_queue)
Creates a new ring queue of the given capacity and stride.
ring_queue_enqueue
KAPI b8 ring_queue_enqueue(ring_queue *queue, void *value)
Adds value to queue, if space is available.
ring_queue_dequeue
KAPI b8 ring_queue_dequeue(ring_queue *queue, void *out_value)
Attempts to retrieve the next value from the provided queue.
ring_queue_destroy
KAPI void ring_queue_destroy(ring_queue *queue)
Destroys the given queue. If memory was not passed in during creation, it is freed here.
queue
A simple queue container. Elements are popped off the queue in the same order they were pushed to it.
Definition: queue.h:21
ring_queue
Represents a ring queue of a particular size. Does not resize dynamically. Naturally,...
Definition: ring_queue.h:9
ring_queue::capacity
u32 capacity
The total number of elements available.
Definition: ring_queue.h:15
ring_queue::owns_memory
b8 owns_memory
Indicates if the queue owns its memory block.
Definition: ring_queue.h:19
ring_queue::tail
i32 tail
The index of the tail of the list.
Definition: ring_queue.h:23
ring_queue::length
u32 length
The current number of elements contained.
Definition: ring_queue.h:11
ring_queue::head
i32 head
The index of the head of the list.
Definition: ring_queue.h:21
ring_queue::stride
u32 stride
The size of each element in bytes.
Definition: ring_queue.h:13
ring_queue::block
void * block
The block of memory to hold the data.
Definition: ring_queue.h:17