EsenthalEngine/Engine/H/Graphics/Renderer Instancing.h

/******************************************************************************/
#if EE_PRIVATE
/******************************************************************************/
// INSTANCE
/******************************************************************************/
#define INSTANCE_PTR 1 // if store 'MeshPart.Variation' as pointer or index (pointer uses 8 bytes of memory, index 4 bytes, pointer doesn't need 'if' in the draw call, while index needs it)

#define PER_INSTANCE_VEL     1
#define PER_INSTANCE_ANG_VEL 0 // TODO: add support for this
/******************************************************************************/
extern Memc<Material::MaterialShader> MaterialShaders;

struct EarlyZInstance
{
 C MeshRender *mesh;
   Matrix      view_matrix;

   EarlyZInstance& set(C MeshRender &mesh);
};
extern Memc<EarlyZInstance> EarlyZInstances[2];

struct ShaderDraw
{
   Int         last_shader_material, first_shader_material; // keep 'last_shader_material' as first member, because it's used most often
   ShaderBase *shader;

   void unlink() {shader->unlink();}
};
extern Memc<ShaderDraw> ShaderDraws, MultiMaterialShaderDraws;

struct ShaderMaterial
{
   Int next_shader_material, last_shader_material_mesh, first_shader_material_mesh; // keep 'next_shader_material' as first member, because it's used most often
#if SUPPORT_MATERIAL_CHANGE_IN_RENDERING
   union
   {
      Material                *material;
      UniqueMultiMaterialData *umm;
   };
#else
   // no need to store the material because we can obtain it from 'ShaderMaterialMesh'
#endif

   void unlink();
};
extern Memc<ShaderMaterial> ShaderMaterials;

struct ShaderMaterialMesh
{
   Int       next_shader_material_mesh, first_instance; // keep 'next_shader_material_mesh' as first member, because it's used most often
 C MeshPart *mesh;
#if SUPPORT_MATERIAL_CHANGE_IN_RENDERING
   void unlink() {mesh->unlink();} // have to unlink all variations because we don't store pointer to variation
#else
   #if INSTANCE_PTR
    C MeshPart::Variation *variation;
    C MeshPart::Variation& Variation()C {return *variation;}
   #else
      Int                  variation_1; // this is "variation-1"
    C MeshPart::Variation& Variation()C {return mesh->getVariation1(variation_1);}
   #endif
   void unlink() {Variation().unlink();}
#endif
};
extern Memc<ShaderMaterialMesh> ShaderMaterialMeshes;

struct SolidShaderMaterialMeshInstance
{
   Int                      next_instance; // index of next instance in the same shader/material/mesh group in 'SolidShaderMaterialMeshInstances' container, keep 'next_instance' as first member, because it's used most often
   Vec                      vel, ang_vel_shader;
   Matrix                   view_matrix;
 C Memc<ShaderParamChange> *shader_param_changes;
   Color                    highlight;
   Byte                     stencil_value;

   SolidShaderMaterialMeshInstance& set();
   SolidShaderMaterialMeshInstance& setSkipVel();
   SolidShaderMaterialMeshInstance& set(C Vec &vel, C Vec &ang_vel_shader);
};
extern Memc<SolidShaderMaterialMeshInstance> SolidShaderMaterialMeshInstances;

struct ShadowShaderMaterialMeshInstance
{
   Int                      next_instance; // index of next instance in the same shader/material/mesh group in 'ShadowShaderMaterialMeshInstances' container, keep 'next_instance' as first member, because it's used most often
   Matrix                   view_matrix;
 C Memc<ShaderParamChange> *shader_param_changes;

   ShadowShaderMaterialMeshInstance& set();
};
extern Memc<ShadowShaderMaterialMeshInstance> ShadowShaderMaterialMeshInstances;

struct AmbientInstance // ambient instances are stored in a simple way, without categorizing to shaders/materials, so we don't have to store one extra "MaterialShader _ambient_material_shader" in 'Material', also ambient instances are almost never used
{
 C MeshPart *mesh;
#if SUPPORT_MATERIAL_CHANGE_IN_RENDERING
   Shader   *shader;
   Material *material;
   #if COUNT_MATERIAL_USAGE
     ~AmbientInstance() {material->decUsage();} // for ambient, material will always be != null, because only materials with ambient value can create ambient instances
   #endif
#else
   #if INSTANCE_PTR
    C MeshPart::Variation *variation;
    C MeshPart::Variation& Variation()C {return *variation;}
   #else
      Int                  variation_1; // this is "variation-1"
    C MeshPart::Variation& Variation()C {return mesh->getVariation1(variation_1);}
   #endif
   #if COUNT_MATERIAL_USAGE
     ~AmbientInstance() {Variation().material->decUsage();} // for ambient, material will always be != null, because only materials with ambient value can create ambient instances
   #endif
#endif
   Matrix                   view_matrix;
 C Memc<ShaderParamChange> *shader_param_changes;

   AmbientInstance& set(C MeshPart &mesh, C MeshPart::Variation &variation);
};
extern Memc<AmbientInstance> AmbientInstances;
/******************************************************************************/
// SKELETON
/******************************************************************************/
struct SkeletonShaderMaterial
{
 C Material *material; // keep this as first member, because it's used most often
   Int       next_skeleton_shader_material, first_mesh_instance, last_mesh_instance;

#if COUNT_MATERIAL_USAGE
  ~SkeletonShaderMaterial() {if(material)material->decUsage();}
#endif
};
extern Memc<SkeletonShaderMaterial> SkeletonShaderMaterials, SkeletonBlendShaderMaterials;

struct SkeletonShaderMaterialMeshInstance
{
   Int                      next_instance; // keep this as first member, because it's used most often
 C MeshRender              *mesh;
 C Memc<ShaderParamChange> *shader_param_changes;

   void set(C MeshRender &mesh);
   void set(C MeshPart   &mesh) {set(mesh.render);}
};
extern Memc<SkeletonShaderMaterialMeshInstance> SkeletonShadowShaderMaterialMeshInstances;

STRUCT(SkeletonSolidShaderMaterialMeshInstance , SkeletonShaderMaterialMeshInstance)
//{
   Color highlight;

   void set(C MeshRender &mesh);
   void set(C MeshPart   &mesh) {set(mesh.render);}
};
extern Memc<SkeletonSolidShaderMaterialMeshInstance> SkeletonSolidShaderMaterialMeshInstances;

STRUCT(SkeletonBlendShaderMaterialMeshInstance , SkeletonSolidShaderMaterialMeshInstance)
//{
   STENCIL_MODE stencil_mode;

   void set(C MeshRender &mesh);
   void set(C MeshPart   &mesh) {set(mesh.render);}
};
extern Memc<SkeletonBlendShaderMaterialMeshInstance> SkeletonBlendShaderMaterialMeshInstances;

struct SkeletonShader
{
   ShaderBase            *shader; // keep this as first member, because it's used most often
   SkeletonShaderMaterial material;
   Int                    next_skeleton_shader;
};
extern Memc<SkeletonShader> SkeletonShaders;

struct SkeletonBlendShader : SkeletonShader
{
   Byte type; // BlendInstance::TYPE
};
extern Memc<SkeletonBlendShader> SkeletonBlendShaders;

struct SkeletonInstance
{
 C AnimatedSkeleton *anim_skel;
   SkeletonShader    skel_shader;

   void set(C AnimatedSkeleton &anim_skel);
   void newInstance(ShaderBase &shader, C Material &material, Memc<SkeletonShaderMaterialMeshInstance> &instances);

   void unlinkSolid () {anim_skel->_instance.solid =-1;}
   void unlinkBlend () {anim_skel->_instance.blend =-1;}
   void unlinkShadow() {anim_skel->_instance.shadow=-1;}
};
struct SkeletonBlendInstance
{
 C AnimatedSkeleton   *anim_skel;
   SkeletonBlendShader skel_shader;

   void set(C AnimatedSkeleton &anim_skel);
   void newInstance(ShaderBase &shader, C Material &material, UInt type);

   void addBlend(Shader &shader, C Material &material, C MeshPart &mesh);
   void addBlend(BLST   &blst  , C Material &material, C MeshPart &mesh);
   void addFur  (Shader &shader, C Material &material, C MeshPart &mesh);

   void unlinkSolid () {anim_skel->_instance.solid =-1;}
   void unlinkBlend () {anim_skel->_instance.blend =-1;}
   void unlinkShadow() {anim_skel->_instance.shadow=-1;}
};

struct SkeletonInstances : Memc<SkeletonInstance>
{
          SkeletonInstance& getSkeletonInstance      (C AnimatedSkeleton &anim_skel, Int &instance_index);
   INLINE SkeletonInstance& getSkeletonInstanceSolid (C AnimatedSkeleton &anim_skel) {return getSkeletonInstance(anim_skel, anim_skel._instance.solid );}
   INLINE SkeletonInstance& getSkeletonInstanceShadow(C AnimatedSkeleton &anim_skel) {return getSkeletonInstance(anim_skel, anim_skel._instance.shadow);}
};
extern SkeletonInstances SkeletonSolidInstances, SkeletonShadowInstances;

struct SkeletonAmbientInstance // ambient instances are stored in a simple way, without categorizing to shaders/materials, so we don't have to store one extra "Int _ambient" in 'AnimatedSkeleton', also ambient instances are almost never used
{
 C MeshPart *mesh;
#if SUPPORT_MATERIAL_CHANGE_IN_RENDERING
   Shader   *shader;
 C Material *material;
   #if COUNT_MATERIAL_USAGE
     ~SkeletonAmbientInstance() {material->decUsage();} // for ambient, material will always be != null, because only materials with ambient value can create ambient instances
   #endif
#else
   #if INSTANCE_PTR
    C MeshPart::Variation *variation;
    C MeshPart::Variation& Variation()C {return *variation;}
   #else
      Int                  variation_1; // this is "variation-1"
    C MeshPart::Variation& Variation()C {return mesh->getVariation1(variation_1);}
   #endif
   #if COUNT_MATERIAL_USAGE
     ~SkeletonAmbientInstance() {Variation().material->decUsage();} // for ambient, material will always be != null, because only materials with ambient value can create ambient instances
   #endif
#endif
 C AnimatedSkeleton        *anim_skel;
 C Memc<ShaderParamChange> *shader_param_changes;

   void set(C MeshPart &mesh, C MeshPart::Variation &variation, C AnimatedSkeleton &anim_skel);
};
extern Memc<SkeletonAmbientInstance> SkeletonAmbientInstances;
/******************************************************************************/
// BLEND
/******************************************************************************/
struct BlendInstance
{
   enum TYPE
   {
      SOLID     ,
      SOLID_BLST,
      SOLID_FUR ,
      SKELETON  ,
      BLEND_OBJ ,
      GAME_OBJ  ,
      GAME_AREA ,
   }type;

   Flt z; // used for sorting

   struct Solid // solid
   {
   #if 1
      union
      {
         Shader *shader;
         BLST   *blst  ;
      };
    C Material                *material;
   #else
    C MeshPart::Variation     *variation;
   #endif
    C MeshPart                *mesh;
      Vec                      vel, ang_vel_shader;
      Matrix                   view_matrix;
    C Memc<ShaderParamChange> *shader_param_changes;
      Color                    highlight;
      STENCIL_MODE             stencil_mode;
   };

   union // Data
   {
      Solid                 s         ; // solid
      SkeletonBlendInstance skeleton  ; // skeleton
      BlendObject          *blend_obj ; // blend object
      Game::Obj            * game_obj ; //  game object
      Game::Area::Data     * game_area; //  game area
   };

   void setViewZ(Flt z) {T.z=z;}
   void setZ    (C VecD &pos);

   void setViewMatrix(C Matrix  &view_matrix) {T.s.view_matrix=view_matrix; setViewZ(view_matrix.pos.z);}
   void setMatrix    (C MatrixM &     matrix);

   void unlink();

  ~BlendInstance();
   BlendInstance() {} // needed because of union
};
STRUCT(BlendInstancesClass , Memc<BlendInstance>)
//{
   BlendInstance& add   (Shader &shader, C Material &material, C MeshPart &mesh, C MeshPart::Variation &variation);
   BlendInstance& add   (BLST   &blst  , C Material &material, C MeshPart &mesh, C MeshPart::Variation &variation, C Vec &vel, C Vec &ang_vel_shader);
   BlendInstance& addFur(Shader &shader, C Material &material, C MeshPart &mesh, C MeshPart::Variation &variation, C Vec &vel);

   void add(BlendObject        &blend_obj, C VecD &pos);
   void add(  Game::Obj        & game_obj );
   void add(  Game::Area::Data & game_area);

   SkeletonBlendInstance& getSkeletonInstance(C AnimatedSkeleton &anim_skel);
};
/******************************************************************************/
// CLOTH
/******************************************************************************/
struct ClothInstance
{
 C Cloth      *cloth;
   ShaderBase *shader;
 C Material   *material;
   Vec         vel;
   Color       highlight;

#if COUNT_MATERIAL_USAGE
  ~ClothInstance() {if(material)material->decUsage();}
#endif
};
STRUCT(ClothInstances , Memc<ClothInstance>)
//{
   void add(C Cloth &cloth, Shader &shader, C Material &material);
   void add(C Cloth &cloth, Shader &shader, C Material &material, C Vec &vel);
   void add(C Cloth &cloth, FRST   &frst  , C Material &material);
};
/******************************************************************************/
// MISC
/******************************************************************************/
STRUCT(GameObjects , Memc<Game::Obj*>)
//{
};
STRUCT(GameAreas, Memc<Game::Area::Data*>)
//{
};
/******************************************************************************/
// VARIABLES
/******************************************************************************/
extern BlendInstancesClass BlendInstances;
extern ClothInstances      SolidClothInstances, ShadowClothInstances;
extern    GameObjects      PaletteObjects, Palette1Objects, OverlayObjects, SolidObjects, AmbientObjects, OutlineObjects, BehindObjects;
extern    GameAreas        PaletteAreas  , Palette1Areas;
/******************************************************************************/
Bool   HasEarlyZInstances();
void  DrawEarlyZInstances();
void ClearEarlyZInstances();

void  DrawSolidInstances();
void ClearSolidInstances();

        Int             Compare(C BlendInstance &a, C BlendInstance &b);
inline void  SortBlendInstances() {BlendInstances.sort(Compare);}
       void  DrawBlendInstances();
       void ClearBlendInstances();

void  SortAmbientInstances();
void  DrawAmbientInstances();
void ClearAmbientInstances();

void PrepareShadowInstances();
void    DrawShadowInstances();

void     DrawPaletteObjects();
void    DrawPalette1Objects();
void     DrawOverlayObjects();
void     DrawOutlineObjects();
void      DrawBehindObjects();

void  ShutInstances();
void  InitInstances();
void ClearInstances();
/******************************************************************************/
#endif
/******************************************************************************/