redstrate/prism
Archived
1
Fork 0
Code Activity

Fix some README grammatical errors

Browse source
This commit is contained in:
Joshua Goins 2022-05-21 16:44:07 -04:00
parent c60c4992f6
commit b1966a9eaf
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -19,13 +19,13 @@ Here is a selection of screenshots that provides a good sense of the graphical c
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. 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 ## Features
* Custom cross platform high-level graphics API * Custom cross-platform high-level graphics API
* Backends available: * Backends available:
* Vulkan * Vulkan
* Metal * Metal
* DX12 * DX12
* Rendering is consistent regardless of platform or API used! * Rendering is consistent regardless of platform or API used!
* Where older or underperforming GPUs are supported (for example, an Apple TV 4K, or a Thinkpad X230), the engine supports disabling expensive features like IBL or point light shadows and has other scalability options. * Where older GPUs are supported (for example, an Apple TV 4K, or a Thinkpad X230), the engine supports disabling expensive features like IBL or point light shadows and has other scalability options.
* Shaders are written in GLSL, and compiled to the required shader language offline and/or at runtime using SPIRV-Cross and glslang. * Shaders are written in GLSL, and compiled to the required shader language offline and/or at runtime using SPIRV-Cross and glslang.
* Other advanced rendering techniques * Other advanced rendering techniques
* Real-time physically based rendering including using scene probes for image-based lighting. * Real-time physically based rendering including using scene probes for image-based lighting.
@ -36,16 +36,16 @@ The sibenik, sponza and buddha models shown are from the [McGuire Computer Graph
* main() and other platform-specific tidbits are abstracted, for easy support of non-desktop platforms like mobile devices. * main() and other platform-specific tidbits are abstracted, for easy support of non-desktop platforms like mobile devices.
* HiDPI support included and enabled by default! * HiDPI support included and enabled by default!
* If available on the platform, multiple windows are supported as well! This is leveraged by Dear ImGui for multiple viewport support. * If available on the platform, multiple windows are supported as well! This is leveraged by Dear ImGui for multiple viewport support.
* Support for querying whether or not the platform is in light/dark mode (where supported). Currently, this only switches between the light/dark imgui themes. * Support for querying whether the platform is in light/dark mode (where supported). Currently, this only switches between the light/dark imgui themes.
* Dear ImGui used for debug/editor UIs * Dear ImGui used for debug/editor UIs
* Uses the experimental docking/viewport branch! * Uses the experimental docking/viewport branch!
* Automatic DPI scaling on fonts for crisp rendering when the window is in a HiDPI environment. * Automatic DPI scaling on fonts for crisp rendering when the window is in a HiDPI environment.
* Custom ImGui backend is built on top the GFX api and other platform agnostic systems. * Custom ImGui backend is built on top the GFX api and other platform-agnostic systems.
* Plenty of custom widgets available for easily creating debug tools, see [imgui_stdlib.h](https://git.sr.ht/~redstrate/prism/tree/master/item/extern/imgui/include/imgui_stdlib.h) and [imgui_utility.hpp](https://git.sr.ht/~redstrate/prism/tree/master/item/engine/core/include/imgui_utility.hpp)! * Plenty of custom widgets available for easily creating debug tools, see [imgui_stdlib.h](https://git.sr.ht/~redstrate/prism/tree/master/item/extern/imgui/include/imgui_stdlib.h) and [imgui_utility.hpp](https://git.sr.ht/~redstrate/prism/tree/master/item/engine/core/include/imgui_utility.hpp)!
* Entity-Component system for modular object building * Entity-Component system for modular object building
* No runtime polymorphism is involved and it leverages the native C++ type system, [components are kept as simple structs](https://git.sr.ht/~redstrate/prism/tree/master/item/engine/core/include/components.hpp). * No runtime polymorphism is involved, and it leverages the native C++ type system, [components are kept as simple structs](https://git.sr.ht/~redstrate/prism/tree/master/item/engine/core/include/components.hpp).
* Asset management * Asset management
* Custom model file format for super fast model loading and small file sizes. * Custom model file format for super-fast model loading and small file sizes.
* Includes a custom Blender addon for easy exporting! * Includes a custom Blender addon for easy exporting!
* Assets are referenced from disk, and only loaded once - and are unloaded once they are no longer referenced. * Assets are referenced from disk, and only loaded once - and are unloaded once they are no longer referenced.
* Thumbnails are created automatically by the editor and stored on disk until further use. * Thumbnails are created automatically by the editor and stored on disk until further use.
@ -53,13 +53,13 @@ The sibenik, sponza and buddha models shown are from the [McGuire Computer Graph
* Quaternions, matrices, vectors, rays, and more are available! * Quaternions, matrices, vectors, rays, and more are available!
* Infinite perspective matrices are available and used by default. * Infinite perspective matrices are available and used by default.
* Custom editors supporting scene, cutscene, material authoring * Custom editors supporting scene, cutscene, material authoring
* Multidocument workflow similar to UE4. * Multi-document workflow similar to UE4.
* Undo/redo system. * Undo/redo system.
* Transform handles for easy object manipulation. * Transform handles for easy object manipulation.
## Building ## Building
Prism will build out of the box in CMake, but on some platforms (like Windows) you will have to point to some of the Prism will build out of the box in CMake, but on some platforms (like Windows) you will have to point to some
dependencies yourself. dependencies yourself.
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. 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.