Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hamoid
hamoid committed Oct 21, 2024
1 parent cab1552 commit c7e7960
Show file tree
Hide file tree
Showing 270 changed files with 153 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/ORX/compositor.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Compositor
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 170
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/distanceFields.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Distance fields
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 220
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/imageFilters.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Image post-processing with filters
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 160
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/imageFit.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Image fit
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 200
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/index.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: ORX
parent: ~
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 1100
has_children: true
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/kinect.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Kinect
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 120
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/midiControllers.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: MIDI controllers
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 140
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/noise.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Noise
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 110
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/osc.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: OSC
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 150
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/poissonFills.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Poisson fills
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 210
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/quickUIs.markdown
View file
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.05.22 16:04:58 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 180
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ORX/shadeStylePresets.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Shade style presets
parent: ORX
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 190
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/ComputeShaders.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Compute shaders
parent: Advanced topics
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 160
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/applicationFlow.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Application Flow
parent: Advanced topics
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 110
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/headlessApplications.markdown
View file
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.05.22 14:22:38 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 140
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/index.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Advanced topics
parent: ~
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 1110
has_children: true
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/integerColorBuffers.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Integer color buffers
parent: Advanced topics
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 155
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/lowLevelDrawing.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Low-level drawing
parent: Advanced topics
last_modified_at: 2024.01.15 12:27:05 +0100
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 150
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/advancedTopics/presentationControl.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Presentation Control
parent: Advanced topics
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 120
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/animation/basicAnimations.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Basic animation
parent: Animation
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 50
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/animation/index.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Animation
parent: ~
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 1080
has_children: true
---
Expand Down
2 changes: 1 addition & 1 deletion docs/animation/interactiveAnimations.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Interactive animations
parent: Animation
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 100
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/bestPractices/index.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Best practices
parent: ~
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 1098
has_children: true
---
Expand Down
16 changes: 7 additions & 9 deletions docs/debugging/logging.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Logging and debugging
parent: ~
last_modified_at: 2024.01.15 13:08:17 +0100
last_modified_at: 2024.10.15 10:27:51 +0200
nav_order: 1105
has_children: true
---
Expand All @@ -31,10 +31,10 @@ To make it verbose we can replace `level: info` with `level: all`.

##### Exception handling

It is possible to change how exception errors are presented by adding
`-Dorg.openrndr.exceptions=JVM` to the VM options under `Run > Edit
Configurations`. This can sometimes help figure out why a program is
crashing.
It is possible to change how exception errors are presented by IntelliJ Idea:
Open the `Run > Edit Configurations` menu and make sure the `VM Options` text
field contains `-Dorg.openrndr.exceptions=JVM`.
This can sometimes help figure out why a program is crashing.

##### Crashing shaders

Expand All @@ -53,11 +53,9 @@ with video exporting.
### Enabling OpenGL debug messages

If your graphics hardware and drivers support OpenGL debug contexts
you can use `-Dorg.openrndr.gl3.debug=TRUE` to enable the debug messages.

Open the `Run > Edit Configurations...` menu in
you can open the `Run > Edit Configurations...` menu in
IntelliJ and make sure the `VM Options` text field contains
`-Dorg.openrndr.gl3.debug=true`.
`-Dorg.openrndr.gl3.debug=true` to enable the debug messages.

### Using RenderDoc

Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/arrayTextures.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Array textures
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 370
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/asynchronousImageLoading.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Asynchronous image loading
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 330
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/circlesRectanglesLines.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Drawing circles, rectangles and lines
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 100
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/clipping.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Clipping
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 320
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/color.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Color
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 130
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/colorbuffers.markdown
View file
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.05.22 14:15:59 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 300
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/concurrencyAndMultithreading.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Concurrency and multithreading
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 360
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/curvesAndShapes.markdown
View file
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.05.22 14:50:56 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 150
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/customRendering.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Custom rendering
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 350
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/drawingPrimitivesBatched.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Drawing primitives batched
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 180
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/drawingSVG.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Drawing SVG
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 160
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/filtersAndPostProcessing.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Filters and post processing
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 310
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/images.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Images
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 110
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/index.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Drawing
parent: ~
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 1040
has_children: true
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/managingDrawStyle.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Managing draw style
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 140
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/drawing/quaternions.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
layout: default
title: Quaternions
parent: Drawing
last_modified_at: 2024.04.04 18:44:14 +0200
last_modified_at: 2024.09.06 17:25:36 +0200
nav_order: 220
has_children: false
---
Expand Down
Loading

0 comments on commit c7e7960

Please sign in to comment.