QuakeForge  0.7.2.210-815cf
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages

Representation of a sound being played. More...

Collaboration diagram for channel_s:
[legend]

Data Fields

vec_t dist_mult
 distance multiplier (attenuation/clip) More...
 
unsigned end
 end time in global paintsamples More...
 
int entchannel
 
int entnum
 to allow overriding a specific sound More...
 
int leftvol
 0-255 volume More...
 
unsigned looping
 where to loop, -1 = no looping More...
 
int master_vol
 0-255 master volume More...
 
struct channel_snext
 next channel in "free" list More...
 
int oldphase
 phase shift between l-r in samples More...
 
vec3_t origin
 origin of sound effect More...
 
int pause
 don't update the channel at all More...
 
int phase
 phase shift between l-r in samples More...
 
unsigned pos
 sample position in sfx More...
 
int rightvol
 0-255 volume More...
 
sfx_tsfx
 sound played by this channel More...
 
int stop
 signal between main program and mixer thread that the channel is to be stopped. More...
 
int done
 

Detailed Description

Representation of a sound being played.

Field Documentation

vec_t dist_mult

distance multiplier (attenuation/clip)

int done
unsigned end

end time in global paintsamples

int entchannel
int entnum

to allow overriding a specific sound

int leftvol

0-255 volume

unsigned looping

where to loop, -1 = no looping

int master_vol

0-255 master volume

struct channel_s* next

next channel in "free" list

int oldphase

phase shift between l-r in samples

vec3_t origin

origin of sound effect

int pause

don't update the channel at all

int phase

phase shift between l-r in samples

unsigned pos

sample position in sfx

int rightvol

0-255 volume

sfx_t* sfx

sound played by this channel

int stop

signal between main program and mixer thread that the channel is to be stopped.

  • both stop and done are zero: normal operation
  • stop is non-zero: main program is done with channel. must wait for mixer to finish with channel before re-using.
  • done is non-zero: mixer is done with channel. can be reused at any time.
  • both stop and done are non-zero: both are done with channel. can be reused at any time.

The documentation for this struct was generated from the following file: