mirror of
https://github.com/GraphiteEditor/Graphite.git
synced 2025-08-30 01:44:07 +00:00
Rename project structure with /core and /client
This commit is contained in:
parent
a8a9e15a4a
commit
4407c671c5
64 changed files with 63 additions and 43 deletions
|
@ -13,20 +13,20 @@
|
|||
|
||||
// Hierarchy
|
||||
|
||||
[<dependencies> Dependencies|
|
||||
[<dependencies> Core Libraries|
|
||||
[<client> Frontend Editor Client]
|
||||
[<client> Headless Editor Client]
|
||||
[<client> Application Client
|
||||
(like a game engine or game that renders .grd graphs at runtime)]
|
||||
[<editor> Editor Library]
|
||||
[<document> Document Library]
|
||||
[<renderer> Renderer Library]
|
||||
[<editor> Editor Core Library]
|
||||
[<document> Document Core Library]
|
||||
[<renderer> Renderer Core Library]
|
||||
|
||||
[Frontend Editor Client] Depends On -> [Editor Library]
|
||||
[Editor Library] Depends On -> [Document Library]
|
||||
[Headless Editor Client] Depends On -> [Document Library]
|
||||
[Document Library] Depends On -> [Renderer Library]
|
||||
[Application Client] Depends On -> [Renderer Library]
|
||||
[Frontend Editor Client] Depends On -> [Editor Core Library]
|
||||
[Editor Core Library] Depends On -> [Document Core Library]
|
||||
[Headless Editor Client] Depends On -> [Document Core Library]
|
||||
[Document Core Library] Depends On -> [Renderer Core Library]
|
||||
[Application Client] Depends On -> [Renderer Core Library]
|
||||
]
|
||||
|
||||
// Client
|
||||
|
|
|
@ -6,9 +6,9 @@ This is a great place to start learning about the Graphite codebase and its arch
|
|||
|
||||
Graphite's core rust codebase is split into three reusable libraries:
|
||||
|
||||
- Graphite Editor Library
|
||||
- Graphite Document Library
|
||||
- Graphite Renderer Library
|
||||
- Graphite Editor Core Library
|
||||
- Graphite Document Core Library
|
||||
- Graphite Renderer Core Library
|
||||
|
||||
Each depends on its successor in the list. These are used internally but also intended for usage by third parties through Rust or linked by a project in C, C++, or another language.
|
||||
|
||||
|
@ -16,22 +16,22 @@ Each depends on its successor in the list. These are used internally but also in
|
|||
|
||||
The main modules of the project architecture are outlined below. Some parts describe future features and the directories don't exist yet. **Bold** modules are required for Graphite 0.1 which is purely an SVG editor.
|
||||
|
||||
- **Web frontend**: `/web-frontend/`
|
||||
- **Web frontend**: `/client/web/`
|
||||
Initial GUI for Graphite that will eventually be replaced by a native GUI implementation
|
||||
- **Vue web app**: `src/`
|
||||
Imports the WASM code and uses Vue props to customize and reuse most GUI components
|
||||
- **Rust WebAssembly wrapper**: `wasm-wrapper/`
|
||||
Wraps the Graphite Editor Library and provides an API for the web app to use unburdened by Rust's complex data types that are not supported by WASM
|
||||
- Native frontend: `/editor-client/`
|
||||
- **Rust WebAssembly wrapper**: `wasm/`
|
||||
Wraps the Editor Core Library and provides an API for the web app to use unburdened by Rust's complex data types that are not supported by WASM
|
||||
- Native frontend: `/client/native/`
|
||||
The future official desktop client. Blocked on Rust's GUI ecosystem improving or dedicating the time to build a custom system that can nicely support editor extensions. The whole GUI should use WGPU for rendering and compile to WASM to make those calls to the WebGPU API.
|
||||
- CLI: `/packages/cli/`
|
||||
A headless, command line GDD document editor (using the Graphite Document Library) and GRD render graph renderer (using the Graphite Renderer Library). Not the initial focus of development, but perhaps useful in testing for certain features throughout the development process. A future version of the CLI will probably redesign the command structure.
|
||||
- **Graphite Editor Library**: `/packages/graphite-editor/`
|
||||
Used by a frontend editor client to maintain GUI state and dispatch user events. The official Graphite editor is the primary user, but others software like game engines could embed their own customized editor implementations. Depends on the Graphite Document Library.
|
||||
- Graphite Document Library: `/packages/graphite-document/`
|
||||
A stateless library for updating Graphite design document (GDD) files. The official Graphite CLI and Graphite Editor Library are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of updating GDD files by sending edit operations. Optionally depends on the Graphite Renderer Library if rendering is required.
|
||||
- Graphite Renderer Library: `/packages/graphite-renderer/`
|
||||
A stateless library (with the help of in-memory and/or on-disk caches for performance) for rendering Graphite's render graph (GRD) files. The official Graphite CLI and Graphite Document Library are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of rendering Graphite's render graphs. For example, games can link the library and render procedural textures with customizable parametric input values.
|
||||
- CLI: `/client/cli/`
|
||||
A headless, command line GDD document editor (using the Document Core Library) and GRD render graph renderer (using the Renderer Core Library). Not the initial focus of development, but perhaps useful in testing for certain features throughout the development process. A future version of the CLI will probably redesign the command structure.
|
||||
- **Graphite Editor Core Library**: `/core/editor/`
|
||||
Used by a frontend editor client to maintain GUI state and dispatch user events. The official Graphite editor is the primary user, but others software like game engines could embed their own customized editor implementations. Depends on the Document Core Library.
|
||||
- Graphite Document Core Library: `/core/document/`
|
||||
A stateless library for updating Graphite design document (GDD) files. The official Graphite CLI and Editor Core Library are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of updating GDD files by sending edit operations. Optionally depends on the Renderer Core Library if rendering is required.
|
||||
- Graphite Renderer Core Library: `/core/renderer/`
|
||||
A stateless library (with the help of in-memory and/or on-disk caches for performance) for rendering Graphite's render graph (GRD) files. The official Graphite CLI and Document Core Library are the primary users, but this library is intended to be useful to any application that wants to link the library for the purpose of rendering Graphite's render graphs. For example, games can link the library and render procedural textures with customizable parametric input values.
|
||||
|
||||
## Architecture diagram
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue