sfxFMODPlugin.h

Classes:

class
SFXSystem plugin that adds the capability to create SFXSources for Designer SFXFMODEvents.
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 _SFXFMODPLUGIN_H_
25#define _SFXFMODPLUGIN_H_
26
27#ifndef _SFXSYSTEM_H_
28   #include "sfx/sfxSystem.h"
29#endif
30
31
32/// SFXSystem plugin that adds the capability to create SFXSources for
33/// Designer SFXFMODEvents.
34///
35/// The plugin will only be installed if an FMOD device has been created.
36/// While SFXFMODEvents may be constructed without an FMOD device, trying
37/// to play such an event then will result in an error.
38///
39class SFXFMODPlugin : public SFXSystemPlugin
40{
41   public:
42   
43      typedef SFXSystemPlugin Parent;
44      
45      ///
46      virtual SFXSource* createSource( SFXTrack* track );
47};
48
49#endif // !_SFXFMODPLUGIN_H_
50