Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
37 changes: 37 additions & 0 deletions scripting/api-reference/image/font.mdx
Original file line number Diff line number Diff line change
@@ -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.


31 changes: 0 additions & 31 deletions scripting/api-reference/image/image.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
13 changes: 13 additions & 0 deletions scripting/api-reference/interfaces/view-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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>`.