shithub: tinygl

Download patch

ref: f335eb384d26994f3b587bac7e573399c5a43175
parent: 07e9153dc15eddb645623b86010dab332761f99a
author: David <gek@katherine>
date: Sat Feb 13 11:14:01 EST 2021

readme update

--- a/README.md
+++ b/README.md
@@ -1,5 +1,8 @@
 # TinyGL- New and Improved
 
+A rework of Fabrice Bellard's TinyGL (still compiling with -std=c99) to be
+more useful as a software rasterizer.
+
 Without Polygon Stipple:
 
 ![GIF Video of demo](capture.gif)
@@ -24,15 +27,39 @@
 It is a small, suckless Software-only partial GL 1.1 implementation.
 
 The original project was by Fabrice Bellard. We have forked it.
+
 The changelog is as such:
+
 * Disabled all non-RGBA rendering modes. The only supported mode is now RGBA.
 
 * Implemented new functions and some of GL 1.1's prototypes including polygon stipple.
 
-* Fixed a myriad of bugs
-NEW FUNCTIONS
-###
+* Fixed a myriad of bugs and... weirdnesses
 
+
+
+Note that this Softrast **is not GL 1.1 compliant** and does not constitute a complete GL implementation.
+
+You *will* have to tweak your code to work with this library. That said, once you have, it will run anywhere that you can get
+C99. TinyGL has very few external dependencies.
+
+
+
+Notable limitations:
+
+* The only supported texture size and format is RGB 256x256
+
+* there is no GL_BLEND compatibility whatsoever
+
+* A lot of prototypes are missing.
+
+* 
+
+
+### NEW FUNCTIONS 
+
+These are functions not in the GL 1.1 spec that i've added to make this library more useful.
+
 ### glDeleteList
 
 An easier to use version of glDeleteLists. glDeleteLists is also implemented.
@@ -76,16 +103,18 @@
 
 * Little endian was assumed in a thousand places in the code
 
-* Lack of screen door transparency support (GL_POLYGON_STIPLE) even though it is virtually zero cost.
+* 
 
-* Missing easy-to-implement prototypes
 
-
   
 ## FULLY COMPATIBLE WITH RGBA!
 
 The library is now configured properly for RGBA rendering. Note that the output *is actually ABGR* 
 but adjusting it is easy, see the SDL examples under SDL_EXAMPLES (They require SDL 1.2 and Mixer to compile)
+
+It is a notable loss in this version of TinyGL that 16 bit color support was removed. The only supported mode is 32 bit
+
+This was done to keep this library maintainable.
 
 # Here is the old description of TinyGL, saved for historical/attribution purposes: