FreeRTOS-Emulator/gfx__utils_8h_source.html

 #ifndef __GFX_UTILS_H__

 #define __GFX_UTILS_H__


 #include <stdio.h>

 #include <stdlib.h>


 int gfxUtilIsCurGLThread(void);


 void gfxUtilSetGLThread(void);


 char *gfxUtilPrependPath(const char *path, char *file);


 char *gfxUtilGetBinFolderPath(char *bin_path);


 const char *gfxUtilFindResourceDirectory(void);


 FILE *gfxUtilFindResource(char *resource_name, const char *mode);


 char *gfxUtilFindResourcePath(char *resource_name);


 typedef void *rbuf_handle_t;


 rbuf_handle_t gfxRbufInit(size_t item_size, size_t item_count);


 rbuf_handle_t gfxRbufInitStatic(size_t item_size, size_t item_count, void *buffer);


 void gfxRbufFree(rbuf_handle_t rbuf);


 void gfxRbufReset(rbuf_handle_t rbuf);


 int gfxRbufPutBuffer(rbuf_handle_t rbuf);


 int gfxRbufPut(rbuf_handle_t rbuf, void *data);


 int gfxRbufFPut(rbuf_handle_t rbuf, void *data);


 void *gfxRbufGetBuffer(rbuf_handle_t rbuf);


 int gfxRbufGet(rbuf_handle_t rbuf, void *data);


 unsigned char gfxRbufEmpty(rbuf_handle_t rbuf);


 unsigned char gfxRbufFull(rbuf_handle_t rbuf);


 size_t gfxRbufSize(rbuf_handle_t rbuf);


 size_t gfxRbufCapacity(rbuf_handle_t rbuf);


 #endif

rbuf_handle_t
void * rbuf_handle_t
A handle to a ring buffer object, created using gfxRbufInit()
Definition: gfx_utils.h:93

gfxRbufReset
void gfxRbufReset(rbuf_handle_t rbuf)
Resets the ring buffer to it's initial state.
Definition: gfx_utils.c:322

gfxUtilPrependPath
char * gfxUtilPrependPath(const char *path, char *file)
Prepends a path string to a filename.
Definition: gfx_utils.c:79

gfxRbufCapacity
size_t gfxRbufCapacity(rbuf_handle_t rbuf)
Returns the maximum number of elements that the ring buffer can store.
Definition: gfx_utils.c:492

gfxRbufPut
int gfxRbufPut(rbuf_handle_t rbuf, void *data)
Fills the next available buffer slot, if a slot is free.
Definition: gfx_utils.c:352

gfxUtilFindResourcePath
char * gfxUtilFindResourcePath(char *resource_name)
Similar to gfxUtilFindResource() only returning the file's path instead of the opened FILE's referenc...
Definition: gfx_utils.c:207

gfxUtilGetBinFolderPath
char * gfxUtilGetBinFolderPath(char *bin_path)
Gets the execution folder of the current program, assumes that program is executing from a folder "bi...
Definition: gfx_utils.c:93

gfxUtilSetGLThread
void gfxUtilSetGLThread(void)
The calling thread is registered as holding the current GL context.
Definition: gfx_utils.c:72

gfxRbufFree
void gfxRbufFree(rbuf_handle_t rbuf)
Frees a ring buffer.
Definition: gfx_utils.c:311

gfxRbufGet
int gfxRbufGet(rbuf_handle_t rbuf, void *data)
Returns a copy of the next buffer item's data.
Definition: gfx_utils.c:425

gfxUtilFindResource
FILE * gfxUtilFindResource(char *resource_name, const char *mode)
Searches for a file in the RESOURCES_DIRECTORY and returns a FILE * if found.
Definition: gfx_utils.c:193

gfxRbufInit
rbuf_handle_t gfxRbufInit(size_t item_size, size_t item_count)
Initialized a ring buffer object with a certain number of objects of a given size.
Definition: gfx_utils.c:257

gfxRbufPutBuffer
int gfxRbufPutBuffer(rbuf_handle_t rbuf)
Used when a reference to the next buffer item is already filled, incrementing the next buffer item sh...
Definition: gfx_utils.c:338

gfxUtilFindResourceDirectory
const char * gfxUtilFindResourceDirectory(void)
Returns the lopcation of the resource directory.
Definition: gfx_utils.c:177

gfxRbufFPut
int gfxRbufFPut(rbuf_handle_t rbuf, void *data)
Fills the next available buffer, overwriting data if the ring buffer is full.
Definition: gfx_utils.c:376

gfxRbufFull
unsigned char gfxRbufFull(rbuf_handle_t rbuf)
Checks if the buffer is full.
Definition: gfx_utils.c:459

gfxRbufInitStatic
rbuf_handle_t gfxRbufInitStatic(size_t item_size, size_t item_count, void *buffer)
Initialized a ring buffer object with a certain number of objects of a given size into a statically a...
Definition: gfx_utils.c:284

gfxUtilIsCurGLThread
int gfxUtilIsCurGLThread(void)
Checks if the calling thread is the thread that currently holds the GL context.
Definition: gfx_utils.c:61

gfxRbufSize
size_t gfxRbufSize(rbuf_handle_t rbuf)
Returns the number of elements currently stored in the ring buffer.
Definition: gfx_utils.c:471

gfxRbufEmpty
unsigned char gfxRbufEmpty(rbuf_handle_t rbuf)
Checks if the buffer is empty or not.
Definition: gfx_utils.c:448

gfxRbufGetBuffer
void * gfxRbufGetBuffer(rbuf_handle_t rbuf)
Returns a reference to the data of the next ring buffer entry.
Definition: gfx_utils.c:397