From bb9eff8ab40038be144b8c83ec2474106512b5e3 Mon Sep 17 00:00:00 2001
From: luigi-rosso <luigi-rosso@users.noreply.github.com>
Date: Sun, 26 Jul 2026 17:26:32 +0000
Subject: [PATCH] Update scripting API documentation

---
 docs.json                                     |  1 +
 scripting/api-reference/image/font.mdx        | 37 +++++++++++++++++++
 scripting/api-reference/image/image.mdx       | 31 ----------------
 .../api-reference/interfaces/view-model.mdx   | 13 +++++++
 4 files changed, 51 insertions(+), 31 deletions(-)
 create mode 100644 scripting/api-reference/image/font.mdx

diff --git a/docs.json b/docs.json
index 1d2cddd6..68daff66 100644
--- a/docs.json
+++ b/docs.json
@@ -440,6 +440,7 @@
                 "group": "Image",
                 "pages": [
                   "scripting/api-reference/image/image",
+                  "scripting/api-reference/image/font",
                   "scripting/api-reference/image/image-filter",
                   "scripting/api-reference/image/image-sampler",
                   "scripting/api-reference/image/image-wrap"
diff --git a/scripting/api-reference/image/font.mdx b/scripting/api-reference/image/font.mdx
new file mode 100644
index 00000000..2a9abe65
--- /dev/null
+++ b/scripting/api-reference/image/font.mdx
@@ -0,0 +1,37 @@
+---
+title: Font
+---
+
+Represents an image asset that can be drawn by the [Renderer](/scripting/api-reference/renderer/renderer).
+```lua highlight={2,7,15}
+type DrawImage = {
+  myImage: Image?,
+  sampler: ImageSampler?,
+}
+
+function init(self: DrawImage, context: Context): boolean
+  self.myImage = context:image('myImage')
+  self.sampler = ImageSampler('clamp', 'clamp', 'bilinear')
+
+  return true
+end
+
+function draw(self: DrawImage, renderer: Renderer)
+  if self.myImage and self.sampler then
+    renderer:drawImage(self.myImage, self.sampler, 'srcOver', 1)
+  end
+end
+
+return function(): Node<DrawImage>
+  return {
+    myImage = nil,
+    sampler = nil,
+    init = init,
+    draw = draw,
+  }
+end
+```
+An immutable font resource. Obtained from a host and assignable to view
+model font properties.
+
+
diff --git a/scripting/api-reference/image/image.mdx b/scripting/api-reference/image/image.mdx
index d9ccbb77..d746cf4c 100644
--- a/scripting/api-reference/image/image.mdx
+++ b/scripting/api-reference/image/image.mdx
@@ -2,37 +2,6 @@
 title: Image
 ---
 
-Represents an image asset that can be drawn by the [Renderer](/scripting/api-reference/renderer/renderer).
-```lua highlight={2,7,15}
-type DrawImage = {
-  myImage: Image?,
-  sampler: ImageSampler?,
-}
-
-function init(self: DrawImage, context: Context): boolean
-  self.myImage = context:image('myImage')
-  self.sampler = ImageSampler('clamp', 'clamp', 'bilinear')
-
-  return true
-end
-
-function draw(self: DrawImage, renderer: Renderer)
-  if self.myImage and self.sampler then
-    renderer:drawImage(self.myImage, self.sampler, 'srcOver', 1)
-  end
-end
-
-return function(): Node<DrawImage>
-  return {
-    myImage = nil,
-    sampler = nil,
-    init = init,
-    draw = draw,
-  }
-end
-```
-
-
 ## Fields
 
 ### `width`
diff --git a/scripting/api-reference/interfaces/view-model.mdx b/scripting/api-reference/interfaces/view-model.mdx
index e41506ef..0eebd32d 100644
--- a/scripting/api-reference/interfaces/view-model.mdx
+++ b/scripting/api-reference/interfaces/view-model.mdx
@@ -245,3 +245,16 @@ end
 ```
 
 
+### `getFont`
+
+{/* getFont: (self: ViewModel, name:string) -> Property<Font>? */}
+<div class="signature">
+```lua
+getFont(name: string) -> Property<Font>?
+```
+</div>
+
+Looks up a font by name.
+Returns a `Property<Font>`.
+
+