summaryrefslogtreecommitdiffhomepage
path: root/src/rlgl.c
diff options
context:
space:
mode:
authorraysan5 <[email protected]>2016-11-16 18:46:13 +0100
committerraysan5 <[email protected]>2016-11-16 18:46:13 +0100
commit6d1b712a9678a7e1d57d994ab51afafbe06ec5fb (patch)
treea42886c764a5b081d58b9a87ddbfc760febb7b61 /src/rlgl.c
parent9d3ad52160a0e32271a8e3d76d9ea95e9bd0684a (diff)
downloadraylib-6d1b712a9678a7e1d57d994ab51afafbe06ec5fb.tar.gz
raylib-6d1b712a9678a7e1d57d994ab51afafbe06ec5fb.zip
Reviewed modules comments
Diffstat (limited to 'src/rlgl.c')
-rw-r--r--src/rlgl.c29
1 files changed, 24 insertions, 5 deletions
diff --git a/src/rlgl.c b/src/rlgl.c
index d3bba07b..28dc5171 100644
--- a/src/rlgl.c
+++ b/src/rlgl.c
@@ -2,11 +2,30 @@
*
* rlgl - raylib OpenGL abstraction layer
*
-* raylib now uses OpenGL 1.1 style functions (rlVertex) that are mapped to selected OpenGL version:
-* OpenGL 1.1 - Direct map rl* -> gl*
-* OpenGL 2.1 - Vertex data is stored in VBOs, call rlglDraw() to render
-* OpenGL 3.3 - Vertex data is stored in VAOs, call rlglDraw() to render
-* OpenGL ES 2 - Vertex data is stored in VBOs or VAOs (when available), call rlglDraw() to render
+* rlgl allows usage of OpenGL 1.1 style functions (rlVertex) that are internally mapped to
+* selected OpenGL version (1.1, 2.1, 3.3 Core, ES 2.0).
+*
+* When chosing an OpenGL version greater than OpenGL 1.1, rlgl stores vertex data on internal
+* VBO buffers (and VAOs if available). It requires calling 3 functions:
+* rlglInit() - Initialize internal buffers and auxiliar resources
+* rlglDraw() - Process internal buffers and send required draw calls
+* rlglClose() - De-initialize internal buffers data and other auxiliar resources
+*
+* External libs:
+* raymath - 3D math functionality (Vector3, Matrix, Quaternion)
+* GLAD - OpenGL extensions loading (OpenGL 3.3 Core only)
+*
+* Module Configuration Flags:
+* GRAPHICS_API_OPENGL_11 - Use OpenGL 1.1 backend
+* GRAPHICS_API_OPENGL_21 - Use OpenGL 2.1 backend
+* GRAPHICS_API_OPENGL_33 - Use OpenGL 3.3 Core profile backend
+* GRAPHICS_API_OPENGL_ES2 - Use OpenGL ES 2.0 backend
+*
+* RLGL_STANDALONE - Use rlgl as standalone library (no raylib dependency)
+* RLGL_NO_STANDARD_SHADER - Avoid standard shader (shader_standard.h) inclusion
+* RLGL_NO_DISTORTION_SHADER - Avoid stereo rendering distortion sahder (shader_distortion.h) inclusion
+* RLGL_OCULUS_SUPPORT - Enable Oculus Rift CV1 functionality
+*
*
* Copyright (c) 2014-2016 Ramon Santamaria (@raysan5)
*