prism/README.md

# Prism
[![sourcehut](https://img.shields.io/badge/repository-sourcehut-lightgrey.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSINCiAgICB3aWR0aD0iMTI4IiBoZWlnaHQ9IjEyOCI+DQogIDxkZWZzPg0KICAgIDxmaWx0ZXIgaWQ9InNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSJibGFjayIgLz4NCiAgICA8L2ZpbHRlcj4NCiAgICA8ZmlsdGVyIGlkPSJ0ZXh0LXNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSIjQUFBIiAvPg0KICAgIDwvZmlsdGVyPg0KICA8L2RlZnM+DQogIDxjaXJjbGUgY3g9IjUwJSIgY3k9IjUwJSIgcj0iMzglIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjQlIg0KICAgIGZpbGw9Im5vbmUiIGZpbHRlcj0idXJsKCNzaGFkb3cpIiAvPg0KICA8Y2lyY2xlIGN4PSI1MCUiIGN5PSI1MCUiIHI9IjM4JSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSI0JSINCiAgICBmaWxsPSJub25lIiBmaWx0ZXI9InVybCgjc2hhZG93KSIgLz4NCjwvc3ZnPg0KCg==)](https://git.sr.ht/~redstrate/prism)
[![GitHub
mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/redstrate/prism)

A cross-platform engine providing real-time physically based rendering. This is the culmination
of several years of my own graphics programming work :-)

Here is a selection of screenshots that provides a good sense of the graphical capabilities of Prism:

![pcss](misc/pcss.png?raw=true)
![sponza](misc/sponza.png?raw=true)

![buddha](misc/buddha.png?raw=true)
![custom models](misc/custom%20models.png?raw=true)

The sibenik, sponza and buddha models shown are from the [McGuire Computer Graphics Archive](https://casual-effects.com/data/), any other models shown are created by me.

## Features
You can view a more comprehensive list of features [here](https://github.com/redstrate/prism/wiki/List-of-Features).

## Building
There are instructions for Windows, Linux, and macOS targets in the [wiki](https://github.com/redstrate/prism/wiki).

There is an example app provided in `example/`. If you want to build the tooling or the example, use the CMake options `BUILD_EXAMPLE` and `BUILD_TOOLS` respectively.

## Usage
The ideal way to use it is by letting prism take over your main() and implementing an app_main() instead,
(and using `add_platform_executable` in CMake) but I'm working on letting developers use the engine as a regular library too.
Add initial files 2020-08-11 12:07:21 -04:00			`# Prism`
Add shrt repo to README 2022-02-28 21:32:02 -05:00			[![sourcehut](https://img.shields.io/badge/repository-sourcehut-lightgrey.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSINCiAgICB3aWR0aD0iMTI4IiBoZWlnaHQ9IjEyOCI+DQogIDxkZWZzPg0KICAgIDxmaWx0ZXIgaWQ9InNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSJibGFjayIgLz4NCiAgICA8L2ZpbHRlcj4NCiAgICA8ZmlsdGVyIGlkPSJ0ZXh0LXNoYWRvdyIgeD0iLTEwJSIgeT0iLTEwJSIgd2lkdGg9IjEyNSUiIGhlaWdodD0iMTI1JSI+DQogICAgICA8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIxLjUiDQogICAgICAgIGZsb29kLWNvbG9yPSIjQUFBIiAvPg0KICAgIDwvZmlsdGVyPg0KICA8L2RlZnM+DQogIDxjaXJjbGUgY3g9IjUwJSIgY3k9IjUwJSIgcj0iMzglIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjQlIg0KICAgIGZpbGw9Im5vbmUiIGZpbHRlcj0idXJsKCNzaGFkb3cpIiAvPg0KICA8Y2lyY2xlIGN4PSI1MCUiIGN5PSI1MCUiIHI9IjM4JSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSI0JSINCiAgICBmaWxsPSJub25lIiBmaWx0ZXI9InVybCgjc2hhZG93KSIgLz4NCjwvc3ZnPg0KCg==)](https://git.sr.ht/~redstrate/prism)
			`[![GitHub`
			`mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https://github.com/redstrate/prism)`

Strip down the README 2022-02-21 00:25:44 -05:00			`A cross-platform engine providing real-time physically based rendering. This is the culmination`
			`of several years of my own graphics programming work :-)`
Add initial files 2020-08-11 12:07:21 -04:00
Strip down the README 2022-02-21 00:25:44 -05:00			`Here is a selection of screenshots that provides a good sense of the graphical capabilities of Prism:`
Add initial files 2020-08-11 12:07:21 -04:00
Add shrt repo to README 2022-02-28 21:32:02 -05:00			`![pcss](misc/pcss.png?raw=true)`
			`![sponza](misc/sponza.png?raw=true)`
Add links and screenshots to README 2020-08-11 12:41:19 -04:00
Add shrt repo to README 2022-02-28 21:32:02 -05:00			`![buddha](misc/buddha.png?raw=true)`
			`![custom models](misc/custom%20models.png?raw=true)`
Add links and screenshots to README 2020-08-11 12:41:19 -04:00
Update README.md 2021-02-04 10:06:57 -05:00			`The sibenik, sponza and buddha models shown are from the [McGuire Computer Graphics Archive](https://casual-effects.com/data/), any other models shown are created by me.`

Add initial files 2020-08-11 12:07:21 -04:00			`## Features`
Update README.md 2021-02-04 10:06:57 -05:00			`You can view a more comprehensive list of features [here](https://github.com/redstrate/prism/wiki/List-of-Features).`
Add initial files 2020-08-11 12:07:21 -04:00
Strip down the README 2022-02-21 00:25:44 -05:00			`## Building`
			`There are instructions for Windows, Linux, and macOS targets in the [wiki](https://github.com/redstrate/prism/wiki).`
Add initial files 2020-08-11 12:07:21 -04:00
Add shrt repo to README 2022-02-28 21:32:02 -05:00			There is an example app provided in `example/`. If you want to build the tooling or the example, use the CMake options `BUILD_EXAMPLE` and `BUILD_TOOLS` respectively.
Hint at usages of the engine in README 2022-03-06 19:16:20 -05:00
			`## Usage`
			`The ideal way to use it is by letting prism take over your main() and implementing an app_main() instead,`
			(and using `add_platform_executable` in CMake) but I'm working on letting developers use the engine as a regular library too.