exo/game-engine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(docs): Enhance rendering section in README with G2D renderer details and auto-configuration information

Browse Source
This commit is contained in:
extio-de
2025-12-24 22:55:44 +01:00
parent 65acda613e
commit d5448e2217
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -125,11 +125,21 @@ Both approaches can be mixed within the same application, allowing each module t
**Property**: `game-engine.renderer.enabled` (default: `true`) **Property**: `game-engine.renderer.enabled` (default: `true`)
Requires a `Renderer` implementation bean to be provided (e.g., G2D renderer). The auto-configuration wires together all rendering components and creates a central `RendererData` object containing all necessary dependencies. The core rendering infrastructure is auto-configured by `RendererAutoConfiguration`, which wires together all rendering components and creates a central `RendererData` object containing all necessary dependencies.
**G2D Renderer Implementation**
**Configuration Class**: `G2DAutoConfiguration`
**Properties**:
- `game-engine.renderer.strategy` (default: `g2d`) - Must be set to "g2d" to enable
- `game-engine.renderer.title` - Optional window title
The `G2DAutoConfiguration` provides the default Java2D-based renderer implementation, which is enabled when the renderer strategy is set to "g2d" (the default).
#### Exposed Spring Beans #### Exposed Spring Beans
- **`Renderer`**: Main rendering interface (implementation must be provided) - **`Renderer`**: Main rendering interface (provided by G2DRenderer or custom implementation)
- **`RendererControl`**: Controls renderer settings like title, scale factor, and video options - **`RendererControl`**: Controls renderer settings like title, scale factor, and video options (provided by G2DRendererControl or custom implementation)
- **`RendererData`**: Central data object containing all renderer dependencies - **`RendererData`**: Central data object containing all renderer dependencies
- **`RendererWorkingSet`**: Manages the current set of objects to be rendered - **`RendererWorkingSet`**: Manages the current set of objects to be rendered
- **`RenderingBoPool`**: Factory for creating rendering business objects - **`RenderingBoPool`**: Factory for creating rendering business objects