The audio listener is the point in the scene from where all the sounds are heard. More...
#include <Listener.hpp>
Static Public Member Functions | |
static void | setGlobalVolume (float volume) |
Change the global volume of all the sounds and musics. | |
static float | getGlobalVolume () |
Get the current value of the global volume. | |
static void | setPosition (float x, float y, float z) |
Set the position of the listener in the scene. | |
static void | setPosition (const Vector3f &position) |
Set the position of the listener in the scene. | |
static Vector3f | getPosition () |
Get the current position of the listener in the scene. | |
static void | setDirection (float x, float y, float z) |
Set the orientation of the listener in the scene. | |
static void | setDirection (const Vector3f &direction) |
Set the orientation of the listener in the scene. | |
static Vector3f | getDirection () |
Get the current orientation of the listener in the scene. | |
The audio listener is the point in the scene from where all the sounds are heard.
The audio listener defines the global properties of the audio environment, it defines where and how sounds and musics are heard.
If sf::View is the eyes of the user, then sf::Listener is his ears (by the way, they are often linked together – same position, orientation, etc.).
sf::Listener is a simple interface, which allows to setup the listener in the 3D audio environment (position and direction), and to adjust the global volume.
Because the listener is unique in the scene, sf::Listener only contains static functions and doesn't have to be instanciated.
Usage example:
Definition at line 42 of file Listener.hpp.
|
static |
Get the current orientation of the listener in the scene.
|
static |
Get the current value of the global volume.
|
static |
Get the current position of the listener in the scene.
|
static |
Set the orientation of the listener in the scene.
The orientation defines the 3D axes of the listener (left, up, front) in the scene. The orientation vector doesn't have to be normalized. The default listener's orientation is (0, 0, -1).
x | X coordinate of the listener's orientation |
y | Y coordinate of the listener's orientation |
z | Z coordinate of the listener's orientation |
|
static |
Set the orientation of the listener in the scene.
The orientation defines the 3D axes of the listener (left, up, front) in the scene. The orientation vector doesn't have to be normalized. The default listener's orientation is (0, 0, -1).
direction | New listener's orientation |
|
static |
Change the global volume of all the sounds and musics.
The volume is a number between 0 and 100; it is combined with the individual volume of each sound / music. The default value for the volume is 100 (maximum).
volume | New global volume, in the range [0, 100] |
|
static |
Set the position of the listener in the scene.
The default listener's position is (0, 0, 0).
x | X coordinate of the listener's position |
y | Y coordinate of the listener's position |
z | Z coordinate of the listener's position |
|
static |
Set the position of the listener in the scene.
The default listener's position is (0, 0, 0).
position | New listener's position |