mixGroupChannels function

bool mixGroupChannels(
  1. int from,
  2. int to,
  3. int tag
)

Assign several consecutive channels to the same tag.

A tag is an arbitrary number that can be assigned to several mixer channels, to form groups of channels.

If 'tag' is -1, the tag is removed (actually -1 is the tag used to represent the group of all the channels).

This function replaces the requested channels' current tags; you may only have one tag per channel.

You may not specify MAX_CHANNEL_POST for a channel.

Note that this returns success and failure in the opposite way from Mix_GroupChannel(). We regret the API design mistake.

\param from the first channel to set the tag on. \param to the last channel to set the tag on, inclusive. \param tag an arbitrary value to assign a channel. \returns true on success or false on failure; call SDL_GetError() for more information.

\since This function is available since SDL_mixer 3.0.0.

extern SDL_DECLSPEC bool SDLCALL Mix_GroupChannels(int from, int to, int tag)

Implementation

bool mixGroupChannels(int from, int to, int tag) {
  final mixGroupChannelsLookupFunction = libSdl3Mixer.lookupFunction<
      Uint8 Function(Int32 from, Int32 to, Int32 tag),
      int Function(int from, int to, int tag)>('Mix_GroupChannels');
  return mixGroupChannelsLookupFunction(from, to, tag) == 1;
}