source/renderer/InstancingModelRenderer.cpp

   1 /* Copyright (C) 2024 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "precompiled.h"
  19 #include "renderer/InstancingModelRenderer.h"
  20
  21 #include "graphics/Color.h"
  22 #include "graphics/LightEnv.h"
  23 #include "graphics/Model.h"
  24 #include "graphics/ModelDef.h"
  25 #include "maths/Vector3D.h"
  26 #include "maths/Vector4D.h"
  27 #include "ps/CLogger.h"
  28 #include "ps/containers/StaticVector.h"
  29 #include "ps/CStrInternStatic.h"
  30 #include "renderer/Renderer.h"
  31 #include "renderer/RenderModifiers.h"
  32 #include "renderer/VertexArray.h"
  33 #include "third_party/mikktspace/weldmesh.h"
  34
  35
  36 struct IModelDef : public CModelDefRPrivate
  37 {
  38         /// Static per-CModel vertex array
  39         VertexArray m_Array;
  40
  41         /// Position and normals are static
  42         VertexArray::Attribute m_Position;
  43         VertexArray::Attribute m_Normal;
  44         VertexArray::Attribute m_Tangent;
  45         VertexArray::Attribute m_BlendJoints; // valid iff gpuSkinning == true
  46         VertexArray::Attribute m_BlendWeights; // valid iff gpuSkinning == true
  47
  48         /// The number of UVs is determined by the model
  49         std::vector<VertexArray::Attribute> m_UVs;
  50
  51         Renderer::Backend::IVertexInputLayout* m_VertexInputLayout = nullptr;
  52
  53         /// Indices are the same for all models, so share them
  54         VertexIndexArray m_IndexArray;
  55
  56         IModelDef(const CModelDefPtr& mdef, bool gpuSkinning, bool calculateTangents);
  57 };
  58
  59
  60 IModelDef::IModelDef(const CModelDefPtr& mdef, bool gpuSkinning, bool calculateTangents)
  61         : m_IndexArray(Renderer::Backend::IBuffer::Usage::TRANSFER_DST),
  62         m_Array(Renderer::Backend::IBuffer::Type::VERTEX, Renderer::Backend::IBuffer::Usage::TRANSFER_DST)
  63 {
  64         size_t numVertices = mdef->GetNumVertices();
  65
  66         m_Position.format = Renderer::Backend::Format::R32G32B32_SFLOAT;
  67         m_Array.AddAttribute(&m_Position);
  68
  69         m_Normal.format = Renderer::Backend::Format::R32G32B32_SFLOAT;
  70         m_Array.AddAttribute(&m_Normal);
  71
  72         m_UVs.resize(mdef->GetNumUVsPerVertex());
  73         for (size_t i = 0; i < mdef->GetNumUVsPerVertex(); i++)
  74         {
  75                 m_UVs[i].format = Renderer::Backend::Format::R32G32_SFLOAT;
  76                 m_Array.AddAttribute(&m_UVs[i]);
  77         }
  78
  79         if (gpuSkinning)
  80         {
  81                 // We can't use a lot of bones because it costs uniform memory. Recommended
  82                 // number of bones per model is 32.
  83                 // Add 1 to NumBones because of the special 'root' bone.
  84                 if (mdef->GetNumBones() + 1 > 64)
  85                         LOGERROR("Model '%s' has too many bones %zu/64", mdef->GetName().string8().c_str(), mdef->GetNumBones() + 1);
  86                 ENSURE(mdef->GetNumBones() + 1 <= 64);
  87
  88                 m_BlendJoints.format = Renderer::Backend::Format::R8G8B8A8_UINT;
  89                 m_Array.AddAttribute(&m_BlendJoints);
  90
  91                 m_BlendWeights.format = Renderer::Backend::Format::R8G8B8A8_UNORM;
  92                 m_Array.AddAttribute(&m_BlendWeights);
  93         }
  94
  95         if (calculateTangents)
  96         {
  97                 // Generate tangents for the geometry:-
  98
  99                 m_Tangent.format = Renderer::Backend::Format::R32G32B32A32_SFLOAT;
 100                 m_Array.AddAttribute(&m_Tangent);
 101
 102                 // floats per vertex; position + normal + tangent + UV*sets [+ GPUskinning]
 103                 int numVertexAttrs = 3 + 3 + 4 + 2 * mdef->GetNumUVsPerVertex();
 104                 if (gpuSkinning)
 105                 {
 106                         numVertexAttrs += 8;
 107                 }
 108
 109                 // the tangent generation can increase the number of vertices temporarily
 110                 // so reserve a bit more memory to avoid reallocations in GenTangents (in most cases)
 111                 std::vector<float> newVertices;
 112                 newVertices.reserve(numVertexAttrs * numVertices * 2);
 113
 114                 // Generate the tangents
 115                 ModelRenderer::GenTangents(mdef, newVertices, gpuSkinning);
 116
 117                 // how many vertices do we have after generating tangents?
 118                 int newNumVert = newVertices.size() / numVertexAttrs;
 119
 120                 std::vector<int> remapTable(newNumVert);
 121                 std::vector<float> vertexDataOut(newNumVert * numVertexAttrs);
 122
 123                 // re-weld the mesh to remove duplicated vertices
 124                 int numVertices2 = WeldMesh(&remapTable[0], &vertexDataOut[0],
 125                                         &newVertices[0], newNumVert, numVertexAttrs);
 126
 127                 // Copy the model data to graphics memory:-
 128
 129                 m_Array.SetNumberOfVertices(numVertices2);
 130                 m_Array.Layout();
 131
 132                 VertexArrayIterator<CVector3D> Position = m_Position.GetIterator<CVector3D>();
 133                 VertexArrayIterator<CVector3D> Normal = m_Normal.GetIterator<CVector3D>();
 134                 VertexArrayIterator<CVector4D> Tangent = m_Tangent.GetIterator<CVector4D>();
 135
 136                 VertexArrayIterator<u8[4]> BlendJoints;
 137                 VertexArrayIterator<u8[4]> BlendWeights;
 138                 if (gpuSkinning)
 139                 {
 140                         BlendJoints = m_BlendJoints.GetIterator<u8[4]>();
 141                         BlendWeights = m_BlendWeights.GetIterator<u8[4]>();
 142                 }
 143
 144                 // copy everything into the vertex array
 145                 for (int i = 0; i < numVertices2; i++)
 146                 {
 147                         int q = numVertexAttrs * i;
 148
 149                         Position[i] = CVector3D(vertexDataOut[q + 0], vertexDataOut[q + 1], vertexDataOut[q + 2]);
 150                         q += 3;
 151
 152                         Normal[i] = CVector3D(vertexDataOut[q + 0], vertexDataOut[q + 1], vertexDataOut[q + 2]);
 153                         q += 3;
 154
 155                         Tangent[i] = CVector4D(vertexDataOut[q + 0], vertexDataOut[q + 1], vertexDataOut[q + 2],
 156                                         vertexDataOut[q + 3]);
 157                         q += 4;
 158
 159                         if (gpuSkinning)
 160                         {
 161                                 for (size_t j = 0; j < 4; ++j)
 162                                 {
 163                                         BlendJoints[i][j] = (u8)vertexDataOut[q + 0 + 2 * j];
 164                                         BlendWeights[i][j] = (u8)vertexDataOut[q + 1 + 2 * j];
 165                                 }
 166                                 q += 8;
 167                         }
 168
 169                         for (size_t j = 0; j < mdef->GetNumUVsPerVertex(); j++)
 170                         {
 171                                 VertexArrayIterator<float[2]> UVit = m_UVs[j].GetIterator<float[2]>();
 172                                 UVit[i][0] = vertexDataOut[q + 0 + 2 * j];
 173                                 UVit[i][1] = vertexDataOut[q + 1 + 2 * j];
 174                         }
 175                 }
 176
 177                 // upload vertex data
 178                 m_Array.Upload();
 179                 m_Array.FreeBackingStore();
 180
 181                 m_IndexArray.SetNumberOfVertices(mdef->GetNumFaces() * 3);
 182                 m_IndexArray.Layout();
 183
 184                 VertexArrayIterator<u16> Indices = m_IndexArray.GetIterator();
 185
 186                 size_t idxidx = 0;
 187
 188                 // reindex geometry and upload index
 189                 for (size_t j = 0; j < mdef->GetNumFaces(); ++j)
 190                 {
 191                         Indices[idxidx++] = remapTable[j * 3 + 0];
 192                         Indices[idxidx++] = remapTable[j * 3 + 1];
 193                         Indices[idxidx++] = remapTable[j * 3 + 2];
 194                 }
 195
 196                 m_IndexArray.Upload();
 197                 m_IndexArray.FreeBackingStore();
 198         }
 199         else
 200         {
 201                 // Upload model without calculating tangents:-
 202
 203                 m_Array.SetNumberOfVertices(numVertices);
 204                 m_Array.Layout();
 205
 206                 VertexArrayIterator<CVector3D> Position = m_Position.GetIterator<CVector3D>();
 207                 VertexArrayIterator<CVector3D> Normal = m_Normal.GetIterator<CVector3D>();
 208
 209                 ModelRenderer::CopyPositionAndNormals(mdef, Position, Normal);
 210
 211                 for (size_t i = 0; i < mdef->GetNumUVsPerVertex(); i++)
 212                 {
 213                         VertexArrayIterator<float[2]> UVit = m_UVs[i].GetIterator<float[2]>();
 214                         ModelRenderer::BuildUV(mdef, UVit, i);
 215                 }
 216
 217                 if (gpuSkinning)
 218                 {
 219                         VertexArrayIterator<u8[4]> BlendJoints = m_BlendJoints.GetIterator<u8[4]>();
 220                         VertexArrayIterator<u8[4]> BlendWeights = m_BlendWeights.GetIterator<u8[4]>();
 221                         for (size_t i = 0; i < numVertices; ++i)
 222                         {
 223                                 const SModelVertex& vtx = mdef->GetVertices()[i];
 224                                 for (size_t j = 0; j < 4; ++j)
 225                                 {
 226                                         BlendJoints[i][j] = vtx.m_Blend.m_Bone[j];
 227                                         BlendWeights[i][j] = (u8)(255.f * vtx.m_Blend.m_Weight[j]);
 228                                 }
 229                         }
 230                 }
 231
 232                 m_Array.Upload();
 233                 m_Array.FreeBackingStore();
 234
 235                 m_IndexArray.SetNumberOfVertices(mdef->GetNumFaces()*3);
 236                 m_IndexArray.Layout();
 237                 ModelRenderer::BuildIndices(mdef, m_IndexArray.GetIterator());
 238                 m_IndexArray.Upload();
 239                 m_IndexArray.FreeBackingStore();
 240         }
 241
 242         const uint32_t stride = m_Array.GetStride();
 243         constexpr size_t MAX_UV = 2;
 244
 245         PS::StaticVector<Renderer::Backend::SVertexAttributeFormat, 5 + MAX_UV> attributes{
 246                 {Renderer::Backend::VertexAttributeStream::POSITION,
 247                         m_Position.format, m_Position.offset, stride,
 248                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0},
 249                 {Renderer::Backend::VertexAttributeStream::NORMAL,
 250                         m_Normal.format, m_Normal.offset, stride,
 251                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0}
 252         };
 253
 254         for (size_t uv = 0; uv < std::min(MAX_UV, mdef->GetNumUVsPerVertex()); ++uv)
 255         {
 256                 const Renderer::Backend::VertexAttributeStream stream =
 257                         static_cast<Renderer::Backend::VertexAttributeStream>(
 258                                 static_cast<int>(Renderer::Backend::VertexAttributeStream::UV0) + uv);
 259                 attributes.push_back({
 260                         stream, m_UVs[uv].format, m_UVs[uv].offset, stride,
 261                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0});
 262         }
 263
 264         // GPU skinning requires extra attributes to compute positions/normals.
 265         if (gpuSkinning)
 266         {
 267                 attributes.push_back({
 268                         Renderer::Backend::VertexAttributeStream::UV2,
 269                         m_BlendJoints.format, m_BlendJoints.offset, stride,
 270                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0});
 271                 attributes.push_back({
 272                         Renderer::Backend::VertexAttributeStream::UV3,
 273                         m_BlendWeights.format, m_BlendWeights.offset, stride,
 274                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0});
 275         }
 276
 277         if (calculateTangents)
 278         {
 279                 attributes.push_back({
 280                         Renderer::Backend::VertexAttributeStream::UV4,
 281                         m_Tangent.format, m_Tangent.offset, stride,
 282                         Renderer::Backend::VertexAttributeRate::PER_VERTEX, 0});
 283         }
 284
 285         m_VertexInputLayout = g_Renderer.GetVertexInputLayout({attributes.begin(), attributes.end()});
 286 }
 287
 288 struct InstancingModelRendererInternals
 289 {
 290         bool gpuSkinning;
 291
 292         bool calculateTangents;
 293
 294         /// Previously prepared modeldef
 295         IModelDef* imodeldef;
 296
 297         /// Index base for imodeldef
 298         u8* imodeldefIndexBase;
 299 };
 300
 301
 302 // Construction and Destruction
 303 InstancingModelRenderer::InstancingModelRenderer(bool gpuSkinning, bool calculateTangents)
 304 {
 305         m = new InstancingModelRendererInternals;
 306         m->gpuSkinning = gpuSkinning;
 307         m->calculateTangents = calculateTangents;
 308         m->imodeldef = 0;
 309 }
 310
 311 InstancingModelRenderer::~InstancingModelRenderer()
 312 {
 313         delete m;
 314 }
 315
 316
 317 // Build modeldef data if necessary - we have no per-CModel data
 318 CModelRData* InstancingModelRenderer::CreateModelData(const void* key, CModel* model)
 319 {
 320         CModelDefPtr mdef = model->GetModelDef();
 321         IModelDef* imodeldef = (IModelDef*)mdef->GetRenderData(m);
 322
 323         if (m->gpuSkinning)
 324                 ENSURE(model->IsSkinned());
 325         else
 326                 ENSURE(!model->IsSkinned());
 327
 328         if (!imodeldef)
 329         {
 330                 imodeldef = new IModelDef(mdef, m->gpuSkinning, m->calculateTangents);
 331                 mdef->SetRenderData(m, imodeldef);
 332         }
 333
 334         return new CModelRData(key);
 335 }
 336
 337
 338 void InstancingModelRenderer::UpdateModelData(CModel* UNUSED(model), CModelRData* UNUSED(data), int UNUSED(updateflags))
 339 {
 340         // We have no per-CModel data
 341 }
 342
 343 void InstancingModelRenderer::UploadModelData(
 344         Renderer::Backend::IDeviceCommandContext* UNUSED(deviceCommandContext),
 345         CModel* UNUSED(model), CModelRData* UNUSED(data))
 346 {
 347         // Data uploaded once during creation as we don't update it dynamically.
 348 }
 349
 350 // Prepare UV coordinates for this modeldef
 351 void InstancingModelRenderer::PrepareModelDef(
 352         Renderer::Backend::IDeviceCommandContext* deviceCommandContext,
 353         const CModelDef& def)
 354 {
 355         m->imodeldef = (IModelDef*)def.GetRenderData(m);
 356         ENSURE(m->imodeldef);
 357
 358         deviceCommandContext->SetVertexInputLayout(m->imodeldef->m_VertexInputLayout);
 359
 360         deviceCommandContext->SetIndexBuffer(m->imodeldef->m_IndexArray.GetBuffer());
 361
 362         const uint32_t stride = m->imodeldef->m_Array.GetStride();
 363         const uint32_t firstVertexOffset = m->imodeldef->m_Array.GetOffset() * stride;
 364
 365         deviceCommandContext->SetVertexBuffer(
 366                 0, m->imodeldef->m_Array.GetBuffer(), firstVertexOffset);
 367 }
 368
 369
 370 // Render one model
 371 void InstancingModelRenderer::RenderModel(
 372         Renderer::Backend::IDeviceCommandContext* deviceCommandContext,
 373         Renderer::Backend::IShaderProgram* shader, CModel* model, CModelRData* UNUSED(data))
 374 {
 375         const CModelDefPtr& mdldef = model->GetModelDef();
 376
 377         if (m->gpuSkinning)
 378         {
 379                 // Bind matrices for current animation state.
 380                 // Add 1 to NumBones because of the special 'root' bone.
 381                 deviceCommandContext->SetUniform(
 382                         shader->GetBindingSlot(str_skinBlendMatrices),
 383                         PS::span<const float>(
 384                                 model->GetAnimatedBoneMatrices()[0]._data,
 385                                 model->GetAnimatedBoneMatrices()[0].AsFloatArray().size() * (mdldef->GetNumBones() + 1)));
 386         }
 387
 388         // Render the lot.
 389         const size_t numberOfFaces = mdldef->GetNumFaces();
 390
 391         deviceCommandContext->DrawIndexedInRange(
 392                 m->imodeldef->m_IndexArray.GetOffset(), numberOfFaces * 3, 0, m->imodeldef->m_Array.GetNumberOfVertices() - 1);
 393
 394         // Bump stats.
 395         g_Renderer.m_Stats.m_DrawCalls++;
 396         g_Renderer.m_Stats.m_ModelTris += numberOfFaces;
 397 }