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

WIP Magic size option; regen docs for 0.9.30 version

Browse source
This commit is contained in:
Bill Kendrick 2023-04-09 23:25:48 -07:00
parent 9dd95721d5
commit e49c55fbe6
456 changed files with 692 additions and 480 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/en/MAGIC-API.txt
View file

@ -6,7 +6,7 @@ Magic Tool Plugin API Documentation
Copyright © 2007-2023 by various contributors; see AUTHORS.txt.
https://tuxpaint.org/
January 25, 2023
April 9, 2023
+----------------------------------------------------+
|Table of Contents |
@ -295,6 +295,15 @@ Magic Tool Plugin API Documentation
Note: Called once for each Magic tool your plugin claims to
contain (by your "get_tool_count()").
int accepted_sizes(magic_api * api, int which)
Return how many size variations the 'Magic' tool accepts. Return a
'0' if the 'Magic' tool should not offer sizing options. Returning
'1' is the same as returning '0'.
Note: Called once for each Magic tool your plugin claims to
contain (by your "get_tool_count()").
void shutdown(magic_api * api)
The plugin should do any cleanup here. If you allocated any memory
@ -367,6 +376,20 @@ Magic Tool Plugin API Documentation
Note: Changed most recently in Tux Paint 0.9.29; Magic API version
0x00000007.
void set_size(magic_api * api, int which, SDL_Surface * canvas,
SDL_Surface * last, Uint8 size, SDL_Rect * update_rect)
Tux Paint will call this function to inform the plugin of the
'Magic' tool size option chosen. (It will be called whenever one
of the plugin's Magic tools that accept sizes becomes active, and
whenever the user picks a new size while such a tool is currently
active.)
Generally, Magic tools will not alter the canvas in any way when
receiving an updated size, but it is possible.
Note: Added to Tux Paint 0.9.30; Magic API version 0x00000008.
void click(magic_api * api, int which, int mode, SDL_Surface * snapshot,
SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect)