From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLSOUND_1_1ILoader.html | 380 ++++++++++++++++++++++++++ 1 file changed, 380 insertions(+) create mode 100644 docs/doxygen/nel/classNLSOUND_1_1ILoader.html (limited to 'docs/doxygen/nel/classNLSOUND_1_1ILoader.html') diff --git a/docs/doxygen/nel/classNLSOUND_1_1ILoader.html b/docs/doxygen/nel/classNLSOUND_1_1ILoader.html new file mode 100644 index 00000000..f9ca94d0 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1ILoader.html @@ -0,0 +1,380 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NLSOUND::ILoader Class Reference

Sound loader interface. +More... +

+#include <loader.h> +

+List of all members. + + + + + + + + + + + + + + + + + + +

Public Methods
virtual void setBuffer (IBuffer *buffer)
Set the destination buffer. More...

virtual uint32 getSize ()=0
Return the size of the data to load (or MAXINT32 if unknown). More...

bool fillBufferPart (uint32 size)
Fill the buffer up to the specified size, calling fillMore() if the buffer supports it, otherwise, fills the buffer entirely, calling IBuffer::fillBuffer(). More...

bool fillBuffer ()
Fills the buffer entirely. More...

ILoader ()
Constructor. More...

virtual ~ILoader ()
Destructor. More...

Protected Methods
virtual void * provideData (uint32 size)=0
Provide data (load). More...

Protected Attributes
IBuffer * _Buffer
+

Detailed Description

+Sound loader interface. +

+Deprecated:: + In order to fill a static buffer, just call fillBuffer(). In order to stream into a buffer, call fillBufferPart() several times.

+Author:: +Olivier Cado , Nevrax France

+Date:: +2001

+ +

+Definition at line 49 of file loader.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NLSOUND::ILoader::ILoader ( ) [inline]
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 69 of file loader.h. +
+References _Buffer.
+

+ + + + +
+ + + + + + + + + +
virtual NLSOUND::ILoader::~ILoader ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Destructor. +
+ +
+Definition at line 72 of file loader.h. +
+References _Buffer.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
bool NLSOUND::ILoader::fillBuffer ( )
+
+ + + + + +
+ + + +
+Fills the buffer entirely. +
+ +
+Definition at line 66 of file loader.cpp. +
+References _Buffer, getSize, nlassert, and provideData.
+

+ + + + +
+ + + + + + + + + + +
bool NLSOUND::ILoader::fillBufferPart ( uint32 size )
+
+ + + + + +
+ + + +
+Fill the buffer up to the specified size, calling fillMore() if the buffer supports it, otherwise, fills the buffer entirely, calling IBuffer::fillBuffer(). +
+ +
+Definition at line 48 of file loader.cpp. +
+References _Buffer, getSize, nlassert, and provideData.
+

+ + + + +
+ + + + + + + + + +
virtual uint32 NLSOUND::ILoader::getSize ( ) [pure virtual]
+
+ + + + + +
+ + + +
+Return the size of the data to load (or MAXINT32 if unknown). +
+ +
+Referenced by fillBuffer, and fillBufferPart.
+

+ + + + +
+ + + + + + + + + + +
virtual void* NLSOUND::ILoader::provideData ( uint32 size ) [protected, pure virtual]
+
+ + + + + +
+ + + +
+Provide data (load). +
+ +
+Referenced by fillBuffer, and fillBufferPart.
+

+ + + + +
+ + + + + + + + + + +
void NLSOUND::ILoader::setBuffer ( IBuffer * buffer ) [virtual]
+
+ + + + + +
+ + + +
+Set the destination buffer. +
+ +
+Definition at line 37 of file loader.cpp. +
+References _Buffer, and nlassert.
+

Member Data Documentation

+ + + + +
+ + +
IBuffer* NLSOUND::ILoader::_Buffer [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 81 of file loader.h. +
+Referenced by fillBuffer, fillBufferPart, ILoader, setBuffer, and ~ILoader.
+

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

+ + + +
+

+ + -- cgit v1.2.1