source/renderer/ParticleRenderer.h

   1 /* Copyright (C) 2022 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 #ifndef INCLUDED_PARTICLERENDERER
  19 #define INCLUDED_PARTICLERENDERER
  20
  21 #include "renderer/backend/IDeviceCommandContext.h"
  22
  23 class CParticleEmitter;
  24 class CShaderDefines;
  25 struct ParticleRendererInternals;
  26
  27 /**
  28  * Render particles.
  29  */
  30 class ParticleRenderer
  31 {
  32         NONCOPYABLE(ParticleRenderer);
  33
  34 public:
  35         ParticleRenderer();
  36         ~ParticleRenderer();
  37
  38         /**
  39          * Add an emitter for rendering in this frame.
  40          */
  41         void Submit(int cullGroup, CParticleEmitter* emitter);
  42
  43         /**
  44          * Prepare internal data structures for rendering.
  45          * Must be called after all Submit calls for a frame, and before
  46          * any rendering calls.
  47          */
  48         void PrepareForRendering(const CShaderDefines& context);
  49
  50         /**
  51          * Upload internal data to the backend. Must be called after the data is
  52          * prepared and before any rendering calls.
  53          */
  54         void Upload(
  55                 Renderer::Backend::IDeviceCommandContext* deviceCommandContext);
  56
  57         /**
  58          * Reset the list of submitted overlays.
  59          */
  60         void EndFrame();
  61
  62         /**
  63          * Render all the submitted particles.
  64          */
  65         void RenderParticles(
  66                 Renderer::Backend::IDeviceCommandContext* deviceCommandContext,
  67                 int cullGroup, bool wireframe = false);
  68
  69         /**
  70          * Render bounding boxes for all the submitted emitters.
  71          */
  72         void RenderBounds(int cullGroup);
  73
  74 private:
  75         ParticleRendererInternals* m;
  76 };
  77
  78 #endif // INCLUDED_PARTICLERENDERER