oops... too many colors in xpm

[xonotic/darkplaces.git] / darkplaces.txt

diff --git a/darkplaces.txt b/darkplaces.txt
index 6ba53506a65e622f6eeb7292af593d8a46a1e668..c20f3b28e0eb4aee7756c782351ce4f620903fea 100644 (file)
--- a/darkplaces.txt
+++ b/darkplaces.txt
@@ -1320,16 +1320,23 @@ Ludwig Nussel for the ~/.games/darkplaces/ user directory support on non-Windows
 \r
 \r
 Shader parameters for DP's own features:\r
-- dp_reflect <r> <g> <b>\r
-  Makes surfaces of this shader reflective with r_glsl_water. The reflection is\r
-  additive. When the color isn't specified, it defaults to white (full\r
-  reflection). If only one color component is specified, it counts as a grey\r
-  value.\r
-- dp_refract <refractmin> <refractmax> <distort> <r> <g> <b>\r
-  Marks a surface as "water" for r_glsl_water, that is, add a refraction\r
-  component too. The refraction amount (see dp_reflect) is at most refractmax\r
-  (when looking straight into it) and at least refractmin (when looking parallel\r
-  to the surface). The default distort is multiplied by distort. The color\r
-  modulates the refraction component. refractmin defaults to 0 when unspecified,\r
-  all others default to 1. If only one color component is specified, it counts\r
-  as a grey value.\r
+- dp_reflect <distort> <r> <g> <b> <a>\r
+  Makes surfaces of this shader reflective with r_water. The reflection is\r
+  alpha blended on the texture with the given alpha, and modulated by the given\r
+  color. distort is used in conjunction with the normalmap to simulate a\r
+  nonplanar water surface.\r
+- dp_refract <distort> <r> <g> <b>\r
+  Makes surfaces of this shader refractive with r_water. The refraction\r
+  replaces the transparency of the texture. distort is used in conjunction with\r
+  the normalmap to simulate a nonplanar water surface.\r
+- dp_water <reflectmin> <reflectmax> <refractdistort> <reflectdistort> <refractr> <refractg> <refractb> <reflectr> <reflectg> <reflectb> <alpha>\r
+  This combines the effects of dp_reflect and dp_refract to simulate a water\r
+  surface. However, the refraction and the reflection are mixed using a Fresnel\r
+  equation that makes the amount of reflection slide from reflectmin when\r
+  looking parallel to the water to reflectmax when looking directly into the\r
+  water. The result of this reflection/refraction mix is then layered BELOW the\r
+  texture of the shader, so basically, it "fills up" the alpha values of the\r
+  water. The alpha value is a multiplicator for the alpha value on the texture\r
+  - set this to a small value like 0.1 to emphasize the reflection and make\r
+  the water transparent; but if r_water is 0, alpha isn't used, so the water can\r
+  be very visible then too.\r