vl::Buffer Class Reference

Implements a buffer whose storage is in local memory. More...

#include <Buffer.hpp>

Inheritance diagram for vl::Buffer:

List of all members.

Public Types
enum	EAllocationMode { UserAllocatedBuffer, AutoAllocatedBuffer }
Public Member Functions
virtual const char *	className ()
	Returns the name of the class.
	Buffer ()
	Buffer (const Buffer &other)
Buffer &	operator= (const Buffer &other)
void	swap (Buffer &other)
	~Buffer ()
void	clear ()
void	resize (size_t byte_count, size_t alignment=0)
void	setUserAllocatedBuffer (void *ptr, size_t bytes)
	Uses a user-allocated buffer as storage.
void	setAllocationMode (EAllocationMode mode)
EAllocationMode	allocationMode () const
size_t	bytesUsed () const
bool	empty () const
unsigned char *	ptr ()
const unsigned char *	ptr () const
size_t	alignment () const
Static Public Member Functions
static void *	alignedMalloc (size_t bytes, size_t alignment)
static void	alignedFree (void *ptr)
Protected Attributes
unsigned char *	mPtr
size_t	mByteCount
size_t	mAlignment
EAllocationMode	mAllocationMode

---

Detailed Description

Implements a buffer whose storage is in local memory.

---

Member Enumeration Documentation

enum vl::Buffer::EAllocationMode

Enumerator:

UserAllocatedBuffer
AutoAllocatedBuffer

---

Constructor & Destructor Documentation

vl::Buffer::Buffer

(

)

[inline]

vl::Buffer::Buffer

(

const Buffer &

other )

[inline]

vl::Buffer::~Buffer

(

)

[inline]

---

Member Function Documentation

virtual const char* vl::Buffer::className

(

)

[inline, virtual]

Returns the name of the class.

Reimplemented from vl::Object.

Reimplemented in vl::GLBufferObject.

Buffer& vl::Buffer::operator=

(

const Buffer &

other )

[inline]

void vl::Buffer::swap

(

Buffer &

other )

[inline]

void vl::Buffer::clear

(

)

[inline]

void vl::Buffer::resize	(	size_t	byte_count,
		size_t	alignment = 0
	)		[inline]

void vl::Buffer::setUserAllocatedBuffer	(	void *	ptr,
		size_t	bytes
	)		[inline]

Uses a user-allocated buffer as storage.

After calling this function any call to resize() is illegal. Calling this function enables the UserAllocatedBuffer mode. Call setAllocationMode( AutoAllocatedBuffer ) to revert to the default behaviour.

void vl::Buffer::setAllocationMode

(

EAllocationMode

mode )

[inline]

EAllocationMode vl::Buffer::allocationMode

(

)

const [inline]

size_t vl::Buffer::bytesUsed

(

)

const [inline]

bool vl::Buffer::empty

(

)

const [inline]

unsigned char* vl::Buffer::ptr

(

)

[inline]

const unsigned char* vl::Buffer::ptr

(

)

const [inline]

size_t vl::Buffer::alignment

(

)

const [inline]

static void* vl::Buffer::alignedMalloc	(	size_t	bytes,
		size_t	alignment
	)		[inline, static]

static void vl::Buffer::alignedFree

(

void *

ptr )

[inline, static]

---

Member Data Documentation

unsigned char* vl::Buffer::mPtr [protected]

size_t vl::Buffer::mByteCount [protected]

size_t vl::Buffer::mAlignment [protected]

EAllocationMode vl::Buffer::mAllocationMode [protected]

---

The documentation for this class was generated from the following file:

• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/Buffer.hpp