mirror/sointu
1
0
Fork 0
mirror of https://github.com/vsariola/sointu.git synced 2025-05-25 18:00:37 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: add go doc comments to 4klang conversion functions

Browse Source
This commit is contained in:
5684185+vsariola@users.noreply.github.com 2023-10-19 10:52:52 +03:00
parent b6815f70cb
commit 15a340317f
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
4klang.go
View File

@ -7,6 +7,10 @@ import (
"io" "io"
) )
// Read4klangPatch reads a 4klang patch (a file usually with .4kp extension)
// from r and returns a Patch, making best attempt to convert 4klang file to a
// sointu Patch. It returns an error if the file is malformed or if the 4kp file
// version is not supported.
func Read4klangPatch(r io.Reader) (patch Patch, err error) { func Read4klangPatch(r io.Reader) (patch Patch, err error) {
var versionTag uint32 var versionTag uint32
var version int var version int
@ -53,6 +57,10 @@ func Read4klangPatch(r io.Reader) (patch Patch, err error) {
return return
} }
// Read4klangInstrument reads a 4klang instrument (a file usually with .4ki
// extension) from r and returns an Instrument, making best attempt to convert
// 4ki file to a sointu Instrument. It returns an error if the file is malformed
// or if the 4ki file version is not supported.
func Read4klangInstrument(r io.Reader) (instr Instrument, err error) { func Read4klangInstrument(r io.Reader) (instr Instrument, err error) {
var versionTag uint32 var versionTag uint32
var version int var version int