Audaspace  1.3.0
A high level audio library.
VolumeStorage.h
Go to the documentation of this file.
1 /*******************************************************************************
2 * Copyright 2015-2016 Juan Francisco Crespo Galán
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16 
17 #pragma once
18 
25 #include "Audaspace.h"
26 
27 #include <atomic>
28 
30 
35 {
36 private:
40  std::atomic<float> m_volume;
41 
42  // delete copy constructor and operator=
43  VolumeStorage(const VolumeStorage&) = delete;
44  VolumeStorage& operator=(const VolumeStorage&) = delete;
45 
46 public:
51 
56  VolumeStorage(float volume);
57 
62  float getVolume();
63 
68  void setVolume(float volume);
69 };
70 
VolumeStorage
This class stores a volume value and allows to change if for a number of sounds in one go.
Definition: VolumeStorage.h:35
VolumeStorage::VolumeStorage
VolumeStorage(float volume)
Creates a VolumeStorage instance with an initial value.
VolumeStorage::getVolume
float getVolume()
Retrieves the current volume value.
VolumeStorage::setVolume
void setVolume(float volume)
Changes the volume value.
AUD_NAMESPACE_END
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition: Audaspace.h:119
AUD_NAMESPACE_BEGIN
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition: Audaspace.h:116
AUD_API
#define AUD_API
Used for exporting symbols in the shared library.
Definition: Audaspace.h:93
VolumeStorage::VolumeStorage
VolumeStorage()
Creates a new VolumeStorage instance with volume 1.
Audaspace.h
The main header file of the library defining the namespace and basic data types.