From 509d88f99033cb3c9f56f85a6ba3605875a6b001 Mon Sep 17 00:00:00 2001 From: David Allemang Date: Tue, 1 Aug 2017 22:06:35 -0400 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 078ee98..c5c9bfc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ # Diamond -simple tile/voxel engine and testing +This project wraps OpenGL objects with managed .NET types. It uses OpenTK for most of the GL function bindings, and relies on OpenTK's math libraries. This is intended mainly as a convenience for writing simple OpenGL4 programs in .NET. + +The wrapper classes use reflection to extract some information about .NET types, allowing them to be seamlessly packed into OpenGL buffers, making it very easy to manipulate buffers with typical .NET collections. + +The attributes `[VertexData]` and `[VertexPointer]` indicate which members of a struct should be sent to which index of a shader. The built-in .NET Layout attributes should also be respected.