Documentation of SFML 2.6.1

Loading...
Searching...
No Matches
Listener.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages 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 freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_LISTENER_HPP
26#define SFML_LISTENER_HPP
27
29// Headers
31#include <SFML/Audio/Export.hpp>
32#include <SFML/System/Vector3.hpp>
33
34
35namespace sf
36{
42class SFML_AUDIO_API Listener
43{
44public:
45
58 static void setGlobalVolume(float volume);
59
68 static float getGlobalVolume();
69
82 static void setPosition(float x, float y, float z);
83
94 static void setPosition(const Vector3f& position);
95
105
123 static void setDirection(float x, float y, float z);
124
140 static void setDirection(const Vector3f& direction);
141
151
169 static void setUpVector(float x, float y, float z);
170
186 static void setUpVector(const Vector3f& upVector);
187
197};
198
199} // namespace sf
200
201
202#endif // SFML_LISTENER_HPP
203
204
The audio listener is the point in the scene from where all the sounds are heard.
Definition Listener.hpp:43
static void setUpVector(float x, float y, float z)
Set the upward vector of the listener in the scene.
static float getGlobalVolume()
Get the current value of the global volume.
static void setDirection(const Vector3f &direction)
Set the forward vector of the listener in the scene.
static void setUpVector(const Vector3f &upVector)
Set the upward vector of the listener in the scene.
static void setPosition(const Vector3f &position)
Set the position of the listener in the scene.
static Vector3f getDirection()
Get the current forward vector of the listener in the scene.
static void setPosition(float x, float y, float z)
Set the position of the listener in the scene.
static void setGlobalVolume(float volume)
Change the global volume of all the sounds and musics.
static Vector3f getPosition()
Get the current position of the listener in the scene.
static Vector3f getUpVector()
Get the current upward vector of the listener in the scene.
static void setDirection(float x, float y, float z)
Set the forward vector of the listener in the scene.
Utility template class for manipulating 3-dimensional vectors.
Definition Vector3.hpp:38