# HG changeset patch
# User Sam Lantinga <slouken@libsdl.org>
# Date 1296756235 28800
# Node ID 97423d858a1ad82e1d6d9b44fb0677bacd0986b4
# Parent  d72793305335efefe8e4a536181bb881ae9cc2d8
Added an intro to the features and goals of the 2D rendering API.

diff -r d72793305335 -r 97423d858a1a include/SDL_render.h
--- a/include/SDL_render.h	Thu Feb 03 02:45:29 2011 -0800
+++ b/include/SDL_render.h	Thu Feb 03 10:03:55 2011 -0800
@@ -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"