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

Sync docs for new tp_magic_example.c

Browse source
This commit is contained in:
Bill Kendrick 2023-04-13 21:13:07 -07:00
parent 9dedb13e61
commit 7d68f38dc7
21 changed files with 756 additions and 161 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/CHANGES.txt
View file

@ -6,7 +6,7 @@ Copyright (c) 2002-2023
Various contributors (see below, and AUTHORS.txt)
https://tuxpaint.org/
2023.April.12 (0.9.30)
2023.April.13 (0.9.30)
* Improvements to Stamp tool:
---------------------------
* Avoid playing English descriptive sound for a stamp

5
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/
April 9, 2023
April 13, 2023
+----------------------------------------------------+
|Table of Contents |
@ -743,7 +743,8 @@ Linux and other Unix-like Platforms
As a stand-alone command, using the GNU C Compiler and BASH shell, for
example:
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o
my_plugin.so
Note: The characters around the "tp-magic-config" command are a
grave/backtick/backquote ("`"), and not an apostrophe/single-quote ("'").

4
docs/en/html/MAGIC-API.html
View file

@ -102,7 +102,7 @@
</p>
<p>
April 9, 2023 </p>
April 13, 2023 </p>
</center>
</header>
@ -781,7 +781,7 @@
As a stand-alone command, using the GNU C Compiler and BASH shell, for example:
<blockquote>
<p><code>
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
</code></p>
</blockquote>
</p>

87
docs/en/html/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
October 19, 2022
April 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

87
docs/en/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
October 19, 2022
April 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

5
docs/es_ES.UTF-8/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/
abril 9, 2023
abril 13, 2023
+----------------------------------------------------+
|Table of Contents |
@ -743,7 +743,8 @@ Linux and other Unix-like Platforms
As a stand-alone command, using the GNU C Compiler and BASH shell, for
example:
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o
my_plugin.so
Note: The characters around the "tp-magic-config" command are a
grave/backtick/backquote ("`"), and not an apostrophe/single-quote ("'").

4
docs/es_ES.UTF-8/html/MAGIC-API.html
View file

@ -102,7 +102,7 @@
</p>
<p>
abril 9, 2023 </p>
abril 13, 2023 </p>
</center>
</header>
@ -781,7 +781,7 @@
As a stand-alone command, using the GNU C Compiler and BASH shell, for example:
<blockquote>
<p><code>
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
</code></p>
</blockquote>
</p>

87
docs/es_ES.UTF-8/html/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
octubre 19, 2022
abril 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

87
docs/es_ES.UTF-8/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
octubre 19, 2022
abril 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

5
docs/fr_FR.UTF-8/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/
avril 9, 2023
avril 13, 2023
+----------------------------------------------------+
|Table of Contents |
@ -743,7 +743,8 @@ Linux and other Unix-like Platforms
As a stand-alone command, using the GNU C Compiler and BASH shell, for
example:
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o
my_plugin.so
Note: The characters around the "tp-magic-config" command are a
grave/backtick/backquote ("`"), and not an apostrophe/single-quote ("'").

4
docs/fr_FR.UTF-8/html/MAGIC-API.html
View file

@ -102,7 +102,7 @@
</p>
<p>
avril 9, 2023 </p>
avril 13, 2023 </p>
</center>
</header>
@ -781,7 +781,7 @@
As a stand-alone command, using the GNU C Compiler and BASH shell, for example:
<blockquote>
<p><code>
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
</code></p>
</blockquote>
</p>

87
docs/fr_FR.UTF-8/html/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
octobre 19, 2022
avril 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

87
docs/fr_FR.UTF-8/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
octobre 19, 2022
avril 13, 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

5
docs/gl_ES.UTF-8/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/
Abril 9, 2023
Abril 13, 2023
+----------------------------------------------------+
|Table of Contents |
@ -743,7 +743,8 @@ Linux and other Unix-like Platforms
As a stand-alone command, using the GNU C Compiler and BASH shell, for
example:
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o
my_plugin.so
Note: The characters around the "tp-magic-config" command are a
grave/backtick/backquote ("`"), and not an apostrophe/single-quote ("'").

4
docs/gl_ES.UTF-8/html/MAGIC-API.html
View file

@ -102,7 +102,7 @@
</p>
<p>
Abril 9, 2023 </p>
Abril 13, 2023 </p>
</center>
</header>
@ -781,7 +781,7 @@
As a stand-alone command, using the GNU C Compiler and BASH shell, for example:
<blockquote>
<p><code>
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
</code></p>
</blockquote>
</p>

87
docs/gl_ES.UTF-8/html/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
19 de Outubro de 2022
13 de Abril de 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

87
docs/gl_ES.UTF-8/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
19 de Outubro de 2022
13 de Abril de 2023
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

5
docs/ja_JP.UTF-8/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/
4月 9, 2023
4月 13, 2023
+----------------------------------------------------+
|Table of Contents |
@ -743,7 +743,8 @@ Linux and other Unix-like Platforms
As a stand-alone command, using the GNU C Compiler and BASH shell, for
example:
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o
my_plugin.so
Note: The characters around the "tp-magic-config" command are a
grave/backtick/backquote ("`"), and not an apostrophe/single-quote ("'").

4
docs/ja_JP.UTF-8/html/MAGIC-API.html
View file

@ -102,7 +102,7 @@
</p>
<p>
4月 9, 2023 </p>
4月 13, 2023 </p>
</center>
</header>
@ -781,7 +781,7 @@
As a stand-alone command, using the GNU C Compiler and BASH shell, for example:
<blockquote>
<p><code>
$ gcc -shared `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
</code></p>
</blockquote>
</p>

87
docs/ja_JP.UTF-8/html/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
2022年10月19日
2023年4月13日
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,

87
docs/ja_JP.UTF-8/tp_magic_example.c
View file

@ -1,7 +1,7 @@
/* tp_magic_example.c
An example of a "Magic" tool plugin for Tux Paint
2022年10月19日
2023年4月13日
*/
@ -82,9 +82,13 @@ const char *tool_descriptions[NUM_TOOLS] = {
/* Sound effects: */
Mix_Chunk *sound_effects[NUM_TOOLS];
/* The current color (an "RGB" -- red, green, blue -- value) the user has selected in Tux Paint: */
/* The current color (an "RGB" -- red, green, blue -- value) the user has
selected in Tux Paint (for tool 1): */
Uint8 example_r, example_g, example_b;
/* The size the user has selected in Tux Paint (for tool 2): */
Uint8 example_size;
/* Our local function prototypes: */
/* ---------------------------------------------------------------------- */
@ -140,7 +144,7 @@ released, aka deallocated) when the user quits Tux Paint, when our
example_shutdown() function is called.
*/
int example_init(magic_api * api)
int example_init(magic_api * api, Uint32 disabled_features)
{
int i;
char filename[1024];
@ -309,6 +313,7 @@ char *example_get_description(magic_api * api, int which, int mode)
return (strdup(our_desc_localized));
}
// Report whether we accept colors
int example_requires_colors(magic_api * api, int which)
@ -333,6 +338,25 @@ int example_modes(magic_api * api, int which)
}
// Report whether the tools offer sizing options
Uint8 example_accepted_sizes(magic_api * api, int which, int mode)
{
if (which == TOOL_ONE)
return 1;
else
return 4;
}
// Return our default sizing option
Uint8 example_default_size(magic_api * api, int which, int mode)
{
return 1;
}
/*
Shut down
@ -393,10 +417,16 @@ example_drag(magic_api * api, int which,
coordinates along the line, as well as other useful things (which of our
'Magic' tools is being used and the current and snapshot canvases).
*/
SDL_LockSurface(snapshot);
SDL_LockSurface(canvas);
api->line((void *) api, which, canvas, snapshot,
old_x, old_y, x, y, 1,
example_line_callback);
SDL_UnlockSurface(canvas);
SDL_UnlockSurface(snapshot);
/*
If we need to, swap the X and/or Y values, so that the coordinates
(old_x,old_y) is always the top left, and the coordinates (x,y) is
@ -426,10 +456,17 @@ example_drag(magic_api * api, int which,
canvas has been modified and should be updated.
*/
update_rect->x = old_x - 4;
update_rect->y = old_y - 4;
update_rect->w = (x + 4) - update_rect->x;
update_rect->h = (y + 4) - update_rect->y;
if (which == TOOL_ONE) {
update_rect->x = old_x;
update_rect->y = old_y;
update_rect->w = (x - old_x) + 1;
update_rect->h = (y - old_y) + 1;
} else {
update_rect->x = old_x - example_size;
update_rect->y = old_y - example_size;
update_rect->w = (x + example_size) - update_rect->x + 1;
update_rect->h = (y + example_size) - update_rect->y + 1;
}
/*
Play the appropriate sound effect
@ -442,7 +479,6 @@ example_drag(magic_api * api, int which,
what speaker to play the sound in. (So the sound will pan from speaker
to speaker as you drag the mouse around the canvas!)
*/
api->playsound(sound_effects[which],
(x * 255) / canvas->w, /* Left/right pan */
255 /* Near/far distance (loudness) */);
@ -466,7 +502,7 @@ example_release(magic_api * api, int which,
/*
Accept colors
When any of our 'Magig' tools are activated by the user, if that tool
When any of our 'Magic' tools are activated by the user, if that tool
accepts colors, the current color selection is sent to us.
Additionally, if one of our color-accepting tools is active when the user
@ -475,7 +511,7 @@ changes their chosen, we'll be informed of that as well.
The color comes in as RGB (red, green, and blue) values from 0 (darkest) to
255 (brightest).
*/
void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
void example_set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
{
/*
We simply store the RGB values in the global variables we declared at
@ -488,6 +524,29 @@ void example_set_color(magic_api * api, Uint8 r, Uint8 g, Uint8 b)
}
/*
Accept sizes
When any of our 'Magic' tools are activated by the user, if that tool
offer's sizes, the current size selection is sent to us.
Additionally, if the user changes the tool's size, we'll be informed of
that as well.
The size comes in as an unsigned integer (Uint8) between 1 and the value
returned by our example_accepted_sizes() function during setup.
*/
void example_set_size(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, Uint8 size, SDL_Rect * update_rect)
{
/*
Store the new size into the global variable we declared at the top of
this file.
*/
example_size = size * 4;
}
/* The Magic Effect Routines! */
/* ---------------------------------------------------------------------- */
@ -548,13 +607,13 @@ void example_line_callback(void *pointer, int which, SDL_Surface * canvas,
else if (which == TOOL_TWO)
{
/*
Tool number 2 copies an 8x8 square of pixels from the opposite side of
the canvas and puts it under the cursor.
Tool number 2 copies a square of pixels (of the size chosen by the user)
from the opposite side of the canvas and puts it under the cursor.
*/
for (yy = -4; yy < 4; yy++)
for (yy = -example_size; yy < example_size; yy++)
{
for (xx = -4; xx < 4; xx++)
for (xx = -example_size; xx < example_size; xx++)
{
api->putpixel(canvas, x + xx, y + yy,
api->getpixel(snapshot,