fadefilter.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 **    Mark Page
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_sound.h"
00036 #include "../soundfilter.h"
00037 
00038 class CL_FadeFilterProvider;
00039 
00043 class CL_API_SOUND CL_FadeFilter : public CL_SoundFilter
00044 {
00047 
00048 public:
00050         CL_FadeFilter(float initial_volume);
00051 
00053         virtual ~CL_FadeFilter();
00054 
00058 
00059 public:
00061         float get_volume() const;
00062 
00066 
00067 public:
00068 
00070         CL_FadeFilterProvider *get_provider() const;
00071 
00073         void set_volume(float new_volume);
00074 
00076         void fade_to_volume(float new_volume, int duration = 1000);
00077 
00081 
00082 private:
00084 };
00085