Commit f4273847 authored by Jan Möbius's avatar Jan Möbius

Improved documentation for TextureControl texture mangling of 1D Textures

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@13754 383ad7c9-94d9-4d36-a494-682f7c89f535
parent a0a79a9a
......@@ -124,26 +124,31 @@ class TextureInterface {
*
* emit this signal if you want to set a special mode for this texture
*
* Supported Mode Flags :\n
* Clamping : clamp=true/false \n
* Min Value for clamping : clamp_min=value \n
* Max Value for clamping : clamp_max=value \n
* Use only absolute values : abs=true/false \n
* repeat texture : repeat=true/false \n
* Maximum value for repeat : max_val=value \n
* center texture : center=true/false \n
* Visible name in ui : visiblename=Name \n
* type : the texture coordinate type ( vertexbased: each vertex has only one texture coordinate ;
* halfedgebased: each vertex has a texture coordinate per face;
* environmentmap: Texturecoords are generated by opengl (sphere map) )
*
*
* \n
* The system works like this :\n
* First the abolute value of the property is taken if requested. Then this value is clamped against the given values. if the texture
* should be repeated, the values are translated such that the minimum is at zero and than scaled such that the maximum is at
* max_val. If its not repeated, the decision is to center the values around 0.5 or not. If not centered, the values are mapped directly
* to 0..1 .If centered, the negative values are mapped to 0..0.5 and the positive values to 0.5..1.
* The values are modified in the following way:\n
*
* First the absolute value of the property is taken if requested:\n
* abs=true/false \n
*
* Then this value is clamped against the given values:\n
* clamp=true/false \n
* clamp_min=value \n
* clamp_max=value \n
*
* If the texture should be repeated, the values are translated such that the minimum is at min_val(0.0 by default)
* and than scaled such that the maximum is at max_val. This data is than passed to the rendering: \n
* repeat=true/false \n
* min_val=value \n
* max_val=value \n
*
* If the texture should not be repeated you could choose to center the data around 0.5. The negative values are than mapped to 0..0.5
* and the positive values to 0.5..1:\n
* center=true/false\n
*
* Otherwise, the values are mapped directly to 0..1. You can also disable that final scaling with:\n
* scale=true/false\n
*
* Examples:\n
* Pass texture without modification: abs=false,clamp=false,repeat=false,center=false,scale=false\n
* @param _textureName Name of your Texture
* @param _mode colon seperated String describing your settings (e.g. clamp,abs )
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment