@lightningjs/renderer 0.9.3 → 1.0.0-rc.0

package/README.md

@@ -89,88 +89,6 @@ See [docs/ManualRegressionTests.md].
 
 See [RELEASE.md](./RELEASE.md)
 
-## Main Space vs Core Space
-
-The Lightning 3 Renderer runs code in two logically seperate environments:
-the **Main Space** and the **Core Space**.
-
-Users of the Renderer will write most of their code for the Main Space using
-the **Main API**. This is code that will always run on the browser's main thread
-and includes initializing the Renderer, creating/modifying/destroying nodes,
-controlling animations, etc.
-
-The Core Space is where the actual rendering of each UI frame happens and is
-mostly meant to be transparent to users of the Renderer. However, the Core Space
-is where all of the code that must be tightly coupled to the rendering process
-must be loaded and run. The Core Space is extendible by users by writing
-**Core Extensions** via the **Core API**. This allows for users to develop their
-own shaders, textures, text renderers, dynamic shader effects, and more. Fonts
-used in an application must be loaded in this way too. The Core Space exists
-seperately from the Main Space because it is allowed to execute on the page's
-main thread OR a Web Worker thread. A **Core Driver** (see below) is used to
-bridge the Main Space with the Core Space.
-
-## Core Drivers
-
-The Lightning 3 Renderer is designed to be able to use a single thread or
-multiple web worker threads based on the configuration of a **Core Driver**.
-
-A Core Driver essentially acts as a bridge between the Main and Core spaces
-defined above.
-
-The Renderer comes with two Core Drivers: the Main Core Driver for single
-threaded rendering and the ThreadX Core Driver for multi-threaded rendering.
-
-NOTE: The ThreadX Core Driver is experimental and even when the Renderer
-graduates from beta may still not be ready for production use.
-
-### Main Core Driver
-
-The Main Core Driver renders your application on the web page's main thread.
-
-It can be configured into the Renderer like so:
-
-```ts
-import { MainCoreDriver, RendererMain } from '@lightningjs/renderer';
-
-const renderer = new RendererMain(
-  {
-    // App Config
-  },
-  'app', // App div ID
-  new MainCoreDriver(), // Main Render driver
-);
-
-// ...
-```
-
-### ThreadX Core Driver
-
-The ThreadX Core Driver renders your application on a seperately spawned
-Web Worker thread.
-
-It can be configured into the Renderer like so:
-
-```ts
-import {
-  ThreadXCoreDriver,
-  RendererMain,
-} from '@lightningjs/renderer';
-
-// The `@lightningjs/vite-plugin-import-chunk-url` Vite plugin is required for this:
-import coreWorkerUrl from './common/CoreWorker.js?importChunkUrl';
-
-const renderer = new RendererMain(
-  {
-    // App Config
-  },
-  'app', // App div ID
-  new ThreadXCoreDriver({
-    coreWorkerUrl,
-  });
-);
-```
-
 ## Core Extensions
 
 To load fonts, and/or other custom code into the Core Space, you must write a

package/dist/exports/index.d.ts

@@ -1,3 +1,40 @@
-export * from './main-api.js';
-export * from './core-api.js';
-export * from './utils.js';
+/**
+ * Lightning 3 Renderer API
+ *
+ * @remarks
+ * This module exports the API for the Lightning 3 Renderer. You
+ * can import the exports from this module like so:
+ * ```ts
+ * import { Renderer } from '@lightning/renderer';
+ * ```
+ *
+ * Generally developers/frameworks using the Renderer will use the Main API to
+ * render applications.
+ *
+ * Do not confuse the Main API with the Core API which is used to extend
+ * capabilities of the Renderer. The Main API code always runs from the main
+ * thread.
+ *
+ * @module
+ */
+export * from '../src/main-api/INode.js';
+export * from '../src/main-api/Renderer.js';
+export * from '../src/common/IAnimationController.js';
+export * from '../src/common/CommonTypes.js';
+export type { TextureMap } from '../src/core/CoreTextureManager.js';
+export type { MemoryInfo } from '../src/core/TextureMemoryManager.js';
+export type { ShaderMap, EffectMap } from '../src/core/CoreShaderManager.js';
+export type { TextRendererMap } from '../src/core/text-rendering/renderers/TextRenderer.js';
+export type { TrFontFaceMap } from '../src/core/text-rendering/font-face-types/TrFontFace.js';
+export type { AnimationSettings } from '../src/core/animations/CoreAnimation.js';
+export type { EffectProps, FadeOutEffectProps, LinearGradientEffectProps, RadialGradientEffectProps, GrayscaleEffectProps, GlitchEffectProps, RadialProgressEffectProps, } from '../src/core/CoreShaderManager.js';
+export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
+export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
+export * from '../src/core/textures/Texture.js';
+export * from '../src/core/text-rendering/renderers/TextRenderer.js';
+export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
+export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
+export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
+export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
+export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
+export type * from '../src/core/Stage.js';

package/dist/exports/index.js

@@ -16,7 +16,39 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './main-api.js';
-export * from './core-api.js';
-export * from './utils.js';
+/**
+ * Lightning 3 Renderer API
+ *
+ * @remarks
+ * This module exports the API for the Lightning 3 Renderer. You
+ * can import the exports from this module like so:
+ * ```ts
+ * import { Renderer } from '@lightning/renderer';
+ * ```
+ *
+ * Generally developers/frameworks using the Renderer will use the Main API to
+ * render applications.
+ *
+ * Do not confuse the Main API with the Core API which is used to extend
+ * capabilities of the Renderer. The Main API code always runs from the main
+ * thread.
+ *
+ * @module
+ */
+export * from '../src/main-api/INode.js';
+export * from '../src/main-api/Renderer.js';
+export * from '../src/common/IAnimationController.js';
+export * from '../src/common/CommonTypes.js';
+// Shaders
+export * from '../src/core/renderers/webgl/WebGlCoreShader.js';
+export * from '../src/core/renderers/webgl/shaders/effects/ShaderEffect.js';
+// Textures
+export * from '../src/core/textures/Texture.js';
+// Text Rendering & Fonts
+export * from '../src/core/text-rendering/renderers/TextRenderer.js';
+export * from '../src/core/text-rendering/renderers/CanvasTextRenderer.js';
+export * from '../src/core/text-rendering/renderers/SdfTextRenderer/SdfTextRenderer.js';
+export * from '../src/core/text-rendering/font-face-types/TrFontFace.js';
+export * from '../src/core/text-rendering/font-face-types/WebTrFontFace.js';
+export * from '../src/core/text-rendering/font-face-types/SdfTrFontFace/SdfTrFontFace.js';
 //# sourceMappingURL=index.js.map

package/dist/exports/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../exports/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../exports/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AACtD,cAAc,8BAA8B,CAAC;AAoB7C,UAAU;AACV,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6DAA6D,CAAC;AAE5E,WAAW;AACX,cAAc,iCAAiC,CAAC;AAEhD,yBAAyB;AACzB,cAAc,sDAAsD,CAAC;AACrE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,yEAAyE,CAAC;AACxF,cAAc,0DAA0D,CAAC;AACzE,cAAc,6DAA6D,CAAC;AAC5E,cAAc,2EAA2E,CAAC"}