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

Add main function for animations

Browse source
This commit is contained in:
schmelczerandras 2020-10-19 11:58:07 +02:00
parent e5423212c3
commit a15cb9e19c
3 changed files with 105 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

50
src/main.ts
View file

@ -6,18 +6,12 @@
* @packageDocumentation
*/
import { DrawableDescriptor } from './drawables/drawable-descriptor';
import { Insights } from './graphics/rendering/insights';
import { ContextAwareRenderer } from './graphics/rendering/renderer/context-aware-renderer';
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;
y: number;
x: T;
y: T;
}
interface Float32Array {
@ -28,47 +22,13 @@ declare global {
applyArrayPlugins();
/**
* Compiles a new renderer instance. There can multiple renderers on a single page.
* > 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,
* allowing the compiler to only create the shaders that will actually be used.
*
* Example usage:
*
* ```js
* import { compile, hsl, CircleFactory, CircleLight } from 'sdf-2d';
*
* const canvas = document.querySelector('canvas');
* const Circle = CircleFactory(hsl(30, 66, 50));
* const renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
* ```
*
* @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 overridden.
*/
export async function compile(
canvas: HTMLCanvasElement,
descriptors: Array<DrawableDescriptor>,
settingsOverrides: Partial<StartupSettings> = {}
): Promise<Renderer> {
return Insights.measureFunction('startup', async () => {
const renderer = new ContextAwareRenderer(canvas, descriptors, settingsOverrides);
await renderer.initializedPromise;
return renderer;
});
}
export * from './compile';
export * from './drawables/drawable';
export * from './drawables/drawable-descriptor';
export * from './drawables/lights/circle-light';
export * from './drawables/lights/flashlight';
export * from './drawables/shapes/circle-factory';
export * from './drawables/shapes/colorful-circle';
export * from './drawables/shapes/droplet-factory';
export * from './drawables/shapes/inverted-tunnel-factory';
export * from './drawables/shapes/meta-circle-factory';
@ -84,3 +44,5 @@ export * from './helper/colors/rgb';
export * from './helper/colors/rgb255';
export * from './helper/colors/rgba';
export * from './helper/colors/rgba255';
export * from './helper/delta-time-calculator';
export * from './run-animation';