sf2::Sample::buffer_t Struct Reference

Pointer address and size of a buffer. More...

#include <SF.h>

List of all members.

Public Member Functions

 buffer_t ()

Public Attributes

void * pStart
 Points to the beginning of the buffer.
unsigned long Size
 Size of the actual data in the buffer in bytes.
unsigned long NullExtensionSize
 The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :).


Detailed Description

Pointer address and size of a buffer.

Definition at line 281 of file SF.h.


Constructor & Destructor Documentation

sf2::Sample::buffer_t::buffer_t (  )  [inline]

Definition at line 285 of file SF.h.

References NullExtensionSize, pStart, and Size.


Member Data Documentation

void* sf2::Sample::buffer_t::pStart

Points to the beginning of the buffer.

Definition at line 282 of file SF.h.

Referenced by buffer_t(), sf2::Sample::GetCache(), sf2::Sample::LoadSampleDataWithNullSamplesExtension(), sf2::Sample::ReleaseSampleData(), and sf2::Sample::Sample().

unsigned long sf2::Sample::buffer_t::Size

Size of the actual data in the buffer in bytes.

Definition at line 283 of file SF.h.

Referenced by buffer_t(), sf2::Sample::GetCache(), sf2::Sample::LoadSampleDataWithNullSamplesExtension(), sf2::Sample::ReleaseSampleData(), and sf2::Sample::Sample().

unsigned long sf2::Sample::buffer_t::NullExtensionSize

The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :).

Definition at line 284 of file SF.h.

Referenced by buffer_t(), sf2::Sample::GetCache(), sf2::Sample::LoadSampleDataWithNullSamplesExtension(), sf2::Sample::ReleaseSampleData(), and sf2::Sample::Sample().


The documentation for this struct was generated from the following file:
Generated on Sun May 1 03:22:48 2011 for libgig by  doxygen 1.5.2