coastline 0.0.4
Loading...
Searching...
No Matches
eventparameters.h File Reference
#include <stdint.h>
Include dependency graph for eventparameters.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  EarEventParams
 The parameters of an event, as the game passes them to MixEvent and MoveEvent. More...

Macros

#define EAR_EVENT_DISTANCE_BAND_COUNT   6
 The number of distance bands of an event.

Typedefs

typedef struct EarEventParams EarEventParams
 The parameters of an event, as the game passes them to MixEvent and MoveEvent.

Enumerations

enum  EarEventParamsFlag {
  EAR_EVENT_DELAY_BY_DISTANCE = 0x1 , EAR_EVENT_DISTANCE_ATTENUATION = 0x2 , EAR_EVENT_START_DELAY = 0x4 , EAR_EVENT_LIFETIME = 0x8 ,
  EAR_EVENT_DIRECTIONAL = 0x10 , EAR_EVENT_LOOPING = 0x20 , EAR_EVENT_NOT_STREAMING = 0x40 , EAR_EVENT_SUPPRESS_LIFETIME = 0x80 ,
  EAR_EVENT_NOTIFY_STOP = 0x100 , EAR_EVENT_DOPPLER = 0x200 , EAR_EVENT_TWIN = 0x400 , EAR_EVENT_ATTENUATION_REQUIRED = 0x800 ,
  EAR_EVENT_TRACK_ELAPSED = 0x1000 , EAR_EVENT_DISTANCE_LIMIT = 0x2000 , EAR_EVENT_PRIORITY = 0x10000 , EAR_EVENT_PAUSED = 0x20000 ,
  EAR_EVENT_MUTED = 0x40000 , EAR_EVENT_ACTIVE_TIME = 0x80000 , EAR_EVENT_FREQUENCY_SCALE = 0x100000 , EAR_EVENT_BASE_FREQUENCY = 0x200000 ,
  EAR_EVENT_NOTIFY_START = 0x400000 , EAR_EVENT_OMNIDIRECTIONAL = 0x800000 , EAR_EVENT_START_POSITION = 0x1000000 , EAR_EVENT_PITCH_VARIATION = 0x2000000 ,
  EAR_EVENT_BACKEND_PARAMETER = 0x4000000
}
 A flag of EarEventParams::flags. More...
enum  EarEventQueueMode {
  EAR_EVENT_QUEUE_TAIL = 0 , EAR_EVENT_QUEUE_NEXT = 1 , EAR_EVENT_QUEUE_REPLACE = 2 , EAR_EVENT_QUEUE_BEFORE_EVENT = 3 ,
  EAR_EVENT_QUEUE_AFTER_EVENT = 4
}
 The low word of EarEventParams::queueControl, how a new event joins its channel. More...

Macro Definition Documentation

◆ EAR_EVENT_DISTANCE_BAND_COUNT

#define EAR_EVENT_DISTANCE_BAND_COUNT   6

The number of distance bands of an event.

Typedef Documentation

◆ EarEventParams

typedef struct EarEventParams EarEventParams

The parameters of an event, as the game passes them to MixEvent and MoveEvent.

Enumeration Type Documentation

◆ EarEventParamsFlag

A flag of EarEventParams::flags.

Enumerator
EAR_EVENT_DELAY_BY_DISTANCE 

The sound reaches the listener at its speed.

EAR_EVENT_DISTANCE_ATTENUATION 

The gain falls between the two distances.

EAR_EVENT_START_DELAY 

EarEventParams::startDelay applies.

EAR_EVENT_LIFETIME 

EarEventParams::lifetime applies.

EAR_EVENT_DIRECTIONAL 

The direction comes from the position.

EAR_EVENT_LOOPING 

The event loops.

EAR_EVENT_NOT_STREAMING 

The event is read whole rather than streamed.

EAR_EVENT_SUPPRESS_LIFETIME 

The lifetime does not count down.

EAR_EVENT_NOTIFY_STOP 

The window is told when the event stops.

EAR_EVENT_DOPPLER 

The frequency follows the speed of the source.

EAR_EVENT_TWIN 

A second event plays the same source alongside.

EAR_EVENT_ATTENUATION_REQUIRED 

The event plays even beyond its distance.

EAR_EVENT_TRACK_ELAPSED 

The time the event has played is kept.

EAR_EVENT_DISTANCE_LIMIT 

EarEventParams::limitDistance applies.

EAR_EVENT_PRIORITY 

EarEventParams::priority applies.

EAR_EVENT_PAUSED 

The event starts or stays paused.

EAR_EVENT_MUTED 

The event starts or stays muted.

EAR_EVENT_ACTIVE_TIME 

EarEventParams::activeTime applies.

EAR_EVENT_FREQUENCY_SCALE 

EarEventParams::frequencyScale applies.

EAR_EVENT_BASE_FREQUENCY 

EarEventParams::baseFrequencyScale applies.

EAR_EVENT_NOTIFY_START 

The window is told when the event starts.

EAR_EVENT_OMNIDIRECTIONAL 

The event plays through matrix 1, direction 4.

EAR_EVENT_START_POSITION 

EarEventParams::startPosition applies.

EAR_EVENT_PITCH_VARIATION 

The base frequency varies at random.

EAR_EVENT_BACKEND_PARAMETER 

EarEventParams::backendParameter applies.

◆ EarEventQueueMode

The low word of EarEventParams::queueControl, how a new event joins its channel.

Enumerator
EAR_EVENT_QUEUE_TAIL 

The event joins after every other.

EAR_EVENT_QUEUE_NEXT 

The event plays after the current one.

EAR_EVENT_QUEUE_REPLACE 

The event plays next and the current one stops.

EAR_EVENT_QUEUE_BEFORE_EVENT 

The event plays before the event of the high word.

EAR_EVENT_QUEUE_AFTER_EVENT 

The event plays after the event of the high word.