Added an intro to the features and goals of the 2D rendering API.

libsdl-org · Feb 3, 2011 · 85ee651 · 85ee651
1 parent f1f81ed
commit 85ee651
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/include/SDL_render.h b/include/SDL_render.h
@@ -24,13 +24,29 @@
  *  \file SDL_render.h
  *  
  *  Header file for SDL 2D rendering functions.
+ *
+ *  This API supports the following features:
+ *      * single pixel points
+ *      * single pixel lines
+ *      * filled rectangles
+ *      * texture images
+ *
+ *  The primitives may be drawn in opaque, blended, or additive modes.
+ *
+ *  The texture images may be drawn in opaque, blended, or additive modes.
+ *  They can have an additional color tint or alpha modulation applied to
+ *  them, and may also be stretched with linear interpolation.
+ *
+ *  This API is designed to accelerate simple 2D operations. You may
+ *  want more functionality such as rotation and particle effects and
+ *  in that case you should use SDL's OpenGL/Direct3D support or one
+ *  of the many good 3D engines.
  */
 
 #ifndef _SDL_render_h
 #define _SDL_render_h
 
 #include "SDL_stdinc.h"
-//#include "SDL_pixels.h"
 #include "SDL_rect.h"
 #include "SDL_video.h"