OpenGL Water Simulation

A real-time OpenGL water and terrain rendering project. Originally built on Windows using Visual Studio, this project has been ported to Linux using cross-platform CMake and C++17.

Features

Water is made of a simple quad having multiple effects on it, like:

• Reflection & Refraction using Frame Buffer Objects
• Fresnel Effect
• Distortion using DUDV maps
• Normal map for light reflections

Available Commands

You have access to a few arguments in order to change the water effects:

• Texture Tiling - Mouse Scroll while holding down 1
• Distortion Strength - Mouse Scroll while holding down 2
• Distortion Speed - Mouse Scroll while holding down 3
• Specular Power - Mouse Scroll while holding down 4
• Light Color - Mouse Scroll while holding down 5, 6 or 7 for R, G or B channels

---

Prerequisites & Dependencies

To compile and run this project on Linux, you will need a C++17 compliant compiler (gcc or clang), cmake, and the following development libraries:

• OpenGL (Core Graphics Drivers)
• GLEW (Extension Wrangler)
• GLFW (Windowing & Input)
• FreeGLUT (Utility Toolkit)
• FreeImage (Image Loading)
• GLM (OpenGL Mathematics)

Dependency Installation

CachyOS / Arch Linux

Most libraries are available via the standard package manager (pacman). Note that freeimage must be installed via the Arch User Repository (AUR) using an AUR helper like paru or yay.

# Install core build tools and standard repositories libraries
sudo pacman -S base-devel cmake glew glfw freeglut glm

# Install FreeImage from the AUR (Do NOT run with sudo)
paru -S freeimage
# OR:
yay -S freeimage

Ubuntu / Debian

If setting up on a Debian-based distribution, use apt:

sudo apt update
sudo apt install build-essential cmake libglew-dev libglfw3-dev freeglut3-dev libfreeimage-dev libglm-dev

---

Building the Project

You can build the project either directly through the terminal or by using Visual Studio Code.

Method 1: Via Terminal (Standard CMake)

From the project root directory, run the following commands to configure and compile:

# Create and enter the build directory
mkdir build && cd build

# Configure the project using native Linux compilers
cmake -DCMAKE_BUILD_TYPE=Debug ..

# Compile the executable
make

Method 2: Via VS Code (Recommended)

1. Open the project folder in VS Code.

2. Install the following extensions:

   • C/C++ (by Microsoft)
   • CMake Tools (by Microsoft)

3. Open the Command Palette (Ctrl + Shift + P) and run CMake: Select a Kit. Choose your native host compiler (e.g., GCC or Clang). Do NOT select clang-cl.

4. Run CMake: Configure.

5. Click the Build button on the bottom blue status bar (or press F7).

---

Running the Application

There are two critical platform constraints to keep in mind when running this application on modern Linux systems:

1. Working Directory: The application loads assets (Shaders, Textures) using relative paths. It must be executed with the project root folder as the working directory.

2. Wayland Display Server: If you are running a Wayland-based desktop (default on CachyOS), GLEW requires an X11 context to initialize properly (No GLX display error). You must pass the GLFW_PLATFORM=x11 environment variable to force XWayland compatibility.

Running via Terminal

Always run the executable from the project root directory (not from inside the build folder):

# Ensure you are in the project root folder
cd /path/to/OpenGL-Water

# Launch the app forcing X11 context compatibility
GLFW_PLATFORM=x11 ./build/OpenGL_Water

Running via VS Code (Automated Setup)

To make clicking the Play [▷] button in VS Code work seamlessly without errors, create or update .vscode/settings.json in your project root with the following configuration:

{
    "cmake.debugConfig": {
        "cwd": "${workspaceFolder}",
        "environment": [
            {
                "name": "GLFW_PLATFORM",
                "value": "x11"
            }
        ]
    }
}

Once saved, clicking Launch / Play on the bottom status bar will properly route the assets paths and handle display window contexts automatically.

---

References

OpenGL Step by Step

ThinMatrix Beginners OpenGL 3D Game Tutorials

ThinMatrix OpenGL Water Tutorials

Dependencies

freeglut | glew | GLFW | FreeImage