vl_buffer.h

Go to the documentation of this file.

#ifndef VL_BUFFER_H
#define VL_BUFFER_H
 
#include "vl_numtypes.h"
#include "vl_memory.h"
 
typedef struct {
    vl_memsize_t size;
 
    vl_dsoffs_t offset;
 
    vl_memory* data;
} vl_buffer;
 
vl_buffer*  vlBufferNew(void);
 
vl_buffer*  vlBufferNewSz(vl_memsize_t initialCapacity);
 
#ifndef vlBufferInit
#define vlBufferInit(bufferPtr) vlBufferInitSz(bufferPtr, VL_DEFAULT_MEMORY_SIZE)
#endif
 
void        vlBufferInitSz(vl_buffer* buffer, vl_memsize_t initialCapacity);
 
void        vlBufferReset(vl_buffer* buffer);
 
void        vlBufferResetSz(vl_buffer* buffer, vl_memsize_t newCapacity);
 
void        vlBufferClear(vl_buffer* buffer);
 
void        vlBufferShrinkToFit(vl_buffer* buffer);
 
vl_buffer*  vlBufferClone(const vl_buffer* src, vl_buffer* dest);
 
vl_memsize_t        vlBufferCopy(vl_buffer* src, vl_buffer* dest, vl_memsize_t len);
 
vl_memsize_t   vlBufferWrite(vl_buffer* buffer, vl_memsize_t size, const void* src);
 
vl_memsize_t      vlBufferRead(vl_buffer* buffer, vl_memsize_t size, void* dest);
 
void        vlBufferSeek(vl_buffer* buffer, vl_uintptr_t offset);
 
void        vlBufferSeekRelative(vl_buffer* buffer, vl_intptr_t offset);
 
void        vlBufferSeekBegin(vl_buffer* buffer);
 
void        vlBufferSeekEnd(vl_buffer* buffer);
 
vl_transient*       vlBufferBegin(vl_buffer* buffer);
 
vl_transient*       vlBufferEnd(vl_buffer* buffer);
 
void        vlBufferFree(vl_buffer* buffer);
 
void        vlBufferDelete(vl_buffer* buffer);
 
#endif //VL_BUFFER_H