fadefilter.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Mark Page
28 */
29 
30 #pragma once
31 
32 #include "../soundfilter.h"
33 
34 namespace clan
35 {
38 
39  class FadeFilterProvider;
40 
42  class FadeFilter : public SoundFilter
43  {
44  public:
46  FadeFilter(float initial_volume);
47 
49  virtual ~FadeFilter();
50 
52  float get_volume() const;
53 
55  FadeFilterProvider *get_provider() const;
56 
58  void set_volume(float new_volume);
59 
61  void fade_to_volume(float new_volume, int duration = 1000);
62  };
63 
65 }
Definition: clanapp.h:35
void fade_to_volume(float new_volume, int duration=1000)
Fade to volume, from 0.0f (no volume) to 1.0f (full volume).
float get_volume() const
Returns the current volume of the fade filter, from 0.0f (no volume) to 1.0f (full volume)...
void set_volume(float new_volume)
Sets the volume instant.
FadeFilterProvider * get_provider() const
Retrieves the provider.
Sound Filter Class.
Definition: soundfilter.h:43
FadeFilter(float initial_volume)
Fade Filter Constructor.
virtual ~FadeFilter()
Fade Filter Destructor.
Fade Filter Class.
Definition: fadefilter.h:42