Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hamoid committed May 22, 2024
1 parent 38999ca commit b0e9599
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/ORX/quickUIs.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Quick UIs
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.05.22 14:14:10 +0200
nav_order: 180
has_children: false
---
Expand All @@ -26,7 +26,7 @@ in [`orx-parameters`](https://github.com/openrndr/orx/tree/master/orx-parameters
`orx-gui` is incredibly powerful in combination with the live coding environment
[`orx-olive`](https://github.com/openrndr/orx/tree/master/orx-jvm/orx-olive),
the guide covers that in the
[live coding section](https://guide.openrndr.org/ORX/liveCoding.html).
[live coding section](https://guide.openrndr.org/useCases/liveCoding.html).
That said, it is not a required combination.

## Prerequisites
Expand Down
4 changes: 2 additions & 2 deletions docs/advancedTopics/headlessApplications.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Headless applications
parent: Advanced topics
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.05.22 14:22:38 +0200
nav_order: 140
has_children: false
---
Expand All @@ -30,7 +30,7 @@ Headless applications cannot draw on the backbuffer, because there
is no backbuffer. In order to draw you need to create a
[RenderTarget](https://guide.openrndr.org/drawing/renderTargets.html) and draw on it.
Render target contents can easily be saved to file, or rendered to
[video](https://guide.openrndr.org/videos/writingToVideoFiles.html).
[video](https://guide.openrndr.org/extensions/writingToVideoFiles.html#writing-to-video-using-render-targets).

#### Mouse and keyboard events

Expand Down
4 changes: 2 additions & 2 deletions docs/drawing/colorbuffers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Color buffers
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.05.22 14:15:59 +0200
nav_order: 300
has_children: false
---
Expand Down Expand Up @@ -103,7 +103,7 @@ cb.saveToFile(File("output.jpg"))
When repeatedly saving color buffers asynchronously (the default) it is possible to run out
of memory. This can happen if the software can not save images at the requested frame rate.
In such situations we can either set `async = false` in `saveToFile()` or avoid `saveToFile` and use the
[VideoWriter](https://guide.openrndr.org/videos/writingToVideoFiles.html#writing-to-video-using-render-targets)
[VideoWriter](https://guide.openrndr.org/extensions/writingToVideoFiles.html#writing-to-video-using-render-targets)
together with [pngSequence](https://github.com/openrndr/orx/tree/master/orx-jvm/orx-video-profiles#png-sequence)
or [tiffSequence](https://github.com/openrndr/orx/tree/master/orx-jvm/orx-video-profiles#tiff-sequence)
instead.
Expand Down
6 changes: 3 additions & 3 deletions docs/drawing/curvesAndShapes.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Curves and shapes
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.05.22 14:20:54 +0200
nav_order: 150
has_children: false
---
Expand Down Expand Up @@ -77,7 +77,7 @@ val points = seg.equidistantPositions(20)
```

The list of available methods can be found at the
[API website](https://api.openrndr.org/openrndr-shape/org.openrndr.shape/-segment/index.html)
[API website](https://api.openrndr.org/openrndr-shape/org.openrndr.shape/-segment2-d/index.html)
or in the
[source code](https://github.com/openrndr/openrndr/tree/master/openrndr-shape/src/commonMain/kotlin/org/openrndr/shape).

Expand Down Expand Up @@ -452,7 +452,7 @@ fun main() = application {
#### reversed, close(), transform(), ...

For more properties and methods explore the
[API website](https://api.openrndr.org/openrndr-shape/org.openrndr.shape/-shape-contour/index.html)
[API website](https://api.openrndr.org/openrndr-shape/org.openrndr.shape/-path/position.html)
or the
[source code](https://github.com/openrndr/openrndr/tree/master/openrndr-shape/src/commonMain/kotlin/org/openrndr/shape).

Expand Down
4 changes: 2 additions & 2 deletions docs/setUpYourFirstProgram.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Set up your first program
parent: What is OPENRNDR?
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.05.22 14:24:03 +0200
nav_order: 20
has_children: false
---
Expand Down Expand Up @@ -93,7 +93,7 @@ If your computer has multiple GPUs, you can choose which one OPENRNDR uses like

At this point you are likely interested in how this program is structured.
The guide explains more in the
[Program basics](https://guide.openrndr.org/programBasics/applicationProgram.html) chapter.
[Program basics](https://guide.openrndr.org/programBasics/application.html) chapter.

If you are more interested in reading source code you can find the code
for the examples in this guide in the
Expand Down

0 comments on commit b0e9599

Please sign in to comment.