REI is a cross-platform rendering framework and a comprehensive graphics API. Adaptable to various platforms, including PC, consoles, and mobile. It simplifies porting, especially for games developed on custom or proprietary engines. Functions as a cross-platform API as well as a helper library for platform-specific API.
REI is a cross-platform rendering framework. It functions as a comprehensive graphics API and is adaptable to various platforms, including PC, consoles, and mobile. It simplifies porting, especially for games developed on custom or proprietary engines. REI can serve as a cross-platform API as well as a helper library for platform-specific API.
*Only available for accredited developers via licensing
vcpkg integrate install
vcpkg install directx-dxc:x86-windows directx-dxc:x64-windows
vcpkg install sdl2:x86-windows sdl2:x64-windows
\<path to repo\>\sources\REI_Platforms\windows\VSProjects\REI.sln
Here are some samples where REI was used.
This sample shows the classic ‘Hello World’ triangle.
This sample shows basic geometry rendering, with a rotating camera.
This sample shows a fontstash example (https://github.com/memononen/fontstash) with REI as a rendering backend.
This sample shows GLTF model loading and display.
This sample shows how to use REI with ImGUI (https://github.com/ocornut/imgui).
This sample shows a NanoVG example (https://github.com/memononen/nanovg) with REI as a rendering backend.
REI_PLATFORM_<platform_name>=1
was declared in the vcxproj/props files of a specific platform. REI_PLATFORM_WINDOWS
is used for Windows.REI_ENABLE_PIX=1
in RendererD3D12.h or project file.packages.config
is not added to all selected projects you can manually reinstall it using "Manage NuGet Packages" when you right-click a specific project. Or you can click to Tools -> NuGet Package Manager -> Package Manager Console. Then run: update-package -reinstall
USE_RENDER_DOC
define which adds VK_LAYER_RENDERDOC_Capture layer to instance.USE_DEBUG_UTILS_EXTENSION
define which adds VK_EXT_debug_utils extension to instance.REI_VK_ALLOW_BARRIER_INSIDE_RENDERPASS
when enabled, a warning will be displayed, otherwise ASSERT(false)
will be triggered when the user uses REI_cmdResourceBarrier inside a renderpass. If enabled, it closes the open render pass when a resource barrier is requested and opens another render pass.defines.hlsli
).REI utilizes the following Open-Source libraries and tools: