Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 5.61 KB

README.md

File metadata and controls

118 lines (83 loc) · 5.61 KB

@thi.ng/scenegraph

npm version npm downloads Mastodon Follow

Note

This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

About

Extensible 2D/3D scene graph with @thi.ng/hiccup-canvas support.

Status

ALPHA - bleeding edge / work-in-progress

Search or submit any issues for this package

Related packages

Installation

yarn add @thi.ng/scenegraph

ESM import:

import * as sg from "@thi.ng/scenegraph";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/scenegraph"></script>

JSDelivr documentation

For Node.js REPL:

const sg = await import("@thi.ng/scenegraph");

Package sizes (brotli'd, pre-treeshake): ESM: 975 bytes

Dependencies

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

Usage examples

Three projects in this repo's /examples directory are using this package:

Screenshot Description Live demo Source
2D scenegraph & shape picking Demo Source
2D scenegraph & image map based geometry manipulation Demo Source
Minimal shader graph developed during livestream #2 Demo Source

API

Generated API docs

TODO

Authors

If this project contributes to an academic publication, please cite it as:

@misc{thing-scenegraph,
  title = "@thi.ng/scenegraph",
  author = "Karsten Schmidt",
  note = "https://thi.ng/scenegraph",
  year = 2016
}

License

© 2016 - 2024 Karsten Schmidt // Apache License 2.0