ajout docs ARENE et GPU_CPU

2026-07-28 21:25:14 +02:00
parent d782469202
commit 2710899292
2 changed files with 250 additions and 0 deletions
@@ -0,0 +1,197 @@
+# Fiche Technique : Gestion des Ressources avec des Arènes Générationalles
+
+Cette fiche technique détaille l'implémentation recommandée pour gérer efficacement et en toute sécurité les ressources (maillages, textures, matériaux, lumières, etc.) au sein du moteur graphique WSG. Nous utilisons le concept d'**arène générationalle**, implémenté via la crate `thunderdome`, pour bénéficier d'IDs stables, de performances optimales et d'une protection contre les erreurs liées à la gestion de la mémoire.
+
+Exemple avec thunderdome, mais il faut aussi évaluer la crate slotmap.
+
+
+## Objectifs
+
+*   **Stabilité des IDs :** Garantir que les identifiants (Handles) des ressources restent valides même si d'autres ressources sont supprimées.
+*   **Performance :** Accéder aux ressources via un ID de manière aussi rapide que possible (accès quasi direct via index).
+*   **Sécurité :** Empêcher l'utilisation accidentelle d'IDs obsolètes ("Dangling IDs") qui pointeraient vers des objets supprimés ou réaffectés.
+*   **Flexibilité :** Permettre l'ajout et la suppression de ressources dynamiquement, tout en encourageant la création groupée initiale pour optimiser la mémoire.
+
+## Concepts Clés
+
+### 1. Arène Typée
+
+Chaque type de ressource nécessite une arène séparée. Par exemple :
+
+*   `MeshArena` pour stocker les `Mesh`
+*   `MaterialArena` pour stocker les `Material`
+*   `TextureArena` pour stocker les `Texture`
+*   `LightArena` pour stocker les `Light`
+
+Cela permet d'optimiser l'accès et de garantir la cohérence des types.
+
+### 2. Handles (Identifiants)
+
+Un Handle est un objet spécial généré par l'arène lors de l'insertion d'une ressource. Il sert de référence stable à cette ressource. Dans `thunderdome`, ce sont des types comme `thunderdome::Key`.
+
+### 3. Génération (Generation)
+
+Pour renforcer la sécurité, chaque Handle encapsule non seulement un **index** (où l'objet est stocké dans le tableau interne de l'arène), mais aussi un numéro de **génération**. Lorsqu'un objet est supprimé, l'emplacement dans le tableau interne est marqué comme vide, mais le numéro de génération associé à cet emplacement est incrémenté. Lorsque ce même emplacement est réutilisé pour un nouvel objet, le nouvel objet reçoit le même index mais une génération plus récente. Si un ancien Handle (avec un index et une ancienne génération) est utilisé pour tenter d'accéder à l'arène, le système vérifie si la génération du Handle correspond à celle stockée à l'index. Si ce n'est pas le cas, l'accès est refusé, empêchant l'utilisation d'un Handle périmé.
+
+## Implémentation avec `thunderdome`
+
+### Dépendance
+
+Ajoutez `thunderdome` à votre `Cargo.toml` :
+
+```toml
+[dependencies]
+thunderdome = "0.5" # Remplacez par la dernière version stable
+```
+
+Structure de Base
+
+```rust
+use thunderdome::{Arena, Index};
+
+// --- Définition des types de ressources ---
+// Ces structs doivent être définies ailleurs dans votre code
+#[derive(Debug)]
+pub struct Mesh {
+    // ... champs du mesh ...
+}
+
+#[derive(Debug)]
+pub struct Material {
+    // ... champs du material ...
+}
+
+#[derive(Debug)]
+pub struct Texture {
+    // ... champs de la texture ...
+}
+
+#[derive(Debug)]
+pub struct Light {
+    // ... champs de la lumière ...
+}
+
+// --- Définition des arènes ---
+pub struct ResourceManager {
+    meshes: Arena<Mesh>,
+    materials: Arena<Material>,
+    textures: Arena<Texture>,
+    lights: Arena<Light>,
+    // Ajoutez d'autres arènes pour d'autres types si nécessaire
+}
+
+impl ResourceManager {
+    pub fn new() -> Self {
+        // Optionnel : spécifier une capacité initiale estimée pour chaque arène
+        // let estimated_mesh_count = 100;
+        // let meshes = Arena::with_capacity(estimated_mesh_count);
+        // ...
+        Self {
+            meshes: Arena::new(),
+            materials: Arena::new(),
+            textures: Arena::new(),
+            lights: Arena::new(),
+        }
+    }
+
+    // --- Méthodes pour ajouter des ressources ---
+    pub fn add_mesh(&mut self, mesh: Mesh) -> Index { // Retourne un Handle (Index)
+        self.meshes.insert(mesh)
+    }
+
+    pub fn add_material(&mut self, material: Material) -> Index {
+        self.materials.insert(material)
+    }
+
+    pub fn add_texture(&mut self, texture: Texture) -> Index {
+        self.textures.insert(texture)
+    }
+
+    pub fn add_light(&mut self, light: Light) -> Index {
+        self.lights.insert(light)
+    }
+
+    // --- Méthodes pour accéder aux ressources ---
+    pub fn get_mesh(&self, handle: Index) -> Option<&Mesh> {
+        self.meshes.get(handle)
+    }
+
+    pub fn get_material(&self, handle: Index) -> Option<&Material> {
+        self.materials.get(handle)
+    }
+
+    pub fn get_texture(&self, handle: Index) -> Option<&Texture> {
+        self.textures.get(handle)
+    }
+
+    pub fn get_light(&self, handle: Index) -> Option<&Light> {
+        self.lights.get(handle)
+    }
+
+    // --- Méthodes pour accéder aux ressources mutables (utile dans update(), mais à éviter pendant le rendu) ---
+    pub fn get_mesh_mut(&mut self, handle: Index) -> Option<&mut Mesh> {
+        self.meshes.get_mut(handle)
+    }
+
+    pub fn get_material_mut(&mut self, handle: Index) -> Option<&mut Material> {
+        self.materials.get_mut(handle)
+    }
+
+    pub fn get_texture_mut(&mut self, handle: Index) -> Option<&mut Texture> {
+        self.textures.get_mut(handle)
+    }
+
+    pub fn get_light_mut(&mut self, handle: Index) -> Option<&mut Light> {
+        self.lights.get_mut(handle)
+    }
+
+    // --- Méthodes pour supprimer des ressources ---
+    pub fn remove_mesh(&mut self, handle: Index) -> Option<Mesh> { // Option<T> retourné est la ressource supprimée
+        self.meshes.remove(handle)
+    }
+
+    pub fn remove_material(&mut self, handle: Index) -> Option<Material> {
+        self.materials.remove(handle)
+    }
+
+    pub fn remove_texture(&mut self, handle: Index) -> Option<Texture> {
+        self.textures.remove(handle)
+    }
+
+    pub fn remove_light(&mut self, handle: Index) -> Option<Light> {
+        self.lights.remove(handle)
+    }
+
+    // --- Méthode pour vérifier si un Handle est toujours valide ---
+    pub fn contains_mesh(&self, handle: Index) -> bool {
+        self.meshes.contains_key(handle)
+    }
+
+    pub fn contains_material(&self, handle: Index) -> bool {
+        self.materials.contains_key(handle)
+    }
+
+    pub fn contains_texture(&self, handle: Index) -> bool {
+        self.textures.contains_key(handle)
+    }
+
+    pub fn contains_light(&self, handle: Index) -> bool {
+        self.lights.contains_key(handle)
+    }
+}
+```
+
+## Bonnes Pratiques d'Utilisation
+
+1. Initialisation Groupée : Encouragez les utilisateurs de WSG à créer la majorité de leurs ressources statiques (maillages de niveau, matériaux de base, textures fixes, lumières ambiantes, etc.) avant de lancer la boucle de rendu principale. Vous pouvez éventuellement fournir une fonction reserve_initial_capacities(&mut resource_manager, expected_counts...) qui appelle Arena::reserve() pour optimiser la mémoire initiale.
+2. Stocker les Handles : Les entités de la scène (ou les objets graphiques) doivent stocker les Index (Handles) retournés lors de l'ajout des ressources. Par exemple, un objet GameObject pourrait contenir un Option<Index> pour son Mesh, un Option<Index> pour son Material, etc.
+3. Accès pendant le rendu : Pendant la phase de rendu (render()), accédez aux ressources via les Handles stockés. Utilisez get() (lecture seule) pour éviter les conflits avec les systèmes de mise à jour concurrents.
+4. Accès pendant la mise à jour : Pendant la phase de mise à jour (update()), vous pouvez utiliser get_mut() si des modifications sont nécessaires. Soyez vigilant à la gestion des lifetimes et de la mutabilité.
+5. Validation : Avant d'utiliser un Handle potentiellement ancien ou incertain, vérifiez sa validité avec contains_* si l'opération n'est pas critique, ou laissez get() renvoyer None si le Handle est invalide.
+6. Suppression Dynamique : Bien que possible, la suppression de ressources pendant la boucle de rendu doit être faite avec prudence. Assurez-vous que les entités ou objets qui référençaient cette ressource soient informés ou nettoyés pour éviter d'utiliser des Handles invalides. La suppression est souvent mieux gérée en fin de frame ou via un système de "marquage pour suppression" suivi d'un nettoyage différé.
+
+## Avantages de cette Approche
+Simplicité d'utilisation : Les développeurs utilisent des Handles stables, sans se soucier des références Rust ou des lifetimes complexes pour les ressources partagées.  
+Performance : Les accès sont rapides, proches de l'accès direct via index, grâce à l'implémentation interne de thunderdome.  
+Sécurité : Le système de génération empêche efficacement l'utilisation de Handles invalides, ce qui peut causer des plantages ou des bugs subtils.  
+Conformité avec Rust : Respecte les principes de propriété et de sécurité mémoire de Rust sans recourir à Rc<RefCell<T>> ou d'autres constructions potentiellement coûteuses ou moins sûres pour la gestion partagée des ressources.
@@ -0,0 +1,53 @@
+Architecture de Rendu 3D GPU-Driven avec wGPU : 
+Bonnes Pratiques & Guide d'Implémentation
+
+Ce document sert de spécification technique et de trame d'implémentation pour l'architecture de rendu 3D pilotée par le GPU (GPU-Driven Rendering) utilisant wgpu. L'objectif est de déléguer un maximum de charges de calcul au GPU pour soulager le CPU et maximiser les performances de parallélisme.
+
+1. Répartition des Rôles : CPU vs GPU (La Source de Vérité)
+
+Pour éviter les goulets d'étranglement dus aux allers-retours sur le bus PCIe, la règle d'or est la suivante : Le CPU est le cerveau logique, le GPU est l'exécutant visuel.
+
+Côté CPU (Source de Vérité)
+- Ce qu'il conserve : Les données logiques et les transformations brutes des objets (ex: Vec<Transform> contenant la position, la rotation, et l'échelle).
+- Ce qu'il fait : Il gère la logique de jeu, l'IA, le réseau et les interactions globales.
+- Ce qu'il ne fait plus : Il ne calcule plus les matrices de transformation mondiales (World Matrices) en masse, et ne fait plus de tests de visibilité unitaires.
+
+Côté GPU (Exécutant Autonome)
+- Ce qu'il calcule : Les World Matrices, le Frustum Culling, et la génération des listes de dessin indirectes.
+- Ce qu'il conserve : Les buffers de données persistants en VRAM (Storage Buffers) qui vivent d'une frame à l'autre sans jamais redescendre vers le CPU.
+
+2. Le Pipeline d'Exécution par Frame (Ordre des Passes)
+
+L'exécution des tâches s'appuie sur une structure séquentielle stricte au sein d'un même CommandEncoder. Le driver et wGPU s'occupent des barrières de mémoire implicites entre chaque étape.
+
+```
+[ CPU : Envoi des Transforms bruts ]
+               ↓
+[ Pass 1 : Compute (Calcul World Matrices + Frustum Culling + Indirect Draw Buffer) ]
+               ↓ (Barrière de mémoire automatique gérée par le driver)
+[ Pass 2 : Render (Draw Indexed Indirect basé sur les objets visibles) ]
+```
+
+Étape par étape :
+- Mise à jour CPU (Minimaliste) : Le CPU écrit les transformations brutes (Transform) modifiées dans un buffer GPU mappé (via un mécanisme de Double Buffering pour éviter les conflits de lecture/écriture).
+- Pass de Calcul (Compute Pass) :
+  - Calcul des World Matrices : Un compute shader lit les transformations brutes et génère la matrice 4x4 finale pour chaque mesh.
+  - Frustum Culling GPU : Le même compute shader (ou un compute pass dédié) compare la Bounding Box (AABB) de chaque objet avec les plans de la caméra (matrice de projection/vue).
+  - Remplissage du Buffer Indirect : Si l'objet est visible, son identifiant est injecté dans un buffer de commandes de dessin indirect (Indirect Draw Buffer).
+- Pass de Rendu (Render Pass) :
+  - Le CPU émet une unique commande globale : draw_indexed_indirect.
+  - Le GPU pioche directement dans le buffer préparé par le compute pass et dessine uniquement les objets visibles, sans intervention du CPU.
+  
+3. Stratégie de Synchronisation
+ - Sécurité de l'ordre : L'ordre d'appel des méthodes sur le CommandEncoder (begin_compute_pass suivi de begin_render_pass) garantit l'ordre d'exécution séquentiel sur le GPU.
+ - Barrières de mémoire : Le pilote insère automatiquement les barrières nécessaires pour s'assurer que le buffer de la WorldMatrix et le buffer Indirect sont complètement écrits par le compute shader avant d'être lus par le render pipeline.
+ - Éviter le Readback (map_async) : Sauf cas exceptionnel (débug ou interaction scriptée critique), aucune donnée géométrique ou de position ne doit remonter du GPU vers le CPU. Le CPU fait confiance à sa propre structure de données initiale pour la logique métier.
+
+4. Synthèse des Structures de Données en VRAM
+
+Pour implémenter cette architecture, prévoyez l'utilisation des buffers wGPU suivants :
+Nom du Buffer,Rôle,Type wGPU,Direction du flux
+Transform Buffer,Stocke les positions/rotations/échelles brutes.,Storage Buffer,CPU → GPU
+Matrix Buffer,Stocke les World Matrices finales calculées.,Storage Buffer,GPU (Calculé) → GPU (Lu par le Render)
+Bounding Box Buffer,Stocke les AABB de chaque mesh pour le culling.,Storage Buffer,CPU → GPU (Statique)
+Indirect Draw Buffer,Contient la liste dynamique des objets à dessiner.,Indirect Buffer + Storage,GPU (Rempli par Compute) → GPU (Lu par Render)