API-Referenz
Automatisch aus den TypeScript-Quellen am 2026-05-21 erzeugt. Mit
task gen:api-referenceneu generieren. Die hand-gepflegte Endanwender-Referenz steht unter Effekte.
Die vollständige öffentliche API der OpticScript-JavaScript-Engine, auf vier Seiten verteilt, damit jede Seite bequem lesbar bleibt:
- Image-API —
ImageHandle(~80 Methoden für Farbe, Filter, Geometrie, Komposition, SVG, Pixelzugriff) plus das globaleEngine-Objekt (loadImage,createCanvas,tool,timer, …). - Pixel — RGBA-Farbwert mit HSL-/Hex-/CSS-
Namensfarben-Umwandlung und der
closestName()-Rückwärtssuche im perzeptuellen Farbraum. - Koordinaten —
Px/UV-Klassen und diepx()/uv()-Factory-Funktionen. - Typen & Enums —
BlendMode,Interp,BorderMode,AlphaMode,WarpBorderplus die gemeinsamen Typ-Aliase (Color,PadColor,Rect). - Matrix-Toolbox —
Mat3/Mat4/Vec*/Quat(gl-matrix), dasMatrix-Global.Mat3.estimate*fittet Transformationen an Punktpaare fürwarpPerspective.
Suchst du die Endanwender-Doku?
Die Effekte-Referenz ist die hand-gepflegte, zweisprachige Schwesterseite zu dieser hier — gleiche Operationen, aber gruppiert nach „Was-bringt-es-dir" statt nach Klasse, mit deutschen Begriffen und Wikipedia-Hintergrund. Nimm die, wenn du herausfinden willst, welcher Effekt zu deinem Look führt — nimm diese hier, wenn du die API aus einem Skript heraus aufrufst.
Diese API-Seite ist derzeit nur englisch — TypeDoc liest die JSDoc-Kommentare im Quellcode, und die sind englisch verfasst. Eine zweisprachige Variante folgt, sobald die Methoden mit
@apidoc-de-Tags annotiert sind.