D:/Programmation/Cpp/SFML/src/SFML/Audio/Sound.hpp

00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages 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 freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_SOUND_HPP
00026 #define SFML_SOUND_HPP
00027 
00029 // Headers
00031 #include <SFML/Audio/SoundImpl.hpp>
00032 #include <SFML/Utilities/SharedPtr.hpp>
00033 
00034 class sfSoundBuffer;
00035 
00036 
00043 class SFML_API sfSound
00044 {
00045 public :
00046 
00059     sfSound(const sfSoundBuffer* Buffer = NULL, bool Loop = false, float Pitch = 1.f, float Volume = 100.f, float X = 0.f, float Y = 0.f, float Z = 0.f);
00060 
00065     void Play();
00066 
00071     void Pause();
00072 
00077     void Stop();
00078 
00085     void SetBuffer(const sfSoundBuffer* Buffer);
00086 
00093     void SetLoop(bool Loop);
00094 
00101     void SetPitch(float Pitch);
00102 
00109     void SetVolume(float Volume);
00110 
00119     void SetPosition(float X, float Y, float Z);
00120 
00127     const sfSoundBuffer* GetBuffer() const;
00128 
00135     bool GetLoop() const;
00136 
00143     float GetPitch() const;
00144 
00151     float GetVolume() const;
00152 
00161     void GetPosition(float& X, float& Y, float& Z) const;
00162 
00169     sfSoundStatus GetStatus() const;
00170 
00177     float GetPlayingOffset() const;
00178 
00179 private :
00180 
00186     void CloneIfNotUnique();
00187 
00189     // Member data
00191     sfSharedPtr<sf_private::sfSoundImpl> myImpl;   
00192     const sfSoundBuffer*                 myBuffer; 
00193 };
00194 
00195 
00196 #endif // SFML_SOUND_HPP

Generated for SFML by  doxygen 1.5.2