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: 2025-08-24 05:32:49 Functions: 9.1 % 11 1

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

Generated by: LCOV version 2.0-1