andras/sdf-2d
andras/sdf-2d
Watch
1
0
Fork
You've already forked sdf-2d
 0
Code Issues Pull requests 5 Projects Releases Packages Wiki Activity Actions

Update links

Browse source
This commit is contained in:
Andras Schmelczer 2026-10-27 15:45:05 +00:00
commit f8e91374bb
1 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

16
documentation-readme.md
View file

@ -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