sf::Listener

sf::Listener Class Reference

Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. More...

#include <Listener.hpp>

List of all members.


Static Public Member Functions

static void SetGlobalVolume (float Volume)
 Change the global volume of all the sounds.
static float GetGlobalVolume ()
 Get the current value of the global volume of all the sounds.
static void SetPosition (float PosX, float PosY, float PosZ)
 Change the position of the listener.
static void GetPosition (float &PosX, float &PosY, float &PosZ)
 Get the current position of the listener.
static void SetTarget (float TargetX, float TargetY, float TargetZ)
 Change the orientation of the listener (the point he must look at).
static void GetTarget (float &TargetX, float &TargetY, float &TargetZ)
 Get the current orientation of the listener (the point he's looking at).

Detailed Description

Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard.

Definition at line 41 of file Listener.hpp.

Member Function Documentation

static void sf::Listener::SetGlobalVolume ( float  Volume  )  [static]

Change the global volume of all the sounds.

The default volume is 100

Parameters:
Volume : New global volume, in the range [0, 100]

static float sf::Listener::GetGlobalVolume (  )  [static]

Get the current value of the global volume of all the sounds.

Returns:
Current global volume, in the range [0, 100]

static void sf::Listener::SetPosition ( float  PosX,
float  PosY,
float  PosZ 
) [static]

Change the position of the listener.

The default position is (0, 0, 0)

Parameters:
PosX : X position of the listener in the world
PosY : Y position of the listener in the world
PosZ : Z position of the listener in the world

static void sf::Listener::GetPosition ( float &  PosX,
float &  PosY,
float &  PosZ 
) [static]

Get the current position of the listener.

Parameters:
PosX : X position of the listener in the world
PosY : Y position of the listener in the world
PosZ : Z position of the listener in the world

static void sf::Listener::SetTarget ( float  TargetX,
float  TargetY,
float  TargetZ 
) [static]

Change the orientation of the listener (the point he must look at).

The default target is (0, 0, -1)

Parameters:
TargetX : X position of the point the listener must look at
TargetY : X position of the point the listener must look at
TargetZ : X position of the point the listener must look at

static void sf::Listener::GetTarget ( float &  TargetX,
float &  TargetY,
float &  TargetZ 
) [static]

Get the current orientation of the listener (the point he's looking at).

Parameters:
TargetX : X position of the point the listener is looking at
TargetY : X position of the point the listener is looking at
TargetZ : X position of the point the listener is looking at

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