Torque3D Documentation / _generateds / sfxFMODBuffer.h

sfxFMODBuffer.h

Engine/source/sfx/fmod/sfxFMODBuffer.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _SFXFMODBUFFER_H_
25#define _SFXFMODBUFFER_H_
26
27#include "fmod.h"
28
29#ifndef _SFXINTERNAL_H_
30#  include "sfx/sfxInternal.h"
31#endif
32
33
34class SFXFMODBuffer : public SFXInternal::SFXWrapAroundBuffer
35{
36      typedef SFXInternal::SFXWrapAroundBuffer Parent;
37
38      friend class SFXFMODDevice;
39      friend class SFXFMODVoice;
40
41   protected:
42
43      FMOD_SOUND *mSound;     
44      FMOD_MODE mMode;
45
46      SFXFMODBuffer( const ThreadSafeRef< SFXStream>& stream, SFXDescription* description );
47      SFXFMODBuffer( const String& filename, SFXDescription* description );
48
49      // SFXWrapAroundBuffer.
50      virtual bool _copyData( U32 offset, const U8* data, U32 length );
51      virtual void _flush();
52
53      virtual ~SFXFMODBuffer();
54
55   public:
56
57      ///
58      static SFXFMODBuffer* create( const ThreadSafeRef< SFXStream>& stream, SFXDescription* description );
59      static SFXFMODBuffer* create( const String& filename, SFXDescription* description );
60
61      virtual U32 getMemoryUsed() const;
62};
63
64#endif // _SFXFMODBUFFER_H_
65