Code Monkey home page Code Monkey logo

rendererengine's Introduction

ZEngine Window Build ZEngine Linux Build ZEngine macOS Build

ZEngine

ZEngine is an open-source 3D rendering engine written in C++ and using Vulkan as graphic API. It can be used for activities such as:

  • Gaming
  • Scientific computation and visualization

Supported Platforms:

  • Windows
  • macOS (Under active revision as of today)
  • Linux (Debian or Ubuntu are recommended systems) (Under active revision as of today)

Setup

Before building, make sure your setup is correct :

Setup Window machine

  • Install Visual Studio 2022 Community or Professional, make sure to add "Desktop development with C++".
  • Install PowerShell Core
  • Install Vulkan SDK (uncheck the GLM headers component when installing)

Building

  1. Install CMake 3.20 or later.
  2. Start Powershell Core and make sure that you can run CMake, You can type cmake --version to simply output the current CMake version installed.
  3. Change directories to the location where you've cloned the repository.
  4. Building on different systems
    • Building on Windows :
      • Debug version : .\Scripts\BuildEngine.ps1 -Configurations Debug -RunBuilds $True -VsVersion 2022
      • Release version : .\Scripts\BuildEngine.ps1 -Configurations Release -RunBuilds $True -VsVersion 2022
  • Notes :
    • RunBuilds can be omitted as its default value is: $True.
    • You can build Debug and Release versions at once by omitting the Configuration parameter
    • On Windows, you can specify the Visual Studio version with VsVersion, it can be omitted as its default value is: 2022

Dependencies

The project uses the following dependencies as submodules :

  • GLFW for window creation and user input management for Windows, Linux, and MacOS,
  • GLM for functions and mathematical calculations,
  • STB for loading and manipulating image files for textures.
  • ImGUI for GUI components and interaction.
  • SPDLOG for logging
  • EnTT for entity component system
  • Assimp for managing and loading asset 2D -3D models
  • yaml-cpp for parsing and emitting YAML files

rendererengine's People

Contributors

aristid-lavri avatar jeanphilippekernel avatar jfancis avatar jnyfah avatar lamarrr avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

rendererengine's Issues

Complete keyboard keys

Add others keyboard keys in KeyCode enum.

Target file : Z_Engine/src/Inputs/KeyCode.h

Update GitHub Action CI

Since we moved to CMake, the build pipeline need to be updated to run on Windows and Linux

  • Window CI
  • Linux CI

Automate building steps with a PowerShellCore script

Since we moved to CMake Build System, this requires typing a command line with a bunch of parameters to drive Debug or Release builds.
Having a build script that can automate this process and provide a flexible way to extend and mix parameters would be useful.

  • Available on Windows
  • Available on Linux

One point that should be TBD is, in the post-build step we must copy/move some files and directories in Debug or Release dirs, the question is :

  • Do we achieve that step in CMake-ish way or in PowerShell Core -ish way ??

Add support of Camera

provide different kind of 3D camera (follow camera, euler camera, ... quaternion camera etc..)

  • Euler Camera

  • FPS Camera

  • we should go from Euler angle to Quaternion for camera rotation

Remove & Refacto comments

Remove comments for clean code.

Target files :

  • Sandbox/src/Assets/Shaders/texture.glsl
  • Sandbox/src/Layers/ExampleLayer.cpp
  • Z_Engine/src/LayerStack.cpp
  • Z_Engine/src/Z_Engine.h
  • Z_Engine/src/Layers/ImguiLayer.h
  • Z_Engine/src/Rendering/Buffers/IndexBuffer.h
  • Z_Engine/src/Rendering/Buffers/VertexArray.h
  • Z_Engine/src/Rendering/Renderer/GraphicRenderer.h
  • Z_Engine/src/Rendering/Shaders/Shader.cpp
  • Z_Engine/src/Window/SDLWin/OpenGLWindow.cpp
  • Z_Engine/src/Engine.cpp

Add Contributing.md documentation

It'll be nice, for new contributors to have a step they can follow to set up the repository locally
and how they can format their pull request to facilitate the triages process (like description, changes, fix) etc...

Complete API provided by MeshBuiler

Add much more API in MeshBuilder to create basic 2D and 3D meshes (square, circle etc...)

  • Quad API

  • Square API

  • Circle API

  • Polygon API

  • Arc API

  • Line API

  • Dot API

  • Cube API

Provide interfaces for better event callback methods

These events should be migrated in appropriate interface (struct / class)

::OnKeyPressed(KeyPressedEvent& event)
::OnKeyReleased(KeyReleasedEvent& event)
::OnMouseButtonPressed(MouseButtonPressedEvent& event)
::OnMouseButtonReleased(MouseButtonReleasedEvent& event)
::OnMouseButtonMoved(MouseButtonMovedEvent& event)
::OnTextInputRaised(TextInputEvent& event)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.