Ticket #2421: colorAdd_TextureMaskMode_v2.patch

binaries/data/mods/public/gui/common/colorFades.js

@@ -84 +84 @@
     var rgb = data.rgb;
     overlay.sprite="colour: " + rgb.r + " " + rgb.g + " " + rgb.b + " " + rgb.o;
 
+    // check, if color mask mode is used and add the filename in this case
+    if (overlay.addColorMask)
+        overlay.sprite += ":" + overlay.addColorMask;
+        
     // recusive call, if duration is positive
     if (!data.stopFade && (data.justStopAtExternCall || data.duration - (data.tickInterval * data.tickCounter) > 0))
     {

binaries/data/mods/public/gui/gui.dtd

@@ -27 +27 @@
 <!-- Defaults are not put in here, because it ruins the concept of styles -->
 
 <!ENTITY % ex_settings
- "buffer_zone               CDATA #IMPLIED
+ "addColorMask              CDATA #IMPLIED
+  buffer_zone               CDATA #IMPLIED
   button_width              CDATA #IMPLIED
   checked                   %bool; #IMPLIED
   dropdown_size             CDATA #IMPLIED
@@ -201 +202 @@
 <!ATTLIST effect
   add_color             CDATA #IMPLIED
   multiply_color        CDATA #IMPLIED
+  textureMaskMode       %bool; #IMPLIED
   grayscale             CDATA #IMPLIED
 >

binaries/data/mods/public/shaders/effects/gui_add.xml

@@ -2 +2 @@
 <effect>
 
     <technique>
+        <require context="!TEXTURE_MASK_MODE"/>
         <require shaders="fixed"/>
         <pass shader="fixed:gui_add"/>
     </technique>

binaries/data/mods/public/shaders/glsl/gui_add.fs

@@ -7 +7 @@
 
 void main()
 {
-  gl_FragColor = texture2D(tex, v_tex) + color;
+    vec4 t = texture2D(tex, v_tex);
+
+    #if TEXTURE_MASK_MODE
+        gl_FragColor.rgb = color.rgb;
+        gl_FragColor.a = min(t.a, color.a);
+    #else
+        gl_FragColor = t + color;
+    #endif
 }

source/gui/CGUI.cpp

@@ -1617 +1617 @@
         {
             effects.m_Greyscale = true;
         }
+        else if (attr_name == "textureMaskMode")
+        {
+            effects.m_TextureMaskMode = true;
+        }
         else
         {
             debug_warn(L"Invalid data - DTD shouldn't allow this");

source/gui/CGUISprite.h

@@ -64 +64 @@
 
 struct SGUIImageEffects
 {
-    SGUIImageEffects() : m_Greyscale(false) {}
+    SGUIImageEffects() : m_Greyscale(false), m_TextureMaskMode(false) {}
     CColor m_AddColor;
     bool m_Greyscale;
+    bool m_TextureMaskMode;
 };
 
 /**

source/gui/CImage.cpp

@@ -35 +35 @@
     AddSetting(GUIST_int,                   "cell_id");
     AddSetting(GUIST_CStrW,                 "tooltip");
     AddSetting(GUIST_CStr,                  "tooltip_style");
+    AddSetting(GUIST_CStr,                  "addColorMask");
 }
 
 CImage::~CImage()

source/gui/GUIRenderer.cpp

@@ -79 +79 @@
         //     "stretched:grayscale:filename.ext" - stretched grayscale image
         //     "cropped:(0.5, 0.25)"    - stretch this ratio (x,y) of the top left of the image
         //     "colour:r g b a"         - solid colour
+        //     "colour:r g b a:filenameMask.ext"  - solid colour with textureMask
         //
         // and if so, try to create it as a new sprite.
         if (SpriteName.substr(0, 10) == "stretched:")
@@ -137 +138 @@
         }
         else if (SpriteName.substr(0, 7) == "colour:")
         {
+            SGUIImage* Image = new SGUIImage;
+
+            // check, if there is a sprite for defining of opacity values
+            int splitIndex = SpriteName.substr(7).find_first_of(":");
             CStrW value = wstring_from_utf8(SpriteName.substr(7));
+            CStrW textureMask;
             CColor color;
 
+            // trim the color value and the name of the textureMask
+            if(splitIndex != std::basic_string<char>::npos)
+            {
+                textureMask = value.substr(splitIndex + 1);
+                value = value.substr(0, splitIndex);
+            }
+
             // Check colour is valid
             if (!GUI<CColor>::ParseString(value, color))
             {
@@ -147 +160 @@
                 return;
             }
 
-            SGUIImage* Image = new SGUIImage;
+            // set background color or add color effect if textureMask is set
+            if(splitIndex != std::basic_string<char>::npos)
+            {
+                // TODO: Should check (nicely) that this is a valid file?
+                Image->m_TextureName = VfsPath("art/textures/ui") / textureMask;
+                Image->m_Effects = new SGUIImageEffects;
+                Image->m_Effects->m_AddColor = color;
+                Image->m_Effects->m_TextureMaskMode = true;
+            }
+            else
+                Image->m_BackColor = color;
 
-            Image->m_BackColor = color;
-
             CClientArea ca(CRect(0, 0, 0, 0), CRect(0, 0, 100, 100));
             Image->m_Size = ca;
             Image->m_TextureSize = ca;
@@ -231 +252 @@
         {
             if ((*cit)->m_Effects->m_AddColor != CColor())
             {
-                Call.m_Shader = g_Renderer.GetShaderManager().LoadEffect(str_gui_add);
+                CShaderDefines defines;
+                // enable texture mask mode
+                if ((*cit)->m_Effects->m_TextureMaskMode)
+                    defines.Add(str_TEXTURE_MASK_MODE, str_1);
+                
+                Call.m_Shader = g_Renderer.GetShaderManager().LoadEffect(str_gui_add, g_Renderer.GetSystemShaderDefines(), defines);
                 Call.m_ShaderColorParameter = (*cit)->m_Effects->m_AddColor;
                 // Always enable blending if something's being subtracted from
                 // the alpha channel

source/ps/CStrInternStatic.h

@@ -64 +64 @@
 X(USE_SHADOW_PCF)
 X(USE_SHADOW_SAMPLER)
 X(USE_WAVES)
+X(TEXTURE_MASK_MODE)
 X2(_emptystring, "")
 X(a_skinJoints)
 X(a_skinWeights)