https://github.com/deccer/enginekit
Abstraction over modern OpenGL
https://github.com/deccer/enginekit
abstraction-layer enginekit graphics-engine graphics-programming modern-opengl opengl opengl46
Last synced: 6 months ago
JSON representation
Abstraction over modern OpenGL
- Host: GitHub
- URL: https://github.com/deccer/enginekit
- Owner: deccer
- License: mit
- Created: 2022-09-03T15:05:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-25T21:34:47.000Z (about 1 year ago)
- Last Synced: 2024-08-31T12:48:02.070Z (9 months ago)
- Topics: abstraction-layer, enginekit, graphics-engine, graphics-programming, modern-opengl, opengl, opengl46
- Language: C#
- Homepage: https://discord.gg/VxEaZ3B4Tg
- Size: 292 MB
- Stars: 21
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EngineKit
[](https://discord.gg/VxEaZ3B4Tg)
Abstraction over modern OpenGL.
It tries to hide the ugliness of the global state machine that is OpenGL.
## Getting Started
It is a little cumbersome, but bare with me.
Create two projects
- `YourProject` as a console project
- `YourProject.Assets` as a class library project (your IDE might have created a `Class1.cs` file, you can delete that safely)
---
- Add `YourProject.Assets` as a project reference to `YourProject`.
- Copy `Fonts` directory from [here](https://github.com/deccer/EngineKit/tree/main/examples/ForwardRendering/ForwardRendering.Assets) into `YourProject.Assets` (i am working on a neater solution)
- Add `EngineKit` to `YourProject` via nuget as a usual package.
- We also need a few other packages:
- `Microsoft.Extensions.Configuration` - handle configuration in general
- `Microsoft.Extensions.Configuration.Json` - to load appsettings.json
- `Microsoft.Extensions.Options.ConfigurationExtensions` - to turn sections of the configuration into usable objects
- `Microsoft.Extensions.DependencyInjection` - that's the dependency injection container we use here
- `Serilog.Sinks.Console` - to print log statement to the console
- `Serilog.Settings.Configuration` - an adapter for serilog to get its configuration from our configuration object
- Create an `appsettings.json` in `YourProject` which should like like [this](https://github.com/deccer/EngineKit/blob/main/examples/ForwardRendering/ForwardRendering/appsettings.json) one.
- Make sure to have it copied when its newer by right clicking it -> Properties -> "Copy to output directory" -> "Copy if newer"
---
- Create a class `YourProjectApplication` in `YourProject` and let it derive from `GraphicsApplication` (let your IDE implement the constructor, if you cannot figure it out look at [this constructor for inspiration](https://github.com/deccer/EngineKit/blob/main/examples/ForwardRendering/ForwardRendering/ForwardRendererApplication.cs#L69C26-L69C26))
- `Program.cs` of `YourProject` should look like
```cs
using EngineKit;
using EngineKit.Extensions;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Serilog;
namespace YourProject;
internal static class Program
{
public static void Main(string[] args)
{
using var serviceProvider = CreateServiceProvider();
var application = serviceProvider.GetRequiredService();
application.Run();
}
private static ServiceProvider CreateServiceProvider()
{
var configuration = new ConfigurationBuilder()
.AddJsonFile("appsettings.json", false)
.Build();
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(configuration)
.CreateLogger();
var services = new ServiceCollection();
services.AddSingleton(configuration);
services.AddSingleton(Log.Logger);
services.Configure(configuration.GetSection(nameof(WindowSettings)));
services.Configure(configuration.GetSection(nameof(ContextSettings)));
services.AddEngine();
services.AddSingleton(); // replace XXX with YourProjectApplication
return services.BuildServiceProvider();
}
}
```
- Run it.
- You should get a black window which you cannot close :)
- For that you can implement `YourProjectApplication`'s `Update` method via
```cs
protected override void Update(float deltaTime)
{
base.Update(deltaTime);
if (IsKeyPressed(Glfw.Key.KeyEscape))
{
Close();
}
}
```
TODO Complex Example