Changes between Version 6 and Version 7 of XmlModuleConfiguration

Timestamp:

Feb 18, 2011, 5:17:28 PM (13 years ago)

Author:

Torben Dannhauer

Comment:

--

XmlModuleConfiguration

@@ -23 +23 @@
 }}}
 
-== distortion ==
+== Distortion ==
+You can enable the distortion module to distort the final image for projection on non-planar surfaces. The channel name is the suffixname of the required configuration files.
+The distortion requires three files:
+ * distort_<channelname>.bmp: The distortion map, with the distortion vector encoded in the RGB values of each pixel of the distortion map.
+ * blend_<channelname>.bmp: The blend map which contains the soft edge blending mask for seamless blending between video projectors.
+ * view_<channelname>.cfg: The configuration file, which contains the frustum and the rotational and translational offset of the projector (and hence of the !OpenGL "camera").
+
+The XML configuration is as followed:
 {{{
 #!xml
 <module name="distortion" enabled="no">
-  <!-- XML configuration of the module "distortion"
-    channelname = name of the channel, used to load the distortion- and blendmaps
-    renderimplementation = technique to distort.
-    Available options: 
-        fbo : renderImplementation = osg::Camera::FRAME_BUFFER_OBJECT
-        pbuffer : renderImplementation = osg::Camera::PIXEL_BUFFER
-        pbuffer-rtt :  renderImplementation = osg::Camera::PIXEL_BUFFER_RTT
-        fb : renderImplementation = osg::Camera::FRAME_BUFFER
-        window : renderImplementation = osg::Camera::SEPERATE_WINDOW
-  -->
   <distortion channelname="center" renderimplemmentation="fbo" width="2048" height="2048" useshader="yes" hdr="yes" usetexturerectangle="no"></distortion>
   <!-- optional: <distortionmap filename="distmap.png"></distortionmap> to set distortionmap independend from channel map-->
   <!-- optional: <blendmap filename="blendmap.png"></blendmap> to set blendmap independend from channel map -->
+</module>
+}}}
+
+You can select the technique which should be used to distort the images. The available renderImplementations are:
+ * fbo : renderImplementation = osg::Camera::FRAME_BUFFER_OBJECT
+ * pbuffer : renderImplementation = osg::Camera::PIXEL_BUFFER
+ * pbuffer-rtt :  renderImplementation = osg::Camera::PIXEL_BUFFER_RTT
+ * fb : renderImplementation = osg::Camera::FRAME_BUFFER
+ * window : renderImplementation = osg::Camera::SEPERATE_WINDOW
+
+You have to select the heights and width of the distortion map you want to use. The flag "useshader" indicates to use shaders instead of plain OpenGL.
+To distort HDR renderings enable the flag "hdr". The Flag "usetexturerectangle" indicated whether a texture rectangle should be used to display the distorted image.
+
+'''OPTIONAL'''[[br]]
+If your distortion- or blendmap are named different from the standard naming scheme, you can define the names explicit insinde the XML <module> entry (parallel to the XML <distortion> entry):
+{{{
+#!xml
+<module name="distortion" enabled="yes">
+  <distortion ...></distortion>
+  <distortionmap filename="yourDistmap.png"></distortionmap>
+  <blendmap filename="yourBlendmap.png"></blendmap>
 </module>
 }}}