Skip to content

Commit 7bcc46f

Browse files
committed
Add information to godocs what is not implemented yet
1 parent 4549d6d commit 7bcc46f

File tree

1 file changed

+37
-35
lines changed

1 file changed

+37
-35
lines changed

audio/audio.go

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ func Sfx(sfxNo int, channel Channel, offset, length int) {
3636
//
3737
// channelMask is a bitfield indicating which of the four sound channels
3838
// should be reserved for music.
39+
//
40+
// Not implemented yet.
3941
func Music(patterNo int, fadeMs int, channelMask byte) {
4042
system.Music(patterNo, fadeMs, channelMask)
4143
}
@@ -102,22 +104,22 @@ const (
102104

103105
type Stat struct {
104106
Sfx [4]int // -1 means no sfx on channel
105-
Note [4]int // -1 means no sfx on channel
106-
Pattern int // currently played music pattern
107-
PatternsCount int // the number of music patterns played since the most recent call to Music().
108-
TicksCount int // the number of ticks (notes or rests) played on the current pattern.
107+
Note [4]int // -1 means no sfx on channel. Not implemented yet.
108+
Pattern int // currently played music pattern. Not implemented yet.
109+
PatternsCount int // the number of music patterns played since the most recent call to Music(). Not implemented yet.
110+
TicksCount int // the number of ticks (notes or rests) played on the current pattern. Not implemented yet.
109111
}
110112

111113
type SoundEffect struct {
112114
Notes [32]Note
113115
Speed byte // 1 is the fastest (~8.33ms). For 120 the length of one note becomes 1 second. 0 means SoundEffect takes no time.
114116
LoopStart byte // 0-63. Notes 32-63 are silent.
115117
LoopStop byte // 0-63. Notes 32-63 are silent.
116-
Detune byte // 0 (disabled), 1 or 2
117-
Reverb byte // 0 (disabled), 1 or 2
118-
Dampen byte // 0 (disabled), 1 or 2
119-
Noiz bool
120-
Buzz bool
118+
Detune byte // 0 (disabled), 1 or 2. Not implemented yet.
119+
Reverb byte // 0 (disabled), 1 or 2. Not implemented yet.
120+
Dampen byte // 0 (disabled), 1 or 2. Not implemented yet.
121+
Noiz bool // Not implemented yet.
122+
Buzz bool // Not implemented yet.
121123
}
122124

123125
func (s SoundEffect) noteAt(no int) Note {
@@ -132,7 +134,7 @@ type Note struct {
132134
Pitch Pitch // 0-63
133135
Instrument Instrument // 0-15
134136
Volume Volume // 0-7
135-
Effect Effect // 0-7
137+
Effect Effect // 0-7. Not implemented yet.
136138
}
137139

138140
type Volume byte
@@ -225,42 +227,42 @@ const (
225227
InstrumentSquare Instrument = 3
226228
InstrumentPulse Instrument = 4
227229
InstrumentOrgan Instrument = 5
228-
InstrumentNoise Instrument = 6
229-
InstrumentPhaser Instrument = 7
230-
InstrumentSfx0 Instrument = 8
231-
InstrumentSfx1 Instrument = 9
232-
InstrumentSfx2 Instrument = 10
233-
InstrumentSfx3 Instrument = 11
234-
InstrumentSfx4 Instrument = 12
235-
InstrumentSfx5 Instrument = 13
236-
InstrumentSfx6 Instrument = 14
237-
InstrumentSfx7 Instrument = 15
230+
InstrumentNoise Instrument = 6 // Not implemented yet.
231+
InstrumentPhaser Instrument = 7 // Not implemented yet.
232+
InstrumentSfx0 Instrument = 8 // Not implemented yet.
233+
InstrumentSfx1 Instrument = 9 // Not implemented yet.
234+
InstrumentSfx2 Instrument = 10 // Not implemented yet.
235+
InstrumentSfx3 Instrument = 11 // Not implemented yet.
236+
InstrumentSfx4 Instrument = 12 // Not implemented yet.
237+
InstrumentSfx5 Instrument = 13 // Not implemented yet.
238+
InstrumentSfx6 Instrument = 14 // Not implemented yet.
239+
InstrumentSfx7 Instrument = 15 // Not implemented yet.
238240
)
239241

240-
type Effect byte
242+
type Effect byte // Not implemented yet.
241243

242244
const (
243-
EffectNoEffect Effect = 0
244-
EffectSlide Effect = 1
245-
EffectVibrato Effect = 2
246-
EffectDrop Effect = 3
247-
EffectFadeIn Effect = 4
248-
EffectFadeOut Effect = 5
249-
EffectArpFast Effect = 6
250-
EffectArpSlow Effect = 7
245+
EffectNoEffect Effect = 0 // Not implemented yet.
246+
EffectSlide Effect = 1 // Not implemented yet.
247+
EffectVibrato Effect = 2 // Not implemented yet.
248+
EffectDrop Effect = 3 // Not implemented yet.
249+
EffectFadeIn Effect = 4 // Not implemented yet.
250+
EffectFadeOut Effect = 5 // Not implemented yet.
251+
EffectArpFast Effect = 6 // Not implemented yet.
252+
EffectArpSlow Effect = 7 // Not implemented yet.
251253
)
252254

253255
// Pattern is a music pattern
254256
type Pattern struct {
255-
Sfx [4]PatternSfx
256-
BeginLoop bool
257-
EndLoop bool
258-
StopAtTheEnd bool
257+
Sfx [4]PatternSfx // Not implemented yet.
258+
BeginLoop bool // Not implemented yet.
259+
EndLoop bool // Not implemented yet.
260+
StopAtTheEnd bool // Not implemented yet.
259261
}
260262

261263
type PatternSfx struct {
262-
SfxNo byte // 0-63
263-
Enabled bool
264+
SfxNo byte // 0-63. Not implemented yet.
265+
Enabled bool // Not implemented yet.
264266
}
265267

266268
func byteToBool(b byte) bool {

0 commit comments

Comments
 (0)