Skip to content
This repository
Browse code

update the README.md

  • Loading branch information...
commit 5d2cdda7b1613d2fac6135290eae0f4eb8a14259 1 parent 6b1a642
Cass Everitt casseveritt authored

Showing 1 changed file with 37 additions and 1 deletion. Show diff stats Hide diff stats

  1. +37 1 README.md
38 README.md
Source Rendered
@@ -3,5 +3,41 @@ Regal
3 3
4 4 Regal for OpenGL
5 5
6   -https://github.com/casseveritt/regal
  6 +https://github.com/p3/regal
  7 +
  8 +From an application developer's perspective, Regal just looks like an OpenGL implementation.
  9 +You link with it instead of your platform's OpenGL library or framework, and that's really
  10 +all you have to do to use Regal. The rest of your code can remain unchanged.
  11 +
  12 ++--------------------------------------------------------------------------------------+
  13 +| **Warning** | Regal is pre-alpha software, it is provided here to look at |
  14 +| | and to play with the examples. Don't use it in your projects yet. |
  15 +| | You have been warned. |
  16 ++--------------------------------------------------------------------------------------+
  17 +
  18 +Why use Regal? (Once it's ready, I mean.)
  19 +
  20 + * It is portable.
  21 + A single, consistent API that runs on all major platforms: Windows, Linux, Mac, iOS, and Android
  22 +
  23 + * It is compatible.
  24 + Feel free to use immediate mode, fixed function, GL_QUADS. Old code still works even on ES and core profiles.
  25 +
  26 + * It is open source.
  27 + There is nothing behind the curtain. You can see what Regal is doing and change it if you need to.
  28 +
  29 + * It is modern.
  30 + You can use Direct State Access and Vertex Array Object unconditionally with Regal because it is supported on all platforms.
  31 + Other similar extensions like debug label and debug output are planned.
  32 +
  33 + * It is efficient.
  34 + If it cannot be implemented efficiently in Regal, it is not supported universally. No tessellation
  35 + support without tessellation hardware, for example.
  36 +
  37 + * It makes development easier.
  38 + Set a breakpoint on a GL entry point. Step into the code. Look at state. Register an error callback.
  39 + Regal makes all this possible today. In addition to debug label and debug output support going in soon,
  40 + there will be support for trace dumps and state dumps to quickly see what your app is doing.
  41 +
  42 +
7 43

0 comments on commit 5d2cdda

Please sign in to comment.
Something went wrong with that request. Please try again.