notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added new MODE_...'s to magic tool docs

Browse source 
Added documentation for "MODE_ONECLICK" and "MODE_PAINT_WITH_PREVIEW",
which were added to Tux Paint magic API 0x00000003 in Tux Paint 0.9.22)
to Tux Paint magic tool development docs.
This commit is contained in:
Bill Kendrick 2018-08-30 01:23:31 -07:00
parent 1ed04ed1a5
commit 5f08467c83
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
magic/docs/html/README.html
View file

@ -9,13 +9,10 @@ alink="#FF00FF">
<center>
<h1>Creating Tux Paint Magic Tool Plugins</h1>
<p>Copyright 2007-2008 by Bill Kendrick and others<br>
New Breed Software</p>
<p><a href="mailto:bill@newbreedsoftware.com">bill@newbreedsoftware.com</a><br>
<p>Copyright 2007-2018 by various contributors; see AUTHORS.txt<br/>
<a href="http://www.tuxpaint.org/">http://www.tuxpaint.org/</a></p>
<p>July 5, 2007 - July 19, 2008</p>
<p>July 5, 2007 - August 30, 2018</p>
</center>
<hr size=2 noshade>
@ -315,15 +312,17 @@ then the names of your functions must begin with "<code><b>zoom_</b></code>"
<li><code><b>int modes(magic_api&nbsp;*&nbsp;api,
int&nbsp;which)</b></code><br>
This lets you tell Tux&nbsp;Paint what modes your tool can be used in
(either as a tool the user can paint with, or a tool that affects
the entire drawing at once)<br>
This lets you tell Tux&nbsp;Paint what modes your tool can be used in;
either as a tool the user can paint with, or a tool that affects
the entire drawing at once.<br>
<br>
You must return a value that's some combination of one or more of
available modes:
<ul>
<li><code>MODE_PAINT</code>
<li><code>MODE_FULLSCREEN</code>
<li><code>MODE_PAINT</code> - freehand paint (click and drag)</li>
<li><code>MODE_FULLSCREEN</code> - applies to full image with one click</li>
<li><code>MODE_PAINT_WITH_PREVIEW</code> - freehand paint, with preview (click and drag)</li>
<li><code>MODE_ONECLICK</code> - applies to an area around the mouse, with one click</li>
</ul>
e.g., if your tool is only one that the user can paint with,
return "<code>MODE_PAINT</code>". If the user can do both,