![]() |
![]() |
![]() |
Buzztard Bt-Core Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
#include <libbtcore/core.h> struct BtWavetable; gboolean bt_wavetable_add_wave (const BtWavetable * const self
,const BtWave * const wave
); BtWave * bt_wavetable_get_wave_by_index (const BtWavetable * const self
,const gulong index
); BtWavetable * bt_wavetable_new (const BtSong * const song
); void bt_wavetable_remember_missing_wave (const BtWavetable * const self
,const gchar * const str
); gboolean bt_wavetable_remove_wave (const BtWavetable * const self
,const BtWave * const wave
);
"missing-waves" gpointer : Read "song" BtSong* : Read / Write / Construct Only "waves" gpointer : Read
Each wave table entry can constist of multiple BtWaves, were each of the waves has a BtWavelevel with the data for a note range.
gboolean bt_wavetable_add_wave (const BtWavetable * const self
,const BtWave * const wave
);
Add the supplied wave to the wavetable. This is automatically done by
#bt_wave_new()
.
|
the wavetable to add the wave to |
|
the new wave instance |
Returns : |
TRUE for success, FALSE otheriwse |
BtWave * bt_wavetable_get_wave_by_index (const BtWavetable * const self
,const gulong index
);
Search the wavetable for a wave by the supplied index.
The wave must have been added previously to this wavetable with bt_wavetable_add_wave()
.
Unref the wave, when done with it.
|
the wavetable to search for the wave |
|
the index of the wave |
Returns : |
BtWave instance or NULL if not found |
BtWavetable * bt_wavetable_new (const BtSong * const song
);
Create a new instance
|
the song the new instance belongs to |
Returns : |
the new instance or NULL in case of an error |
void bt_wavetable_remember_missing_wave (const BtWavetable * const self
,const gchar * const str
);
Loaders can use this function to collect information about wavetable entries that failed to load. The front-end can access this later by reading BtWavetable::missing-waves property.
|
the wavetable |
|
human readable description of the missing wave |
gboolean bt_wavetable_remove_wave (const BtWavetable * const self
,const BtWave * const wave
);
Remove the supplied wave from the wavetable.
|
the wavetable to remove the wave from |
|
the wave instance |
Returns : |
TRUE for success, FALSE otheriwse |
"missing-waves"
property "missing-waves" gpointer : Read
The list of missing waves, don't change.
"song"
property"song" BtSong* : Read / Write / Construct Only
Set song object, the wavetable belongs to.
"wave-added"
signalvoid user_function (BtWavetable *self,
BtWave *wave,
gpointer user_data) : No Hooks
A new wave item has been added to the wavetable
|
the wavetable object that emitted the signal |
|
the new wave |
|
user data set when the signal handler was connected. |
"wave-removed"
signalvoid user_function (BtWavetable *self,
BtWave *wave,
gpointer user_data) : No Hooks
A wave item has been removed from the wavetable
|
the setup object that emitted the signal |
|
the old wave |
|
user data set when the signal handler was connected. |