Skripting API

In diesem Artikel wird beschrieben, welche Funktionen und Variablen für Skripts in den Komponenten Abbildungs-Skripte und Kurven-Skripte verfügbar sind. Alle Filter Forge-API-Funktionen (nicht aber Variablen) sind im Skript-Editor durch eine orangefarbene Syntax hervorgehoben.

Verfügbarkeit von Standard-Lua-Bibliotheken

Sichere Skripte (d.h. Skripte, bei denen die Einstellung Unsichere Skripte in den Skripteinstellungen deaktiviert ist) dürfen Lua-Funktionen aus den folgenden Standard-Lua-Bibliotheken aufrufen:

• String-Bibliothek.
• Tabellen-Bibliothek.
• Mathematische Bibliothek. Beachte, dass die Funktionen math.random() und math.randomseed() nicht von der Funktion get_sample() des Skripts aufgerufen werden können, sondern nur von prepare(). Diese Einschränkung gilt sowohl für sichere als auch für unsichere Skripte.
• Basic-Bibliothek, ausgenommen die Coroutine-Bibliothek und die Funktionen dofile(), getfenv(), getmetatable(), load(), loadfile(), loadstring(), pcall(), rawequal(), rawget(), rawset(), setfenv(), setmetatable() und xpcall().

Unsichere Skripte dürfen alle Lua-Funktionen aus allen Standard-Lua-Bibliotheken aufrufen.

API Variablen

Die Skripte in Filter Forge können mehrere globale Variablen verwenden, mit denen du den Wert der globalen Schieberegle Größe und Variation, die Breite und Höhe des Arbeitsbildes und mehr abfragen kannst. Wenn du in Skripten auf diese Variablen verweist, denke daran, dass Lua zwischen Groß- und Kleinschreibung unterscheidet, sodass die Variablennamen in Großbuchstaben geschrieben werden müssen, wie in der Liste gezeigt:

• SIZE – Der Wert des globalen Schiebereglers Größe. Nur für Skripte verfügbar, die in ihren Skripteinstellungen "Verwendung der globalen Größeneinstellung übernehmen" aktiviert haben. Wird in Pixel gemessen, kann aber nicht-ganzzahlige Werte annehmen.
• VARIATION – Der Wert des Schiebereglers für die globale Variation. Nur für Skripte verfügbar, die in ihren Skripteinstellungen "Verwendung der globalen Variationseinstellung übernehmen" aktiviert haben.
• OUTPUT_WIDTH und OUTPUT_HEIGHT – Breite und Höhe des aktuell in Filter Forge geladenen Bildes. Gemessen in Pixel.
• SEAMLESS_REGION_WIDTH und SEAMLESS_REGION_HEIGHT – Breite und Höhe des nahtlosen Bereichs, sprich des Bereichs, in dem das Skript eine nahtlos gekachelte Ausgabe liefern muss. Nur für Skripte verfügbar, die in ihren Skripteinstellungen die Option Nahtlos gekachelte Ergebnisse erzeugen" aktiviert haben. Beide Variablen werden als Verhältnis zu SIZE gemessen. Wenn z. B. SIZE 300 Pixel und die Breite des nahtlosen Bereichs 450 Pixel beträgt, nimmt die Variable SEAMLESS_REGION_WIDTH den Wert 1,5 an.
• SEAMLESS – Der Status der globalen Nahtlose Kachelung Checkbox, entweder true oder false. Nur für Skripte verfügbar, die in ihren Skripteinstellungen "Erzeugt nahtlos gekachelte Ergebnisse" aktiviert haben.

API-Funktionen für den Verweis auf benutzerdefinierte Eingaben

Filter Forge bietet Funktionen, mit denen du Werte von benutzerdefinierten Eingaben abfragen kannst, die über den Eingabe-Editor zu einer Abbildungs-Skript oder Kurven-Skript -Komponente hinzugefügt wurden. Jeder Eingabetyp (z. B. Schieberegler, Checkbox usw.) hat eine entsprechende Abfragefunktion. Informationen zu Eingabetypen und ihren entsprechenden Funktionen findest du unter: Referenzieren von Eingaben aus Skripten.

API-Funktionen für smarte Kantenglättung

Filter Forge bietet eine Funktion combine_aa_zones(), die das Kombinieren von Kantenglättungs-Zonen vereinfacht. Weitere Informationen zu dieser Funktion und zur Handhabung von Kantenglättung in Skripten im Allgemeinen findest du unter Implementieren von Smarter Kantenglättung.

API-Funktionen für Rauschen

Filter Forge bietet eine ... Funktion, die den Prozess von ... vereinfacht. Weitere Informationen zu dieser Funktion und zur Verwendung der Rauscherzeugung in Skripten im Allgemeinen findest du unter: Rauschen-API.

API-Funktionen für Mischmodi

Filter Forge bietet eine ... Funktion, die den Prozess von ... vereinfacht. Weitere Informationen zu dieser Funktion und zur Verwendung von Mischmodi in Skripten findest du unter: Mischmodi-API.

Schreiben in das Meldungsprotokoll

Du kannst die Standard-Lua-Funktion error() verwenden, um Fehlermeldungen in das Meldungsprotokoll zu schreiben. Beachte, dass der Aufruf dieser Funktion das Skript beendet. Derzeit gibt es keine anderen Möglichkeiten, Meldungen an das Meldungsprotokoll zu senden, ohne das Skript zu unterbrechen.