Sync redone MAGIC-API docs (new glossary)

...aslo bump dates here & there.

docs/CHANGES.txt

@@ -6,7 +6,7 @@ Copyright (c) 2002-2024
 Various contributors (see below, and AUTHORS.txt)
 https://tuxpaint.org/
 
-2024.January.27 (0.9.32)
+2024.January.29 (0.9.32)
   * Improvements to Magic tools:
     ----------------------------
     * Magic tool plugin API updates
@@ -179,6 +179,14 @@ https://tuxpaint.org/
       + USA Map
       Pere Pujal i Carabantes <perepujal@gmail.com>
 
+  * Documentation updates:
+    ----------------------
+    * MAGIC API documentation glossary will now appear sorted
+      alphabetically based on the localized versions of terms.
+      (Reworked how that section of the document is constructed, over in
+      `tuxpaint-docs` repository.)
+      Bill Kendrick <bill@newbreedsoftware.com>
+
   * Ports & Building:
     -----------------
     * Don't pollute documentation folder ($DOC_PREFIX) with build scripts.

docs/en/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                               January 26, 2024
+                               January 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/en/README.txt

@@ -6,7 +6,7 @@
         Copyright © 2002-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                               January 27, 2024
+                               January 29, 2024
 
 +-------------------------------------------------+
 |                Table of Contents                |

docs/en/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            January 26, 2024          </p>
+            January 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/en/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            January 27, 2024          </p>
+            January 29, 2024          </p>
         </center>
       </header>
       <table border="2"

docs/es_ES.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                enero 26, 2024
+                                enero 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/es_ES.UTF-8/README.txt

@@ -6,7 +6,7 @@
         Copyright © 2002-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                enero 27, 2024
+                                enero 29, 2024
 
 +-------------------------------------------------+
 |                Table of Contents                |

docs/es_ES.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            enero 26, 2024          </p>
+            enero 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/es_ES.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            enero 27, 2024          </p>
+            enero 29, 2024          </p>
         </center>
       </header>
       <table border="2"

docs/fr_FR.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                               janvier 26, 2024
+                               janvier 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/fr_FR.UTF-8/README.txt

@@ -6,7 +6,7 @@
        Copyright © 2002-2024 by divers contributeurs; voir AUTHORS.txt.
                              https://tuxpaint.org/
 
-                               janvier 27, 2024
+                               janvier 29, 2024
 
 +-------------------------------------------------------+
 |                  Table des matières                   |

docs/fr_FR.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            janvier 26, 2024          </p>
+            janvier 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/fr_FR.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            janvier 27, 2024          </p>
+            janvier 29, 2024          </p>
         </center>
       </header>
       <table border="2"

docs/gl_ES.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                               Xaneiro 26, 2024
+                               Xaneiro 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/gl_ES.UTF-8/README.txt

@@ -6,7 +6,7 @@
         Copyright © 2002-2024 by varios colaboradores; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                             27 de Xaneiro de 2024
+                             29 de Xaneiro de 2024
 
 +--------------------------------------------------------+
 |                         Índice                         |

docs/gl_ES.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            Xaneiro 26, 2024          </p>
+            Xaneiro 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/gl_ES.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            27 de Xaneiro de 2024          </p>
+            29 de Xaneiro de 2024          </p>
         </center>
       </header>
       <table border="2"

docs/is_IS.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
    Höfundarréttur © 2007-2024 eftir various contributors; sjá AUTHORS-skrá.
                              https://tuxpaint.org/
 
-                                26. janúar 2024
+                                29. janúar 2024
 
 +--------------------------------------------------+
 |                   Efnisyfirlit                   |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Orðasafn
 
-  * alfa: See "RGBA"
+&
-  * &: See "'og' merki"
+    See "'og' merki"
-  * 'og' merki (bendlar): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * 'og' merki (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bitar"
+.
-  * API: Application Programming Interface. TBD
+    See "punktur"
-  * viðfang: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * bakslag: See "grave"
+alfa
-  * bitar: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+API
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    Application Programming Interface. Definition not yet presented.
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+
-    right to left: ones place, tens place, hundreds place, thousands place,
+arrow
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    "->". A symbol in C that references an element within a pointer to a
-    etc. See also: "bæti"
+    struct.
-  * blátt: See "RGBA"
+
-  * boole gildið 'eða': A mathematical operation that results in a true value
+backquote / bakslag
-    if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1".
+    See "grave"
-    "0 | 0" results in "0".)
+
-  * |: See "boole gildið 'eða'"
+BASH
-  * .: See "punktur"
+    The "Bourne Again Shell", a Unix shell and command language.
-  * `: See "grave"
+
-  * *: See "star"
+bitar
-  * bæti: A unit of memory made up of 8 bits. As a signed value, it can
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    represent -128 through 127. As an unsigned value, it can represent 0
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    through 255. As a series of bits, for example, the byte "00001100"
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    represents the decimal value 12.
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-  * svörun: TBD
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C enumeration: A construct in C that allows you to label numeric values
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    THREE };"
+    See also: "bæti"
-  * C function: TBD
+
-  * C function prototype: TBD
+blátt
-  * C header file: TBD
+    See "RGBA"
-  * rás: TBD
+
-  * smellur: The action of pressing a button on a mouse.
+boole gildið 'eða'
-  * hnit: A set of numbers corresponding to a physical position; for example,
+    A mathematical operation that results in a true value if either operand is
-    in a two-dimensional (2D) image, "X" and "Y" coordinates specify the
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-    position across (left-to-right) and down the image, respectively. In SDL,
+    "0".)
-    the coordinates (0,0) is the top-leftmost pixel of a surface.
+    See also: "bitar"
-  * C pointer: A variable that contains the location of a piece of memory;
+
-    usually used to 'point' to another variable. Since C functions can only
+bæti
-    return one value as a result, pointers are often sent to functions to allow
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    the function to change the values of multiple variables. (For example, Tux
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * C structure: A construct in C that allows you to declare a new variable
+    value 12.
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    See also: "bitar"
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+
-    its dimensions (width and height).
+C enumeration
-  * #define: A C statement that defines a substitution that can occur later in
+    A construct in C that allows you to label numeric values (usually starting
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+C function / C function prototype / C header file
-  * stærðir: The size of an object, in terms of its width (left to right) and
+    Definition not yet presented.
-    height (top to bottom).
+    See also: "C function prototype"
-  * .dll: See "Shared Object"
+
-  * punktur: ".". A symbol in C that references an element within a struct.
+C pointer
-  * draga: The action of moving a mouse while the button remains held.
+    A variable that contains the location of a piece of memory; usually used to
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+    'point' to another variable. Since C functions can only return one value as
-    elements of SDL_Surface store the surface's width and height,
+    a result, pointers are often sent to functions to allow the function to
-    respectively.)
+    change the values of multiple variables. (For example, Tux Paint's
-  * enum: See "C enumeration"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * float: See "fleytitala"
+
-  * fleytitala: TBD
+C structure
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+    A construct in C that allows you to declare a new variable 'type' which may
-    that contains information about a surface; for example, the number of bits
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    (width and height).
-    functions (such as "strdup()").
+
-  * function: See "C function"
+colorspace
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also:
-  * GIMP: An Open Source image manipulation and paint program.
+      + RGBA
-  * GNU C Compiler: See "gcc"
+      + HSV
-  * grave: The "`" character; used by the BASH shell to use the output of a
+
-    command as the command-line arguments to another.
+
-  * grænt: See "RGBA"
+#define
-  * ->: See "arrow"
+    A C statement that defines a substitution that can occur later in the code.
-  * .h: See "C header file"
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * haus: See "C header file"
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * header file: See "C header file"
+    create macros. Typically placed within C header files.
-  * HSV: Hue, Saturation and Value. TBD
+
-  * litblær: See "HSV"
+.dll
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    See "Shared Object"
-    and returns it as an "SDL_Surface *".
+
-  * #include: A C statement that asks the compiler to read the contents of
+draga
-    another file (usually a header file).
+    The action of moving a mouse while the button remains held, or moving a
-  * int: See "integer"
+    finger or stylus across a screen or tablet, without removing it.
-  * integer: TBD
+    See also:
-  * libSDL: See "Simple DirectMedia Layer"
+      + smellur
-  * línulegt: TBD
+      + sleppa
-  * fjölvi: A C construct that looks similar to a C function, but is simply a #
+
-    define that is expanded 'inline'. For example, if you declared the macro "#
+
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+element
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-    "c = 1 + 2;".
+    SDL_Surface store the surface's width and height, respectively.)
-  * magic_api: A C structure that is passed along to a plugin's functions that
+    See also:
-    exposes data and functions within the running copy of Tux Paint.
+      + C structure
-  * make: A utility that automatically determines which pieces of a larger
+      + punktur
-    program need to be recompiled, and issues the commands to recompile them.
+      + arrow
-    See also: "Makefile"
+
-  * Makefile: A text file used by the "make" utility; it describes the
+
-    relationships among files in your program, and the commands for updating
+enum
-    each file. (For example, to compile a human-readable source-code file into
+    See "C enumeration"
-    a computer-readable executable program file.)
+
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+fjölvi
-    available via the "Magic" tool button.
+    A C construct that looks similar to a C function, but is simply a #define
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    that is expanded 'inline'. For example, if you declared the macro "#define
-    contains a sound.
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+    2;".
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+fleytitala
-  * namespace: TBD
+    Definition not yet presented.
-  * .ogg: See "Ogg Vorbis"
+    See also: "integer"
-  * Ogg Vorbis: See also: "WAV"
+
-  * Viðbót: TBD
+float
-  * .png: Portable Network Graphics. An extensible file format for the
+    See "fleytitala"
-    lossless, portable, well-compressed storage of raster images. It's the file
+
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+format
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    contains information about a surface; for example, the number of bits used
-    See also the "png(5)" man page)
+    to represent each pixel).
-  * pointer: See "C pointer"
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * frumgerð: See "C function prototype"
+
-  * rautt: See "RGBA"
+free()
-  * sleppa: The action of releasing a button on a mouse.
+    A C function that frees (deallocates) memory allocated by other C functions
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+    (such as "strdup()").
-  * RGB: See "RGBA"
+    Refer to the "malloc(3)" man page.
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+frumgerð
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    See "C function prototype"
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+
-    "SDL_FreeSurface(3)" man page)
+function
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+    See "C function"
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+
-    the format of the surface the pixel was taken from, and pointers to three
+gcc
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+    See "GNU C Compiler"
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+gildi
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    See "HSV"
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+GIMP
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+    program.
-    "SDL_MapRGB(3)" man page)
+    See also: "Krita"
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+GNU C Compiler
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    The GNU C compiler, a portable Open Source package for compiling and
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+    linking programs written in the C programming language.
-    them).
+    Refer to the "gcc(1)" man page.
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+
-    area. It contains elements representing the coordinates of the top left
+grave
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+    The "`" character; used by the BASH shell to use the output of a command as
-    also the "SDL_Rect(3)" man page)
+    the command-line arguments to another.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+grænt
-  * Shared Object: A piece of code that's compiled separately from the main
+    See "RGBA"
-    application, and loaded dynamically, at runtime.
+
-  * Simple DirectMedia Layer: A programming library that allows programs
+.h / haus / header file
-    portable low level access to a video framebuffer, audio output, mouse, and
+    See "C header file"
-    keyboard. (See also: http://www.libsdl.org/)
+
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+hnit
-    string and one or more additional arguments, and puts them together.
+    A set of numbers corresponding to a physical position; for example, in a
-    "snprintf()" takes the resulting output and stores it into a string, making
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-    sure not to go beyond the string's buffer size (which must also be
+    across (left-to-right) and down the image, respectively. In SDL, the
-    supplied). For example, assume a string "char str[20];" has been declared;
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+HSV
-  * .so: See "Shared Object"
+    Hue, Saturation and Value.Definition not yet presented.
-  * sRBG: See "RGBA"
+    See also:
-  * star: "*". A symbol in C that, when used in the declaration of variables
+      + RGBA
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+      + colorspace
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+IMG_Load()
-    does not change the value of "p", which is still a pointer to an integer.
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-    In essence, it changed the integer that's being pointed to.) See also:
+    as an "SDL_Surface *".
-    "'og' merki"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+#include
-    string, copies the string to it, and returns a "char *" pointer to the new
+    A C statement that asks the compiler to read the contents of another file
-    copy. See also the "strdup(3)" man page)
+    (usually a header file).
-  * struct: See "C structure"
+
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+int
-    Plugins must '#include' it.
+    See "integer"
-  * tp-magic-config: A command-line program that provides information about the
+
-    installed version of Tux Paint to plugin developers (such as what C
+integer
-    compiler flags they should compile with, and where plugin shared objects
+    Definition not yet presented.
-    and data files should be installed). See also the "tp-magic-config(3)" man
+    See also: "fleytitala"
-    page)
+
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+Krita
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+    An Open Source image manipulation and paint program.
-    enough information to store three or four bytes representing a pixel's
+    See also: "GIMP"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+libSDL
-    byte that can represent 0 through 255.
+    See "Simple DirectMedia Layer"
-  * óundirritað: In C, a variable that can store a numeric value can be
+
-    declared as either "signed" (the default), or "unsigned". In the former
+litblær
-    case, one bit of the value is used to denote the sign of the value (either
+    See "HSV"
-    positive or negative). In the latter case, the value can only be positive,
+
-    but benefits from one extra bit of storage for the number. A signed byte (8
+línulegt
-    bits), for example, can represent any number between -128 and 127. An
+    Definition not yet presented.
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+
-    of graphics in SDL, unsigned values should be used for RGB values, since
+Magic tool
-    each channel (red, green and blue) may be between 0 (off) and 255
+    One of a number of effects or drawing tools in Tux Paint, made available
-    (brightest).
+    via the "Magic" tool button.
-  * gildi: See "HSV"
+
-  * variable: A construct in computer programming that contains a value which
+magic_api
-    can be referenced again later by referring to the variable's name, and
+    A C structure that is passed along to a plugin's functions that exposes
-    typically changed later. For example, a variable to hold someone's age
+    data and functions within the running copy of Tux Paint.
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+make
-  * .wav: See also: "Ogg Vorbis"
+    A utility that automatically determines which pieces of a larger program
-  * (w,h): See "Stærðir"
+    need to be recompiled, and issues the commands to recompile them.
-  * (x,y): See "Hnit"
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+'og' merki (bendlar)
+    "&". A symbol in C that allows you to refer to the memory address of a
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
+    is a 'pointer to "i"'.)
+    See also: "star"
+
+'og' merki (bitwise operator)
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
+    both values will be returned. For example, "11 & 6" compares the binary
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
+    result is 2 ('0010').
+    See also: "bitar"
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+punktur
+    ".". A symbol in C that references an element within a struct.
+    See also:
+      + C structure
+      + arrow
+
+
+rautt / RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+rás
+    Definition not yet presented.
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+sleppa
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + smellur
+      + draga
+
+
+smellur
+    The action of pressing a button on a mouse, tapping a touchscreen, or
+    pressing a stylus to a tablet.
+    See also:
+      + draga
+      + sleppa
+
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "'og' merki"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+stærðir
+    The size of an object, in terms of its width (left to right) and height
+    (top to bottom).
+
+svörun
+    Definition not yet presented.
+
+tap
+    See "smellur"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+viðfang
+    A value sent to a function.
+
+(w,h)
+    See "stærðir"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "hnit"
+
+|
+    See "boole gildið 'eða'"
+
+óundirritað
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
 

docs/is_IS.UTF-8/README.txt

@@ -6,7 +6,7 @@
         Copyright © 2002-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                janúar 27, 2024
+                                janúar 29, 2024
 
 +-------------------------------------------------+
 |                Table of Contents                |

docs/is_IS.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            26. janúar 2024          </p>
+            29. janúar 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Orðasafn        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alfa:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Orðasafn    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "'og' merki"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>'og' merki (bendlar):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "'og' merki"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>'og' merki (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bitar"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>viðfang:</b>
+        See "punktur"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alfa</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>API</dt>
-        <li>
+      <dd>
-          <b>bakslag:</b>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          See "grave"        </li>
+            <dt>arrow</dt>
-        <li>
+      <dd>
-          <b>bitar:</b>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "bæti"        </li>
+            <dt>backquote / bakslag</dt>
-        <li>
+      <dd>
-          <b>blátt:</b>
+        See "grave"              </dd>
-          See "RGBA"        </li>
+            <dt>BASH</dt>
-        <li>
+      <dd>
-          <b>boole gildið 'eða':</b>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+            <dt>bitar</dt>
-        <li>
+      <dd>
-          <b><code>|</code>:</b>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          See "boole gildið 'eða'"        </li>
+See also: "bæti"      </dd>
-        <li>
+            <dt>blátt</dt>
-          <b><code>.</code>:</b>
+      <dd>
-          See "punktur"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>boole gildið &#039;eða&#039;</dt>
-          <b><code>`</code>:</b>
+      <dd>
-          See "grave"        </li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-        <li>
+See also: "bitar"      </dd>
-          <b><code>*</code>:</b>
+            <dt>bæti</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-          <b>bæti:</b>
+See also: "bitar"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>svörun:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C enumeration:</b>
+See also: "C function prototype"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>C pointer</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-           <i>TBD</i>
+            <dt>C structure</dt>
-        </li>
+      <dd>
-        <li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-          <b>C function prototype:</b>
+            <dt>colorspace</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        <i>Definition not yet presented.</i>        <br/>
-        <li>
+See also:
-          <b>C header file:</b>
+<ul>
-           <i>TBD</i>
+<li>RGBA</li><li>HSV</li></ul>
-        </li>
+      </dd>
-        <li>
+            <dt><code>#define</code></dt>
-          <b>rás:</b>
+      <dd>
-           <i>TBD</i>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>smellur:</b>
+        See "Shared Object"              </dd>
-          The action of pressing a button on a mouse.        </li>
+            <dt>draga</dt>
-        <li>
+      <dd>
-          <b>hnit:</b>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+See also:
-        <li>
+<ul>
-          <b>C pointer:</b>
+<li>smellur</li><li>sleppa</li></ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b>C structure:</b>
+      <dd>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b><code>#define</code>:</b>
+<ul>
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<li>C structure</li><li>punktur</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b>stærðir:</b>
+            <dt><code>enum</code></dt>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><code>.dll</code>:</b>
+            <dt>fjölvi</dt>
-          See "Shared Object"        </li>
+      <dd>
-        <li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-          <b>punktur:</b>
+            <dt>fleytitala</dt>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>draga:</b>
+See also: "integer"      </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>float</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "fleytitala"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "C enumeration"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>float</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "fleytitala"        </li>
+            <dt>frumgerð</dt>
-        <li>
+      <dd>
-          <b>fleytitala:</b>
+        See "C function prototype"              </dd>
-           <i>TBD</i>
+            <dt>function</dt>
-        </li>
+      <dd>
-        <li>
+        See "C function"              </dd>
-          <b><code>format</code>:</b>
+            <dt><code>gcc</code></dt>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "GNU C Compiler"              </dd>
-          <b><code>free()</code>:</b>
+            <dt>gildi</dt>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>function:</b>
+            <dt>GIMP</dt>
-          See "C function"        </li>
+      <dd>
-        <li>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          <b><code>gcc</code>:</b>
+See also: "Krita"      </dd>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+            <dt>GNU C Compiler</dt>
-        <li>
+      <dd>
-          <b><cite>GIMP</cite>:</b>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-          An Open Source image manipulation and paint program.        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "gcc"        </li>
+            <dt>grænt</dt>
-        <li>
+      <dd>
-          <b>grave:</b>
+        See "RGBA"              </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>.h</code> / haus / header file</dt>
-        <li>
+      <dd>
-          <b>grænt:</b>
+        See "C header file"              </dd>
-          See "RGBA"        </li>
+            <dt>hnit</dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "arrow"        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "C header file"        </li>
+See also:
-        <li>
+<ul>
-          <b>haus:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-          See "C header file"        </li>
+      </dd>
-        <li>
+            <dt><code>IMG_Load()</code></dt>
-          <b>header file:</b>
+      <dd>
-          See "C header file"        </li>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-        <li>
+            <dt><code>#include</code></dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-        </li>
+            <dt><code>int</code></dt>
-        <li>
+      <dd>
-          <b>litblær:</b>
+        See "integer"              </dd>
-          See "HSV"        </li>
+            <dt>integer</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+See also: "fleytitala"      </dd>
-        <li>
+            <dt>Krita</dt>
-          <b><code>#include</code>:</b>
+      <dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+        An Open Source image manipulation and paint program.        <br/>
-        <li>
+See also: "GIMP"      </dd>
-          <b><code>int</code>:</b>
+            <dt>libSDL</dt>
-          See "integer"        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b>integer:</b>
+            <dt>litblær</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        See "HSV"              </dd>
-        <li>
+            <dt>línulegt</dt>
-          <b><code>libSDL</code>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b>línulegt:</b>
+      <dd>
-           <i>TBD</i>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        </li>
+            <dt><code>magic_api</code></dt>
-        <li>
+      <dd>
-          <b>fjölvi:</b>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>magic_api</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><code>make</code>:</b>
+      <dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b><code>Makefile</code>:</b>
+      <dd>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        <li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-        <li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-        <li>
+            <dt>namespace</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>&#039;og&#039; merki (bendlar)</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>namespace:</b>
+            <dt>&#039;og&#039; merki (bitwise operator)</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-        <li>
+See also: "bitar"      </dd>
-          <b><code>.ogg</code>:</b>
+            <dt><code>.ogg</code></dt>
-          See "Ogg Vorbis"        </li>
+      <dd>
-        <li>
+        See "Ogg Vorbis"              </dd>
-          <b><cite>Ogg Vorbis</cite>:</b>
+            <dt>Ogg Vorbis / plugin</dt>
-          See also: "WAV"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>Viðbót:</b>
+See also: "WAVE"      </dd>
-           <i>TBD</i>
+            <dt><code>.png</code></dt>
-        </li>
+      <dd>
-        <li>
+        See "Portable Network Graphics"              </dd>
-          <b>.png:</b>
+            <dt>pointer</dt>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C pointer"              </dd>
-          <b>pointer:</b>
+            <dt>Portable Network Graphics</dt>
-          See "C pointer"        </li>
+      <dd>
-        <li>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          <b>frumgerð:</b>
+See also: "Scalable Vector Graphic"      </dd>
-          See "C function prototype"        </li>
+            <dt>punktur</dt>
-        <li>
+      <dd>
-          <b>rautt:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "RGBA"        </li>
+See also:
-        <li>
+<ul>
-          <b>sleppa:</b>
+<li>C structure</li><li>arrow</li></ul>
-          The action of releasing a button on a mouse.        </li>
+      </dd>
-        <li>
+            <dt>rautt / RGB</dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "RGBA"              </dd>
-        </li>
+            <dt>RGBA</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          See "RGBA"        </li>
+See also:
-        <li>
+<ul>
-          <b>saturation:</b>
+<li>HSV</li><li>colorspace</li></ul>
-          See "HSV"        </li>
+      </dd>
-        <li>
+            <dt>rás</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>saturation</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "HSV"              </dd>
-        <li>
+            <dt>SDL</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          <b><code>SDL_MapRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-        <li>
+            <dt><code>SDL_GetRGB()</code></dt>
-          <b><cite>SDL_image</cite>:</b>
+      <dd>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-        <li>
+See also:
-          <b><cite>SDL_mixer</cite>:</b>
+<ul>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-        <li>
+      </dd>
-          <b><code>SDL_Rect</code>:</b>
+            <dt><code>SDL_image</code></dt>
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          <b><code>SDL_Surface *</code>:</b>
+            <dt><code>SDL_MapRGB()</code></dt>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+      <dd>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-        <li>
+See also:
-          <b>Shared Object:</b>
+<ul>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-        <li>
+      </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_mixer</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_Rect</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-          <b><code>.so</code>:</b>
+            <dt><code>SDL_Surface *</code></dt>
-          See "Shared Object"        </li>
+      <dd>
-        <li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-          <b><code>sRBG</code>:</b>
+            <dt>shared object</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-          <b>star:</b>
+            <dt>shell</dt>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "'og' merki"        </li>
+      <dd>
-        <li>
+        See "BASH"              </dd>
-          <b><code>strdup()</code>:</b>
+            <dt>Simple DirectMedia Layer</dt>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-          <b><code>struct</code>:</b>
+            <dt>sleppa</dt>
-          See "C structure"        </li>
+      <dd>
-        <li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-          <b><code>tp_magic_api.h</code>:</b>
+See also:
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+<ul>
-        <li>
+<li>smellur</li><li>draga</li></ul>
-          <b><code>tp-magic-config</code>:</b>
+      </dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+            <dt>smellur</dt>
-        <li>
+      <dd>
-          <b><code>Uint32</code>:</b>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+See also:
-        <li>
+<ul>
-          <b><code>Uint8</code>:</b>
+<li>draga</li><li>sleppa</li></ul>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+      </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>óundirritað:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b>gildi:</b>
+      <dd>
-          See "HSV"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-        <li>
+See also: "'og' merki"      </dd>
-          <b><code>(w,h)</code>:</b>
+            <dt><code>strdup()</code></dt>
-          See "Stærðir"        </li>
+      <dd>
-        <li>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
-          <b><code>(x,y)</code>:</b>
+            <dt><code>struct</code></dt>
-          See "Hnit"        </li>
+      <dd>
-      </ul>
+        See "C structure"              </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>stærðir</code></dt>
+      <dd>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
+            <dt>svörun</dt>
+      <dd>
+        <i>Definition not yet presented.</i>              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "smellur"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt>viðfang</dt>
+      <dd>
+        A value sent to a function.              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "stærðir"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "hnit"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boole gildið 'eða'"              </dd>
+            <dt>óundirritað</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/is_IS.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            janúar 27, 2024          </p>
+            janúar 29, 2024          </p>
         </center>
       </header>
       <table border="2"

docs/ja_JP.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                 1月 26, 2024
+                                 1月 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/ja_JP.UTF-8/README.txt

@@ -6,7 +6,7 @@
        Copyright © 2002-2024 by various contributors; AUTHORS.txt 参照.
                              https://tuxpaint.org/
 
-                                 2024年1月27日
+                                 2024年1月29日
 
 +--------------------------------------------------+
 |                       目次                       |

docs/ja_JP.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            1月 26, 2024          </p>
+            1月 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/ja_JP.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            2024年1月27日          </p>
+            2024年1月29日          </p>
         </center>
       </header>
       <table border="2"

docs/sq_AL.UTF-8/MAGIC-API.txt

@@ -6,7 +6,7 @@
         Copyright © 2007-2024 by various contributors; see AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                janar 26, 2024
+                                janar 29, 2024
 
 +--------------------------------------------------+
 |                Table of Contents                 |
@@ -1068,228 +1068,505 @@ Additionally, other Tux Paint developers and users can be found on the
 
 Glossary
 
-  * alpha: See "RGBA"
+&
-  * &: See "ampersand"
+    See "ampersand"
-  * ampersand (pointers): "&". A symbol in C that allows you to refer to the
+
-    memory address of a variable; that is, a pointer. (For example, consider
+*
-    "int i;". Later, "&i" refers to the memory where "i" is stored, not the
+    See "star"
-    value of "i" itself; it is a 'pointer to "i"'.) See also: "star"
+
-  * ampersand (bitwise operator): "&". A symbol in C that acts as a bitwise
+->
-    "and" operator. Only bits set in both values will be returned. For example,
+    See "arrow"
-    "11 & 6" compares the binary values '1011' to '0110'. Only the bit in the
+
-    2's place is set, so the result is 2 ('0010'). See also: "bit"
+.
-  * API: Application Programming Interface. TBD
+    See "dot"
-  * argument: A value sent to a function.
+
-  * arrow: "->". A symbol in C that references an element within a pointer to a
+`
-    struct.
+    See "grave"
-  * backquote: See "grave"
+
-  * backtick: See "grave"
+alpha
-  * bit: "Binary digit." Bits are the basic storage unit in a computer's
+    See "RGBA"
-    memory, disk, networking, etc. They represent either 0 or 1. (Compared to a
+
-    decimal digit, which can be anything between 0 and 9.) Just as a series of
+ampersand (bitwise operator)
-    decimal digits can represent a larger number (e.g., "1" and "5" is fifteen
+    "&". A symbol in C that acts as a bitwise "and" operator. Only bits set in
-    (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from
+    both values will be returned. For example, "11 & 6" compares the binary
-    right to left: ones place, tens place, hundreds place, thousands place,
+    values '1011' to '0110'. Only the bit in the 2's place is set, so the
-    etc. In binary, it is: ones place, twos place, fours place, eights place,
+    result is 2 ('0010').
-    etc. See also: "byte"
+    See also: "bit"
-  * blue: See "RGBA"
+
-  * boolean 'or': A mathematical operation that results in a true value if
+ampersand (pointers)
-    either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0
+    "&". A symbol in C that allows you to refer to the memory address of a
-    | 0" results in "0".)
+    variable; that is, a pointer. (For example, consider "int i;". Later, "&i"
-  * |: See "boolean 'or'"
+    refers to the memory where "i" is stored, not the value of "i" itself; it
-  * .: See "dot"
+    is a 'pointer to "i"'.)
-  * `: See "grave"
+    See also: "star"
-  * *: See "star"
+
-  * byte: A unit of memory made up of 8 bits. As a signed value, it can
+API
-    represent -128 through 127. As an unsigned value, it can represent 0
+    Application Programming Interface. Definition not yet presented.
-    through 255. As a series of bits, for example, the byte "00001100"
+
-    represents the decimal value 12.
+argument
-  * callback: TBD
+    A value sent to a function.
-  * C enumeration: A construct in C that allows you to label numeric values
+
-    (usually starting at 0 and incrementing by one). (e.g., "enum { ONE, TWO,
+arrow
-    THREE };"
+    "->". A symbol in C that references an element within a pointer to a
-  * C function: TBD
+    struct.
-  * C function prototype: TBD
+
-  * C header file: TBD
+backquote / backtick
-  * channel: TBD
+    See "grave"
-  * click: The action of pressing a button on a mouse.
+
-  * coordinates: A set of numbers corresponding to a physical position; for
+BASH
-    example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify
+    The "Bourne Again Shell", a Unix shell and command language.
-    the position across (left-to-right) and down the image, respectively. In
+
-    SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.
+bit
-  * C pointer: A variable that contains the location of a piece of memory;
+    "Binary digit." Bits are the basic storage unit in a computer's memory,
-    usually used to 'point' to another variable. Since C functions can only
+    disk, networking, etc. They represent either 0 or 1. (Compared to a decimal
-    return one value as a result, pointers are often sent to functions to allow
+    digit, which can be anything between 0 and 9.) Just as a series of decimal
-    the function to change the values of multiple variables. (For example, Tux
+    digits can represent a larger number (e.g., "1" and "5" is fifteen (15)),
-    Paint's "rgbtohsv()" and "hsvtorgb()".)
+    so can bits (e.g., "1" and "0", is two). In decimal, we go from right to
-  * C structure: A construct in C that allows you to declare a new variable
+    left: ones place, tens place, hundreds place, thousands place, etc. In
-    'type' which may contain other types within. For example, SDL's "SDL_Rect"
+    binary, it is: ones place, twos place, fours place, eights place, etc.
-    contains four integer values, the coordinates of the rectangle (X,Y), and
+    See also: "byte"
-    its dimensions (width and height).
+
-  * #define: A C statement that defines a substitution that can occur later in
+blue
-    the code. Generally used for constant values (e.g., "#define RADIUS 16";
+    See "RGBA"
-    all instances of "RADIUS" will be replaced with "16"), but can also be used
+
-    to create macros. Typically placed within C header files.
+boolean 'or'
-  * dimensions: The size of an object, in terms of its width (left to right)
+    A mathematical operation that results in a true value if either operand is
-    and height (top to bottom).
+    true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in
-  * .dll: See "Shared Object"
+    "0".)
-  * dot: ".". A symbol in C that references an element within a struct.
+    See also: "bit"
-  * drag: The action of moving a mouse while the button remains held.
+
-  * element: A variable stored within a C structure. (Example: "w" and "h"
+byte
-    elements of SDL_Surface store the surface's width and height,
+    A unit of memory made up of 8 bits. As a signed value, it can represent
-    respectively.)
+    -128 through 127. As an unsigned value, it can represent 0 through 255. As
-  * enum: See "C enumeration"
+    a series of bits, for example, the byte "00001100" represents the decimal
-  * float: See "floating point"
+    value 12.
-  * floating point: TBD
+    See also: "bit"
-  * format: An SDL_Surface element (a pointer to an SDL_PixelFormat structure)
+
-    that contains information about a surface; for example, the number of bits
+C enumeration
-    used to represent each pixel). See also the "SDL_PixelFormat(3)" man page)
+    A construct in C that allows you to label numeric values (usually starting
-  * free(): A C function that frees (deallocates) memory allocated by other C
+    at 0 and incrementing by one). (e.g., "enum { ONE, TWO, THREE };"
-    functions (such as "strdup()").
+
-  * function: See "C function"
+C function / C function prototype / C header file
-  * gcc: The GNU C compiler, a portable Open Source compiler. See also the "gcc
+    Definition not yet presented.
-    (1)" man page)
+    See also: "C function prototype"
-  * GIMP: An Open Source image manipulation and paint program.
+
-  * GNU C Compiler: See "gcc"
+C pointer
-  * grave: The "`" character; used by the BASH shell to use the output of a
+    A variable that contains the location of a piece of memory; usually used to
-    command as the command-line arguments to another.
+    'point' to another variable. Since C functions can only return one value as
-  * green: See "RGBA"
+    a result, pointers are often sent to functions to allow the function to
-  * ->: See "arrow"
+    change the values of multiple variables. (For example, Tux Paint's
-  * .h: See "C header file"
+    "rgbtohsv()" and "hsvtorgb()".)
-  * header: See "C header file"
+
-  * header file: See "C header file"
+C structure
-  * HSV: Hue, Saturation and Value. TBD
+    A construct in C that allows you to declare a new variable 'type' which may
-  * hue: See "HSV"
+    contain other types within. For example, SDL's "SDL_Rect" contains four
-  * IMG_Load(): An SDL_image function that loads an image file (e.g., a PNG)
+    integer values, the coordinates of the rectangle (X,Y), and its dimensions
-    and returns it as an "SDL_Surface *".
+    (width and height).
-  * #include: A C statement that asks the compiler to read the contents of
+
-    another file (usually a header file).
+callback / channel
-  * int: See "integer"
+    Definition not yet presented.
-  * integer: TBD
+
-  * libSDL: See "Simple DirectMedia Layer"
+click
-  * linear: TBD
+    The action of pressing a button on a mouse, tapping a touchscreen, or
-  * macro: A C construct that looks similar to a C function, but is simply a #
+    pressing a stylus to a tablet.
-    define that is expanded 'inline'. For example, if you declared the macro "#
+    See also:
-    define ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that
+      + drag
-    line of code would literally expand to "c = ((1) + (2));", or more simply,
+      + release
-    "c = 1 + 2;".
+
-  * magic_api: A C structure that is passed along to a plugin's functions that
+
-    exposes data and functions within the running copy of Tux Paint.
+colorspace
-  * make: A utility that automatically determines which pieces of a larger
+    Definition not yet presented.
-    program need to be recompiled, and issues the commands to recompile them.
+    See also:
-    See also: "Makefile"
+      + RGBA
-  * Makefile: A text file used by the "make" utility; it describes the
+      + HSV
-    relationships among files in your program, and the commands for updating
+
-    each file. (For example, to compile a human-readable source-code file into
+
-    a computer-readable executable program file.)
+coordinates
-  * Magic tool: One of a number of effects or drawing tools in Tux Paint, made
+    A set of numbers corresponding to a physical position; for example, in a
-    available via the "Magic" tool button.
+    two-dimensional (2D) image, "X" and "Y" coordinates specify the position
-  * Mix_Chunk *: (A pointer to) a C structure defined by SDL_mixer that
+    across (left-to-right) and down the image, respectively. In SDL, the
-    contains a sound.
+    coordinates (0,0) is the top-leftmost pixel of a surface.
-  * Mix_FreeChunk(): An SDL_mixer function that frees (deallocates) memory
+
-    allocated for an SDL_mixer sound 'chunk' ("Mix_Chunk *").
+#define
-  * Mix_LoadWAV(): An SDL_mixer function that loads a sound file (WAV, Ogg
+    A C statement that defines a substitution that can occur later in the code.
-    Vorbis, etc.) and returns it as a "Mix_Chunk *".
+    Generally used for constant values (e.g., "#define RADIUS 16"; all
-  * namespace: TBD
+    instances of "RADIUS" will be replaced with "16"), but can also be used to
-  * .ogg: See "Ogg Vorbis"
+    create macros. Typically placed within C header files.
-  * Ogg Vorbis: See also: "WAV"
+
-  * Plugin: TBD
+dimensions
-  * .png: Portable Network Graphics. An extensible file format for the
+    The size of an object, in terms of its width (left to right) and height
-    lossless, portable, well-compressed storage of raster images. It's the file
+    (top to bottom).
-    format Tux Paint uses to save images, and for its brushes and stamps. It's
+
-    an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp
+.dll
-    alpha transparency), excellent for use in graphics programs like Tux Paint.
+    See "Shared Object"
-    See also the "png(5)" man page)
+
-  * pointer: See "C pointer"
+dot
-  * prototype: See "C function prototype"
+    ".". A symbol in C that references an element within a struct.
-  * red: See "RGBA"
+    See also:
-  * release: The action of releasing a button on a mouse.
+      + C structure
-  * RGBA: "Red, Green, Blue, Alpha." TBD
+      + arrow
-  * RGB: See "RGBA"
+
-  * saturation: See "HSV"
+
-  * SDL: See "Simple DirectMedia Layer"
+drag
-  * SDL_FreeSurface(): An libSDL function that frees (deallocates) memory
+    The action of moving a mouse while the button remains held, or moving a
-    allocated for an SDL surface ("SDL_Surface *"). See also the
+    finger or stylus across a screen or tablet, without removing it.
-    "SDL_FreeSurface(3)" man page)
+    See also:
-  * SDL_GetRGB(): A libSDL function that, given a Uint32 pixel value (e.g., one
+      + click
-    returned from the Tux Paint's Magic tool API helper function "getpixel()"),
+      + release
-    the format of the surface the pixel was taken from, and pointers to three
+
-    Uint8 variables, will place the Red, Green and Blue (RGB) values of the
+
-    pixel into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf,
+element
-    x, y), surf->format, &r, &g, &b);".) See also the "SDL_GetRGB(3)" man page)
+    A variable stored within a C structure. (Example: "w" and "h" elements of
-  * SDL_MapRGB(): A libSDL function that, given the format of a surface and
+    SDL_Surface store the surface's width and height, respectively.)
-    Uint8 values representing Red, Green and Blue values for a pixel, returns a
+    See also:
-    Uint32 pixel value that can be placed in the surface (e.g., using Tux
+      + C structure
-    Paint's Magic tool API helper function "putpixel()"). (Example: "putpixel
+      + dot
-    (surf, x, y, SDL_MapRGB(surf->format, r, g, b));".) See also the
+      + arrow
-    "SDL_MapRGB(3)" man page)
+
-  * SDL_image: A library on top of libSDL that can load various kinds of image
+
-    files (e.g., PNG) and return them as an "SDL_Surface *".
+enum
-  * SDL_mixer: A library on top of libSDL that can load various kinds of sound
+    See "C enumeration"
-    files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix
+
-    them).
+float
-  * SDL_Rect: A C structure defined by libSDL that represents a rectangular
+    See "floating point"
-    area. It contains elements representing the coordinates of the top left
+
-    corner of the rectange (x,y) and the dimensions of the rectangle (w,h). See
+floating point
-    also the "SDL_Rect(3)" man page)
+    Definition not yet presented.
-  * SDL_Surface *: (A pointer to) a C structure defined by libSDL that contains
+    See also: "integer"
-    a drawing surface. See also the "SDL_Surface(3)" man page)
+
-  * Shared Object: A piece of code that's compiled separately from the main
+format
-    application, and loaded dynamically, at runtime.
+    An SDL_Surface element (a pointer to an SDL_PixelFormat structure) that
-  * Simple DirectMedia Layer: A programming library that allows programs
+    contains information about a surface; for example, the number of bits used
-    portable low level access to a video framebuffer, audio output, mouse, and
+    to represent each pixel).
-    keyboard. (See also: http://www.libsdl.org/)
+    Refer to the "SDL_PixelFormat(3)" man page.
-  * snprintf(): A C function, related to "printf()", which takes a 'format'
+
-    string and one or more additional arguments, and puts them together.
+free()
-    "snprintf()" takes the resulting output and stores it into a string, making
+    A C function that frees (deallocates) memory allocated by other C functions
-    sure not to go beyond the string's buffer size (which must also be
+    (such as "strdup()").
-    supplied). For example, assume a string "char str[20];" has been declared;
+    Refer to the "malloc(3)" man page.
-    "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name:
+
-    Bill, Age: 32" into 'str'. See also the "snprintf(3)" man page)
+function
-  * .so: See "Shared Object"
+    See "C function"
-  * sRBG: See "RGBA"
+
-  * star: "*". A symbol in C that, when used in the declaration of variables
+gcc
-    (e.g., arguments to a function), denotes that the variable is a pointer.
+    See "GNU C Compiler"
-    (For example, "int * p;" means that "p" is a pointer to an integer.) When
+
-    used next to a pointer, it 'dereferences' the variable. (For example, later
+GIMP
-    "*p = 50;" assigns the value of 50 to the memory that "p" points to; it
+    GNU Image Manipulation Program, an Open Source image manipulation and paint
-    does not change the value of "p", which is still a pointer to an integer.
+    program.
-    In essence, it changed the integer that's being pointed to.) See also:
+    See also: "Krita"
-    "ampersand"
+
-  * strdup(): A C function that allocates enough memory to store a copy of a
+GNU C Compiler
-    string, copies the string to it, and returns a "char *" pointer to the new
+    The GNU C compiler, a portable Open Source package for compiling and
-    copy. See also the "strdup(3)" man page)
+    linking programs written in the C programming language.
-  * struct: See "C structure"
+    Refer to the "gcc(1)" man page.
-  * tp_magic_api.h: A header file that defines Tux Paint's Magic tool API.
+
-    Plugins must '#include' it.
+grave
-  * tp-magic-config: A command-line program that provides information about the
+    The "`" character; used by the BASH shell to use the output of a command as
-    installed version of Tux Paint to plugin developers (such as what C
+    the command-line arguments to another.
-    compiler flags they should compile with, and where plugin shared objects
+
-    and data files should be installed). See also the "tp-magic-config(3)" man
+green
-    page)
+    See "RGBA"
-  * Uint32: A 32-bit, unsigned integer (defined by libSDL). In other words,
+
-    four bytes that can represent 0 through 4294967295. (Typically used to hold
+.h / header / header file
-    enough information to store three or four bytes representing a pixel's
+    See "C header file"
-    color; i.e., RBGA value).
+
-  * Uint8: An 8-bit, unsigned integer (defined by libSDL). In other words, a
+HSV
-    byte that can represent 0 through 255.
+    Hue, Saturation and Value.Definition not yet presented.
-  * unsigned: In C, a variable that can store a numeric value can be declared
+    See also:
-    as either "signed" (the default), or "unsigned". In the former case, one
+      + RGBA
-    bit of the value is used to denote the sign of the value (either positive
+      + colorspace
-    or negative). In the latter case, the value can only be positive, but
+
-    benefits from one extra bit of storage for the number. A signed byte (8
+
-    bits), for example, can represent any number between -128 and 127. An
+hue
-    unsigned byte can go up to 255, but it cannot go below 0. For the purposes
+    See "HSV"
-    of graphics in SDL, unsigned values should be used for RGB values, since
+
-    each channel (red, green and blue) may be between 0 (off) and 255
+IMG_Load()
-    (brightest).
+    An SDL_image function that loads an image file (e.g., a PNG) and returns it
-  * value: See "HSV"
+    as an "SDL_Surface *".
-  * variable: A construct in computer programming that contains a value which
+
-    can be referenced again later by referring to the variable's name, and
+#include
-    typically changed later. For example, a variable to hold someone's age
+    A C statement that asks the compiler to read the contents of another file
-    could be declared as an integer: "int a;". It can be examined later: "if (a
+    (usually a header file).
-    >= 18) { /* they are an adult */ } else { /* they are not an adult */ }".
+
-  * .wav: See also: "Ogg Vorbis"
+int
-  * (w,h): See "Dimensions"
+    See "integer"
-  * (x,y): See "Coordinates"
+
+integer
+    Definition not yet presented.
+    See also: "floating point"
+
+Krita
+    An Open Source image manipulation and paint program.
+    See also: "GIMP"
+
+libSDL
+    See "Simple DirectMedia Layer"
+
+linear
+    Definition not yet presented.
+
+macro
+    A C construct that looks similar to a C function, but is simply a #define
+    that is expanded 'inline'. For example, if you declared the macro "#define
+    ADD(A,B) ((A)+(B))", and then used it with "c = ADD(1,2);", that line of
+    code would literally expand to "c = ((1) + (2));", or more simply, "c = 1 +
+    2;".
+
+Magic tool
+    One of a number of effects or drawing tools in Tux Paint, made available
+    via the "Magic" tool button.
+
+magic_api
+    A C structure that is passed along to a plugin's functions that exposes
+    data and functions within the running copy of Tux Paint.
+
+make
+    A utility that automatically determines which pieces of a larger program
+    need to be recompiled, and issues the commands to recompile them.
+    See also: "Makefile"
+
+Makefile
+    A text file used by the "make" utility; it describes the relationships
+    among files in your program, and the commands for updating each file. (For
+    example, to compile a human-readable source-code file into a
+    computer-readable executable program file.)
+
+Mix_Chunk *
+    (A pointer to) a C structure defined by SDL_mixer that contains a sound.
+
+Mix_FreeChunk()
+    An SDL_mixer function that frees (deallocates) memory allocated for an
+    SDL_mixer sound 'chunk' ("Mix_Chunk *").
+
+Mix_LoadWAV()
+    An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and
+    returns it as a "Mix_Chunk *".
+
+namespace
+    Definition not yet presented.
+
+.ogg
+    See "Ogg Vorbis"
+
+Ogg Vorbis / plugin
+    Definition not yet presented.
+    See also: "WAVE"
+
+.png
+    See "Portable Network Graphics"
+
+pointer
+    See "C pointer"
+
+Portable Network Graphics
+    Portable Network Graphics. An extensible file format for the lossless,
+    portable, well-compressed storage of raster images. It's the file format
+    Tux Paint uses to save images, and for its brushes and stamps. It's an easy
+    way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha
+    transparency), excellent for use in graphics programs like Tux Paint.
+    Refer to the "png(5)" man page.
+    See also: "Scalable Vector Graphic"
+
+prototype
+    See "C function prototype"
+
+red
+    See "RGBA"
+
+release
+    The action of releasing a mouse button, or removing a finger or stylus from
+    a screen or tablet.
+    See also:
+      + click
+      + drag
+
+
+RGB
+    See "RGBA"
+
+RGBA
+    Red, Green, Blue, and Alpha.Definition not yet presented.
+    See also:
+      + HSV
+      + colorspace
+
+
+saturation
+    See "HSV"
+
+SDL
+    See "Simple DirectMedia Layer"
+
+SDL_FreeSurface()
+    A libSDL function that frees (deallocates) memory allocated for an SDL
+    surface ("SDL_Surface *").
+
+SDL_GetRGB()
+    A libSDL function that, given a Uint32 pixel value (e.g., one returned from
+    the Tux Paint's Magic tool API helper function "getpixel()"), the format of
+    the surface the pixel was taken from, and pointers to three Uint8
+    variables, will place the Red, Green and Blue (RGB) values of the pixel
+    into the three Uint8 variables. (Example: "SDL_GetRGB(getpixel(surf, x, y),
+    surf->format, &r, &g, &b);".)
+    Refer to the "SDL_GetRGB(3)" man page.
+    See also:
+      + SDL_MapRGB()
+      + RGBA
+
+
+SDL_image
+    A library on top of libSDL that can load various kinds of image files
+    (e.g., PNG) and return them as an "SDL_Surface *".
+
+SDL_MapRGB()
+    A libSDL function that, given the format of a surface and Uint8 values
+    representing Red, Green and Blue values for a pixel, returns a Uint32 pixel
+    value that can be placed in the surface (e.g., using Tux Paint's Magic tool
+    API helper function "putpixel()"). (Example: "putpixel(surf, x, y,
+    SDL_MapRGB(surf->format, r, g, b));".)
+    Refer to the "SDL_MapRGB(3)" man page.
+    See also:
+      + SDL_GetRGB()
+      + RGBA
+
+
+SDL_mixer
+    A library on top of libSDL that can load various kinds of sound files (WAV,
+    Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).
+
+SDL_Rect
+    A C structure defined by libSDL that represents a rectangular area. It
+    contains elements representing the coordinates of the top left corner of
+    the rectange (x,y) and the dimensions of the rectangle (w,h).
+    Refer to the "SDL_Rect(3)" man page.
+
+SDL_Surface *
+    (A pointer to) a C structure defined by libSDL that contains a drawing
+    surface.
+    Refer to the "SDL_Surface(3)" man page.
+
+shared object
+    A piece of code that's compiled separately from the main application, and
+    loaded dynamically, at runtime.
+
+shell
+    See "BASH"
+
+Simple DirectMedia Layer
+    The Simple DirectMedia Layer (libSDL) is a programming library that
+    provides portable low-level access to a video framebuffer, audio output,
+    and mouse and keyboard input. (See: http://www.libsdl.org/)
+
+snprintf()
+    A C function, related to "printf()", which takes a 'format' string and one
+    or more additional arguments, and puts them together. "snprintf()" takes
+    the resulting output and stores it into a string, making sure not to go
+    beyond the string's buffer size (which must also be supplied). For example,
+    assume a string "char str[20];" has been declared; "snprintf(str, 20,
+    "Name: %s, Age: %d", "Bill", 32);" will store "Name: Bill, Age: 32" into
+    'str'.
+    Refer to the "sprintf(3)" man page.
+
+.so
+    See "shared object"
+
+sRGB
+    See "RGBA"
+
+star
+    "*". A symbol in C that, when used in the declaration of variables (e.g.,
+    arguments to a function), denotes that the variable is a pointer. (For
+    example, "int * p;" means that "p" is a pointer to an integer.) When used
+    next to a pointer, it 'dereferences' the variable. (For example, later "*p
+    = 50;" assigns the value of 50 to the memory that "p" points to; it does
+    not change the value of "p", which is still a pointer to an integer. In
+    essence, it changed the integer that's being pointed to.)
+    See also: "ampersand"
+
+strdup()
+    A C function that allocates enough memory to store a copy of a string,
+    copies the string to it, and returns a "char *" pointer to the new copy.
+    Refer to the "strdup(3)" man page.
+
+struct
+    See "C structure"
+
+tap
+    See "click"
+
+tp-magic-config
+    A command-line program that provides information about the installed
+    version of Tux Paint to plugin developers (such as what C compiler flags
+    they should compile with, and where plugin shared objects and data files
+    should be installed).
+    Refer to the "tp-magic-config(3)" man page.
+
+tp_magic_api.h
+    A header file that defines Tux Paint's Magic tool API. Plugins must '#
+    include' it.
+
+Uint32
+    A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes
+    that can represent 0 through 4,294,967,295. (Typically used to hold enough
+    information to store three or four bytes representing a pixel's color;
+    i.e., RBGA value).
+    See also:
+      + Uint8
+      + integer
+      + unsigned
+
+
+Uint8
+    An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that
+    can represent 0 through 255.
+    See also:
+      + Uint32
+      + integer
+      + unsigned
+
+
+unsigned
+    In C, a variable that can store a numeric value can be declared as either
+    "signed" (the default), or "unsigned". In the former case, one bit of the
+    value is used to denote the sign of the value (either positive or
+    negative). In the latter case, the value can only be positive, but benefits
+    from one extra bit of storage for the number. A signed byte (8 bits), for
+    example, can represent any number between -128 and 127. An unsigned byte
+    can go up to 255, but it cannot go below 0. For the purposes of graphics in
+    SDL, unsigned values should be used for RGB values, since each channel
+    (red, green and blue) may be between 0 (off) and 255 (brightest).
+    See also:
+      + Uint8
+      + Uint32
+      + integer
+
+
+value
+    See "HSV"
+
+variable
+    A construct in computer programming that contains a value which can be
+    referenced again later by referring to the variable's name, and typically
+    changed later. For example, a variable to hold someone's age could be
+    declared as an integer: "int age;". It can be examined later — e.g., "if
+    (age >= 18) { /* they are an adult */ } else { /* they are not an adult */
+    }" — as well as modified later — e.g., age = 32; /* set age to 32 */
+
+(w,h)
+    See "dimensions"
+
+.wav
+    See "WAVE"
+
+WAVE
+    Waveform Audio File Format (WAVE, or WAV). Definition not yet presented.
+    See also: "Ogg Vorbis"
+
+(x,y)
+    See "coordinates"
+
+|
+    See "boolean 'or'"
+
 

docs/sq_AL.UTF-8/README.txt

@@ -6,7 +6,7 @@
  Të drejta kopjimi © 2002-2024 nga kontribues të ndryshëm; shihni AUTHORS.txt.
                              https://tuxpaint.org/
 
-                                 27 janar 2024
+                                 29 janar 2024
 
 +---------------------------------------------------+
 |                 Pasqyrë e Lëndës                  |

docs/sq_AL.UTF-8/html/MAGIC-API.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            janar 26, 2024          </p>
+            janar 29, 2024          </p>
         </center>
       </header>
 
@@ -1143,335 +1143,391 @@
     </section><!-- H1: Getting Help -->
 
     
-    <section class="outer"><!-- H1: Glossary -->
-      <header>
-        <h1 id="glossary">
-          Glossary        </h1>
-      </header>
     
-      <ul>
+<section class="outer"><!-- H1: Glossary -->
-        <li>
+  <header>
-          <b>alpha:</b>
+    <h1 id="glossary">
-          See "RGBA"        </li>
+      Glossary    </h1>
-        <li>
+  </header>
-          <b><code>&amp;</code>:</b>
+
-          See "ampersand"        </li>
+  <dl>
-        <li>
+          <dt><code>&amp;</code></dt>
-          <b>ampersand (pointers):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)          See also: "star"        </li>
+        See "ampersand"              </dd>
-        <li>
+            <dt><code>*</code></dt>
-          <b>ampersand (bitwise operator):</b>
+      <dd>
-          "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').          See also: "bit"        </li>
+        See "star"              </dd>
-        <li>
+            <dt><code>-&gt;</code></dt>
-          <b>API:</b>
+      <dd>
-           Application Programming Interface. <i>TBD</i>
+        See "arrow"              </dd>
-        </li>
+            <dt><code>.</code></dt>
-        <li>
+      <dd>
-          <b>argument:</b>
+        See "dot"              </dd>
-          A value sent to a function.        </li>
+            <dt><code>`</code></dt>
-        <li>
+      <dd>
-          <b>arrow:</b>
+        See "grave"              </dd>
-          "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.        </li>
+            <dt>alpha</dt>
-        <li>
+      <dd>
-          <b>backquote:</b>
+        See "RGBA"              </dd>
-          See "grave"        </li>
+            <dt>ampersand (bitwise operator)</dt>
-        <li>
+      <dd>
-          <b>backtick:</b>
+        "<code>&amp;</code>". A symbol in C that acts as a bitwise "and" operator. Only bits set in both values will be returned. For example, "<code>11 &amp; 6</code>" compares the binary values '1011' to '0110'. Only the bit in the 2's place is set, so the result is <code>2</code> ('0010').        <br/>
-          See "grave"        </li>
+See also: "bit"      </dd>
-        <li>
+            <dt>ampersand (pointers)</dt>
-          <b>bit:</b>
+      <dd>
-          "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.          See also: "byte"        </li>
+        "<code>&amp;</code>". A symbol in C that allows you to refer to the memory address of a variable; that is, a pointer. (For example, consider "<code>int i;</code>". Later, "<code>&amp;i</code>" refers to the memory where "<code>i</code>" is stored, not the value of "<code>i</code>" itself; it is a 'pointer to "<code>i</code>"'.)        <br/>
-        <li>
+See also: "star"      </dd>
-          <b>blue:</b>
+            <dt>API</dt>
-          See "RGBA"        </li>
+      <dd>
-        <li>
+        Application Programming Interface. <i>Definition not yet presented.</i>              </dd>
-          <b>boolean 'or':</b>
+            <dt>argument</dt>
-          A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        </li>
+      <dd>
-        <li>
+        A value sent to a function.              </dd>
-          <b><code>|</code>:</b>
+            <dt>arrow</dt>
-          See "boolean 'or'"        </li>
+      <dd>
-        <li>
+        "<code>-&gt;</code>". A symbol in C that references an element within a pointer to a struct.              </dd>
-          <b><code>.</code>:</b>
+            <dt>backquote / backtick</dt>
-          See "dot"        </li>
+      <dd>
-        <li>
+        See "grave"              </dd>
-          <b><code>`</code>:</b>
+            <dt>BASH</dt>
-          See "grave"        </li>
+      <dd>
-        <li>
+        The "Bourne Again Shell", a Unix shell and command language.              </dd>
-          <b><code>*</code>:</b>
+            <dt>bit</dt>
-          See "star"        </li>
+      <dd>
-        <li>
+        "Binary digit." Bits are the basic storage unit in a computer's memory, disk, networking, etc. They represent either 0 or 1. (Compared to a decimal digit, which can be anything between 0 and 9.) Just as a series of decimal digits can represent a larger number (e.g., "1" and "5" is fifteen (15)), so can bits (e.g., "1" and "0", is two). In decimal, we go from right to left: ones place, tens place, hundreds place, thousands place, etc. In binary, it is: ones place, twos place, fours place, eights place, etc.        <br/>
-          <b>byte:</b>
+See also: "byte"      </dd>
-          A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        </li>
+            <dt>blue</dt>
-        <li>
+      <dd>
-          <b>callback:</b>
+        See "RGBA"              </dd>
-           <i>TBD</i>
+            <dt>boolean &#039;or&#039;</dt>
-        </li>
+      <dd>
-        <li>
+        A mathematical operation that results in a true value if either operand is true. ("1 | 0", "0 | 1" and "1 | 1" all result in "1". "0 | 0" results in "0".)        <br/>
-          <b>C enumeration:</b>
+See also: "bit"      </dd>
-          A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"        </li>
+            <dt>byte</dt>
-        <li>
+      <dd>
-          <b>C function:</b>
+        A unit of memory made up of 8 bits. As a signed value, it can represent -128 through 127. As an unsigned value, it can represent 0 through 255. As a series of bits, for example, the byte "00001100" represents the decimal value 12.        <br/>
-           <i>TBD</i>
+See also: "bit"      </dd>
-        </li>
+            <dt>C enumeration</dt>
-        <li>
+      <dd>
-          <b>C function prototype:</b>
+        A construct in C that allows you to label numeric values (usually starting at 0 and incrementing by one). (e.g., "<code>enum { ONE, TWO, THREE };</code>"              </dd>
-           <i>TBD</i>
+            <dt>C function / C function prototype / C header file</dt>
-        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>C header file:</b>
+See also: "C function prototype"      </dd>
-           <i>TBD</i>
+            <dt>C pointer</dt>
-        </li>
+      <dd>
-        <li>
+        A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)              </dd>
-          <b>channel:</b>
+            <dt>C structure</dt>
-           <i>TBD</i>
+      <dd>
-        </li>
+        A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).              </dd>
-        <li>
+            <dt>callback / channel</dt>
-          <b>click:</b>
+      <dd>
-          The action of pressing a button on a mouse.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>click</dt>
-          <b>coordinates:</b>
+      <dd>
-          A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.        </li>
+        The action of pressing a button on a mouse, tapping a touchscreen, or pressing a stylus to a tablet.        <br/>
-        <li>
+See also:
-          <b>C pointer:</b>
+<ul>
-          A variable that contains the location of a piece of memory; usually used to 'point' to another variable. Since C functions can only return one value as a result, pointers are often sent to functions to allow the function to change the values of multiple variables. (For example, Tux Paint's "<code>rgbtohsv()</code>" and "<code>hsvtorgb()</code>".)        </li>
+<li>drag</li><li>release</li></ul>
-        <li>
+      </dd>
-          <b>C structure:</b>
+            <dt>colorspace</dt>
-          A construct in C that allows you to declare a new variable 'type' which may contain other types within. For example, SDL's "<code>SDL_Rect</code>" contains four integer values, the coordinates of the rectangle (X,Y), and its dimensions (width and height).        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>#define</code>:</b>
+See also:
-          A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.        </li>
+<ul>
-        <li>
+<li>RGBA</li><li>HSV</li></ul>
-          <b>dimensions:</b>
+      </dd>
-          The size of an object, in terms of its width (left to right) and height (top to bottom).        </li>
+            <dt>coordinates</dt>
-        <li>
+      <dd>
-          <b><code>.dll</code>:</b>
+        A set of numbers corresponding to a physical position; for example, in a two-dimensional (2D) image, "X" and "Y" coordinates specify the position across (left-to-right) and down the image, respectively. In SDL, the coordinates (0,0) is the top-leftmost pixel of a surface.              </dd>
-          See "Shared Object"        </li>
+            <dt><code>#define</code></dt>
-        <li>
+      <dd>
-          <b>dot:</b>
+        A C statement that defines a substitution that can occur later in the code. Generally used for constant values (e.g., "<code>#define RADIUS 16</code>"; all instances of "<code>RADIUS</code>" will be replaced with "<code>16</code>"), but can also be used to create macros. Typically placed within C header files.              </dd>
-          "<code>.</code>". A symbol in C that references an element within a struct.        </li>
+            <dt><code>dimensions</code></dt>
-        <li>
+      <dd>
-          <b>drag:</b>
+        The size of an object, in terms of its width (left to right) and height (top to bottom).              </dd>
-          The action of moving a mouse while the button remains held.        </li>
+            <dt><code>.dll</code></dt>
-        <li>
+      <dd>
-          <b>element:</b>
+        See "Shared Object"              </dd>
-          A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        </li>
+            <dt>dot</dt>
-        <li>
+      <dd>
-          <b><code>enum</code>:</b>
+        "<code>.</code>". A symbol in C that references an element within a struct.        <br/>
-          See "C enumeration"        </li>
+See also:
-        <li>
+<ul>
-          <b><code>float</code>:</b>
+<li>C structure</li><li>arrow</li></ul>
-          See "floating point"        </li>
+      </dd>
-        <li>
+            <dt>drag</dt>
-          <b>floating point:</b>
+      <dd>
-           <i>TBD</i>
+        The action of moving a mouse while the button remains held, or moving a finger or stylus across a screen or tablet, without removing it.        <br/>
-        </li>
+See also:
-        <li>
+<ul>
-          <b><code>format</code>:</b>
+<li>click</li><li>release</li></ul>
-          An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).          See also the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>)        </li>
+      </dd>
-        <li>
+            <dt>element</dt>
-          <b><code>free()</code>:</b>
+      <dd>
-          A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").        </li>
+        A variable stored within a C structure. (Example: "<code>w</code>" and "<code>h</code>" elements of SDL_Surface store the surface's width and height, respectively.)        <br/>
-        <li>
+See also:
-          <b>function:</b>
+<ul>
-          See "C function"        </li>
+<li>C structure</li><li>dot</li><li>arrow</li></ul>
-        <li>
+      </dd>
-          <b><code>gcc</code>:</b>
+            <dt><code>enum</code></dt>
-          The GNU C compiler, a portable Open Source compiler.          See also the "<code>gcc(1)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "C enumeration"              </dd>
-          <b><cite>GIMP</cite>:</b>
+            <dt><code>float</code></dt>
-          An Open Source image manipulation and paint program.        </li>
+      <dd>
-        <li>
+        See "floating point"              </dd>
-          <b><cite>GNU C Compiler</cite>:</b>
+            <dt>floating point</dt>
-          See "gcc"        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b>grave:</b>
+See also: "integer"      </dd>
-          The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.        </li>
+            <dt><code>format</code></dt>
-        <li>
+      <dd>
-          <b>green:</b>
+        An <code>SDL_Surface</code> element (a pointer to an <code>SDL_PixelFormat</code> structure) that contains information about a surface; for example, the number of bits used to represent each pixel).<br/>Refer to the "<code>SDL_PixelFormat(3)</code>" <i>man page</i>.              </dd>
-          See "RGBA"        </li>
+            <dt><code>free()</code></dt>
-        <li>
+      <dd>
-          <b><code>-&gt;</code>:</b>
+        A C function that frees (deallocates) memory allocated by other C functions (such as "<code>strdup()</code>").<br/>Refer to the "<code>malloc(3)</code>" <i>man page</i>.              </dd>
-          See "arrow"        </li>
+            <dt>function</dt>
-        <li>
+      <dd>
-          <b><code>.h</code>:</b>
+        See "C function"              </dd>
-          See "C header file"        </li>
+            <dt><code>gcc</code></dt>
-        <li>
+      <dd>
-          <b>header:</b>
+        See "GNU C Compiler"              </dd>
-          See "C header file"        </li>
+            <dt>GIMP</dt>
-        <li>
+      <dd>
-          <b>header file:</b>
+        GNU Image Manipulation Program, an Open Source image manipulation and paint program.        <br/>
-          See "C header file"        </li>
+See also: "Krita"      </dd>
-        <li>
+            <dt>GNU C Compiler</dt>
-          <b><code>HSV</code>:</b>
+      <dd>
-           Hue, Saturation and Value. <i>TBD</i>
+        The GNU C compiler, a portable Open Source package for compiling and linking programs written in the C programming language.<br/>Refer to the "<code>gcc(1)</code>" <i>man page</i>.              </dd>
-        </li>
+            <dt>grave</dt>
-        <li>
+      <dd>
-          <b>hue:</b>
+        The "<code><font size=+1>`</font></code>" character; used by the BASH shell to use the output of a command as the command-line arguments to another.              </dd>
-          See "HSV"        </li>
+            <dt>green</dt>
-        <li>
+      <dd>
-          <b><code>IMG_Load()</code>:</b>
+        See "RGBA"              </dd>
-          An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".        </li>
+            <dt><code>.h</code> / header / header file</dt>
-        <li>
+      <dd>
-          <b><code>#include</code>:</b>
+        See "C header file"              </dd>
-          A C statement that asks the compiler to read the contents of another file (usually a header file).        </li>
+            <dt>HSV</dt>
-        <li>
+      <dd>
-          <b><code>int</code>:</b>
+        Hue, Saturation and Value.<i>Definition not yet presented.</i>        <br/>
-          See "integer"        </li>
+See also:
-        <li>
+<ul>
-          <b>integer:</b>
+<li>RGBA</li><li>colorspace</li></ul>
-           <i>TBD</i>
+      </dd>
-        </li>
+            <dt>hue</dt>
-        <li>
+      <dd>
-          <b><code>libSDL</code>:</b>
+        See "HSV"              </dd>
-          See "Simple DirectMedia Layer"        </li>
+            <dt><code>IMG_Load()</code></dt>
-        <li>
+      <dd>
-          <b>linear:</b>
+        An SDL_image function that loads an image file (e.g., a PNG) and returns it as an "<code>SDL_Surface *</code>".              </dd>
-           <i>TBD</i>
+            <dt><code>#include</code></dt>
-        </li>
+      <dd>
-        <li>
+        A C statement that asks the compiler to read the contents of another file (usually a header file).              </dd>
-          <b>macro:</b>
+            <dt><code>int</code></dt>
-          A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".        </li>
+      <dd>
-        <li>
+        See "integer"              </dd>
-          <b><code>magic_api</code>:</b>
+            <dt>integer</dt>
-          A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.        </li>
+      <dd>
-        <li>
+        <i>Definition not yet presented.</i>        <br/>
-          <b><code>make</code>:</b>
+See also: "floating point"      </dd>
-          A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.          See also: "Makefile"        </li>
+            <dt>Krita</dt>
-        <li>
+      <dd>
-          <b><code>Makefile</code>:</b>
+        An Open Source image manipulation and paint program.        <br/>
-          A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)        </li>
+See also: "GIMP"      </dd>
-        <li>
+            <dt>libSDL</dt>
-          <b>Magic tool:</b>
+      <dd>
-          One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.        </li>
+        See "Simple DirectMedia Layer"              </dd>
-        <li>
+            <dt>linear</dt>
-          <b><code>Mix_Chunk *</code>:</b>
+      <dd>
-          (A pointer to) a C structure defined by SDL_mixer that contains a sound.        </li>
+        <i>Definition not yet presented.</i>              </dd>
-        <li>
+            <dt>macro</dt>
-          <b><code>Mix_FreeChunk()</code>:</b>
+      <dd>
-          An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").        </li>
+        A C construct that looks similar to a C function, but is simply a #define that is expanded 'inline'. For example, if you declared the macro "<code>#define ADD(A,B) ((A)+(B))</code>", and then used it with "<code>c = ADD(1,2);</code>", that line of code would literally expand to "<code>c = ((1) + (2));</code>", or more simply, "<code>c = 1 + 2;</code>".              </dd>
-        <li>
+            <dt>Magic tool</dt>
-          <b><code>Mix_LoadWAV()</code>:</b>
+      <dd>
-          An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".        </li>
+        One of a number of effects or drawing tools in Tux Paint, made available via the "Magic" tool button.              </dd>
-        <li>
+            <dt><code>magic_api</code></dt>
-          <b>namespace:</b>
+      <dd>
-           <i>TBD</i>
+        A C structure that is passed along to a plugin's functions that exposes data and functions within the running copy of Tux Paint.              </dd>
-        </li>
+            <dt><code>make</code></dt>
-        <li>
+      <dd>
-          <b><code>.ogg</code>:</b>
+        A utility that automatically determines which pieces of a larger program need to be recompiled, and issues the commands to recompile them.        <br/>
-          See "Ogg Vorbis"        </li>
+See also: "Makefile"      </dd>
-        <li>
+            <dt><code>Makefile</code></dt>
-          <b><cite>Ogg Vorbis</cite>:</b>
+      <dd>
-          See also: "WAV"        </li>
+        A text file used by the "make" utility; it describes the relationships among files in your program, and the commands for updating each file. (For example, to compile a human-readable source-code file into a computer-readable executable program file.)              </dd>
-        <li>
+            <dt><code>Mix_Chunk *</code></dt>
-          <b>Plugin:</b>
+      <dd>
-           <i>TBD</i>
+        (A pointer to) a C structure defined by SDL_mixer that contains a sound.              </dd>
-        </li>
+            <dt><code>Mix_FreeChunk()</code></dt>
-        <li>
+      <dd>
-          <b>.png:</b>
+        An SDL_mixer function that frees (deallocates) memory allocated for an SDL_mixer sound 'chunk' ("<code>Mix_Chunk *</code>").              </dd>
-          Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.          See also the "<code>png(5)</code>" <i>man page</i>)        </li>
+            <dt><code>Mix_LoadWAV()</code></dt>
-        <li>
+      <dd>
-          <b>pointer:</b>
+        An SDL_mixer function that loads a sound file (WAV, Ogg Vorbis, etc.) and returns it as a "<code>Mix_Chunk *</code>".              </dd>
-          See "C pointer"        </li>
+            <dt>namespace</dt>
-        <li>
+      <dd>
-          <b>prototype:</b>
+        <i>Definition not yet presented.</i>              </dd>
-          See "C function prototype"        </li>
+            <dt><code>.ogg</code></dt>
-        <li>
+      <dd>
-          <b>red:</b>
+        See "Ogg Vorbis"              </dd>
-          See "RGBA"        </li>
+            <dt>Ogg Vorbis / plugin</dt>
-        <li>
+      <dd>
-          <b>release:</b>
+        <i>Definition not yet presented.</i>        <br/>
-          The action of releasing a button on a mouse.        </li>
+See also: "WAVE"      </dd>
-        <li>
+            <dt><code>.png</code></dt>
-          <b><code>RGBA</code>:</b>
+      <dd>
-           "Red, Green, Blue, Alpha." <i>TBD</i>
+        See "Portable Network Graphics"              </dd>
-        </li>
+            <dt>pointer</dt>
-        <li>
+      <dd>
-          <b><code>RGB</code>:</b>
+        See "C pointer"              </dd>
-          See "RGBA"        </li>
+            <dt>Portable Network Graphics</dt>
-        <li>
+      <dd>
-          <b>saturation:</b>
+        Portable Network Graphics. An extensible file format for the lossless, portable, well-compressed storage of raster images. It's the file format Tux Paint uses to save images, and for its brushes and stamps. It's an easy way to store 32bpp RGBA images (24bpp true color with full 8bpp alpha transparency), excellent for use in graphics programs like Tux Paint.<br/>Refer to the "<code>png(5)</code>" <i>man page</i>.        <br/>
-          See "HSV"        </li>
+See also: "Scalable Vector Graphic"      </dd>
-        <li>
+            <dt>prototype</dt>
-          <b><cite>SDL</cite>:</b>
+      <dd>
-          See "Simple DirectMedia Layer"        </li>
+        See "C function prototype"              </dd>
-        <li>
+            <dt>red</dt>
-          <b><code>SDL_FreeSurface()</code>:</b>
+      <dd>
-          An libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").          See also the "<code>SDL_FreeSurface(3)</code>" <i>man page</i>)        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>release</dt>
-          <b><code>SDL_GetRGB()</code>:</b>
+      <dd>
-          A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)          See also the "<code>SDL_GetRGB(3)</code>" <i>man page</i>)        </li>
+        The action of releasing a mouse button, or removing a finger or stylus from a screen or tablet.        <br/>
-        <li>
+See also:
-          <b><code>SDL_MapRGB()</code>:</b>
+<ul>
-          A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)          See also the "<code>SDL_MapRGB(3)</code>" <i>man page</i>)        </li>
+<li>click</li><li>drag</li></ul>
-        <li>
+      </dd>
-          <b><cite>SDL_image</cite>:</b>
+            <dt>RGB</dt>
-          A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".        </li>
+      <dd>
-        <li>
+        See "RGBA"              </dd>
-          <b><cite>SDL_mixer</cite>:</b>
+            <dt>RGBA</dt>
-          A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).        </li>
+      <dd>
-        <li>
+        Red, Green, Blue, and Alpha.<i>Definition not yet presented.</i>        <br/>
-          <b><code>SDL_Rect</code>:</b>
+See also:
-          A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).          See also the "<code>SDL_Rect(3)</code>" <i>man page</i>)        </li>
+<ul>
-        <li>
+<li>HSV</li><li>colorspace</li></ul>
-          <b><code>SDL_Surface *</code>:</b>
+      </dd>
-          (A pointer to) a C structure defined by libSDL that contains a drawing surface.
+            <dt>saturation</dt>
-          See also the "<code>SDL_Surface(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        See "HSV"              </dd>
-          <b>Shared Object:</b>
+            <dt>SDL</dt>
-          A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.        </li>
+      <dd>
-        <li>
+        See "Simple DirectMedia Layer"              </dd>
-          <b><cite>Simple DirectMedia Layer</cite>:</b>
+            <dt><code>SDL_FreeSurface()</code></dt>
-          A programming library that allows programs portable low level access to a video framebuffer, audio output, mouse, and keyboard. (See also: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)        </li>
+      <dd>
-        <li>
+        A libSDL function that frees (deallocates) memory allocated for an SDL surface ("<code>SDL_Surface *</code>").              </dd>
-          <b><code>snprintf()</code>:</b>
+            <dt><code>SDL_GetRGB()</code></dt>
-          A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "char str[20];" has been declared; "snprintf(str, 20, "Name: %s, Age: %d", "Bill", "32");" will store "Name: Bill, Age: 32" into 'str'.          See also the "<code>snprintf(3)</code>" <i>man page</i>)        </li>
+      <dd>
-        <li>
+        A libSDL function that, given a <code>Uint32</code> pixel value (e.g., one returned from the Tux Paint's Magic tool API helper function "<code>getpixel()</code>"), the format of the surface the pixel was taken from, and pointers to three <code>Uint8</code> variables, will place the Red, Green and Blue (RGB) values of the pixel into the three <code>Uint8</code> variables. (Example: "<code>SDL_GetRGB(getpixel(surf, x, y), surf-&gt;format, &amp;r, &amp;g, &amp;b);</code>".)<br/>Refer to the "<code>SDL_GetRGB(3)</code>" <i>man page</i>.        <br/>
-          <b><code>.so</code>:</b>
+See also:
-          See "Shared Object"        </li>
+<ul>
-        <li>
+<li>SDL_MapRGB()</li><li>RGBA</li></ul>
-          <b><code>sRBG</code>:</b>
+      </dd>
-          See "RGBA"        </li>
+            <dt><code>SDL_image</code></dt>
-        <li>
+      <dd>
-          <b>star:</b>
+        A library on top of libSDL that can load various kinds of image files (e.g., PNG) and return them as an "<code>SDL_Surface *</code>".              </dd>
-          "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)          See also: "ampersand"        </li>
+            <dt><code>SDL_MapRGB()</code></dt>
-        <li>
+      <dd>
-          <b><code>strdup()</code>:</b>
+        A libSDL function that, given the format of a surface and <code>Uint8</code> values representing Red, Green and Blue values for a pixel, returns a <code>Uint32</code> pixel value that can be placed in the surface (e.g., using Tux Paint's Magic tool API helper function "<code>putpixel()</code>"). (Example: "<code>putpixel(surf, x, y, SDL_MapRGB(surf-&gt;format, r, g, b));</code>".)<br/>Refer to the "<code>SDL_MapRGB(3)</code>" <i>man page</i>.        <br/>
-          A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.          See also the "<code>strdup(3)</code>" <i>man page</i>)        </li>
+See also:
-        <li>
+<ul>
-          <b><code>struct</code>:</b>
+<li>SDL_GetRGB()</li><li>RGBA</li></ul>
-          See "C structure"        </li>
+      </dd>
-        <li>
+            <dt><code>SDL_mixer</code></dt>
-          <b><code>tp_magic_api.h</code>:</b>
+      <dd>
-          A header file that defines Tux Paint's Magic tool API.  Plugins must '#include' it.        </li>
+        A library on top of libSDL that can load various kinds of sound files (WAV, Ogg Vorbis, etc.) and play back multiple sounds at once (mix them).              </dd>
-        <li>
+            <dt><code>SDL_Rect</code></dt>
-          <b><code>tp-magic-config</code>:</b>
+      <dd>
-          A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).          See also the "<code>tp-magic-config(3)</code>" <i>man page</i>)        </li>
+        A C structure defined by libSDL that represents a rectangular area. It contains elements representing the coordinates of the top left corner of the rectange (x,y) and the dimensions of the rectangle (w,h).<br/>Refer to the "<code>SDL_Rect(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>SDL_Surface *</code></dt>
-          <b><code>Uint32</code>:</b>
+      <dd>
-          A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4294967295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        </li>
+        (A pointer to) a C structure defined by libSDL that contains a drawing surface.<br/>Refer to the "<code>SDL_Surface(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt>shared object</dt>
-          <b><code>Uint8</code>:</b>
+      <dd>
-          An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        </li>
+        A piece of code that's compiled separately from the main application, and loaded dynamically, at runtime.              </dd>
-        <li>
+            <dt>shell</dt>
-          <b>unsigned:</b>
+      <dd>
-          In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        </li>
+        See "BASH"              </dd>
-        <li>
+            <dt>Simple DirectMedia Layer</dt>
-          <b>value:</b>
+      <dd>
-          See "HSV"        </li>
+        The Simple DirectMedia Layer (libSDL) is a programming library that provides portable low-level access to a video framebuffer, audio output, and mouse and keyboard input. (See: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)              </dd>
-        <li>
+            <dt><code>snprintf()</code></dt>
-          <b>variable:</b>
+      <dd>
-          A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "int a;". It can be examined later: "if (a &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }".        </li>
+        A C function, related to "printf()", which takes a 'format' string and one or more additional arguments, and puts them together. "snprintf()" takes the resulting output and stores it into a string, making sure not to go beyond the string's buffer size (which must also be supplied). For example, assume a string "<code>char str[20];</code>" has been declared; "<code>snprintf(str, 20, "Name: %s, Age: %d", "Bill", 32);</code>" will store "Name: Bill, Age: 32" into '<code>str</code>'.<br/>Refer to the "<code>sprintf(3)</code>" <i>man page</i>.              </dd>
-        <li>
+            <dt><code>.so</code></dt>
-          <b><code>.wav</code>:</b>
+      <dd>
-          See also: "Ogg Vorbis"        </li>
+        See "shared object"              </dd>
-        <li>
+            <dt>sRGB</dt>
-          <b><code>(w,h)</code>:</b>
+      <dd>
-          See "Dimensions"        </li>
+        See "RGBA"              </dd>
-        <li>
+            <dt>star</dt>
-          <b><code>(x,y)</code>:</b>
+      <dd>
-          See "Coordinates"        </li>
+        "<code>*</code>". A symbol in C that, when used in the declaration of variables (e.g., arguments to a function), denotes that the variable is a pointer. (For example, "<code>int * p;</code>" means that "<code>p</code>" is a <i>pointer</i> to an integer.) When used next to a pointer, it 'dereferences' the variable. (For example, later "<code>*p = 50;</code>" assigns the value of 50 to the memory that "<code>p</code>" points to; it does not change the value of "<code>p</code>", which is still a pointer to an integer. In essence, it changed the integer that's being pointed to.)        <br/>
-      </ul>
+See also: "ampersand"      </dd>
-    </section><!-- H1: Glossary -->
+            <dt><code>strdup()</code></dt>
+      <dd>
+        A C function that allocates enough memory to store a copy of a string, copies the string to it, and returns a "<code>char *</code>" pointer to the new copy.<br/>Refer to the "<code>strdup(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>struct</code></dt>
+      <dd>
+        See "C structure"              </dd>
+            <dt>tap</dt>
+      <dd>
+        See "click"              </dd>
+            <dt><code>tp-magic-config</code></dt>
+      <dd>
+        A command-line program that provides information about the installed version of Tux Paint to plugin developers (such as what C compiler flags they should compile with, and where plugin shared objects and data files should be installed).<br/>Refer to the "<code>tp-magic-config(3)</code>" <i>man page</i>.              </dd>
+            <dt><code>tp_magic_api.h</code></dt>
+      <dd>
+        A header file that defines Tux Paint's Magic tool API.  Plugins must '<code>#include</code>' it.              </dd>
+            <dt><code>Uint32</code></dt>
+      <dd>
+        A 32-bit, unsigned integer (defined by libSDL). In other words, four bytes that can represent 0 through 4,294,967,295. (Typically used to hold enough information to store three or four bytes representing a pixel's color; i.e., RBGA value).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt><code>Uint8</code></dt>
+      <dd>
+        An 8-bit, unsigned integer (defined by libSDL). In other words, a byte that can represent 0 through 255.        <br/>
+See also:
+<ul>
+<li>Uint32</li><li>integer</li><li>unsigned</li></ul>
+      </dd>
+            <dt>unsigned</dt>
+      <dd>
+        In C, a variable that can store a numeric value can be declared as either "signed" (the default), or "unsigned". In the former case, one bit of the value is used to denote the sign of the value (either positive or negative). In the latter case, the value can only be positive, but benefits from one extra bit of storage for the number. A signed byte (8 bits), for example, can represent any number between -128 and 127. An unsigned byte can go up to 255, but it cannot go below 0. For the purposes of graphics in SDL, unsigned values should be used for RGB values, since each channel (red, green and blue) may be between 0 (off) and 255 (brightest).        <br/>
+See also:
+<ul>
+<li>Uint8</li><li>Uint32</li><li>integer</li></ul>
+      </dd>
+            <dt>value</dt>
+      <dd>
+        See "HSV"              </dd>
+            <dt>variable</dt>
+      <dd>
+        A construct in computer programming that contains a value which can be referenced again later by referring to the variable's name, and typically changed later. For example, a variable to hold someone's age could be declared as an integer: "<code>int age</code>;". It can be examined later &mdash; e.g., "<code>if (age &gt;= 18) { /* they are an adult */ } else { /* they are not an adult */ }</code>" &mdash; as well as modified later &mdash; e.g., <code>age = 32; /* set age to 32 */</code>              </dd>
+            <dt><code>(w,h)</code></dt>
+      <dd>
+        See "dimensions"              </dd>
+            <dt><code>.wav</code></dt>
+      <dd>
+        See "WAVE"              </dd>
+            <dt>WAVE</dt>
+      <dd>
+        Waveform Audio File Format (WAVE, or WAV). <i>Definition not yet presented.</i>        <br/>
+See also: "Ogg Vorbis"      </dd>
+            <dt><code>(x,y)</code></dt>
+      <dd>
+        See "coordinates"              </dd>
+            <dt><code>|</code></dt>
+      <dd>
+        See "boolean 'or'"              </dd>
+        </dl>
+
+</section><!-- H1: Glossary -->
+
 
   </body>
 </html>

docs/sq_AL.UTF-8/html/README.html

@@ -102,7 +102,7 @@
           </p>
 
           <p>
-            27 janar 2024          </p>
+            29 janar 2024          </p>
         </center>
       </header>
       <table border="2"

src/org.tuxpaint.Tuxpaint.appdata.xml.in

@@ -44,7 +44,7 @@
     </screenshot>
   </screenshots>
   <releases>
-    <release version="0.9.32" date="2024-01-16">
+    <release version="0.9.32" date="2024-01-28">
       <description>
         <p>New Magic tools: 1-, 2-, and 3-Point Perspective line-drawing tools (and corresponding vanishing point editors).</p>
         <p>New Magic tools: Isometric, Dimetric, Trimetric, and Oblique line-drawing tools (and corresponding angle editors).</p>

win32/resources.rc

@@ -47,7 +47,7 @@ BEGIN
             VALUE "FileDescription", "Tux Paint - Interactive Paint Program.\0"
             VALUE "FileVersion", "0.9.32\0"
             VALUE "InternalName", "Tux Paint\0"
-            VALUE "LegalCopyright", "Copyright (C) 2002-2023 by Bill Kendrick, et al\0"
+            VALUE "LegalCopyright", "Copyright (C) 2002-2024 by Bill Kendrick, et al\0"
             VALUE "LegalTrademarks", "\0"
             VALUE "OriginalFilename", "TuxPaint.exe\0"
             VALUE "PrivateBuild", "\0"