vl_buffer.h

Go to the documentation of this file.

 
#ifndef VL_BUFFER_H
#define VL_BUFFER_H
 
#include "vl_memory.h"
#include "vl_numtypes.h"
 
typedef struct
{
    vl_memsize_t size;
 
    vl_dsoffs_t offset;
 
    vl_memory* data;
} vl_buffer;
 
VL_API vl_buffer* vlBufferNewExt(vl_memsize_t size, vl_uint16_t align);
 
static inline vl_buffer* vlBufferNew(void) { return vlBufferNewExt(VL_DEFAULT_MEMORY_SIZE, VL_DEFAULT_MEMORY_ALIGN); }
 
VL_API void vlBufferInitExt(vl_buffer* buffer, vl_memsize_t size, vl_uint16_t align);
 
static inline void vlBufferInit(vl_buffer* buffer)
{
    vlBufferInitExt(buffer, VL_DEFAULT_MEMORY_SIZE, VL_DEFAULT_MEMORY_ALIGN);
}
 
VL_API void vlBufferReset(vl_buffer* buffer, vl_memsize_t newCapacity);
 
VL_API void vlBufferClear(vl_buffer* buffer);
 
VL_API void vlBufferShrinkToFit(vl_buffer* buffer);
 
VL_API vl_buffer* vlBufferClone(const vl_buffer* src, vl_buffer* dest);
 
VL_API vl_memsize_t vlBufferCopy(vl_buffer* src, vl_buffer* dest, vl_memsize_t len);
 
VL_API vl_memsize_t vlBufferWrite(vl_buffer* buffer, vl_memsize_t size, const void* src);
 
VL_API vl_memsize_t vlBufferRead(vl_buffer* buffer, vl_memsize_t size, void* dest);
 
static inline void vlBufferSeek(vl_buffer* buffer, vl_uintptr_t offset) { buffer->offset = offset; }
 
static inline void vlBufferSeekRelative(vl_buffer* buffer, vl_intptr_t offset) { buffer->offset += offset; }
 
static inline void vlBufferSeekBegin(vl_buffer* buffer) { buffer->offset = 0; }
 
static inline void vlBufferSeekEnd(vl_buffer* buffer) { buffer->offset = buffer->size; }
 
static inline vl_transient* vlBufferBegin(vl_buffer* buffer) { return buffer->data; }
 
static inline vl_transient* vlBufferEnd(vl_buffer* buffer) { return buffer->data + buffer->size; }
 
VL_API void vlBufferFree(vl_buffer* buffer);
 
VL_API void vlBufferDelete(vl_buffer* buffer);
 
#endif // VL_BUFFER_H