Sound pause/unpause Magic API functions...
...plus documenting them. ...plus using them in new "Comic Dots" Magic tool.
This commit is contained in:
Bill Kendrick
parent
143b50733c
commit
d94e85e26e
33 changed files with 723 additions and 129 deletions
|
|
@ -6,7 +6,7 @@
|
|||
Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
|
||||
https://tuxpaint.org/
|
||||
|
||||
juin 1, 2024
|
||||
septembre 17, 2024
|
||||
|
||||
+--------------------------------------------------+
|
||||
| Table of Contents |
|
||||
|
|
@ -22,6 +22,7 @@
|
|||
| o Pixel Manipulations |
|
||||
| o Helper Functions |
|
||||
| o Informational |
|
||||
| o Sound Functions |
|
||||
| o Tux Paint System Calls |
|
||||
| o Color Conversions |
|
||||
| + Helper Macros in "tp_magic_api.h" |
|
||||
|
|
@ -640,12 +641,7 @@ char * data_directory
|
|||
|
||||
|
||||
|
||||
Tux Paint System Calls
|
||||
|
||||
void update_progress_bar(void)
|
||||
Asks Tux Paint to animate and draw one frame of its progress bar (at the
|
||||
bottom of the screen). Useful for routines that may take a long time, to
|
||||
provide feedback to the user that Tux Paint has not crashed or frozen.
|
||||
Sound Functions
|
||||
|
||||
void playsound(Mix_Chunk * snd, int pan, int dist)
|
||||
|
||||
|
|
@ -670,6 +666,46 @@ void stopsound(void)
|
|||
silence effects when the user stops using the tool (in your 'release'
|
||||
function).
|
||||
|
||||
int playingsound(void)
|
||||
|
||||
Call this function to determine whether a magic tool sound effect is still
|
||||
currently playing. Can be used by magic tools that pause and unpause their
|
||||
sounds (see below) to determine whether it's time to start a new sound —
|
||||
call playsound() instead of unpausesound(). A '1' is returned if a sound is
|
||||
playing; '0' otherwise.
|
||||
|
||||
Note: Added to Tux Paint 0.9.34; Magic API version 0x0000000B.
|
||||
|
||||
|
||||
|
||||
void pausesound(void)
|
||||
|
||||
Pauses the magic tool sound effect; it may be unpaused to resume playing.
|
||||
Useful when a magic tool sound is very long; avoid repeatedly playing just
|
||||
a short clip of the beginning when the user draws small strokes by starting
|
||||
(playsound()) and stopping (stopsound()) the sound. Use playingsound() to
|
||||
determine whether you can unpause or must play from the start.
|
||||
|
||||
Note: Added to Tux Paint 0.9.34; Magic API version 0x0000000B.
|
||||
|
||||
|
||||
|
||||
void unpausesound(void)
|
||||
|
||||
Resumes a paused magic tool sound effect, if one was playing.
|
||||
|
||||
Note: Added to Tux Paint 0.9.34; Magic API version 0x0000000B.
|
||||
|
||||
|
||||
|
||||
|
||||
Tux Paint System Calls
|
||||
|
||||
void update_progress_bar(void)
|
||||
Asks Tux Paint to animate and draw one frame of its progress bar (at the
|
||||
bottom of the screen). Useful for routines that may take a long time, to
|
||||
provide feedback to the user that Tux Paint has not crashed or frozen.
|
||||
|
||||
void special_notify(int flag)
|
||||
This function notifies Tux Paint of special events. Various values defined
|
||||
in "tp_magic_api.h" can be 'or'ed together (using C's boolean 'or': "|")
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
Copyright © 2002-2024 by divers contributeurs; voir AUTHORS.txt.
|
||||
https://tuxpaint.org/
|
||||
|
||||
septembre 16, 2024
|
||||
septembre 17, 2024
|
||||
|
||||
+-------------------------------------------------------+
|
||||
| Table des matières |
|
||||
|
|
@ -110,6 +110,12 @@ D. Qu'y a-t-il de neuf dans la version 0.9.34 de Tux Paint ?
|
|||
|
||||
New brushes
|
||||
New brushes for the Paint and Lines tools: Fluff (gradient).
|
||||
New Magic tool: Comic dots
|
||||
Draws a repeating dot pattern, simulating the "Ben Day process" used in
|
||||
early comic books.
|
||||
|
||||
Magic API Updates
|
||||
Sound pause and resume functions added.
|
||||
|
||||
Voir CHANGES.txt pour la liste complète des changements.
|
||||
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@
|
|||
</p>
|
||||
|
||||
<p>
|
||||
juin 1, 2024 </p>
|
||||
septembre 17, 2024 </p>
|
||||
</center>
|
||||
</header>
|
||||
|
||||
|
|
@ -128,7 +128,7 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li><a href="#tpfuncs">Tux Paint Functions and Data</a> <ul>
|
||||
<li><a href="#pixel_manip">Pixel Manipulations</a></li> <li><a href="#helper_funcs">Helper Functions</a></li> <li><a href="#informational">Informational</a></li> <li><a href="#syscalls">Tux Paint System Calls</a></li> <li><a href="#color_convs">Color Conversions</a></li> </ul>
|
||||
<li><a href="#pixel_manip">Pixel Manipulations</a></li> <li><a href="#helper_funcs">Helper Functions</a></li> <li><a href="#informational">Informational</a></li> <li><a href="#sound">Sound Functions</a></li> <li><a href="#syscalls">Tux Paint System Calls</a></li> <li><a href="#color_convs">Color Conversions</a></li> </ul>
|
||||
</li>
|
||||
<li><a href="#macros">Helper Macros in "tp_magic_api.h"</a></li> <li><a href="#consts">Constant Definitions in "tp_magic_api.h"</a></li> </ul>
|
||||
</li>
|
||||
|
|
@ -636,17 +636,13 @@
|
|||
</dl>
|
||||
</section><!-- H3: Informational -->
|
||||
|
||||
<section class="indent"><!-- H3: Tux Paint System Calls -->
|
||||
<section class="indent"><!-- H3: Sound Functions -->
|
||||
<header>
|
||||
<h3 id="syscalls">
|
||||
Tux Paint System Calls </h3>
|
||||
<h3 id="sound">
|
||||
Sound Functions </h3>
|
||||
</header>
|
||||
|
||||
<dl>
|
||||
<dt><code><b>void update_progress_bar(void)</b></code></dt>
|
||||
<dd>
|
||||
Asks Tux Paint to animate and draw one frame of its progress bar (at the bottom of the screen). Useful for routines that may take a long time, to provide feedback to the user that Tux Paint has not crashed or frozen. </dd>
|
||||
|
||||
<dt><code><b>void playsound(Mix_Chunk * snd, int pan, int dist)</b></code></dt>
|
||||
<dd>
|
||||
<p>
|
||||
|
|
@ -663,6 +659,43 @@
|
|||
<dd>
|
||||
This function stops playing a sound played by <code>playsound()</code>. It is useful to silence effects when the user stops using the tool (in your '<code>release</code>' function). </dd>
|
||||
|
||||
<dt><code><b>int playingsound(void)</b></code></dt>
|
||||
<dd>
|
||||
<p>
|
||||
Call this function to determine whether a magic tool sound effect is still currently playing. Can be used by magic tools that pause and unpause their sounds (see below) to determine whether it's time to start a new sound — call <code>playsound()</code> instead of <code>unpausesound()</code>. A '1' is returned if a sound is playing; '0' otherwise. </p>
|
||||
<p>
|
||||
<b>Note:</b> Added to Tux Paint 0.9.34; Magic API version 0x0000000B. </p>
|
||||
</dd>
|
||||
|
||||
<dt><code><b>void pausesound(void)</b></code></dt>
|
||||
<dd>
|
||||
<p>
|
||||
Pauses the magic tool sound effect; it may be unpaused to resume playing. Useful when a magic tool sound is very long; avoid repeatedly playing just a short clip of the beginning when the user draws small strokes by starting (<code>playsound()</code>) and stopping (<code>stopsound()</code>) the sound. Use <code>playingsound()</code> to determine whether you can unpause or must play from the start. </p>
|
||||
<p>
|
||||
<b>Note:</b> Added to Tux Paint 0.9.34; Magic API version 0x0000000B. </p>
|
||||
</dd>
|
||||
|
||||
<dt><code><b>void unpausesound(void)</b></code></dt>
|
||||
<dd>
|
||||
<p>
|
||||
Resumes a paused magic tool sound effect, if one was playing. </p>
|
||||
<p>
|
||||
<b>Note:</b> Added to Tux Paint 0.9.34; Magic API version 0x0000000B. </p>
|
||||
</dd>
|
||||
</dl>
|
||||
</section><!-- H3: Sound Functions -->
|
||||
|
||||
<section class="indent"><!-- H3: Tux Paint System Calls -->
|
||||
<header>
|
||||
<h3 id="syscalls">
|
||||
Tux Paint System Calls </h3>
|
||||
</header>
|
||||
|
||||
<dl>
|
||||
<dt><code><b>void update_progress_bar(void)</b></code></dt>
|
||||
<dd>
|
||||
Asks Tux Paint to animate and draw one frame of its progress bar (at the bottom of the screen). Useful for routines that may take a long time, to provide feedback to the user that Tux Paint has not crashed or frozen. </dd>
|
||||
|
||||
<dt id="special_notify"><code><b>void special_notify(int flag)</b></code></dt>
|
||||
<dd>
|
||||
This function notifies Tux Paint of special events. Various values defined in "<code>tp_magic_api.h</code>" can be 'or'ed together (using C's boolean 'or': "<code>|</code>") and sent to this function. <dl>
|
||||
|
|
|
|||
|
|
@ -236,6 +236,9 @@
|
|||
|
||||
<dt>New Magic tool: Comic dots</dt>
|
||||
<dd>Draws a repeating dot pattern, simulating the "Ben Day process" used in early comic books.</dd>
|
||||
|
||||
<dt>Magic API Updates</dt>
|
||||
<dd>Sound pause and resume functions added.</dt>
|
||||
</dl>
|
||||
|
||||
<p>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue