From a4d5d3682bb066b70c2101f96d9c5b268301a154 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sat, 10 Nov 2012 21:14:59 +0100 Subject: [PATCH] Doc: added page with links to valuable "best practices" information. --- doc/best-practices.dox | 15 +++++++++++++++ doc/features.dox | 1 - doc/tips.dox | 8 ++++++++ 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 doc/best-practices.dox create mode 100644 doc/tips.dox diff --git a/doc/best-practices.dox b/doc/best-practices.dox new file mode 100644 index 000000000..c3f500338 --- /dev/null +++ b/doc/best-practices.dox @@ -0,0 +1,15 @@ +/** @page best-practices Best practices in OpenGL + +@brief Platform-specific and general performance advices + +Here is collection of carefully selected links to official guidelines and +other articles with valuable information to help developers create better +applications. Feel free to add one, if it contains new unique information. + +@section best-practices-platform Platform-specific + +- Mac OS - [Best Practices for Working with Vertex Data](https://developer.apple.com/library/mac/#documentation/graphicsimaging/Conceptual/OpenGL-MacProgGuide/opengl_vertexdata/opengl_vertexdata.html), [Best Practices for Working with Texture Data](https://developer.apple.com/library/mac/#documentation/graphicsimaging/Conceptual/OpenGL-MacProgGuide/opengl_texturedata/opengl_texturedata.html) +- iOS - [Best Practices for Working with Vertex Data](http://developer.apple.com/library/ios/#documentation/3DDrawing/Conceptual/OpenGLES_ProgrammingGuide/TechniquesforWorkingwithVertexData/TechniquesforWorkingwithVertexData.html), [Best Practices for Working with Texture Data](http://developer.apple.com/library/ios/#documentation/3DDrawing/Conceptual/OpenGLES_ProgrammingGuide/TechniquesForWorkingWithTextureData/TechniquesForWorkingWithTextureData.html), [Best Practices for Shaders](http://developer.apple.com/library/ios/#documentation/3DDrawing/Conceptual/OpenGLES_ProgrammingGuide/BestPracticesforShaders/BestPracticesforShaders.html#//apple_ref/doc/uid/TP40008793-CH7-SW3) +- Google Chrome Native Client - [Best practices for 3D graphics](https://developers.google.com/native-client/beta/devguide/coding/3D-graphics#best-practices) + +*/ diff --git a/doc/features.dox b/doc/features.dox index d033816fe..339e66824 100644 --- a/doc/features.dox +++ b/doc/features.dox @@ -5,6 +5,5 @@ namespace Magnum { - @subpage matrix-vector - @copybrief matrix-vector - @subpage scenegraph - @copybrief scenegraph - @subpage collision-detection - @copybrief collision-detection -- @subpage compilation-speedup - @copybrief compilation-speedup */ } diff --git a/doc/tips.dox b/doc/tips.dox new file mode 100644 index 000000000..dfaea8909 --- /dev/null +++ b/doc/tips.dox @@ -0,0 +1,8 @@ +namespace Magnum { +/** @page tips Tips and tricks +@brief Hints for better productivity and performance + +- @subpage compilation-speedup - @copybrief compilation-speedup +- @subpage best-practices - @copybrief best-practices +*/ +}