diff options
| author | engineer124 <47598039+engineer124@users.noreply.github.com> | 2022-08-15 14:39:57 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-15 14:39:57 -0400 |
| commit | 82fe521721ecd8506e4bc5954e406db1e8de8edc (patch) | |
| tree | 8c9d59f81335145084e25fa2142b9bb03cf73e6b /include/sfx.h | |
| parent | 0082c299c62ca5debfbaee1ce21d67df7fb0b441 (diff) | |
Audio Sfx (code_801A5BD0 and selected sfx functions in code_8019AF00.c) OK and Documented (#798)
* Rename functions
* code_801A5BD0 OK
* PR 1, improve spacing
* Rename unused struct
* Rename Sfx Variables
* PR Feedback, update names
* Add comment
* cleanup vars
* Fix merge
* Rework documentation, include more functions in sfx system
* PR suggestions
* fix AudioSfx_MuteBanks
* missed enum
* more cleanup
* more suggestions
Diffstat (limited to 'include/sfx.h')
| -rw-r--r-- | include/sfx.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/include/sfx.h b/include/sfx.h index 6f432db98..33c79abf4 100644 --- a/include/sfx.h +++ b/include/sfx.h @@ -1,6 +1,19 @@ #ifndef SFX_H #define SFX_H +/** + * With `SFX_FLAG` on, play the entire sfx audio clip. + * Requesting the sfx while playing will restart the sfx from the beginning. + * i.e. sfx only needs to be requested once. + * + * With `SFX_FLAG` off, play the sfx for only one frame. + * Requesting the sfx while playing will allow the sfx to continue to the next frame. + * i.e. sfx needs to be requested every frame. + * + * By default, `SFX_FLAG` is on. + * Use `- SFX_FLAG` to turn `SFX_FLAG` off. + */ +#define SFX_FLAG_MASK 0xC00 #define SFX_FLAG 0x800 // ------------ PLAYER ------------ |