base on Tiny C++ Software Renderer / Rasterizer, and implements OpenGL and Vulkan renderers for comparison # SoftGLRender [](https://github.com/keith2018/SoftGLRender/actions/workflows/cmake_macos.yml) [](https://github.com/keith2018/SoftGLRender/actions/workflows/cmake_windows.yml) [](https://github.com/keith2018/SoftGLRender/actions/workflows/cmake_linux.yml) Tiny C++ software renderer/rasterizer that implements the main steps of the GPU rendering pipeline, including point, line and polygon rasterization, texture mapping, depth testing, color blending, etc., and emulates vertex shaders and fragment shaders using C++, 3D models (GLTF) are loaded by [Assimp](https://github.com/assimp/assimp), and using [GLM](https://github.com/g-truc/glm) as math library. The project also adds OpenGL and Vulkan renderers implementation, you can switch between them (Software/OpenGL/Vulkan) in real time while running. The purpose of this project is to provide a starting point for developers who want to learn about modern graphics programming. ## Examples | | | |-------------------------------|--------------------------------| |  |  | |  |  | |  |  | ## Features ### Software Renderer #### Pipeline - Vertex shading - View Frustum culling (line & triangle) - Perspective Correct Interpolation - Back-Front face culling - Point/Line/Triangle rasterization - Fragment Shading - Shader derivative `dFdx` `dFdy` - Depth test & Alpha blending - Early Z test & Reversed Z - MSAA 4x #### Texture Mapping - Mipmaps generation and sampling - Sample parameters: `Lod`, `Bias`, `Offset` - All kinds of texture filtering & wrapping mode - Image storage tiling and swizzling - Linear: pixel values are stored line by line, commonly used as image RGBA buffer - Tiled: block base storage, inside the block pixels are stored as `Linear` - Morton: block base storage, inside the block pixels are stored as morton pattern (similar to zigzag) #### Optimization - Multi-Threading: rasterization is block based with multi-threading support - SIMD: barycentric coordinate calculation, shader's varying interpolation, etc. ### Viewer - Config panel based on `imgui` - Orbit camera controller - Blinn-Phong shading - PBR & IBL shading - Skybox cubeMap & equirectangular - Shadow mapping - FXAA anti-aliasing - RenderDoc in-application frame capture ## Renderer abstraction All renderers (Software/OpenGL/Vulkan) are implemented based on this abstract renderer class: ```cpp class Renderer { public: // framebuffer std::shared_ptr<FrameBuffer> createFrameBuffer(bool offscreen); // texture std::shared_ptr<Texture> createTexture(const TextureDesc &desc); // vertex std::shared_ptr<VertexArrayObject> createVertexArrayObject(const VertexArray &vertexArray); // shader program std::shared_ptr<ShaderProgram> createShaderProgram(); // pipeline states std::shared_ptr<PipelineStates> createPipelineStates(const RenderStates &renderStates); // uniform std::shared_ptr<UniformBlock> createUniformBlock(const std::string &name, int size); std::shared_ptr<UniformSampler> createUniformSampler(const std::string &name, const TextureDesc &desc); // pipeline void beginRenderPass(std::shared_ptr<FrameBuffer> &frameBuffer, const ClearStates &states); void setViewPort(int x, int y, int width, int height); void setVertexArrayObject(std::shared_ptr<VertexArrayObject> &vao); void setShaderProgram(std::shared_ptr<ShaderProgram> &program); void setShaderResources(std::shared_ptr<ShaderResources> &uniforms); void setPipelineStates(std::shared_ptr<PipelineStates> &states); void draw(); void endRenderPass(); }; ``` ## Getting Started ### Prerequisites To build the project, you must first install the following tools: - CMake 3.10 or higher - Compiler environment with C++11 support If you want to run the vulkan renderer, you need to install vulkan library as follows: 1. Download the Vulkan SDK from the official website: https://vulkan.lunarg.com/sdk/home 2. Install the SDK on your system. The installation process may vary depending on your operating system. 3. Set the environment variable VULKAN_SDK/VK_ICD_FILENAMES/VK_LAYER_PATH to the path where you installed the SDK. ### Getting the Code To get the code for this library, you can clone the GitHub repository using the following command: ```bash git clone https://github.com/keith2018/SoftGLRender.git ``` Alternatively, you can download the source code as a ZIP file from the GitHub repository. ### Building the Project To build the project, navigate to the root directory of the repository and run the following commands: ```bash mkdir build cmake -B ./build -DCMAKE_BUILD_TYPE=Release cmake --build ./build --config Release ``` This will generate the executable file and copy assets to directory `bin`, which you can run by executing the following command: ```bash cd bin/Release ./SoftGLRender ``` ## Directory structure - `assets`: GLTF models and skybox textures, `assets.json` is the index of all model & skybox materials - `src`: Main source code directory - `Base`: Basic utility classes like file, hash, timer, etc. - `Render`: Renderer abstraction, include vertex, texture, uniform, framebuffer, etc. - `Software`: Software renderer implementation - `OpenGL`: OpenGL renderer implementation - `Vulkan`: Vulkan renderer implementation - `Viewer`: GLTF loading (based on Assimp), camera & controller, config panel, and render pass management - `Shader/GLSL`: GLSL shader code, for OpenGL & Vulkan renderer - `Shader/Software`: C++ simulation of vertex shaders and fragment shaders - `third_party`: External libraries and assets ## Third Party Libraries - `assimp` [https://github.com/assimp/assimp](https://github.com/assimp/assimp) - `glfw` [https://github.com/glfw/glfw](https://github.com/glfw/glfw) - `glm` [https://github.com/g-truc/glm](https://github.com/g-truc/glm) - `glslang` [https://github.com/KhronosGroup/glslang](https://github.com/KhronosGroup/glslang) - `imgui` [https://github.com/ocornut/imgui](https://github.com/ocornut/imgui) - `json11` [https://github.com/dropbox/json11](https://github.com/dropbox/json11) - `stb_image` [https://github.com/nothings/stb](https://github.com/nothings/stb) - `vma` [https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator) ## Contributing If you would like to contribute to the project, you are welcome to submit pull requests with bug fixes, new features, or other improvements. Please ensure that your code is well-documented and adheres to the project's coding standards. ## License This code is licensed under the MIT License (see [LICENSE](LICENSE)). ", Assign "at most 3 tags" to the expected json: {"id":"6141","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"