SfxTypes.hpp File Reference

Sound effect identifiers, categories, and the SoundClip data type. More...

#include <SDL3/SDL_audio.h>
#include <cstddef>
#include <cstdint>
#include <optional>
#include <string_view>
#include <vector>

Include dependency graph for SfxTypes.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SoundClip
	A decoded sound clip ready for playback. More...

Enumerations
enum class	SfxId : uint8_t {   RifleFire , RocketFire , RailGunFire , EnergyGunFire ,   ShotgunFire , RifleReload , RocketReload , RailGunReload ,   EnergyReload , ShotgunReload , RailGunCharge , FleshHit ,   Headshot , Explosion , RocketExplosion , MolotovExplosion ,   HEExplosion , DamageTaken , ArmorBreak , Death ,   KillConfirm , ChargeRifleLoad , ChargeRifleShoot , EnergyBeamLoop ,   Healing , PowerupPickup , DamagePowerupPickup , OvershieldPowerupPickup ,   FootstepLight , FootstepHeavy , ConcreteFootstep01 , ConcreteFootstep02 ,   ConcreteFootstep03 , ConcreteFootstep04 , ConcreteFootstep05 , ConcreteFootstep06 ,   ConcreteFootstep07 , ConcreteFootstep08 , ConcreteFootstep09 , ConcreteFootstep10 ,   ConcreteFootstep11 , ConcreteFootstep12 , ConcreteFootstep13 , ConcreteFootstep14 ,   ConcreteFootstep15 , ConcreteFootstep16 , ConcreteFootstep17 , DirtFootstep01 ,   DirtFootstep02 , DirtFootstep03 , DirtFootstep04 , DirtFootstep05 ,   DirtFootstep06 , DirtFootstep07 , DirtFootstep08 , DirtFootstep09 ,   DirtFootstep10 , DirtFootstep11 , DirtFootstep12 , DirtFootstep13 ,   DirtFootstep14 , Slide , DashSfx , GravityFlipSfx ,   GrappleSfx , RecallSfx , GrenadeThrow , VoiceStart ,   VoiceStop , MenuMusic , GameMusic , GameMusicLoop ,   UiHover01 , UiHover02 , UiConfirm01 , UiConfirm02 ,   UiBack01 , UiToggle01 , UiSliderStep01 , UiModal01 ,   UiSuccess01 , UiError01 , UiError02 , UiDisabled01 ,   UiDanger01 , _Count }
	Identifies a loaded sound clip. More...
enum class	UiSoundAction : uint8_t {   Hover , Confirm , Back , Toggle ,   SliderStep , ModalOpen , ModalClose , Success ,   Error , Disabled , Danger , _Count }
	Semantic menu/UI sound actions. More...
enum class	SfxCategory : uint8_t {   Weapons , Impacts , Player , Footsteps ,   Voice , Music , UI , _Count }
	Sound category for per-category volume control. More...

Functions
const char *	sfxIdName (SfxId id) noexcept
std::optional< SfxId >	sfxIdFromName (std::string_view name) noexcept
const char *	sfxCategoryName (SfxCategory category) noexcept

Detailed Description

Sound effect identifiers, categories, and the SoundClip data type.

Enumeration Type Documentation

SfxCategory

enum class SfxCategory : uint8_t

strong

Sound category for per-category volume control.

Enumerator
Weapons
Impacts
Player
Footsteps
Voice
Music
UI
_Count

SfxId

enum class SfxId : uint8_t

strong

Identifies a loaded sound clip.

Enumerator
RifleFire	Weapons/Rifle/Rifle_Shooting.wav.
RocketFire	Weapons/Rocket/Rocket_Shooting.wav.
RailGunFire	Weapons/Railgun/Railgun_Shooting.wav.
EnergyGunFire	Weapons/EnergyWeapon/Energy_Shooting_Start.wav.
ShotgunFire	Weapons/Shotgun/Shotgun_Shooting.wav.
RifleReload	Weapons/Rifle/Rifle_Reloading.wav.
RocketReload	Weapons/Rocket/Rocket_Reloading.wav.
RailGunReload	Weapons/Railgun/Railgun_Reloading.wav.
EnergyReload	Weapons/EnergyWeapon/Energy_Reloading.wav.
ShotgunReload	Weapons/Shotgun/Shotgun_Reloading.wav.
RailGunCharge	Weapons/Railgun/Railgun_Charge.wav.
FleshHit	Voicy_Flesh Bullet Impact SFX.mp3.
Headshot	Voicy_Headshot Rapid SFX.mp3.
Explosion	Generic explosion fallback.
RocketExplosion	Weapons/Rocket/Explosion_Rocket.wav.
MolotovExplosion	Weapons/Grenade/Explosion_Molotov.wav.
HEExplosion	Weapons/Grenade/Explosion_HE.wav.
DamageTaken	damage.mp3
ArmorBreak	Voicy_Fortnite Shield Break.mp3.
Death	Death.wav.
KillConfirm	Voicy_Pilot Killed Indicator SFX.mp3.
ChargeRifleLoad	Legacy charge cue alias.
ChargeRifleShoot	charge-rifle-shoot.wav (play on release)
EnergyBeamLoop	Weapons/EnergyWeapon/Energy_Shooting.wav (play while beam active).
Healing	Health.wav.
PowerupPickup	Generic powerup pickup fallback.
DamagePowerupPickup	damage_powerup.mp3
OvershieldPowerupPickup	overshield_powerup.mp3
FootstepLight
FootstepHeavy
ConcreteFootstep01
ConcreteFootstep02
ConcreteFootstep03
ConcreteFootstep04
ConcreteFootstep05
ConcreteFootstep06
ConcreteFootstep07
ConcreteFootstep08
ConcreteFootstep09
ConcreteFootstep10
ConcreteFootstep11
ConcreteFootstep12
ConcreteFootstep13
ConcreteFootstep14
ConcreteFootstep15
ConcreteFootstep16
ConcreteFootstep17
DirtFootstep01
DirtFootstep02
DirtFootstep03
DirtFootstep04
DirtFootstep05
DirtFootstep06
DirtFootstep07
DirtFootstep08
DirtFootstep09
DirtFootstep10
DirtFootstep11
DirtFootstep12
DirtFootstep13
DirtFootstep14
Slide	sliding.mp3 — looped while in Slide mode.
DashSfx	Synth: dash whoosh.
GravityFlipSfx	Synth: gravity flip warble.
GrappleSfx	Synth: grapple twang/launch.
RecallSfx	Synth: recall rewind.
GrenadeThrow
VoiceStart
VoiceStop
MenuMusic	Music/Gamesong1.wav.
GameMusic	Music/Gamesong2.wav.
GameMusicLoop	Music/Gamesong2_Main2.wav.
UiHover01
UiHover02
UiConfirm01
UiConfirm02
UiBack01
UiToggle01
UiSliderStep01
UiModal01
UiSuccess01
UiError01
UiError02
UiDisabled01
UiDanger01
_Count

UiSoundAction

enum class UiSoundAction : uint8_t

strong

Semantic menu/UI sound actions.

Enumerator
Hover
Confirm
Back
Toggle
SliderStep
ModalOpen
ModalClose
Success
Error
Disabled
Danger
_Count

Function Documentation

sfxCategoryName()

const char * sfxCategoryName ( SfxCategory category )

inlinenoexcept

sfxIdFromName()

std::optional< SfxId > sfxIdFromName ( std::string_view name )

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

sfxIdName()

const char * sfxIdName ( SfxId id )

inlinenoexcept

Here is the caller graph for this function: