C++ C CMake GLSL Python C# Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
dependencies @ b7640a5
doc
install
source Cascaded shadow maps are implemented and functional. (#217) Jun 29, 2018
travis
.gitignore
.gitmodules
.tgitconfig
.travis.yml Cascaded shadow maps are implemented and functional. (#217) Jun 29, 2018
AUTHORS
ChangeLog
LICENSE
NEWS Updated doc main page. Dec 30, 2017
README.md
appveyor.yml Review render queue (#215) Jun 21, 2018
freeimage-license.txt Initial commit Feb 20, 2014

README.md

Server Result
Travis CI (Linux) Build Status
AppVeyor (Windows) Build Status

Castor3D

Castor3D is a 3D engine written in C++ 17. It works on Windows and also on GNU/Linux. It relies on RendererLib as a rendering API, allowing Vulkan, OpenGL 3.X and OpenGL 4.X. It is still a work in progress, feel free to contribute!

Features

  • Deferred rendering.
  • Normal mapping.
  • Parallax Occlusion mapping.
  • Screen Space Ambient Occlusion (using Scalable Ambiant Obscurance implementation).
  • Shadow Mapping (allowing to choose between Raw, PCF or Variance Shadow Maps).
  • Reflection/Refraction Mapping.
  • PBR rendering (Metallic and Specular workflows), and Legacy rendering.
  • HDR rendering with various tone mapping operators.
  • Screen Space Subsurface Scattering (without backlit transmittance yet).
  • Volumetric Light Scattering for directional light source projecting shadows.
  • Scene graph.
  • Modular architecture through plug-ins.
  • Shaders are generated automatically from material and pass configuration.
  • Shaders are writable directly from C++ code.

Implemented Plug-ins

Renderers

  • VkRenderSystem.
  • Gl3RenderSystem.
  • Gl4RenderSystem.

Importers

  • ASSIMP: Multiple format mesh importer.
  • PLY: Stanford Polygon library mesh importer.
  • OBJ: Wavefront OBJ mesh importer.

Dividers

  • Loop subdivision surfaces.
  • Phong tessellation.
  • PN-Triangles surfaces.

PostEffects

  • Bloom: HDR Bloom implementation.
  • FilmGrain: To display some grain on the render.
  • GrayScale.
  • LightStreaks (using Kawase Light Streaks).
  • FXAA Antialiasing.
  • SMAA Antialiasing (1X and T2X so far).
  • Linear Motion Blur.

Generators

  • DiamondSquareTerrain: to generate terrains inside Castor3D scenes, using diamond-quare algorithm.

Generic

  • CastorGUI: to build GUIs inside Castor3D scenes.

ToneMappings

  • LinearToneMapping: Default tone mapping.
  • HaarmPieterDuikerToneMapping: Haarm Pieter Duiker tone mapping.
  • HejlBurgessDawsonToneMapping: Hejl Burgess Dawson tone mapping.
  • ReinhardToneMapping: Reinhard tone mapping.
  • Uncharted2ToneMapping: Uncharted 2 tone mapping.

Other applications

  • CastorViewer: A scene viewer based on Castor3D.
  • CastorMeshConverter: A converter from various mesh files to Castor3D mesh format.
  • CastorMeshUpgrader: Upgrades from earlier versions of Castor3D mesh format to the latest one.
  • ImgConverter: Allows you to convert any image file type to XPM or ICO.

Sponza Cerberus Park, Legacy Park, PBR Nyra, PBR

Links

General Questions

  1. I need a feature that Castor3D do not implement, what should I do ? There are two ways. First, Castor3D is a free software and library, so you are welcome to improve it yourself ;-) ! Second, just ask the author :-) !

  2. I implemented a cool feature, can I commit it ? Obviously you are welcome to send the author any improvement. But obviously the author is quite careful with readability, correctness and stability, and will read and check any contribution before including it. Thus, it can take time... There are few basic rules to write contributions:

  3. Do never change the indentation of any part of the code that's not yours.

  4. Do never send codes without a lot of comments in (bad or good) English.

  5. Do never send codes with obscure and/or non-English variable names.

  6. How can I ask the author ? Just send a mail to dragonjoker59@hotmail.com !