Sh: Source File Index

Index of Sh Files

Every documented source file in the Sh project is listed here, each with a brief description and a link to its code. Explore the entries below to see how the Sh shading language and its supporting utilities are implemented.

Doxygen documentation logo
Documentation generated with Doxygen

Primary Headers and Utilities

Begin with the main include file, then look through the utility headers that back the rest of the library.

  • sh.hpp — The primary Sh include file; adding this one header is all it takes to start using Sh.
  • shutil.hpp — The header that provides additional Sh utilities.
  • ShFunc.hpp — A collection of small, miscellaneous Sh utility functions.
  • ShSyntax.hpp — Syntactical definitions for Sh.

Kernels and Nibbles

The headers below supply ready-to-use kernels and nibbles for typical shading work.

  • ShKernelLib.hpp — Implements a set of handy kernels and nibbles (simple kernels).
  • ShKernelLight.hpp — A collection of light shaders; a light shader may use any vertex shader output from ShKerneLib::vsh and must emit a single irrad holding the irradiance at a surface of type T (likely ShColor3f).
  • ShKernelPost.hpp — Postprocessing kernels.
  • ShKernelSurface.hpp — The surface shader kernels.
  • ShNibbles.hpp — A group of nibbles: functions that return ShPrograms for basic operations.

Noise, Textures, and Meshes

  • ShNoise.hpp — An implementation of Perlin noise.
  • ShWorley.hpp — An implementation of the 2D ShWorley texture.
  • ShMesh.hpp — A simple half-edge-based mesh structure.

About This Documentation

This file index was generated with Doxygen. Learn more at the Doxygen project site, or head back to the documentation home page.

Doxygen Website Documentation Home

Each entry in this index points to a specific header, so you can jump straight to the part of Sh you need — whether that is the main include, a kernel library, or a noise and texture utility. Use the descriptions above to pick the right file before opening its source.