Flourish is a cross-platform 3D rendering library. It is designed to allow both high and low level interaction with the underlying graphics APIs. It is also designed to be used with a multithreaded rendering approach. Flourish supports Vulkan for all platforms with (eventually) the option of switching to native Metal when running on Apple devices.
This library was written to replace the internal one used in the Heart game engine. It is a work in progress, but it is currently has numerous features.
Flourish is intended to be used as a medium-level abstraction for the underlying graphics APIs on semi-modern devices. As it is an abstraction, some extremely fine-grained and targeted features or optimizations may not be available to the user. Additionally, in order to create a clean and simplified API, some assumptions here and there are made, which may mean older or esoteric hardware will not work correctly.
- Render graph based GPU execution model
- Build graphs once or dynamically
- Define dependencies between work and resources
- Sync or async GPU work execution
- Multithreaded GPU command recording and submission
- Automatic optimizations for frame-based rendering
- Double and triple buffering support
- Queryable features depending on user hardware
- ALPHA support for hardware-accelerated ray tracing
- (Partial) bindless descriptor model
- Built-in GLSL shader compilation and reflection
- Automatic lifetime management for most resources
- Sync or async data uploads to and from the GPU
- Texture compression support
Flourish has been tested on the following platforms: windows, android arm64, macos arm64.
Flourish currently supports Vulkan 1.1 with a minimal amount of required extensions, which should be supported on most platforms.
Setting up Flourish is relatively simple, and it utilizes CMake and git submodules.
- Clone the repo using the
--recursiveflag to ensure all submodules are downloaded - Make sure the VulkanSDK is accessible via the
${VULKAN_SDK}environment variable (this should happen automatically with the installer on Windows)
- On MacOS, this should be <sdk_version>/macOS
To use in a project, add_subdirectory should be sufficient if using git submodules or another form of package management. CMake install support will come at some point in the future.
add_subdirectory("path-to-flourish")
target_link_libraries(MyTarget PUBLIC FlourishCore)
target_include_directories(MyTarget PUBLIC "path-to-flourish/Flourish/src")There are also some CMake compile options that can be set using
set(FLOURISH_FLAG OFF)or
set(FLOURISH_STR_FLAG "string")FLOURISH_BUILD_TESTS: Build the test program. Default off.FLOURISH_ENABLE_LOGGING: Enable logging output from the library. Default on.FLOURISH_ENABLE_AFTERMATH: Enable integration with NVIDIA NSight Aftermath. The SDK must be accessible via the${NSIGHT_AFTERMATH_SDK}environment variable. Default off.FLOURISH_GLFW_INCLUDE_DIR: Path to the include directory of GLFW. Default empty. Setting a value here will enable builtin GLFW support for Flourish.FLOURISH_IMGUI_INCLUDE_DIR: Path to the include directory of ImGui. Default empty. Setting a value here will enable builtin ImGUI support for Flourish.FLOURISH_TRACY_INCLUDE_DIR: Path to the include directory of Tracy. Default empty. Setting a value here will enable builtin profiling for Flourish calls.
Coming soon
Copyright (C) 2024 Evan Thompson
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/