LCOV - code coverage report
Current view: top level - engine/render - grass.cpp (source / functions) Coverage Total Hit
Test: Libprimis Test Coverage Lines: 4.1 % 220 9
Test Date: 2026-05-09 04:28:55 Functions: 9.1 % 11 1

            Line data    Source code
       1              : /**
       2              :  * @file billboarded grass generation atop cube geometry
       3              :  *
       4              :  * grass can be rendered on the top side of geometry, in an "X" shape atop cubes
       5              :  * grass is billboarded, and faces the camera, and can be modified as to its draw
       6              :  * distance
       7              :  */
       8              : #include "../libprimis-headers/cube.h"
       9              : #include "../../shared/geomexts.h"
      10              : #include "../../shared/glemu.h"
      11              : #include "../../shared/glexts.h"
      12              : 
      13              : #include "grass.h"
      14              : #include "octarender.h"
      15              : #include "rendergl.h"
      16              : #include "renderva.h"
      17              : #include "shader.h"
      18              : #include "shaderparam.h"
      19              : #include "texture.h"
      20              : 
      21              : #include "interface/control.h"
      22              : 
      23              : #include "world/octaworld.h"
      24              : 
      25              : namespace //internal functionality not seen by other files
      26              : {
      27              :     VARP(grass, 0, 1, 1);           //toggles rendering of grass
      28              :     VARP(grassdist, 0, 256, 10000); //maximum distance to render grass
      29              :     FVARP(grasstaper, 0, 0.2, 1);
      30              :     FVARP(grassstep, 0.5, 2, 8);
      31              :     VARP(grassheight, 1, 4, 64);    //height of grass in cube units
      32              : 
      33              :     constexpr int numgrasswedges = 8;
      34              : 
      35              :     struct grasswedge final
      36              :     {
      37              :         vec dir, across, edge1, edge2;
      38              :         plane bound1, bound2;
      39              : 
      40            8 :         grasswedge(int i) :
      41            8 :           dir(2*M_PI*(i+0.5f)/static_cast<float>(numgrasswedges), 0),
      42            8 :           across(2*M_PI*((i+0.5f)/static_cast<float>(numgrasswedges) + 0.25f), 0),
      43            8 :           edge1(vec(2*M_PI*i/static_cast<float>(numgrasswedges), 0).div(std::cos(M_PI/numgrasswedges))),
      44            8 :           edge2(vec(2*M_PI*(i+1)/static_cast<float>(numgrasswedges), 0).div(std::cos(M_PI/numgrasswedges))),
      45            8 :           bound1(vec(2*M_PI*(i/static_cast<float>(numgrasswedges) - 0.25f), 0), 0),
      46            8 :           bound2(vec(2*M_PI*((i+1)/static_cast<float>(numgrasswedges) + 0.25f), 0), 0)
      47              :         {
      48            8 :             across.div(-across.dot(bound1));
      49            8 :         }
      50              :     } grasswedges[numgrasswedges] = { 0, 1, 2, 3, 4, 5, 6, 7 };
      51              : 
      52              :     struct grassvert final
      53              :     {
      54              :         vec pos;
      55              :         vec4<uchar> color;
      56              :         vec2 tc;
      57              :     };
      58              : 
      59              :     std::vector<grassvert> grassverts;
      60              :     GLuint grassvbo = 0;
      61              :     int grassvbosize = 0;
      62              : 
      63              :     VAR(maxgrass, 10, 10000, 10000);            //number of grass squares allowed to be rendered at a time
      64              : 
      65              :     struct grassgroup final
      66              :     {
      67              :         const grasstri *tri;
      68              :         int tex,
      69              :             offset,
      70              :             numquads;
      71              :     };
      72              : 
      73              :     std::vector<grassgroup> grassgroups;
      74              : 
      75              :     constexpr int numgrassoffsets = 32;
      76              : 
      77              :     std::array<float, numgrassoffsets> grassoffsets = { -1 };
      78              :     std::array<float, numgrassoffsets> grassanimoffsets;
      79              :     int lastgrassanim = -1;
      80              : 
      81              :     VARR(grassanimmillis, 0, 3000, 60000);      //sets the characteristic rate of grass animation change
      82              :     FVARR(grassanimscale, 0, 0.03f, 1);         //sets the intensity of the animation (size of waviness)
      83              : 
      84              :     //updates the grass animation offset values based on the current time
      85            0 :     void animategrass()
      86              :     {
      87            0 :         for(int i = 0; i < numgrassoffsets; ++i)
      88              :         {
      89            0 :             grassanimoffsets[i] = grassanimscale*std::sin(2*M_PI*(grassoffsets[i] + lastmillis/static_cast<float>(grassanimmillis)));
      90              :         }
      91            0 :         lastgrassanim = lastmillis;
      92            0 :     }
      93              : 
      94              :     VARR(grassscale, 1, 2, 64);  //scale factor for grass texture
      95            0 :     CVAR0R(grasscolor, 0xFFFFFF);//tint color for grass
      96              :     FVARR(grasstest, 0, 0.6f, 1);
      97              : 
      98              :     /**
      99              :      * @brief Generate the grass geometry placed above cubes
     100              :      *
     101              :      * Grass always faces the camera (billboarded) and therefore grass geom is
     102              :      * calculated realtime to face the camera
     103              :      *
     104              :      * @brief group the grass group to use, or if nullptr a new one will be used
     105              :      * @brief w grass wedge geometry information
     106              :      * @brief tex the grass texture to apply
     107              :      */
     108            0 :     void gengrassquads(grassgroup *&group, const grasswedge &w, const grasstri &g, const Texture *tex)
     109              :     {
     110            0 :         float t = camera1->o.dot(w.dir);
     111            0 :         int tstep = static_cast<int>(std::ceil(t/grassstep));
     112            0 :         float tstart = tstep*grassstep,
     113            0 :               t0 = w.dir.dot(g.v[0]),
     114            0 :               t1 = w.dir.dot(g.v[1]),
     115            0 :               t2 = w.dir.dot(g.v[2]),
     116            0 :               t3 = w.dir.dot(g.v[3]),
     117            0 :               tmin = std::min(std::min(t0, t1), std::min(t2, t3)),
     118            0 :               tmax = std::max(std::max(t0, t1), std::max(t2, t3));
     119            0 :         if(tmax < tstart || tmin > t + grassdist)
     120              :         {
     121            0 :             return;
     122              :         }
     123            0 :         int minstep = std::max(static_cast<int>(std::ceil(tmin/grassstep)) - tstep, 1),
     124            0 :             maxstep = static_cast<int>(std::floor(std::min(tmax, t + grassdist)/grassstep)) - tstep,
     125            0 :             numsteps = maxstep - minstep + 1;
     126              : 
     127            0 :         float texscale = (grassscale*tex->ys)/static_cast<float>(grassheight*tex->xs),
     128            0 :               animscale = grassheight*texscale;
     129            0 :         vec tc;
     130            0 :         tc.cross(g.surface, w.dir).mul(texscale);
     131              : 
     132            0 :         int offset = tstep + maxstep;
     133            0 :         if(offset < 0)
     134              :         {
     135            0 :             offset = numgrassoffsets - (-offset)%numgrassoffsets;
     136              :         }
     137            0 :         offset += numsteps + numgrassoffsets - numsteps%numgrassoffsets;
     138              : 
     139            0 :         float leftdist = t0;
     140            0 :         const vec *leftv = &g.v[0];
     141            0 :         if(t1 > leftdist)
     142              :         {
     143            0 :             leftv = &g.v[1];
     144            0 :             leftdist = t1;
     145              :         }
     146            0 :         if(t2 > leftdist)
     147              :         {
     148            0 :             leftv = &g.v[2];
     149            0 :             leftdist = t2;
     150              :         }
     151            0 :         if(t3 > leftdist)
     152              :         {
     153            0 :             leftv = &g.v[3];
     154            0 :             leftdist = t3;
     155              :         }
     156            0 :         float rightdist = leftdist;
     157            0 :         const vec *rightv = leftv;
     158              : 
     159            0 :         vec across(w.across.x, w.across.y, g.surface.zdelta(w.across)),
     160            0 :             leftdir(0, 0, 0),
     161            0 :             rightdir(0, 0, 0),
     162            0 :             leftp = *leftv,
     163            0 :             rightp = *rightv;
     164            0 :         float taperdist = grassdist*grasstaper,
     165            0 :               taperscale = 1.0f / (grassdist - taperdist),
     166            0 :               dist = maxstep*grassstep + tstart,
     167            0 :               leftb = 0,
     168            0 :               rightb = 0,
     169            0 :               leftdb = 0,
     170            0 :               rightdb = 0;
     171            0 :         for(int i = maxstep; i >= minstep; i--, offset--, leftp.add(leftdir), rightp.add(rightdir), leftb += leftdb, rightb += rightdb, dist -= grassstep)
     172              :         {
     173            0 :             if(dist <= leftdist)
     174              :             {
     175            0 :                 const vec *prev = leftv;
     176            0 :                 float prevdist = leftdist;
     177            0 :                 if(--leftv < &g.v[0])
     178              :                 {
     179            0 :                     leftv += g.numv;
     180              :                 }
     181            0 :                 leftdist = leftv->dot(w.dir);
     182            0 :                 if(dist <= leftdist)
     183              :                 {
     184            0 :                     prev = leftv;
     185            0 :                     prevdist = leftdist;
     186            0 :                     if(--leftv < &g.v[0])
     187              :                     {
     188            0 :                         leftv += g.numv;
     189              :                     }
     190            0 :                     leftdist = leftv->dot(w.dir);
     191              :                 }
     192            0 :                 leftdir = vec(*leftv).sub(*prev);
     193            0 :                 leftdir.mul(grassstep/-w.dir.dot(leftdir));
     194            0 :                 leftp = vec(leftdir).mul((prevdist - dist)/grassstep).add(*prev);
     195            0 :                 leftb = w.bound1.dist(leftp);
     196            0 :                 leftdb = w.bound1.dot(leftdir);
     197              :             }
     198            0 :             if(dist <= rightdist)
     199              :             {
     200            0 :                 const vec *prev = rightv;
     201            0 :                 float prevdist = rightdist;
     202            0 :                 if(++rightv >= &g.v[g.numv])
     203              :                 {
     204            0 :                     rightv = &g.v[0];
     205              :                 }
     206            0 :                 rightdist = rightv->dot(w.dir);
     207            0 :                 if(dist <= rightdist)
     208              :                 {
     209            0 :                     prev = rightv;
     210            0 :                     prevdist = rightdist;
     211            0 :                     if(++rightv >= &g.v[g.numv])
     212              :                     {
     213            0 :                         rightv = &g.v[0];
     214              :                     }
     215            0 :                     rightdist = rightv->dot(w.dir);
     216              :                 }
     217            0 :                 rightdir = vec(*rightv).sub(*prev);
     218            0 :                 rightdir.mul(grassstep/-w.dir.dot(rightdir));
     219            0 :                 rightp = vec(rightdir).mul((prevdist - dist)/grassstep).add(*prev);
     220            0 :                 rightb = w.bound2.dist(rightp);
     221            0 :                 rightdb = w.bound2.dot(rightdir);
     222              :             }
     223            0 :             vec p1 = leftp,
     224            0 :                 p2 = rightp;
     225            0 :             if(leftb > 0)
     226              :             {
     227            0 :                 if(w.bound1.dist(p2) >= 0)
     228              :                 {
     229            0 :                     continue;
     230              :                 }
     231            0 :                 p1.add(vec(across).mul(leftb));
     232              :             }
     233            0 :             if(rightb > 0)
     234              :             {
     235            0 :                 if(w.bound2.dist(p1) >= 0)
     236              :                 {
     237            0 :                     continue;
     238              :                 }
     239            0 :                 p2.sub(vec(across).mul(rightb));
     240              :             }
     241              : 
     242            0 :             if(static_cast<int>(grassverts.size()) >= 4*maxgrass)
     243              :             {
     244            0 :                 break;
     245              :             }
     246              : 
     247            0 :             if(!group)
     248              :             {
     249              :                 grassgroup group;
     250            0 :                 group.tri = &g;
     251            0 :                 group.tex = tex->id;
     252            0 :                 group.offset = grassverts.size()/4;
     253            0 :                 group.numquads = 0;
     254            0 :                 grassgroups.push_back(group);
     255            0 :                 if(lastgrassanim!=lastmillis)
     256              :                 {
     257            0 :                     animategrass();
     258              :                 }
     259              :             }
     260              : 
     261            0 :             group->numquads++;
     262              : 
     263            0 :             float tcoffset = grassoffsets[offset%numgrassoffsets],
     264            0 :                   animoffset = animscale*grassanimoffsets[offset%numgrassoffsets],
     265            0 :                   tc1 = tc.dot(p1) + tcoffset,
     266            0 :                   tc2 = tc.dot(p2) + tcoffset,
     267            0 :                   fade = dist - t > taperdist ? (grassdist - (dist - t))*taperscale : 1,
     268            0 :                   height = grassheight * fade;
     269            0 :             vec4<uchar> color(grasscolor, 255);
     270              :     //=====================================================================GRASSVERT
     271              :             #define GRASSVERT(n, tcv, modify) { \
     272              :                 grassvert gv; \
     273              :                 gv.pos = p##n; \
     274              :                 gv.color = color; \
     275              :                 gv.tc = vec2(tc##n, tcv); \
     276              :                 modify; \
     277              :                 grassverts.push_back(std::move(gv)); \
     278              :             }
     279              : 
     280            0 :             GRASSVERT(2, 0, { gv.pos.z += height; gv.tc.x += animoffset; });
     281            0 :             GRASSVERT(1, 0, { gv.pos.z += height; gv.tc.x += animoffset; });
     282            0 :             GRASSVERT(1, 1, );
     283            0 :             GRASSVERT(2, 1, );
     284              : 
     285              :             #undef GRASSVERT
     286              :     //==============================================================================
     287              :         }
     288              :     }
     289              : 
     290              :     // generates grass geometry for a given vertex array
     291            0 :     void gengrassquads(const vtxarray &va)
     292              :     {
     293            0 :         for(const grasstri &g : va.grasstris)
     294              :         {
     295            0 :             if(view.isfoggedsphere(g.radius, g.center))
     296              :             {
     297            0 :                 continue;
     298              :             }
     299            0 :             float dist = g.center.dist(camera1->o);
     300            0 :             if(dist - g.radius > grassdist)
     301              :             {
     302            0 :                 continue;
     303              :             }
     304            0 :             Slot &s = *lookupvslot(g.texture, false).slot;
     305            0 :             if(!s.grasstex)
     306              :             {
     307            0 :                 if(!s.grass)
     308              :                 {
     309            0 :                     continue;
     310              :                 }
     311            0 :                 s.grasstex = textureload(s.grass, 2);
     312              :             }
     313            0 :             grassgroup *group = nullptr;
     314            0 :             for(const grasswedge &w : grasswedges)
     315              :             {
     316            0 :                 if(w.bound1.dist(g.center) > g.radius || w.bound2.dist(g.center) > g.radius)
     317              :                 {
     318            0 :                     continue;
     319              :                 }
     320            0 :                 gengrassquads(group, w, g, s.grasstex);
     321              :             }
     322              :         }
     323            0 :     }
     324              : 
     325              :     bool hasgrassshader = false;
     326              : 
     327            0 :     void cleargrassshaders()
     328              :     {
     329            0 :         hasgrassshader = false;
     330            0 :     }
     331              : 
     332            0 :     Shader *loadgrassshader()
     333              :     {
     334            0 :         std::string name = "grass";
     335            0 :         return generateshader(name, "grassshader ");
     336              : 
     337            0 :     }
     338              : }
     339              : 
     340              : /* externally relevant functions */
     341              : ///////////////////////////////////
     342              : 
     343            0 : void generategrass()
     344              : {
     345            0 :     if(!grass || !grassdist)
     346              :     {
     347            0 :         return;
     348              :     }
     349            0 :     grassgroups.clear();
     350            0 :     grassverts.clear();
     351              : 
     352            0 :     if(grassoffsets[0] < 0)
     353              :     {
     354            0 :         for(int i = 0; i < numgrassoffsets; ++i)
     355              :         {
     356            0 :             grassoffsets[i] = randomint(0x1000000)/static_cast<float>(0x1000000);
     357              :         }
     358              :     }
     359              : 
     360            0 :     for(grasswedge &w : grasswedges)
     361              :     {
     362            0 :         w.bound1.offset = -camera1->o.dot(w.bound1);
     363            0 :         w.bound2.offset = -camera1->o.dot(w.bound2);
     364              :     }
     365              : 
     366            0 :     for(const vtxarray *va = visibleva; va; va = va->next)
     367              :     {
     368            0 :         if(va->grasstris.empty() || va->occluded >= Occlude_Geom)
     369              :         {
     370            0 :             continue;
     371              :         }
     372            0 :         if(va->distance > grassdist)
     373              :         {
     374            0 :             continue;
     375              :         }
     376            0 :         gengrassquads(*va);
     377              :     }
     378              : 
     379            0 :     if(grassgroups.empty())
     380              :     {
     381            0 :         return;
     382              :     }
     383            0 :     if(!grassvbo)
     384              :     {
     385            0 :         glGenBuffers(1, &grassvbo);
     386              :     }
     387            0 :     gle::bindvbo(grassvbo);
     388            0 :     int size = grassverts.size()*sizeof(grassvert);
     389            0 :     grassvbosize = std::max(grassvbosize, size);
     390            0 :     glBufferData(GL_ARRAY_BUFFER, grassvbosize, size == grassvbosize ? grassverts.data() : nullptr, GL_STREAM_DRAW);
     391            0 :     if(size != grassvbosize)
     392              :     {
     393            0 :         glBufferSubData(GL_ARRAY_BUFFER, 0, size, grassverts.data());
     394              :     }
     395            0 :     gle::clearvbo();
     396              : }
     397              : 
     398            0 : void loadgrassshaders()
     399              : {
     400            0 :     hasgrassshader = (loadgrassshader() != nullptr);
     401            0 : }
     402              : 
     403            0 : void rendergrass()
     404              : {
     405            0 :     if(!grass || !grassdist || grassgroups.empty() || !hasgrassshader)
     406              :     {
     407            0 :         return;
     408              :     }
     409            0 :     glDisable(GL_CULL_FACE);
     410              : 
     411            0 :     gle::bindvbo(grassvbo);
     412              : 
     413            0 :     const grassvert *ptr = nullptr;
     414            0 :     gle::vertexpointer(sizeof(grassvert), ptr->pos.data());
     415            0 :     gle::colorpointer(sizeof(grassvert), ptr->color.data());
     416            0 :     gle::texcoord0pointer(sizeof(grassvert), ptr->tc.data());
     417            0 :     gle::enablevertex();
     418            0 :     gle::enablecolor();
     419            0 :     gle::enabletexcoord0();
     420            0 :     gle::enablequads();
     421              : 
     422            0 :     GLOBALPARAMF(grasstest, grasstest); //toggles use of grass (depth) test shader
     423              : 
     424            0 :     int texid = -1;
     425            0 :     for(const grassgroup &g : grassgroups)
     426              :     {
     427            0 :         if(texid != g.tex)
     428              :         {
     429            0 :             glBindTexture(GL_TEXTURE_2D, g.tex);
     430            0 :             texid = g.tex;
     431              :         }
     432              : 
     433            0 :         gle::drawquads(g.offset, g.numquads);
     434            0 :         xtravertsva += 4*g.numquads;
     435              :     }
     436              : 
     437            0 :     gle::disablequads();
     438            0 :     gle::disablevertex();
     439            0 :     gle::disablecolor();
     440            0 :     gle::disabletexcoord0();
     441              : 
     442            0 :     gle::clearvbo();
     443              : 
     444            0 :     glEnable(GL_CULL_FACE);
     445              : }
     446              : 
     447            0 : void cleanupgrass()
     448              : {
     449            0 :     if(grassvbo)
     450              :     {
     451            0 :         glDeleteBuffers(1, &grassvbo);
     452            0 :         grassvbo = 0;
     453              :     }
     454            0 :     grassvbosize = 0;
     455              : 
     456            0 :     cleargrassshaders();
     457            0 : }
        

Generated by: LCOV version 2.0-1