.. Reactive Surface FX documentation master file

Reactive Surface FX Manual
==========================

.. image:: _static/images/overview.png
   :alt: Reactive Surface FX Sidebar UI Overview
   :align: center
   :width: 100%

**Reactive Surface FX** is a modular, high-performance **Blender 4.2+ / 5.0+** extension designed for reactive display simulation, proximity-driven surface illumination, dynamic UV canvas rasterization, and physical mesh transformations.

Key Capabilities
----------------

* **Proximity & Directional Sensing**: Real-time BVH raycasting from surfaces to proximity drivers with custom directions and falloff curves.
* **Versatile Surface Modes & Hardware Acceleration**:

  * **GPU Compute vs CPU Device**: Hardware-accelerated native compute shaders executing directly in VRAM for fluid 60+ FPS viewport playback.
  * **Dynamic Texture Canvas**: Real-time UV painting (up to 4096×4096) with **Continuous Stroke** brush interpolation for unbroken ribbons of paint.
  * **Faceted (Pixels)**: Flip-dots, LED grids, and segmented displays with procedural bezels and gap fills.
  * **Smooth Vertices**: Continuous Gouraud gradients across high-density meshes.

* **Full PBR & Texture Transfer**: Transfer Metallic, Roughness, and Base Color, or perform 3D contact UV stamping and surface reveals.
* **Physical Geometric Transformations**:

  * 3D Mold Conformance hugging driver geometry.
  * Pinscreen normal displacement and mechanical flip rotations.
  * Concentric wave ripples and 4D turbulent noise wakes.
  * 1-Click Geometry Nodes procedural formulas (Magnetic Repulse, Vortex Swirl, Stepped Quantize).
  * 3D Object Instancing replacing faces with custom meshes (spheres, pins, Suzannes).

* **Persistence & Baking**: Phosphor decay trails, 1–64× temporal sub-frame supersampling, and persistent on-disk simulation baking.
* **7 Pre-Built Procedural Demos**: Instant 1-click test setups demonstrating clocks, falling spheres, UV stamps, spinning LED wheels, fluids, cloth, and bucket painting.

User Manual Contents
--------------------

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started/installation
   getting_started/quickstart

.. toctree::
   :maxdepth: 2
   :caption: N-Panel Sidebar Sections

   n_panel/display_simulation
   n_panel/drivers_sensing
   n_panel/texture_transfer
   n_panel/physical_transform
   n_panel/persistence_cache
   n_panel/demo_setups

.. toctree::
   :maxdepth: 2
   :caption: Pre-built Demo Presets

   demos/digital_clock
   demos/falling_spheres
   demos/texture_sampling
   demos/led_wheel
   demos/fluid_luminescence
   demos/luminous_cloth
   demos/bucket_painting

.. toctree::
   :maxdepth: 2
   :caption: Reference & Architecture

   core_concepts/architecture
   reference/operators
   reference/properties