vae::core::Source Struct Reference

#include <vae_source.hpp>

Collaboration diagram for vae::core::Source:

Public Types
enum class	Format { wav , ogg , generator }

Public Member Functions
	Source ()

Public Attributes
SourceHandle	id
bool	stream: 1
	If false entire sample will be loaded in ram, there's no streaming for now. More...
bool	resample: 1
	Whether the sound will be resampled when loading it. More...
bool	raw: 1
	The data in path is a data buffer. More...
enum vae::core::Source::Format	format
Sample	gain
	Gain applied to every voice creatd frin this source. More...
AudioBuffer	signal
	Audio signal itself loaded by SourceLoader. More...
PathString	path
	Filesystem path. More...
NameString	name
	Name for debugging. More...

Detailed Description

Definition at line 9 of file vae_source.hpp.

Member Enumeration Documentation

Format

enum class vae::core::Source::Format

strong

Enumerator
wav	Uses dr_wav to decode wavs.
ogg	Uses stb_vorbis to decode oggs.
generator	Not implemented.

Definition at line 14 of file vae_source.hpp.

                          {
            wav,            ///< Uses dr_wav to decode wavs
            ogg,            ///< Uses stb_vorbis to decode oggs
            generator       ///< Not implemented
        } format : 2;

Constructor & Destructor Documentation

Source()

vae::core::Source::Source ( )

inline

Definition at line 25 of file vae_source.hpp.

                 {
            stream = false;
            resample = false;
            gain = 1.0;
            id = InvalidSourceHandle;
            raw = false;
        }

Member Data Documentation

format

enum vae::core::Source::Format vae::core::Source::format

gain

Sample vae::core::Source::gain

Gain applied to every voice creatd frin this source.

Definition at line 20 of file vae_source.hpp.

id

SourceHandle vae::core::Source::id

Definition at line 10 of file vae_source.hpp.

name

NameString vae::core::Source::name

Name for debugging.

Definition at line 23 of file vae_source.hpp.

path

PathString vae::core::Source::path

Filesystem path.

Definition at line 22 of file vae_source.hpp.

raw

bool vae::core::Source::raw

The data in path is a data buffer.

Definition at line 13 of file vae_source.hpp.

resample

bool vae::core::Source::resample

Whether the sound will be resampled when loading it.

Definition at line 12 of file vae_source.hpp.

signal

AudioBuffer vae::core::Source::signal

Audio signal itself loaded by SourceLoader.

Definition at line 21 of file vae_source.hpp.

stream

bool vae::core::Source::stream

If false entire sample will be loaded in ram, there's no streaming for now.

Definition at line 11 of file vae_source.hpp.

---

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

• vae_source.hpp