andras/sdf-2d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Finish documentation

Browse source
This commit is contained in:
schmelczerandras 2020-09-28 16:26:55 +02:00
parent 49473bf905
commit 31fcfd3d6b
86 changed files with 1383 additions and 8485 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/main.ts
View file

@ -13,6 +13,7 @@ import { Renderer } from './graphics/rendering/renderer/renderer';
import { StartupSettings } from './graphics/rendering/settings/startup-settings';
import { applyArrayPlugins } from './helper/array';
/** @internal */
declare global {
interface Array<T> {
x: number;
@ -29,8 +30,8 @@ applyArrayPlugins();
/**
* Compiles a new renderer instance. There can multiple renderers on a single page.
* > Asynchronous behaviour is required for paralell shader compiling.
* > Trying to draw before the returned promise resolves results in no action taken.
* > Asynchronous behaviour is required for parallel shader compiling.
* > Trying to draw before the returned promise resolves, results in no action taken.
* > Settings can be set before promise resolution and they will be applied later.
*
* The descriptors of every to-be-drawn objects are required before creating the renderer,
@ -48,9 +49,7 @@ applyArrayPlugins();
* @param canvas The returned renderer will only be able to draw to this canvas.
* @param descriptors The descriptor of every single object (and light) that
* ever needs to be drawn by this renderer has to be given before compiling.
* @param settingsOverrides Sensible defaults are provided, but these can be overriden.
*
* @category Startup
* @param settingsOverrides Sensible defaults are provided, but these can be overridden.
*/
export async function compile(
canvas: HTMLCanvasElement,