Documentation de SFML 2.5.1

sf::Listener Class Reference

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. More...
 
static float getGlobalVolume ()
 Get the current value of the global volume. More...
 
static void setPosition (float x, float y, float z)
 Set the position of the listener in the scene. More...
 
static void setPosition (const Vector3f &position)
 Set the position of the listener in the scene. More...
 
static Vector3f getPosition ()
 Get the current position of the listener in the scene. More...
 
static void setDirection (float x, float y, float z)
 Set the forward vector of the listener in the scene. More...
 
static void setDirection (const Vector3f &direction)
 Set the forward vector of the listener in the scene. More...
 
static Vector3f getDirection ()
 Get the current forward vector of the listener in the scene. More...
 
static void setUpVector (float x, float y, float z)
 Set the upward vector of the listener in the scene. More...
 
static void setUpVector (const Vector3f &upVector)
 Set the upward vector of the listener in the scene. More...
 
static Vector3f getUpVector ()
 Get the current upward vector of the listener in the scene. More...
 

Detailed Description

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, direction and up vector), 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 instantiated.

Usage example:

// Move the listener to the position (1, 0, -5)
// Make it face the right axis (1, 0, 0)
// Reduce the global volume

Definition at line 42 of file Listener.hpp.

Member Function Documentation

◆ getDirection()

static Vector3f sf::Listener::getDirection ( )
static

Get the current forward vector of the listener in the scene.

Returns
Listener's forward vector (not normalized)
See also
setDirection

◆ getGlobalVolume()

static float sf::Listener::getGlobalVolume ( )
static

Get the current value of the global volume.

Returns
Current global volume, in the range [0, 100]
See also
setGlobalVolume

◆ getPosition()

static Vector3f sf::Listener::getPosition ( )
static

Get the current position of the listener in the scene.

Returns
Listener's position
See also
setPosition

◆ getUpVector()

static Vector3f sf::Listener::getUpVector ( )
static

Get the current upward vector of the listener in the scene.

Returns
Listener's upward vector (not normalized)
See also
setUpVector

◆ setDirection() [1/2]

static void sf::Listener::setDirection ( float  x,
float  y,
float  z 
)
static

Set the forward vector of the listener in the scene.

The direction (also called "at vector") is the vector pointing forward from the listener's perspective. Together with the up vector, it defines the 3D orientation of the listener in the scene. The direction vector doesn't have to be normalized. The default listener's direction is (0, 0, -1).

Parameters
xX coordinate of the listener's direction
yY coordinate of the listener's direction
zZ coordinate of the listener's direction
See also
getDirection, setUpVector, setPosition

◆ setDirection() [2/2]

static void sf::Listener::setDirection ( const Vector3f direction)
static

Set the forward vector of the listener in the scene.

The direction (also called "at vector") is the vector pointing forward from the listener's perspective. Together with the up vector, it defines the 3D orientation of the listener in the scene. The direction vector doesn't have to be normalized. The default listener's direction is (0, 0, -1).

Parameters
directionNew listener's direction
See also
getDirection, setUpVector, setPosition

◆ setGlobalVolume()

static void sf::Listener::setGlobalVolume ( float  volume)
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).

Parameters
volumeNew global volume, in the range [0, 100]
See also
getGlobalVolume

◆ setPosition() [1/2]

static void sf::Listener::setPosition ( float  x,
float  y,
float  z 
)
static

Set the position of the listener in the scene.

The default listener's position is (0, 0, 0).

Parameters
xX coordinate of the listener's position
yY coordinate of the listener's position
zZ coordinate of the listener's position
See also
getPosition, setDirection

◆ setPosition() [2/2]

static void sf::Listener::setPosition ( const Vector3f position)
static

Set the position of the listener in the scene.

The default listener's position is (0, 0, 0).

Parameters
positionNew listener's position
See also
getPosition, setDirection

◆ setUpVector() [1/2]

static void sf::Listener::setUpVector ( float  x,
float  y,
float  z 
)
static

Set the upward vector of the listener in the scene.

The up vector is the vector that points upward from the listener's perspective. Together with the direction, it defines the 3D orientation of the listener in the scene. The up vector doesn't have to be normalized. The default listener's up vector is (0, 1, 0). It is usually not necessary to change it, especially in 2D scenarios.

Parameters
xX coordinate of the listener's up vector
yY coordinate of the listener's up vector
zZ coordinate of the listener's up vector
See also
getUpVector, setDirection, setPosition

◆ setUpVector() [2/2]

static void sf::Listener::setUpVector ( const Vector3f upVector)
static

Set the upward vector of the listener in the scene.

The up vector is the vector that points upward from the listener's perspective. Together with the direction, it defines the 3D orientation of the listener in the scene. The up vector doesn't have to be normalized. The default listener's up vector is (0, 1, 0). It is usually not necessary to change it, especially in 2D scenarios.

Parameters
upVectorNew listener's up vector
See also
getUpVector, setDirection, setPosition

The documentation for this class was generated from the following file: