Copyright © 2007-2025 av olika bidragsgivare; se AUTHORS.txt.
https://tuxpaint.org/
januari 12, 2025
Rita med Tux's "Magic"-verktyg kommer som en uppsättning "plugins" som laddas när Rita med Tux startar.
Denna uppdelning möjliggör en snabbare utveckling av "magiska" verktyg och gör det möjligt för programmerare att skapa och testa nya verktyg utan att behöva integrera dem i Rita med Tuxs källkod. (Användare av mer professionella grafikverktyg, t.ex. GIMP, bör känna till detta plugin-koncept)
Rita med Tux är skrivet i programspråket C och använder biblioteket Simple DirectMedia Layer ("libSDL", eller bara "SDL"; finns på https://www.libsdl.org/). Därför måste man, åtminstone för tillfället, förstå C-språket och hur man kompilerar C-baserade program. Det rekommenderas starkt att man känner till SDL API, men några grundläggande SDL-koncept kommer att behandlas i detta dokument.
De som skapar plugins för "magiska" verktyg för Rita med Tux måste tillhandahålla vissa gränssnitt (C-funktioner) som Rita med Tux kan anropa.
Rita med Tux använder SDL:s rutiner "SDL_LoadObject()" och "SDL_LoadFunction()" för att ladda plugins (filer med delade objekt, t.ex. ".so
"-filer i Linux eller ".dll
"-filer i Windows) och hitta funktionerna i dem.
Rita med Tux tillhandahåller i sin tur ett antal hjälpfunktioner som plugin-programmet kan (eller ibland måste) använda. Detta exponeras som en C-struktur (eller"struct
") som innehåller pekare till funktioner och andra data i Rita med Tux. En pekare till denna struktur skickas vidare till plugin-funktionerna som ett argument när Rita med Tux anropar dem.
Plugins bör #inkludera
C-huvudfilen"tp_magic_api.h
", som exponerar plugin-API:et för verktyget "Magic". När du kör C-kompilatorn för att bygga ett plugin bör du också använda kommandoradsverktyget"tp-magic-config
" för att få lämpliga kompilatorflaggor (till exempel var kompilatorn kan hitta Rita med Tux-pluginhuvudfilen, liksom SDLs huvudfiler) för att bygga ett plugin. (Se"Kompilering" nedan.)
C-huvudfilen och kommandoradsverktyget som nämns ovan ingår i Rita med Tux - eller i vissa fall som en del av ett "Rita med Tux 'Magic' Tool Plugin Development package".
plugins för "Magic"-verktyg måste innehålla de funktioner som anges nedan. Observera: För att undvika kollisioner i namnrymden måste varje funktionsnamn börja med det delade objektets filnamn (t.ex. skulle "blur.so" eller "blur.dll" ha funktioner vars namn börjar med"blur_
"). Detta inkluderar privata funktioner (sådana som inte används direkt av Rita med Tux), såvida du inte deklarerar dem som"statiska
".
Här följer en beskrivning av de argument som många av funktionerna i ditt plugin måste acceptera.
magic_api * api
Pekare till en C-struktur som innehåller pekare till Rita med Tux-funktioner och andra data som insticksprogrammet kan (och ibland bör) använda. Innehållet i denna struktur beskrivs nedan..
Observera: Strukturen magic_api
definieras i C-headerfilen"tp_magic_api.h
", som du bör inkludera högst upp i ditt plugins C-källfil:
#include "tp_magic_api.h"
int which
SDL_Surface * snapshot
"snapshot
" och skriv till"canvas
", nedan) SDL_Surface * canvas
SDL_Rect * update_rect
update_rect->x = x - 16;
update_rect->y = y - 16;
update_rect->w = 32;
update_rect->h = 32;
Om din effekt ändrar hela duken (t.ex. vänder den upp och ner) fyller du den på följande sätt:
update_rect->x = 0;
update_rect->y = 0;
update_rect->w = canvas->w;
update_rect->h = canvas->h;
Obs:"update_rect
" är en C-pekare (en"SDL_Rect *
" snarare än bara en"SDL_Rect
") eftersom du måste fylla i dess innehåll. Eftersom det är en pekare kommer du åt dess element via"->"
(pil) snarare än ".
" (punkt). Ditt insticksprogram måste minst innehålla alla följande funktioner.
Observera: Kom ihåg att plugin-programmets funktionsnamn måste föregås av plugin-programmets filnamn. Det vill säga, om ditt plugin heter"zoom.so
" (på Linux) eller "zoom.dll
" (på Windows), måste namnen på dina funktioner börja med "zoom_
" (t.ex. "zoom_get_name(...)
").
Uint32 api_version(void)
Insticksprogrammet bör returnera ett heltalsvärde som representerar versionen av Rita med Tux 'Magic' tool plugin API som insticksprogrammet byggdes mot. Det säkraste är att returnera värdet av TP_MAGIC_API_VERSION
, som definieras i"tp_magic_api.h
". Om Rita med Tux anser att ditt plugin är kompatibelt kommer det att fortsätta och använda det.
Obs: Anropas en gång av Rita med Tux, vid uppstart. Den anropas först.
int init(magic_api * api, Uint8 disabled_features, Uint8 complexity_level)
Plugin-programmet bör göra alla initialiseringar här. Returnera '1' om initieringen lyckades, eller '0' om den inte gjorde det (och Rita med Tux kommer inte att presentera några 'Magic'-verktyg från insticksprogrammet).
Obs: Anropas en gång av Rita med Tux, vid uppstart. Det anropas efter"api_version()
", om Rita med Tux anser att ditt plugin är kompatibelt.
Värdet disabled_features
innehåller bits som ställts in för alla Rita med Tux-funktioner som är relevanta för Magic-verktyg som har inaktiverats i den här sessionen. Test med hjälp av C:s bitvisa operator "och","&".
Funktionerna är definierade i tp_magic_api.h:
:
MAGIC_FEATURE_CONTROL
: Kontroll av magiska verktyg (färg vs helskärm) (--nomagiccontrols
) MAGIC_FEATURE_SIZE
: Storlek på magiskt verktyg (--nomagicsizes
)
Variabeln complexity_level
innehåller den "komplexitetsnivå" som Rita med Tux magiska verktyg kan erbjuda - det vill säga användarens expertisnivå. Nivåerna definieras i tp_magic_api.h:
:
MAGIC_COMPLEXITY_NOVICE
(0): Novis (--complexity=novice
) MAGIC_COMPLEXITY_BEGINNER
(1): Nybörjare (--complexity=beginner
) MAGIC_COMPLEXITY_ADVANCED
(2): Avancerad (standard) (--complexity=advanced
) Notera: Senast ändrad i Rita med Tux 0.9.32; Magic API version 0x00000009.
int get_tool_count(magic_api * api)
Detta ska returnera antalet magiska verktyg som detta plugin tillhandahåller till Rita med Tux.
Obs: Anropas en gång av Rita med Tux, vid start. Den anropas efter din"init()
", om den lyckades.
Obs: Du kanske vill svara på olika sätt beroende på om vissa funktioner har inaktiverats (t.ex. kontroller för "paint" kontra "entire picture" eller kontroller för "Magic sizes").
int modes(magic_api * api, int which)
Här kan du tala om för Rita med Tux vilka lägen ditt verktyg kan användas i; antingen som ett verktyg som användaren kan måla med eller som ett verktyg som påverkar hela ritningen på en gång.
Du måste returnera ett värde som är en kombination av ett eller flera av de tillgängliga lägena:
MODE_PAINT
- måla på fri hand (klicka och dra) MODE_FULLSCREEN
- gäller för hela bilden med ett klick MODE_PAINT_WITH_PREVIEW
- frihandsmålning, med förhandsgranskning (klicka och dra) MODE_ONECLICK
- gäller för ett område runt musen, med ett klick "MODE_PAINT
". Om användaren kan göra båda, returnera"MODE_PAINT | MODE_FULLSCREEN
" för att tala om för Rita med Tux att den kan göra båda.
Observera: Anropas en gång för varje Magic-verktyg som ditt plugin påstår sig innehålla (genom ditt"get_tool_count()
").
Obs: Tillagd till Rita med Tux 0.9.21; Magic API-version 0x00000002.
char * get_name(magic_api * api, int which)
Detta bör returnera en sträng som innehåller namnet på ett magiskt verktyg. Detta kommer att visas på knappen i "Magic"-väljaren i Rita med Tux.
Rita med Tux kommer att free()
strängen vid avslutning, så du bör linda in den i ett C strdup()
-anrop.
Observera: Anropas en gång för varje Magic-verktyg som ditt plugin påstår sig innehålla (genom ditt"get_tool_count()
").
int get_group(magic_api * api, int which)
Använd detta för att gruppera verktyg tillsammans inom sektioner av "Magic"-väljaren. Ett antal grupper är fördefinierade i ett enum
som finns i"tp_magic_api.h
":
MAGIC_TYPE_DISTORTS
— Verktyg som förvränger bildens form, t.ex. Blur, Emboss och Ripples MAGIC_TYPE_COLOR_FILTERS
— Verktyg som främst påverkar bildens färger utan att förvränga dem, t.ex. Darken, Negative och Tint MAGIC_TYPE_PICTURE_WARPS
— Verktyg som förvränger eller flyttar hela bilden, t.ex. Shift, Flip och Waves MAGIC_TYPE_PAINTING
— Verktyg som i allmänhet målar nytt innehåll vid markörens position, som Grass, Bricks och Rails MAGIC_TYPE_PATTERN_PAINTING
— Verktyg som målar på flera ställen samtidigt, t.ex. Kalejdoskop och Symmetry-verktygen MAGIC_TYPE_PICTURE_DECORATIONS
— Verktyg som applicerar dekorationer på hela bilden, t.ex. Blinds och Checkboard MAGIC_TYPE_ARTISTIC
— Specialverktyg för konstnärliga ändamål, t.ex. Flower, String-verktygen och Rainbow-arc-ritverktygen.
Observera: Anropas en gång för varje Magic-verktyg som ditt plugin påstår sig innehålla (genom ditt"get_tool_count()
").
Obs: Tillagd till Rita med Tux 0.9.27; Magic API-version 0x00000005.
SDL_Surface * get_icon(magic_api * api, int which)
Detta bör returnera en SDL_Surface som innehåller ikonen som representerar verktyget. (En gråskalebild med alfa, inte större än 40x40.) Detta kommer att visas på knappen i "Magic"-väljaren i Rita med Tux.
Rita med Tux kommer att frigöra ("SDL_FreeSurface()
") ytan när den avslutas.
Observera: Anropas en gång för varje Magic-verktyg som ditt plugin påstår sig innehålla (genom ditt"get_tool_count()
").
char * get_description(magic_api * api, int which, int mode)
Detta bör returnera en sträng som innehåller en beskrivning av hur man använder ett visst magiskt verktyg. Detta kommer att visas som ett hjälptips, förklarat av pingvinen Tux, i Rita med Tux.
Rita med Tux kommer att free()
strängen vid avslutning, så du bör linda in den i ett C strdup()
-anrop.
Obs: För varje Magic-verktyg som ditt plugin påstår sig innehålla (rapporterat av din "get_tool_count()
"-funktion), kommer denna funktion att anropas för varje läge som verktyget påstår sig stödja (rapporterat av din "modes()
"-funktion).
Med andra ord, om ditt plugin innehåller två verktyg, ett som bara fungerar i färgläge och det andra som fungerar i både färgläge och fullbildsläge, kommer ditt plugins"get_description()
" att anropas tre gånger.
int requires_colors(magic_api * api, int which)
Returnerar en "1" om "Magic"-verktyget accepterar färger (paletten "Colors" i Rita med Tux kommer att vara tillgänglig), eller "0" om inte.
Observera: Anropas en gång för varje Magic-verktyg som ditt plugin påstår sig innehålla (genom ditt"get_tool_count()
").
Uint8 accepted_sizes(magic_api * api, int which, int mode)
Returnerar hur många storleksvariationer som 'Magic'-verktyget accepterar i det angivna läget (dvs.'MODE_PAINT
' eller'MODE_FULLSCREEN
). Returnera '0' om 'Magic'-verktyget inte ska erbjuda storleksalternativ. Att returnera '1' är samma sak som att returnera '0'.
Obs: För varje Magic-verktyg som ditt plugin påstår sig innehålla (rapporterat av din "get_tool_count()
"-funktion), kommer denna funktion att anropas för varje läge som verktyget påstår sig stödja (rapporterat av din "modes()
"-funktion).
Obs: Tillagd till Rita med Tux 0.9.30; Magic API-version 0x00000008.
Uint8 default_size(magic_api * api, int which, int mode)
Returnerar den standardstorlek som verktyget "Magic" ska börja med i det angivna läget. Detta kommer att vara standardinställningen för verktyget första gången det används under en Rita med Tux-session. Om Rita med Tux anropas med storleksalternativet avaktiverat kommer detta att vara den enda storlek som Rita med Tux begär. Returnera ett tal mellan '1' och det belopp som du returnerade i accepted_sizes()
.
Obs: För varje Magic-verktyg som ditt plugin påstår sig innehålla (rapporterat av din "get_tool_count()
"-funktion), kommer denna funktion att anropas för varje läge som verktyget påstår sig stödja (rapporterat av din "modes()
"-funktion).
Obs: Tillagd till Rita med Tux 0.9.30; Magic API-version 0x00000008.
void shutdown(magic_api * api)
Plugin-programmet bör göra all upprensning här. Om du har allokerat något minne eller använt SDL_Mixer för att ladda några ljud under init()
, till exempel, bör du frigöra(
) det allokerade minnet och Mix_FreeChunk()
ljuden här.
Obs: Denna funktion anropas en gång när Rita med Tux avslutas.
void switchin(magic_api * api, int which, int mode, SDL_Surface * snapshot, SDL_Surface * canvas)
void switchout(magic_api * api, int which, int mode, SDL_Surface * snapshot, SDL_Surface * canvas)
switchin()
anropas när ett av plugin-programmets magiska verktyg blir aktivt, och switchout()
anropas när ett blir inaktivt. Detta kan bero på att användaren just har klickat på ett specifikt magiskt verktyg (det aktuella verktyget kopplas ut och ett nytt kopplas in).
Det kan också hända när användaren lämnar/återvänder från valet av "magiska" verktyg när han/hon utför någon annan aktivitet (t.ex. använder ett annat verktyg, som "Text" eller "Brush", aktiverar ett tillfälligt verktyg, som "Undo" och "Redo", eller återvänder från en dialog - eventuellt med en ny bild när den växlar tillbaka - som "Open", "New" eller "Quit"). I detta fall är samma magiska verktyg först "utslaget" och sedan "inslaget igen", vanligtvis några ögonblick senare.
Slutligen kan det också hända när användaren ändrar "läge" för ett verktyg (t.ex. från färgläge till fullbildsläge). Först anropas switchout()
för det gamla läget, sedan anropas switchin()
för det nya läget.
Dessa funktioner gör det möjligt för användare att interagera på komplicerade sätt med Magic-verktyg (t.ex. ett verktyg som låter användaren rita flera streck på fri hand och sedan använder det som indata, t.ex. handskrift - normalt kan användaren klicka någonstans i målarduken för att tala om för Magic-verktyget att de är "klara", men om de byter till ett annat verktyg kanske Magic-verktyget vill ångra alla tillfälliga ändringar i målarduken).
Dessa funktioner skulle också kunna användas för att effektivisera vissa effekter; en bakomliggande kopia av hela duken skulle kunna ändras på något sätt när användaren först växlar till duken, och sedan skulle delar av den kopian kunna ritas på duken när användaren ritar med Magic-verktyget.
Obs: Tillagd till Rita med Tux 0.9.21; Magic API-version 0x00000002.
void set_color(magic_api * api, int which, SDL_Surface * canvas, SDL_Surface * last, Uint8 r, Uint8 g, Uint8 b, SDL_Rect * update_rect)
Rita med Tux anropar denna funktion för att informera insticksprogrammet om RGB-värdena för den aktuella valda färgen i Rita med Tuxs palett "Colors". (Funktionen anropas när ett av plugin-programmets magiska verktyg som accepterar färger blir aktivt, och när användaren väljer en ny färg medan ett sådant verktyg är aktivt)
I allmänhet kommer Magic-verktygen inte att ändra målarduken på något sätt när de får en uppdaterad färg, men det är möjligt. (Till exempel använder verktygen "Zoom" och "Perspective" effekter som använder det aktuella färgvalet som en solid bakgrund. Effekterna kan justeras med efterföljande klick/drag-operationer, men du kan också justera bakgrundsfärgen, utan att ändra zoomnivån eller perspektivet, genom att helt enkelt välja en ny färg)
Notera: Senast ändrad i Rita med Tux 0.9.29; Magic API version 0x00000007.
void set_size(magic_api * api, int which, int mode, SDL_Surface * canvas, SDL_Surface * last, Uint8 size, SDL_Rect * update_rect)
Rita med Tux anropar denna funktion för att informera insticksprogrammet om det valda storleksalternativet för "Magic"-verktyget. (Den anropas när ett av plugin-programmets magiska verktyg som accepterar storlekar blir aktivt, och när användaren väljer en ny storlek medan ett sådant verktyg är aktivt)
I allmänhet kommer Magic-verktygen inte att ändra duken på något sätt när de får en uppdaterad storlek, men det är möjligt.
Obs: Tillagd till Rita med Tux 0.9.30; Magic API-version 0x00000008.
void click(magic_api * api, int which, int mode, SDL_Surface * snapshot, SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect)
Plugin-programmet ska tillämpa lämpligt "Magic"-verktyg på"canvas
"-ytan. (x,y)-koordinaterna är var musen befann sig (inom canvasen) när musknappen klickades, och du får veta vilket "läge" ditt verktyg är i (dvs."MODE_PAINT
" eller"MODE_FULLSCREEN
").
Plugin-programmet bör rapportera tillbaka vilken del av duken som påverkades genom att fylla i elementen (x,y) och (w,h) i"update_rect
".
Innehållet i teckningsytan omedelbart före musklicket lagras i"snapshot
"-ytan.
void drag(magic_api * api, int which, SDL_Surface * snapshot, SDL_Surface * canvas, int ox, int oy, int x, int y, SDL_Rect * update_rect)
Plugin-programmet bör tillämpa lämpligt "Magic"-verktyg på"canvas"
-ytan. Koordinaterna (ox,oy) och (x,y) är musens position i början och slutet av strecket.
Plugins som låter användaren "rita" effekter på duken använder vanligtvis Rita med Tux's"line()
" 'Magic' tool plugin-hjälpfunktion för att beräkna punkterna på linjen mellan (ox,oy) och (x,y), och anropar en annan funktion inom pluginet för att tillämpa effekten vid varje punkt. (Se"Rita med Tux-funktioner och data" nedan).
Plugin-programmet bör rapportera tillbaka vilken del av duken som påverkades genom att fylla i elementen (x,y) och (w,h) i"update_rect
".
Obs: Innehållet i ritningsytan omedelbart före musklicket förblir detsamma som det var (när plugin-programmets "click()
"-funktion anropades) och är fortfarande tillgängligt i"snapshot
"-ytan.
void release(magic_api * api, int which, SDL_Surface * snapshot, SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect)
Plugin-programmet bör använda lämpligt "Magic"-verktyg på"canvas"
-ytan. (x,y)-koordinaterna är var musen befann sig (inom duken) när musknappen släpptes.
Plugin-programmet bör rapportera tillbaka vilken del av duken som påverkades genom att fylla i elementen (x,y) och (w,h) i "update_rect".
Obs: Innehållet i ritningsytan omedelbart före musklicket förblir detsamma som det var (när plugin-programmets "click()
"-funktion anropades) och är fortfarande tillgängligt i "snapshot"-ytan.
Rita med Tux tillhandahåller ett antal hjälpfunktioner som plugins kan komma åt via strukturen"magic_api
", som skickas till alla plugins funktioner. (Se"Obligatoriska plugin-funktioner" ovan.)
Uint32 getpixel(SDL_Surface * surf, int x, int y)
void putpixel(SDL_Surface * surf, int x, int y, Uint32 pixel)
Uint32 xorpixel(SDL_Surface * surf, int x, int y)
SDL_Surface * scale(SDL_Surface * surf, int w, int h, int keep_aspect)
Detta accepterar en befintlig SDL-yta och skapar en ny som skalas till en godtycklig storlek. (Den ursprungliga ytan förblir orörd.)
Flaggan"keep_aspect
" kan sättas till '1' för att tvinga den nya ytan att behålla samma form (bildförhållande) som originalet, vilket innebär att den kanske inte har samma bredd och höjd som du begärde. (Kontrollera elementen"->w
" och"->h
" i utdata "SDL_Surface *" för att avgöra den faktiska storleken)
int in_circle(int x, int y, int radius)
void line(void * api, int which, SDL_Surface * canvas, SDL_Surface * snapshot, int x1, int y1, int x2, int y2, int step, FUNC callback)
Denna funktion beräknar alla punkter på en linje mellan koordinaterna (x1,y1) och (x2,y2). Varje 'steg'-iteration anropar den funktionen 'callback'.
Den skickar (x,y)-koordinaterna på linjen till "callback"-funktionen, Rita med Tuxs"magic_api
"-struktur (som en"void *
"-pekare som du måste skicka till den), ett "which"-värde som representerar vilket av plugin-programmets "Magic"-verktyg som används, och de aktuella och snapshot-bilderna.
Exempel på prototyp av en callback-funktion som kan skickas till Rita med Tux's"line()
" 'Magic' tool plugin helper-funktion:
void exampleCallBack(void * ptr_to_api, int which_tool, SDL_Surface * canvas, SDL_Surface * snapshot, int x, int y);
Exempel på användning av"line()
"-hjälpen (t.ex. inom ett plugins draw()
-funktion):
api->line((void *) api, which, canvas, snapshot, ox, oy, x, y, 1, exampleCallBack);
Uint8 touched(int x, int y)
Med den här funktionen kan du undvika att bearbeta samma pixlar flera gånger när användaren drar musen över ett område på duken, vilket ökar Rita med Tuxs svarstid, särskilt med matematiktunga effekter.
Om din effekts"click(
)"-,"drag(
)"- och/eller"release(
)"-funktioner tar innehållet i källytan ("snapshot
") och alltid skapar samma resultat i målytan ("canvas
"), bör du linda in effekten i ett anrop till"api->touched(
)".
Denna funktion returnerar helt enkelt om den redan har anropats för samma (x,y)-koordinater sedan användaren först klickade på musen. Med andra ord, första gången du anropar den för en viss (x,y)-koordinat returnerar den '0'. Framtida anrop kommer att returnera '1' tills användaren släpper musknappen.
Obs: Magiska effekter som kontinuerligt påverkar destinationsytan ("canvas
") (utan hänsyn till"snapshotytan
") har ingen anledning att använda denna funktion. Verktygen "Blur" och "Smudge" som medföljer Rita med Tux är exempel på sådana effekter.
char * tp_version
int canvas_w
int canvas_h
(canvas_w)
och höjden (canvas_h
) på teckningsytan (i pixlar). int button_down(void)
char * data_directory
Denna sträng innehåller den katalog där Rita med Tuxs datafiler lagras. På Linux kan detta till exempel vara"/usr/share/tuxpaint/
".
Magiska verktyg bör innehålla en ikon (se"get_icon(
)", ovan) och uppmuntras att innehålla ljudeffekter, det är användbart för plugins att veta var sådana saker finns.
Vid kompilering och installation av ett insticksprogram bör kommandoradsverktyget"tp-magic-config
" användas för att avgöra var sådana data ska placeras för att den installerade versionen av Rita med Tux ska hitta dem. (Se"Installera" nedan.)
Obs: Om ditt plugin är installerat lokalt (t.
ex. i din katalog"~/.tuxpaint/plugins/
"), snarare än globalt (systemövergripande), kommer värdet"data_directory
" att vara annorlunda. (t.ex. "/home/användarnamn/.tuxpaint/plugins/data/
").
void playsound(Mix_Chunk * snd, int pan, int dist)
Denna funktion spelar upp ett ljud (ett som laddats av SDL-hjälpbiblioteket "SDL_mixer"). Den använder SDL_mixers"Mix_SetPanning()
" för att ställa in ljudets volym på vänster och höger högtalare, baserat på värdena"pan
" och"dist
" som skickas till den.
En"pan"
på 128 innebär att ljudet spelas upp med samma volym i vänster och höger högtalare. En"pan
" på 0 gör att ljudet spelas upp helt till vänster och 255 helt till höger.
Värdet"dist"
påverkar den totala volymen. 255 är högst och 0 är tyst.
Värdena"pan
" och"dist
" kan användas för att simulera plats och avstånd för "Magic"-verktygets effekt.
void stopsound(void)
playsound().
Det är användbart för att tysta effekter när användaren slutar använda verktyget (i din"release
"-funktion). int playingsound(void)
Anropa denna funktion för att avgöra om en ljudeffekt från ett magiskt verktyg fortfarande spelas upp. Kan användas av magiska verktyg som pausar och avpausar sina ljud (se nedan) för att avgöra om det är dags att starta ett nytt ljud - anropa playsound()
istället för unpausesound()
. En "1" returneras om ett ljud spelas upp, annars en "0".
Obs: Tillagd till Rita med Tux 0.9.34; Magic API-version 0x0000000B.
void pausesound(void)
Pausar ljudeffekten för det magiska verktyget; den kan avpausas för att återuppta uppspelningen. Användbart när ett magiskt verktygsljud är mycket långt; undvik att upprepade gånger spela bara ett kort klipp av början när användaren ritar små streck genom att starta (playsound()
) och stoppa (stopsound()
) ljudet. Använd playingsound()
för att avgöra om du kan avbryta eller måste spela upp från början.
Obs: Tillagd till Rita med Tux 0.9.34; Magic API-version 0x0000000B.
void unpausesound(void)
Återupptar en pausad ljudeffekt för det magiska verktyget, om en sådan spelades.
Obs: Tillagd till Rita med Tux 0.9.34; Magic API-version 0x0000000B.
void update_progress_bar(void)
void special_notify(int flag)
"tp_magic_api.h
" kan kombineras (med hjälp av C:s booleska 'or':"|
") och skickas till denna funktion. SPECIAL_FLIP
Innehållet på duken har vänts vertikalt.
Om en "Starter"-bild användes som grund för den här bilden ska den också vändas, och en registrering av vändningen ska lagras som en del av Rita med Tuxs buffertstapel för ångerrätt. Dessutom ska det faktum att startbilden har vänts (eller inte vänts) sparas på disken när den aktuella teckningen sparas.
SPECIAL_MIRROR
SPECIAL_FLIP
, men för magiska verktyg som speglar innehållet i duken horisontellt. void retract_undo(void)
Varje gång användaren klickar i duken medan han eller hon använder Magic-verktyget läggs en ny ögonblicksbild av duken till i "Undo"-historiken. Detta gör det möjligt för användaren att klicka på "Undo" för att återställa bilden till det tillstånd den befann sig i precis innan de klickade med ditt Magic-verktyg. De kan klicka på "Redo" för att återställa ändringen.
Vissa mer sofistikerade Magic-verktyg kräver dock att ett eller flera steg utförs innan den slutliga "effekten" uppnås. Till exempel kräver "Filled Polygon" att du placerar minst tre sammankopplade punkter och sedan kopplar ihop den första och den sista punkten för att skapa en form som läggs till på duken. Under tiden ritas en interaktiv förhandsgranskning av formen - en kontur med stora prickar som representerar varje punkt - på duken. (Punkterna kan flyttas, eller till och med tas bort, innan formen är klar)
API-funktionen retract_undo()
kan användas av ett Magic-verktyg för att beordra det att kasta bort den "Undo"-bild som det just tog, som ett sätt att förhindra att förhandsvisningar som visas under åtgärder i flera steg visas på duken när kommandona "Undo" och "Redo" används.
💡 Detta är en avancerad funktion.
Obs: Tillagd till Rita med Tux 0.9.33; Magic API-version 0x0000000A.
float sRGB_to_linear(Uint8 srbg)
uint8 linear_to_sRGB(float linear)
void rgbtohsv(Uint8 r, Uint8 g, Uint8 b, float * h, float * s, float * v)
void hsvtorgb(float h, float s, float v, Uint8 * r, Uint8 * g, Uint8 * b)
Mer information finns i artikeln om sRGB på Wikipedia och artikeln om HSV-färgrymden på Wikipedia..
tp_magic_api.h
"
Förutom C-strukturen"magic_api
" som innehåller funktioner och data som beskrivs ovan, innehåller C-huvudfilen tp_magic_api.h
också några hjälpmakron som du kan använda.
min(x, y)
max(x, y)
(min)
eller maximum(max)
av 'x' och 'y'. Till exempel kommer min()
att returnera värdet på 'x' om det är mindre än eller lika med 'y', annars kommer det att returnera 'y'. clamp(lo, value, hi)
Ett värde som inte får vara mindre än "lo" och inte högre än "hi". (Det vill säga, om "värde" är mindre än "lo", används "lo"; om "värde" är större än "hi", används "hi"; i annat fall används "värde")
Exempel: red = clamp(0, n, 255);
kommer att sätta variabeln "red" till värdet av variabeln "n", men utan att tillåta att den blir mindre än 0 eller större än 255.
Observera: Detta makro är helt enkelt en #definition
av: "(min(max(värde,lo),hi))".
.
tp_magic_api.h
"
Följande är en sammanfattning av de konstantvärden som ställs in (via"#define
") i huvudfilen för verktygs-API:et 'Magic'.
TP_MAGIC_API_VERSION
Detta heltalsvärde representerar vilken version av Rita med Tux 'Magic' tool API som rubriken motsvarar.
Det bör refereras till av ditt magiska verktygs"api_version()"
-funktion, för att informera den löpande kopian av Rita med Tux om ditt plugin är kompatibelt eller inte.
Obs: Detta versionsnummer motsvarar inte Rita med Tux's eget versionsnummer (t.ex. "0.9.35"). API:et kommer inte att ändras varje gång en ny version av Rita med Tux släpps, vilket innebär att plugins som kompilerats för tidigare versioner av Rita med Tux ofta kommer att köras under nyare versioner.
SPECIAL_MIRROR
SPECIAL_FLIP
"special_notify()
". De beskrivs ovan.
Använd C-kompilatorns kommandoradsalternativ"-shared
" för att generera en fil med delade objekt (".so
") baserat på C-källkoden för ditt verktygsplugin 'Magic'.
Använd kommandot"tp-magic-config --cflags
", som levereras som en del av Rita med Tux - eller i vissa fall som en del av ett "Rita med Tux 'Magic' Tool Plugin Development package" - för att tillhandahålla ytterligare kommandoradsflaggor till din C-kompilator som hjälper den att bygga ditt plugin.
Som ett fristående kommando, till exempel med GNU C-kompilatorn och BASH-skalet:
$ gcc -shared -fpic `tp-magic-config --cflags` my_plugin.c -o my_plugin.so
Observera: Tecknen runt kommandot"tp-magic-config
" är en grav/backtick/backquote ("`
"), och inte en apostrof/enkel citationstecken ("'
"). De talar om för skalet att det ska utföra kommandot i kommandot (i det här fallet"tp-magic-config .
..") och använda resultatet som ett argument till kommandot som ska utföras (i det här fallet"gcc
...").
Ett utdrag från en Makefile för att kompilera en Rita med Tux "Magic" tool plugin kan se ut så här:
CFLAGS=-Wall -O2 $(shell tp-magic-config --cflags)
my_plugin.so: my_plugin.c
gcc -shared $(CFLAGS) -o my_plugin.so my_plugin.c
Den första raden sätter upp Makefile-variabeln ("CFLAGS
") som innehåller flaggor för kompilatorn."-Wall
" ber om att alla kompilatorvarningar ska visas. "-O2
" begär optimering på nivå 2. "($shell tp-magic-config --cflags)"
kör"tp-magic-config
" för att hämta ytterligare kompilatorflaggor som "Magic"-verktygets insticksprogram kräver. (Direktivet "$(shell ...)
" liknar tecknet ` ("grav") i BASH-skalexemplen ovan)
På nästa rad definieras ett Makefile-mål,"my_plugin.so
", och det anges att det är beroende av C-källfilen"my_plugin.c
". (Varje gång C-filen ändras vet"make
" att den ska kompileras om och producera en uppdaterad ".so
"-fil. Om C-filen inte hade ändrats skulle den inte bry sig om att kompilera om)
Den sista raden definierar det kommando som"make
" ska köra när det bestämmer att det behöver (om)kompilera filen ".so
". Här använder vi"gcc
", med kommandoradsargumenten"-shared
och"$(CFLAGS
)", som ovan."-o my_plugin.so
" talar om för C-kompilatorn att utdatafilen ska vara"my_plugin
.so
". Det sista argumentet är C-filen som ska kompileras, i det här fallet"my_plugin.c
".
Observera: Kommandon som listas under ett Makefile-mål ska anges med ett enda tabbtecken.
En ännu mer generaliserad Makefile kan se ut så här:
CFLAGS=-Wall -O2 $(shell tp-magic-config --cflags)
my_plugin_1.so: my_plugin_1.c
$(CC) -shared $(CFLAGS) -o $@ $<
my_plugin_2.so: my_plugin_2.c
$(CC) -shared $(CFLAGS) -o $@ $<
Precis som tidigare finns det rader som definierar kommandot som"make
" ska köra när det upptäcker att det behöver (om)kompilera ".so
"-filen/filerna. Här används dock mer allmänna termer...
"$(CC)
" utökas till din standardkompilator för C (t.ex."gcc
"). "-shared
" och"$(CFLAGS
)" är kommandoradsargument till kompilatorn, som ovan."-o $@
" talar om för C-kompilatorn vad utdatafilen ska vara;"make
" ersätter"$@
" med namnet på målet, i det här fallet"my_plugin_1.so
" eller"my_plugin_2
.so
". Och slutligen är det sista argumentet den C-fil som ska kompileras; "make
" ersätter"$<
" med målets beroende, i det här fallet"my_plugin_1
.c" eller"my_plugin_2
.c".
TBD
TBD
Använd kommandoradsverktyget"tp-magic-config
", som levereras som en del av Rita med Tux - eller i vissa fall som en del av ett "Rita med Tux 'Magic' Tool Plugin Development package" - för att bestämma var dina plugins filer ska placeras.
Använd"tp-magic-config --pluginprefix
" för att bestämma var plugin shared object (".so
")-filerna ska installeras. Det värde som returneras av detta kommando är den globala plats där den installerade kopian av Rita med Tux letar efter insticksprogram (t.ex. "/usr/lib/tuxpaint/plugins
").
Alternativt kan du använda"tp-magic-config --localpluginprefix
" för att ta reda på var Rita med Tux förväntar sig att hitta lokala plugins för den aktuella användaren (t.ex. "/home/username/.tuxpaint/plugins
").
Som fristående kommandon, t.ex. i BASH-skalet:
# cp my_plugin.so `tp-magic-config --pluginprefix`
# chmod 644 `tp-magic-config --pluginprefix`/my_plugin.so
Obs: Se anmärkningen ovan angående tecknet "`"(grav)..
Använd kommandot"tp-magic-config --plugindocprefix
" för att bestämma var dokumentationen för dina "Magic"-verktyg ska placeras. Det värde som returneras av detta kommando är den plats där dokumentationen till den installerade kopian av Rita med Tux lagras. Huvuddokumentationen innehåller en länk till en mapp där dokumentationen för "Magic"-verktygen förväntas installeras
t.ex. "/usr/share/doc/tuxpaint/magic-docs
").
Observera: Det är bäst att inkludera både HTML- och klartextversioner av din dokumentation. Det finns en underkatalog"html
" i katalogen"magic-docs
", och det är där HTML-versionerna ska läggas.
Som fristående kommandon, t.ex. i BASH-skalet:
# cp my_plugin.html `tp-magic-config --plugindocprefix`/html
# cp my_plugin.txt `tp-magic-config --plugindocprefix`
Obs: Se anmärkningen ovan angående tecknet "`"(grav)..
Observera: För närvarande finns det inget alternativ"--localplugindocprefix
".
Använd kommandot"tp-magic-config --dataprefix
", som ingår i Rita med Tux, för att bestämma var datafiler (PNG-ikoner, Ogg Vorbis-ljudeffekter etc.) ska installeras. Värdet som returneras av detta kommando kommer att vara detsamma som värdet på strängen"data_directory
" som lagras i strukturen"magic_api
" som funktionerna i ditt insticksprogram tar emot (t.ex. "/usr/share/tuxpaint/
").
För lokalt installerade insticksprogram (endast för den aktuella användaren) använder du"tp-magic-config --localdataprefix
". Den returnerar värdet på strängen"data_directory
" som lokalt installerade insticksprogram ser i sin"magic_api
"-struktur (t.ex. "/home/username/.tuxpaint/plugins/data/
").
Observera: Rita med Tuxs standardinsticksprogram för verktyget Magic installerar sina data i underkatalogerna"magic
" i Rita med Tuxs datakataloger"images
" och"sounds
" (t.ex. "/usr/share/tuxpaint/images/magic/
"). Vi uppmuntrar dig att göra detsamma.
Som fristående kommandon, t.ex. i BASH-skalet:
# cp my_plugin_icon.png `tp-magic-config --dataprefix`/images/magic/
# chmod 644 `tp-magic-config --dataprefix`/images/magic/my_plugin_icon.png
Obs: Se anmärkningen ovan angående tecknet "`"(grav)..
Ett utdrag från en mer generell Makefile kan se ut så här:
PLUGINPREFIX=$(shell tp-magic-config --pluginprefix)
PLUGINDOCPREFIX=$(shell tp-magic-config --plugindocprefix)
DATAPREFIX=$(shell tp-magic-config --dataprefix)
install:
#
# Install plugin
mkdir -p $(PLUGINPREFIX)
cp *.so $(PLUGINPREFIX)/
chmod 644 $(PLUGINPREFIX)/*.so
#
# Install icons
mkdir -p $(DATAPREFIX)/images/magic
cp icons/*.png $(DATAPREFIX)/images/magic/
chmod 644 $(DATAPREFIX)/images/magic/*.png
#
# Install sound effects
mkdir -p $(DATAPREFIX)/sounds/magic
cp sounds/*.ogg $(DATAPREFIX)/sounds/magic/
chmod 644 $(DATAPREFIX)/sounds/magic/*.ogg
#
# Install docs
mkdir -p $(PLUGINDOCPREFIX)/html
cp docs/*.html $(PLUGINDOCPREFIX)/html/
cp docs/*.txt $(PLUGINDOCPREFIX)/
chmod 644 $(PLUGINDOCPREFIX)/html/*.html
chmod 644 $(PLUGINDOCPREFIX)/*.txt
De tre första raderna ställer in Makefile-variabler som innehåller de sökvägar som returneras av kommandoradsverktyget"tp-magic-config
". (Direktivet"$(shell ...)
" liknar tecknet ` ("grave") i BASH-skalexemplen ovan)
Under det finns ett"install
"-mål i Makefile. (Påkallas av till exempel"$ sudo make install
" eller"# make install
")
Målet"install
" använder"mkdir -p
" för att se till att plugin-katalogen finns, använder sedan"cp
" för att kopiera alla plugin (".so
")-filer till den och anropar"chmod
" för att se till att de är läsbara.
Därefter utförs en liknande serie kommandon för att installera ikonfiler (".png
"-bilder) och ljudeffekter (".ogg
"-filer) i underkataloger i Rita med Tuxs datakatalog och för att installera dokumentation (".html
"- och ".txt
"-filer) i Rita med Tuxs dokumentationskatalog.
Obs: Makefile-exemplet ovan förutsätter att användaren har behörighet att installera Rita med Tux-plugins i hela systemet.
TBD
TBD
Plugins för Rita med Tux kan innehålla mer än en effekt. Om du har flera effekter som liknar varandra kan det vara vettigt att placera dem i en plugin-fil för att minska overhead och dela kod.
Följande förslag kan hjälpa dig att skapa plugins som innehåller flera effekter:
"enum
" för att räkna upp effekterna och räkna dem.
enum {
ETT_VERKTYG,
ANNAT_VERKTYG,
OCH_YTTERLIGARE_ETT_VERKTYG,
NUM_TOOLS };
"NUM_TOOLS
" när"get_tool_count()
" anropas, och jämför"which"
-värden som skickas till andra funktioner med de andra uppräknade värdena. "NUM_TOOLS
" för att innehålla effektspecifika data.
char * my_plugin_snd_filnamn[NUM_TOOLS] = {
"one.ogg", "another.ogg", "yet_another.ogg" };
Mix_Chunk * min_plugin_snds[NUM_TOOLS]");
"for
"-loop för att ladda eller skapa effektspecifika data (t.ex. ladda ljudeffekter under din"init()
").
int i;
char fname[1024];
for (i = 0; i < NUM_TOOLS; i++)
{
/* Blir till exempel "/usr/share/tuxpaint/sounds/magic/one.ogg" */
snprintf(fname, sizeof(fname), "%s/sounds/magic/%s",
api->data_prefix, my_plugin_snd_filnamn[i]);
min_plugin_snds[i] = Mix_LoadWAV(fname);
}
"shutdown()
").
int i;
for (i = 0; i < NUM_TOOLS; i++)
Mix_FreeChunk(min_plugin_snds[i]);
"which"
-värden som skickas till dina funktioner som ett index i dessa matriser (t.ex. för att spela upp lämplig ljudeffekt för ett verktyg).
Observera: Även om ditt plugin för närvarande bara innehåller en effekt, kan det vara bra att följa stegen ovan så att du kan lägga till en ny variant av en effekt med liten ansträngning. ("NUM_TOOLS
" kommer helt enkelt att vara '1', dina arrayer kommer att ha längden '1', etc.)
; layer 1
The C source file "tp_magic_example.c
" contains a complete example of a plugin with multiple simple effects.
Mer information finns på webbplatsen för Rita med Tux: https://tuxpaint.org/ och på webbplatsen för biblioteket Simple DirectMedia Layer: http://www.libsdl.org/..
Dessutom finns andra utvecklare och användare av Rita med Tux på e-postlistorna"tuxpaint-devel
" och"tuxpaint-users
": https://tuxpaint.org/lists/..
&
*
->
.
`
"&"
. En symbol i C som fungerar som en bitvis "och"-operator. Endast bitar som är inställda i båda värdena returneras. Till exempel jämför"11 & 6
" de binära värdena '1011' med '0110'. Endast biten på 2:ans plats är inställd, så resultatet blir 2
('0010'). "&"
. En symbol i C som gör det möjligt att referera till minnesadressen för en variabel, dvs. en pekare. (Tänk till exempel på"int i;
". Senare hänvisar"&i
" till minnet där "i
" är lagrat, inte värdet på "i
" i sig; det är en "pekare till"i
"") "rgbtohsv()
" och"hsvtorgb()
") "SDL_Rect
" innehåller till exempel fyra heltalsvärden, rektangelns koordinater (X,Y) och dess dimensioner (bredd och höjd). "enum { ONE, TWO, THREE };
" #define
#define RADIUS 16
"; alla förekomster av"RADIUS
" ersätts med"16
"), men kan också användas för att skapa makron. Placeras vanligtvis i C-headerfiler. dimensioner
.dll
"w
" och"h
" i SDL_Surface lagrar ytans bredd respektive höjd) enum
float
format
SDL_Surface-element
(en pekare till en SDL_PixelFormat-struktur
) som innehåller information om en yta, t.ex. antalet bitar som används för att representera varje pixel.)SDL_PixelFormat(3)
" man page. free()
strdup(
)").malloc(3)
" man page. gcc
gcc(1)
" man page. `
"; används av BASH-skalet för att använda utdata från ett kommando som kommandoradsargument för ett annat. .h
IMG_Load()
"SDL_Surface *
". #include
int
magic_api
make
Makefile
"#define ADD(A,B) ((A)+(B))
" och sedan använde det med"c = ADD(1,2);
", skulle den kodraden bokstavligen expandera till"c = ((1) + (2));
", eller enklare uttryckt,"c = 1 + 2;
". Mix_Chunk *
Mix_FreeChunk()
Mix_Chunk *
"). Mix_LoadWAV()
"Mix_Chunk *
". .ogg
"->"
. En symbol i C som refererar till ett element inom en pekare till en struktur. .png
png(5)
" man page. .
". En symbol i C som refererar till ett element inom en struktur. SDL_FreeSurface()
SDL_Surface *
"). SDL_GetRGB()
Uint32-pixelvärde
(t.ex. ett som returneras från Rita med Tux's Magic tool API-hjälpfunktionen "getpixel()
"), formatet på ytan som pixeln togs från och pekare till tre Uint8-variabler
, placerar pixelns RGB-värden (rött, grönt och blått) i de tre Uint8-variablerna
. (Exempel:"SDL_GetRGB(getpixel(surf, x, y), surf->format, &r, &g, &b);
"SDL_GetRGB(3)
" man page. SDL_image
"SDL_Surface *
". SDL_MapRGB()
Uint8-värden
som representerar röda, gröna och blå värden för en pixel, returnerar ett Uint32-pixelvärde
som kan placeras i ytan (t.ex. med hjälp av Rita med Tux's Magic tool API-hjälpfunktion"putpixel()")
. (Exempel:"putpixel(surf, x, y, SDL_MapRGB(surf->format, r, g, b));
".)SDL_MapRGB(3)
" man page. SDL_mixer
SDL_Rect
SDL_Rect(3)
" man page. SDL_Surface *
SDL_Surface(3)
" man page. snprintf()
"char str[20]
;" har deklarerats;"snprintf(str, 20, "Namn: %s, Ålder: %d", "Bill", 32);
" lagrar "Namn: Bill, Ålder: 32" i'str
'.sprintf(3)
" man page. .so
"*
". En symbol i C som, när den används i deklarationen av variabler (t.ex. argument till en funktion), anger att variabeln är en pekare. (Till exempel"int * p;
" betyder att"p
" är en pekare till ett heltal.) När den används bredvid en pekare "dereferencerar" den variabeln. (Till exempel, senare"*p = 50;
" tilldelar värdet 50 till det minne som "p
" pekar på; det ändrar inte värdet på "p
", som fortfarande är en pekare på ett heltal. I själva verket ändras det heltal som pekas ut) strdup()
"char *
"-pekare till den nya kopian.strdup(3)
" man page. struct
tp-magic-config
tp-magic-config(3)
" man page. tp_magic_api.h
'#inkludera
' den. Uint32
Uint8
"int age
;". Den kan undersökas senare - t.ex."if (age >= 18) { /* they are an adult */ } else { /* they are not an adult */ } }
" - och även ändras senare - t.ex. age = 32; /* set age to 32 */
(w,h)
.wav
(x,y)
|