Torque3D Documentation / _generateds / sfxNullProvider.cpp

sfxNullProvider.cpp

Engine/source/sfx/null/sfxNullProvider.cpp

More...

Classes:

Detailed Description

Public Variables

 MODULE_END 
 MODULE_INIT 
 MODULE_SHUTDOWN 
SFXNullProvider * mProvider 
 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#include "sfx/sfxProvider.h"
25#include "sfx/null/sfxNullDevice.h"
26#include "core/strings/stringFunctions.h"
27#include "core/module.h"
28
29
30class SFXNullProvider : public SFXProvider
31{
32public:
33
34   SFXNullProvider()
35      : SFXProvider( "Null" ) {}
36   virtual ~SFXNullProvider();
37
38protected:
39   void addDeviceDesc( const String& name, const String& desc );
40   void init();
41
42public:
43
44   SFXDevice* createDevice( const String& deviceName, bool useHardware, S32 maxBuffers );
45
46};
47
48MODULE_BEGIN( SFXNull )
49
50   MODULE_INIT_BEFORE( SFX )
51   MODULE_SHUTDOWN_AFTER( SFX )
52   
53   SFXNullProvider* mProvider;
54
55   MODULE_INIT
56   {
57      mProvider = new SFXNullProvider;
58   }
59   
60   MODULE_SHUTDOWN
61   {
62      delete mProvider;
63   }
64
65MODULE_END;
66
67void SFXNullProvider::init()
68{
69   regProvider( this );
70   addDeviceDesc( "Null", "SFX Null Device" );
71}
72
73SFXNullProvider::~SFXNullProvider()
74{
75}
76
77
78void SFXNullProvider::addDeviceDesc( const String& name, const String& desc )
79{
80   SFXDeviceInfo* info = new SFXDeviceInfo;
81   info->name = desc;
82   info->driver = name;
83   info->hasHardware = false;
84   info->maxBuffers = 8;
85
86   mDeviceInfo.push_back( info );
87}
88
89SFXDevice* SFXNullProvider::createDevice( const String& deviceName, bool useHardware, S32 maxBuffers )
90{
91   SFXDeviceInfo* info = _findDeviceInfo( deviceName );
92
93   // Do we find one to create?
94   if ( info )
95      return new SFXNullDevice( this, info->name, useHardware, maxBuffers );
96
97   return NULL;
98}
99