capo::IEngine Class Reference

Audio Engine. API to create Audio Sources. Represents 3D spatialized listener. Uses default audio device. More...

#include <capo/engine.hpp>

Inheritance diagram for capo::IEngine:

Public Member Functions
virtual auto	create_source () -> std::unique_ptr< ISource >=0
	Create an Audio Source.
virtual auto	get_position () const -> Vec3f=0
	Obtain the listener's 3D position.
virtual void	set_position (Vec3f const &position)=0
	Set the listener's 3D position.
virtual auto	get_direction () const -> Vec3f=0
	Obtain the listener's direction as a unit vector.
virtual void	set_direction (Vec3f const &direction)=0
	Set the listener's direction as a unit vector.
virtual auto	get_world_up () const -> Vec3f=0
	Obtain the world up as a unit vector.
virtual void	set_world_up (Vec3f const &direction)=0
	Set the world up as a unit vector.
Public Member Functions inherited from capo::Polymorphic
	Polymorphic ()=default
virtual	~Polymorphic ()=default
	Polymorphic (Polymorphic const &)=default
	Polymorphic (Polymorphic &&)=default
auto	operator= (Polymorphic const &) -> Polymorphic &=default
auto	operator= (Polymorphic &&) -> Polymorphic &=default

Detailed Description

Audio Engine. API to create Audio Sources. Represents 3D spatialized listener. Uses default audio device.

Member Function Documentation

create_source()

virtual auto capo::IEngine::create_source ( ) -> std::unique_ptr< ISource >

pure virtual

Create an Audio Source.

Returns

null on failure.

get_direction()

virtual auto capo::IEngine::get_direction ( ) const -> Vec3f

pure virtual

Obtain the listener's direction as a unit vector.

get_position()

virtual auto capo::IEngine::get_position ( ) const -> Vec3f

pure virtual

Obtain the listener's 3D position.

get_world_up()

virtual auto capo::IEngine::get_world_up ( ) const -> Vec3f

pure virtual

Obtain the world up as a unit vector.

set_direction()

virtual void capo::IEngine::set_direction ( Vec3f const &  direction )

pure virtual

Set the listener's direction as a unit vector.

set_position()

virtual void capo::IEngine::set_position ( Vec3f const &  position )

pure virtual

Set the listener's 3D position.

set_world_up()

virtual void capo::IEngine::set_world_up ( Vec3f const &  direction )

pure virtual

Set the world up as a unit vector.

---

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

• engine.hpp