Welcome to the Pi-Engine documentation! This index provides an overview and quick links to all major documentation sections and class references in the engine.
Acknowledgment
Much of the documentation for PiEngine was generated with the help of GitHub Copilot (AI), under the supervision and review of the core developers (Shri Hari (TanPi) and Gunavarthan). As a small team with limited time, we used AI tools to accelerate the writing process and ensure comprehensive, high-quality docs for the community. All content was checked and curated by us.
If you find any errors or issues in the documentation, please open an issue so we can fix it promptly.
| Section | Description |
|---|---|
| Math | Math utilities: vectors, matrices, math functions |
| GameObject | Entity system: GameObject, Transform, ID management |
| Components | Attachable behaviors: rendering, camera, custom logic |
| Core | Engine systems: input, timing, window, camera |
| Editor | Editor windows, tools, and extensibility |
- Browse each section for detailed class and function documentation.
- Use the tables and quick links in each section for fast navigation.
- See usage examples and best practices in each package's README.
- For math utilities: MathF, Vector, Matrix4
- For entity logic: GameObject, Transform
- For components: Component, CameraComponent, RendererComponent
- For engine systems: Camera, Input, Time, Window
- For editor windows: Editor, EditorWindow, ConsoleWindow, DockingWindow, FileWindow, HierarchyWindow, InspectorWindow, LayerWindow, NavigationWindow, PerfomanceWindow, RendererInspector, RenderGraphEditorWindow, SceneWindow, ComponentPropertyBlock
- Start with the package README for an overview.
- Use the "See Also" sections for related topics.
- Refer to example code for integration tips.