openrndr / openrndr-guide

Source files for the OPENRNDR guide

OPENRNDR

A Kotlin/JVM and Kotlin/JS library for creative coding, real-time and interactive graphics. Can currently be used on Windows, macOS and Linux/x64 to create standalone graphical applications.

Basics and use are further explained in the OPENRNDR guide.

Repository structure

module	description
openrndr-animatable	Tooling for interactive animations
openrndr-application	Application and Program classes
openrndr-binpack	Binpacking algorithm used for texture atlasses
openrndr-color	Color spaces
openrndr-dds	DirectDraw Surface file (.dds) loader
openrndr-demos	A collection of small in-repository demos
openrndr-draw	Drawing primitives
openrndr-event	Event classes
openrndr-extensions	Built-in OPENRNDR extensions
openrndr-filter	Built-in filters
openrndr-js	Kotlin/JS specific modules
openrndr-jvm	Kotlin/JVM specific modules
openrndr-math	Math functions and classes
openrndr-nullgl	Mock graphics back-end
openrndr-shape	Classes and functions for working with 2D shapes
openrndr-svg	Loading and saving SVG
openrndr-utils	Assorted utilities

Using OPENRNDR

You are advised to use the OPENRNDR template which provides a quick start to using the library.

OPENRNDR's Javascript/WebGL is still experimental and under development. However, if you feel like trying it you should use the OPENRNDR JS template.

Building OPENRNDR

After cloning the repository, make sure you have Java 11 or newer installed and run the following command:

./gradlew build

This should start the build process, which will take some time to complete.

Note that OPENRNDR does not depend on anything that is not on Maven Central, builds should be easy and predictable.

Installing OPENRNDR as Maven artifacts

In order to use the OPENRNDR build from your applications one has to install OPENRNDR's Maven artifacts in the local Maven repository.

./gradlew publishToMavenLocal snapshot

A more detailed walk-through of building, publishing to Maven local and contributing can be found in the wiki.

Community

Visit the OPENRNDR website for the latest news on OPENRNDR, showcases and events

Join us on the OPENRNDR forum for questions, tutorials and showcases.

Reach us more directly on the OPENRNDR Slack.

openrndr-guide's Issues

Add link in the guide to this repository

That makes it more obvious how to contribute

Waiting for animation to finish not finished

https://github.com/openrndr/openrndr-guide/blob/master/docs/08_Animation/C00_InteractiveAnimations.md#waiting-for-an-animation-to-finish

The last two code boxes seem incomplete.

Writing SVG Files is missing

At the bottom of the Drawing SVG chapter there is a link for how to write SVG files, however, the link goes to a blank page.

Is it that the link is incorrect or that the content doesn't exist yet?

Wrong index in example in C00_Render_targets_and_color_buffers

The example in

https://guide.openrndr.org/#/06_Advanced_drawing/C00_Render_targets_and_color_buffers?id=compositing-using-render-targets-and-alpha-channels

gives an error, as rt1 only has one colorbuffer, ie the code line

drawer.image(rt1.colorBuffer(1))

should be

drawer.image(rt1.colorBuffer(0))

instead imho.

Invalid full example links in guide

The links to the full examples on https://guide.openrndr.org/#/10_OPENRNDR_Extras/C01_Noise are all 404

[Topic] Differences between Segment/LineSegment/LineStrip/LineLoop

An explanation on how they differ from each other or in which circumstances to use one or the other.

Missing ':run' in explanation howto run tutorials?

Hi - I think there is a ':run' missing in the last sentence of

https://guide.openrndr.org/#/02_Getting_Started_with_OPENRNDR/C01_TutorialRepository?id=running-tutorials-from-the-command-line

You can run an individual example from the tutorial repository from the command line using ./gradlew :<project-name> → You can run an individual example from the tutorial repository from the command line using ./gradlew :<project-name>:run

At least for me this is required to actually run a tutorial.

[orx-compositor] `use` and `addTo` not yet mentioned

Add them to https://guide.openrndr.org/#/10_OPENRNDR_Extras/C07_Compositor
based on https://openrndr.discourse.group/t/openrndr-0-3-40-orx-0-3-50-released/60/9?u=ricardo

Update just-the-docs

https://github.com/just-the-docs/just-the-docs/releases

Is it possible to change FPS limit?

Based on my observations, openrndr limits its frame rate to 60 FPS. Is it possible to modify this limit?

Dead links

There are a number of dead links floating around online to pages in the guide that are no longer there.

For example, the Tutorials link on the OpenRNDR homepage itself is dead. So are old links in Github issues (e.g. this issue).

It'd be great if the guide automatically redirected from the old links to the new links. Alternatively, it could at least show search results for missing pages based on the slug.

Search feature in the guide doesn't look inside tables

In the guide, if one searches for blendMode or u_fill there are zero results. The search feature might need some tweaking?

how to preview or build static files?

hello
wanna translate guide document to korean. and want to preview results as follow here but there is no task, build directory under the repository.

did I miss something of thouse files are missing in this repo?

thank you.

Is there a way to write a png file for every frame?

I'd like to create a PNG file for each frame within the extend {} block until it reaches a certain number of frames.

I tried using the Screenshots extension but I find it a bit hard to control. I am looking for something similar to the VideoWriter that works within the extend draw loop block but for pngs.

[Topic] How to use AtomicCounters?

Not necessarily an independent topic, but an entry about them.

Cover integer atomic counters and image.

C08 Quick UI issues

https://guide.openrndr.org/#/10_OPENRNDR_Extras/C08_Quick_UIs?id=actionparameter

• Uses @DoubleParameter in @IntParameter
• No mention of @DoubleListParameter

Add section about loading and saving data

Include examples with JSON, XML and CSV.

How to access raw pixel values?

I have a quite specific usecase, where I need to compute similarity between two images:

var similarity = 0.0
for (x in 0..width) for (y in 0..height) {
  euclid_distance(image0.rgb(x,y), image1.rgb(x,y)) // image 0,1 are composite shapes or svg
}
return similarity / width*height

I wasn't able to find .rgb(x,y) in the guide or the API, is there anything like it?
Moreover, I need this operation to be super fast, so the call to .rgb should have zero overhead. Also I wonder if openrdnr could allow me to implement it on GPU to get some further speedups.

add documentation for ColorBuffer.shadow

Add documentation for getting pixel color values using the shadow property.

For example: https://openrndr.discourse.group/t/load-image-and-get-pixel-value/42

Fonts not found

When trying to draw some text as explained in https://guide.openrndr.org/#/04_Drawing_basics/C02_Text using the current master of https://github.com/openrndr/openrndr-template with

fun main() = application {
    configure {
        width = 800
        height = 800
    }
    program  {
        val font = loadFont("file:data/IBMPlexMono-Bold.ttf", 24.0)

        extend {
            drawer.fontMap = font
            drawer.fill = ColorRGBa.WHITE
            drawer.text("Counter $seconds", width / 2.0 - 100.0, height / 2.0)
        }
    }
}

it fails with

Exception in thread "main" java.io.FileNotFoundException: data\IBMPlexMono-Bold.ttf (The system cannot find the file specified)

It would be great if example-template (or one of the dependencies) could either somehow include these fonts, or the doc-example would use a default system font.

I managed to solve the issue by downloading the fonts from https://fonts.google.com/specimen/IBM+Plex+Mono

docsify reformats code producing long lines

When I run the docsify gradle task after editing a guide page, the texts are indeed updated, but the part inside the code block stays unchanged for some reason.

I tried deleting

• build/classes/kotlin/GeneratedExamples/examples/04_Drawing_basics/C05_ComplexShapes005Kt.class
• build/dokgen/generated/examples-export/04_Drawing_basics/C05_ComplexShapes005.kt
• build/dokgen/generated/examples/04_Drawing_basics/C05_ComplexShapes005.kt

and running docsify again but somehow the code in the html page does not change.

[Topic] How to make use of Bytebuffers?

A small entry on how to use them, reading, converting to indented type and why they could be a better choice than using a ColorBufferShadow (when it's an alternative).

Standard Uniforms are missing

See
https://github.com/openrndr/openrndr-guide/blob/master/docs/06_Advanced_drawing/C04_Shade_styles.md#standard-uniforms

It's a duplicate of the prefix overview.

ShadeStyles missing some information

Link

Does not mention:

• x_modelMatrix
• x_modelNormalMatrix

Perhaps there could be some examples which make use of one of the preprocessors and vertexTransform.