https://github.com/r2turntrue/irodori
easy-to-use, safe rendering library written in c#
https://github.com/r2turntrue/irodori
3d opengl rendering rendering-engine
Last synced: 4 months ago
JSON representation
easy-to-use, safe rendering library written in c#
- Host: GitHub
- URL: https://github.com/r2turntrue/irodori
- Owner: R2turnTrue
- License: mit
- Created: 2025-08-23T18:20:05.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2025-09-27T16:04:03.000Z (5 months ago)
- Last Synced: 2025-09-27T17:37:21.417Z (5 months ago)
- Topics: 3d, opengl, rendering, rendering-engine
- Language: C#
- Homepage: https://www.nuget.org/packages/Irodori/
- Size: 442 KB
- Stars: 5
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# irodori
> means "to color" in Japanese
a rendering library written in C#
## install
```bash
dotnet package add Irodori
dotnet package add Irodori.Backend.OpenGL
dotnet package add Irodori.Windowing.Sdl2
```
## features
- easy to use & simple
- just a few lines to create a window and render something
- null safety
- no null reference exceptions!
- type strict
- minimum implicit conversions, most things are explicit.
- zero throws
- no exceptions thrown during runtime by the library. don't worry about unexpected crashes.
- use `IrodoriReturn` to handle errors explicitly.
- NativeAOT ready
- zero reflection, works with NativeAOT
## minimal example
### window
```csharp
using Irodori;
// ...
var gfx = Gfx.Create()
.WithBackend(new OpenGlBackend())
.WithWindowing(new Sdl2Windowing())
.WithWindowConfig(new Window.InitConfig
{
Title = "SampleDraw",
Width = 1280,
Height = 720,
Resizable = false
})
.Init()
.Unwrap();
while (!gfx.Window.ShouldClose)
{
gfx.Window.PollEvents();
gfx.Clear(Color.CornflowerBlue);
gfx.Window.SwapBuffers();
}
```
### triangle
```csharp
string vshCode = @"
#version 330 core
layout(location = 0) in vec3 aPos;
layout(location = 1) in vec3 aColor;
out vec3 ourColor;
void main()
{
gl_Position = vec4(aPos, 1.0);
ourColor = aColor;
}
";
string fshCode = @"
#version 330 core
out vec4 FragColor;
in vec3 ourColor;
uniform float factor;
void main()
{
FragColor = vec4(ourColor, 1.0) * factor;
}
";
var gfx = Gfx.Create()
.WithBackend(new OpenGlBackend())
.WithWindowing(new Sdl2Windowing())
.WithWindowConfig(new Window.InitConfig
{
Title = "SampleDraw",
Width = 1280,
Height = 720,
Resizable = false
})
.Init()
.Unwrap();
var vsh = gfx.CreateShader(EShaderType.Vertex, vshCode)
.Compile()
.Unwrap();
var fsh = gfx.CreateShader(EShaderType.Fragment, fshCode)
.Compile()
.Unwrap();
var prog = gfx.CreateShaderProgram()
.AttachShader(vsh)
.AttachShader(fsh)
.Link()
.Unwrap();
vsh.Dispose();
fsh.Dispose();
var vertexData = VertexData.Create()
.AddVertex(new Vector3(-0.5f, -0.5f, 0.0f), new Vector3(0.0f, 0.0f, 1.0f))
.AddVertex(new Vector3(0.5f, -0.5f, 0.0f), new Vector3(0.0f, 1.0f, 0.0f))
.AddVertex(new Vector3(0.0f, 0.5f, 0.0f), new Vector3(1.0f, 0.0f, 0.0f));
var vertexBuffer = gfx.CreateVertexBuffer(VertexBufferFormat.Create()
.AddAttrib(VertexBufferFormat.Attrib.Vector3())
.AddAttrib(VertexBufferFormat.Attrib.Vector3()))
.Upload(vertexData)
.Unwrap();
float t = 0;
while (!gfx.Window.ShouldClose)
{
gfx.Window.PollEvents();
gfx.Clear(Color.CornflowerBlue);
prog.SetFloat("factor", (MathF.Sin(t) + 1) / 2.0f); // Flicker effect
vertexBuffer.Draw(prog);
t += 0.1f;
gfx.Window.SwapBuffers();
}
```
## supported backends
- [x] opengl
- [ ] vulkan
- [ ] direct3d 11
- [ ] direct3d 12
- [ ] metal
- [ ] webgl
- [ ] webgpu