Refactor type registration

Author: LunaTheFoxgirl

building-a-renderer.md

@@ -12,19 +12,26 @@ This data is sent to you through a series of `DrawCmd` instances.
 
 ```d
 struct DrawCmd {
-    Texture[8] sources;
-    uint32_t state;
-    float opacity;
-    uint32_t blendMode;
-    uint32_t maskMode;
-    uint32_t vtxOffset;
-    uint32_t idxOffset;
-    uint32_t elemCount;
+    in_texture_t*[8]    sources;
+    in_drawstate_t      state;
+    in_blend_mode_t     blendMode;
+    in_mask_mode_t      maskMode;
+    uint32_t            vtxOffset;
+    uint32_t            idxOffset;
+    uint                type;
+    void[64]            vars;
 }
 ```
 
 Inochi2D is capable of providing these draw lists with the assumption that your renderer supports index/element data, and optionally, vertex offsets. If your API does not support vertex offsets, set `useBaseVertex` in the Draw List to `false`.
 
+### Variables
+
+Some nodes in Inochi2D provide further data needed to render the the node, these are provided in
+`vars`, up to 64 bytes of variable space is allocated per draw command. Read the individual Node's
+documentation for which variables are stored within. The `type` variable can be used to determine which
+node type the data pertains to. 
+
 ## DrawState
 
 Inochi2D's rendering pipeline is rather complex, the framework supports masking and multi-layered compositing. As such, `DrawState` supplies flags for you to determine how to handle individual commands.
@@ -44,4 +51,30 @@ Inochi2D's rendering pipeline is rather complex, the framework supports masking
 You can then during `maskedDraw` add this texture to your pass, multiply `rgba` with `rrrr` from the mask texture.
 * On the transition from `maskedDraw` to `normal`, if you are not using unique shaders for `normal` you may want to clear the mask texture with all `0xFF`.
 * `compositeEnd` **may** be followed by `defineMask`, ensure that `compsiteBlit` is able to use the defined mask.
-* `compositeBlit` *should* be implemented by drawing a viewport-filling quad, an NDC mesh is provided for you in this DrawState to make it easier.
+* `compositeBlit` *should* be implemented by drawing a viewport-filling quad, an NDC mesh is provided for you in this DrawState to make it easier.
+
+## Registered Types
+
+Following is a list of all currently registered types, all types have a 32 bit type ID,
+with `0x00000000` to `0x0000FFFF` being reserved by Inochi2D.
+
+Following is a table of all the base node types of Inochi2D.
+
+|         ID | Name            |
+| ---------: | :-------------- |
+| 0x00000000 | Node            |
+| 0x00000001 | Drawable        |
+| 0x00000101 | Part            |
+| 0x00000201 | AnimatedPart    |
+| 0x00000002 | Deformer        |
+| 0x00000102 | MeshGroup       |
+| 0x00000202 | LatticeDeformer |
+| 0x00000003 | Driver          |
+| 0x00000103 | SimplePhysics   |
+| 0x00000004 | Composite       |
+
+All Inochi2D node types follow a numeric ID sequence of `0x0000SSBB` where  
+ * `SS` is the subnode id
+ * `BB` is the supernode id
+
+Part has ID 0x00000101, as it's type `01` (Part), derived from type `01` (Drawable)

source/inochi2d/cffi/render.d

@@ -217,14 +217,15 @@ enum in_blend_mode_t
     A drawing command from the Inochi2D draw list
 */
 struct in_drawcmd_t {
-    in_texture_t*[IN_MAX_ATTACHMENTS] sources;
-    in_drawstate_t state;
-    float opacity;
-    in_blend_mode_t blendMode;
-    in_mask_mode_t maskMode;
-    uint vtxOffset;
-    uint idxOffset;
-    uint elemCount;
+    in_texture_t*[IN_MAX_ATTACHMENTS]   sources;
+    in_drawstate_t                      state;
+    in_blend_mode_t                     blendMode;
+    in_mask_mode_t                      maskMode;
+    uint                                vtxOffset;
+    uint                                idxOffset;
+    uint                                elemCount;
+    uint                                type;
+    void[64]                            vars;
 }
 
 /**

source/inochi2d/core/nodes/composite/package.d

@@ -18,10 +18,17 @@ import std.exception;
 public import inochi2d.core.render.state;
 import numem;
 
+struct CompositeVars {
+align(vec4.sizeof):
+    vec3 tint;
+    vec3 screenTint;
+    float opacity;
+}
+
 /**
     Composite Node
 */
-@TypeId("Composite")
+@TypeId("Composite", 0x0004)
 class Composite : Node {
 private:
     DrawListAlloc* __screenSpaceAlloc;
@@ -139,9 +146,6 @@ protected:
     vec3 offsetTint = vec3(0);
     vec3 offsetScreenTint = vec3(0);
 
-    override
-    string typeId() { return "Composite"; }
-
     // TODO: Cache this
     size_t maskCount() {
         size_t c;
@@ -332,6 +336,12 @@ public:
         if (!renderEnabled || toRender.length == 0)
             return;
 
+        CompositeVars compositeVars = CompositeVars(
+            tint*offsetTint,
+            screenTint*offsetScreenTint,
+            opacity*offsetOpacity
+        );
+
         this.selfSort();
 
         // Push sub render area.
@@ -348,7 +358,7 @@ public:
         }
 
         // Then blit it to the main framebuffer
-        drawList.setOpacity(offsetOpacity);
+        drawList.setVariables!CompositeVars(nid, compositeVars);
         drawList.setMesh(__screenSpaceAlloc);
         drawList.setDrawState(DrawState.compositeBlit);
         drawList.setBlending(blendingMode);

source/inochi2d/core/nodes/deformer/latticedeformer.d

@@ -15,7 +15,7 @@ import inmath.linalg;
     A deformer which uses a 2D lattice as the basis for
     its deformation.
 */
-@TypeId("LatticeDeformer")
+@TypeId("LatticeDeformer", 0x0202)
 class LatticeDeformer : Deformer {
 private:
     int subdivs;
@@ -73,6 +73,4 @@ public:
     override void resetDeform() {
 
     }
-
-    override string typeId() { return "LatticeDeformer"; }
 }

source/inochi2d/core/nodes/deformer/meshdeformer.d

@@ -20,7 +20,7 @@ import numem;
     A deformer which deforms child nodes stored within it,
 
 */
-@TypeId("MeshGroup")
+@TypeId("MeshGroup", 0x0102)
 class MeshDeformer : Deformer {
 private:
     Mesh mesh_;
@@ -247,9 +247,6 @@ public:
         super.rescan();
         this.rebuildStructures();
     }
-
-    override
-    string typeId() { return "MeshGroup"; }
 }
 
 private

source/inochi2d/core/nodes/deformer/package.d

@@ -21,6 +21,8 @@ public import inochi2d.core.nodes.deformer.latticedeformer;
 
     Deformations happen in world space
 */
+@TypeId("Deformer", 0x0002)
+@TypeIdAbstract
 abstract
 class Deformer : Node, IDeformable {
 private:

source/inochi2d/core/nodes/drawable/apart.d

@@ -6,18 +6,7 @@ import inochi2d.core.math;
 /**
     Parts which contain spritesheet animation
 */
-@TypeId("AnimatedPart")
+@TypeId("AnimatedPart", 0x0201)
 class AnimatedPart : Part {
-private:
 
-protected:
-    override
-    string typeId() { return "AnimatedPart"; }
-
-public:
-
-    /**
-        The amount of splits in the texture
-    */
-    vec2i splits;
 }

source/inochi2d/core/nodes/drawable/package.d

@@ -20,20 +20,15 @@ public import inochi2d.core.mesh;
 public import inochi2d.core.nodes.drawable.part;
 public import inochi2d.core.nodes.drawable.apart;
 
-package(inochi2d)
-void inInitDrawable() {
-    inRegisterNodeType!Part;
-}
-
 /**
     Nodes that are meant to render something in to the Inochi2D scene
     Other nodes don't have to render anything and serve mostly other 
     purposes.
 
     The main types of Drawables are Parts and Masks
 */
-
-@TypeId("Drawable")
+@TypeId("Drawable", 0x0001)
+@TypeIdAbstract
 abstract class Drawable : Node, IDeformable {
 private:
     Mesh mesh_;
@@ -192,7 +187,4 @@ public:
     void drawAsMask(float delta, DrawList drawList, MaskingMode mode) {
         drawList.setMesh(drawListSlot);
     }
-
-    override
-    string typeId() { return "Drawable"; }
 }

source/inochi2d/core/nodes/drawable/part.d

@@ -28,17 +28,22 @@ enum TextureUsage : size_t {
     COUNT
 }
 
+struct PartVars {
+align(vec4.sizeof):
+    vec3 tint;
+    vec3 screenTint;
+    float opacity;
+    float emissionStrength;
+}
+
 /**
     Dynamic Mesh Part
 */
-@TypeId("Part")
+@TypeId("Part", 0x0101)
 class Part : Drawable {
 private:
 protected:
 
-    override
-    string typeId() { return "Part"; }
-
     /**
         Allows serializing self data (with pretty serializer)
     */
@@ -101,19 +106,6 @@ protected:
     vec3 offsetTint = vec3(0);
     vec3 offsetScreenTint = vec3(0);
 
-    // TODO: Cache this
-    size_t maskCount() {
-        size_t c;
-        foreach(m; masks) if (m.mode == MaskingMode.mask) c++;
-        return c;
-    }
-
-    size_t dodgeCount() {
-        size_t c;
-        foreach(m; masks) if (m.mode == MaskingMode.dodge) c++;
-        return c;
-    }
-
 public:
     /**
         List of textures this part can use
@@ -273,16 +265,15 @@ public:
     override
     float getValue(string key) {
         switch(key) {
-            case "alphaThreshold":  return offsetMaskThreshold;
-            case "opacity":         return offsetOpacity;
-            case "tint.r":          return offsetTint.x;
-            case "tint.g":          return offsetTint.y;
-            case "tint.b":          return offsetTint.z;
-            case "screenTint.r":    return offsetScreenTint.x;
-            case "screenTint.g":    return offsetScreenTint.y;
-            case "screenTint.b":    return offsetScreenTint.z;
+            case "opacity":             return offsetOpacity;
+            case "tint.r":              return offsetTint.x;
+            case "tint.g":              return offsetTint.y;
+            case "tint.b":              return offsetTint.z;
+            case "screenTint.r":        return offsetScreenTint.x;
+            case "screenTint.g":        return offsetScreenTint.y;
+            case "screenTint.b":        return offsetScreenTint.z;
             case "emissionStrength":    return offsetEmissionStrength;
-            default:                return super.getValue(key);
+            default:                    return super.getValue(key);
         }
     }
 
@@ -322,6 +313,13 @@ public:
     void draw(float delta, DrawList drawList) {
         if (!renderEnabled)
             return;
+
+        PartVars vars = PartVars(
+            tint*offsetTint,
+            screenTint*offsetScreenTint,
+            opacity*offsetOpacity,
+            emissionStrength*offsetEmissionStrength
+        );
 
         if (masks.length > 0) {
             foreach(ref mask; masks) {
@@ -331,7 +329,7 @@ public:
 
             super.draw(delta, drawList);
             drawList.setDrawState(DrawState.maskedDraw);
-            drawList.setOpacity(offsetOpacity);
+            drawList.setVariables!PartVars(nid, vars);
             drawList.setBlending(blendingMode);
             drawList.setSources(textures);
             drawList.next();
@@ -341,7 +339,7 @@ public:
         super.draw(delta, drawList);
         drawList.setSources(textures);
         drawList.setBlending(blendingMode);
-        drawList.setOpacity(offsetOpacity);
+        drawList.setVariables!PartVars(nid, vars);
         drawList.next();
     }
 

source/inochi2d/core/nodes/drivers/package.d

@@ -15,7 +15,8 @@ public import inochi2d.core.nodes.drivers.simplephysics;
 /**
     Driver abstract node type
 */
-@TypeId("Driver")
+@TypeId("Driver", 0x00000003)
+@TypeIdAbstract
 abstract class Driver : Node {
 protected:
     this() { }