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

Sync docs: Grab Magic API set_color() change

Browse source
This commit is contained in:
Bill Kendrick 2023-01-25 02:25:43 -08:00
parent 3b1c26c93d
commit c7b0c78fb9
10 changed files with 130 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -3,10 +3,10 @@
Magic Tool Plugin API Documentation
Copyright © 2007-2022 by various contributors; see AUTHORS.txt.
Copyright © 2007-2023 by various contributors; see AUTHORS.txt.
https://tuxpaint.org/
October 18, 2022
January 25, 2023
+----------------------------------------------------+
|Table of Contents |
@ -347,13 +347,26 @@ Magic Tool Plugin API Documentation
Note: Added to Tux Paint 0.9.21; Magic API version 0x00000002.
void set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 g)
void set_color(magic_api * api, int which, SDL_Surface * canvas,
SDL_Surface * last, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
Tux Paint will call this function to inform the plugin of the RGB
values of the currently-selected color in Tux Paint's 'Colors'
palette. (It will be called whenever one of the plugin's Magic
tools that accept colors becomes active, and whenever the user
picks a new color while such a tool is currently active.)
Generally, Magic tools will not alter the canvas in any way when
receiving an updated color, but it is possible. (For example, the
"Zoom" and "Perspective" tools apply effects which uses the
current color choice as a solid background. The effects may be
adjusted with subsequent click/drag operations, but you may also
adjust the background color, without altering the zoom level or
perspective, by simply picking a new color.)
Note: Changed most recently in Tux Paint 0.9.29; Magic API version
0x00000007.
void click(magic_api * api, int which, int mode, SDL_Surface * snapshot,
SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect)