diff --git a/README.md b/README.md index 1409bb3..d6a5ee7 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ A graphics library for real-time rendering of 2D signed distance fields on the w ## Links - [View it in action (demos)](https://sdf2d.schmelczer.dev) -- [View it in action (video game)](https://decla.red) +- [View it in action (video game)](https://doppler.schmelczer.dev/) - [Documentation](https://sdf-2d-docs.schmelczer.dev/) -- [In-depth information](https://git.schmelczer.dev/andras/sdf-2d/blob/master/media/thesis-andras-schmelczer.pdf) +- [In-depth information](https://schmelczer.dev/media/downloads/sdf2d-andras-schmelczer.pdf) ## Features diff --git a/docs/index.html b/docs/index.html index 62f2e47..a19b1e1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,25 +10,25 @@ -

If you're planning to create animated content, use the runAnimation function to save yourself from writing boilerplate code. -See its documentation for more details.

+

If you're planning to create animated content, use the runAnimation function to save yourself from writing boilerplate code. +See its documentation for more details.

Iñigo Quilez has a great collection of 2D SDFs

diff --git a/documentation-readme.md b/documentation-readme.md index 517a6fa..114a2b5 100644 --- a/documentation-readme.md +++ b/documentation-readme.md @@ -12,23 +12,23 @@ The motivation behind this library and more in-depth information about the rende ## Usage (1st option) -- To start using cutting-edge 2D graphics, you first need a renderer instance. You can get one by calling the [compile function](globals.html#compile). - - For this, you have to provide one or more [DrawableDescriptors](interfaces/drawabledescriptor.html). - - Optionally, the default compile settings can be overridden using [StartupSettings](interfaces/startupsettings.html). -- Once you have a renderer, you can start drawing objects through the [Renderer](interfaces/renderer.html) interface. +- To start using cutting-edge 2D graphics, you first need a renderer instance. You can get one by calling the [compile function](functions/compile.compile.html). + - For this, you have to provide one or more [DrawableDescriptors](interfaces/drawables_drawable-descriptor.DrawableDescriptor.html). + - Optionally, the default compile settings can be overridden using [StartupSettings](interfaces/graphics_rendering_settings_startup-settings.StartupSettings.html). +- Once you have a renderer, you can start drawing objects through the [Renderer](interfaces/graphics_rendering_renderer_renderer.Renderer.html) interface. ## Usage (2nd option) -If you're planning to create animated content, use the [runAnimation function](globals.html#runanimation) to save yourself from writing boilerplate code. -See its [documentation](globals.html#runanimation) for more details. +If you're planning to create animated content, use the [runAnimation function](functions/run-animation.runAnimation.html) to save yourself from writing boilerplate code. +See its [documentation](functions/run-animation.runAnimation.html) for more details. ## Extending drawables > Iñigo Quilez has a great collection of [2D SDFs](https://iquilezles.org/www/articles/distfunctions2d/distfunctions2d.htm) -- Subclass [Drawable](classes/drawable.html) +- Subclass [Drawable](classes/drawables_drawable.Drawable.html) - Implement its abstract methods -- Add a static `descriptor` property of type [DrawableDescriptor](interfaces/drawabledescriptor.html) to your class +- Add a static `descriptor` property of type [DrawableDescriptor](interfaces/drawables_drawable-descriptor.DrawableDescriptor.html) to your class - Follow the instructions given in [Usage](#usage-1st-option) ## Useful to know