X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pages%2FSDL-Mixer-Effects.html-inc;h=6a530e632e03e591383411e2920b3800fe4ea614;hb=0b221bb4fce84647a6cb9d7343de7330fb561c71;hp=ba2e9c2eb348c261cbd5548dcc8eab9fe485358e;hpb=d5943b684b1240307fbf0a103abbf18dd93998f4;p=sdlgit%2FSDL-Site.git diff --git a/pages/SDL-Mixer-Effects.html-inc b/pages/SDL-Mixer-Effects.html-inc index ba2e9c2..6a530e6 100644 --- a/pages/SDL-Mixer-Effects.html-inc +++ b/pages/SDL-Mixer-Effects.html-inc @@ -109,7 +109,7 @@ space. When a processor is finished being used, any function passed into $

Remove the registered effect function from the effect list for channel. If the channel is active the registered effect will have its $done_callback function called, if it was specified in -SDL::Mixer::Effects::register.

+SDL::Mixer::Effects::register.

Returns: Zero on errors, such as invalid channel, or effect function not registered on channel.

Note: Do not use this on a threaded perl. This will crash.

@@ -120,7 +120,7 @@ If the channel is active the registered effect will have its $done_callbac

This removes all effects registered to $channel. If the channel is active all the registered effects will have their $done_callback -functions called, if they were specified in SDL::Mixer::Effects::register.

+functions called, if they were specified in SDL::Mixer::Effects::register.

Returns: Zero on errors, such as channel not existing.

Note: Do not use this on a threaded perl. This will crash.

@@ -132,8 +132,8 @@ functions called, if they were specified in SDL::Mixer::Effects::register with MIX_CHANNEL_POST to use multiple postmix processors. -This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::register.

+There can only be one postmix function used at a time through this method. Use SDL::Mixer::Effects::register with MIX_CHANNEL_POST to use multiple postmix processors. +This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::register.

Note: Do not use this on a threaded perl. This will crash.

@@ -144,7 +144,7 @@ This postmix processor is run AFTER all the registered postmixers set up by

This effect simulates a simple attenuation of volume due to distance. The volume never quite reaches silence, even at max distance (255).

NOTE: Using a distance of 0 will cause the effect to unregister itself from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::unregister_all on the channel.

+SDL::Mixer::Effects::unregister_all on the channel.

Returns: Zero on errors, such as an invalid channel, or if Mix_RegisterEffect failed.

@@ -153,11 +153,11 @@ This postmix processor is run AFTER all the registered postmixers set up by SDL::Mixer::Effects::set_panning( $channel, $left, $right ); -

This effect will only work on stereo audio. Meaning you called SDL::Mixer::open_audio with 2 channels.

+

This effect will only work on stereo audio. Meaning you called SDL::Mixer::open_audio with 2 channels.

Note: Setting both left and right to 255 will unregister the effect from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::unregister_all on the channel.

+SDL::Mixer::Effects::unregister_all on the channel.

Note: Using this function on a mono audio device will not register the effect, nor will it return an error status.

-

Returns: Zero on errors, such as bad channel, or if SDL::Mixer::Effects::register failed.

+

Returns: Zero on errors, such as bad channel, or if SDL::Mixer::Effects::register failed.

set_position

@@ -178,7 +178,7 @@ angle and distance from the camera's point of view, the effect pans and attenuat

So you can see it goes clockwise starting at directly in front.

$distance is 0(close/loud) to 255(far/quiet).

Note: Using angle and distance of 0, will cause the effect to unregister itself from channel. You cannot unregister it any other way, -unless you use SDL::Mixer::Effects::unregister_all on the channel.

+unless you use SDL::Mixer::Effects::unregister_all on the channel.

Returns: Zero on errors, such as an invalid channel, or if SDL::Mixer::Effects::register failed.

@@ -189,7 +189,7 @@ unless you use SDL::Mixer::Effe

If you pass 1 to $flip it simple reverse stereo, swaps left and right channel sound.

Note: Using a flip of 0, will cause the effect to unregister itself from channel. You cannot unregister it any other way, unless you use -SDL::Mixer::Effects::register on the channel.

+SDL::Mixer::Effects::register on the channel.

AUTHORS

Top