diff options
| author | Kai Wasserbäch <kai@dev.carbon-project.org> | 2011-08-23 10:48:58 +0200 |
|---|---|---|
| committer | Ian Romanick <ian.d.romanick@intel.com> | 2011-08-25 07:21:00 -0700 |
| commit | dbec3a5daf6fd012adc4d9690ef1dccc65969e04 (patch) | |
| tree | 52415835ffe31fab4e2cadedae6eb9d519a889ae /docs | |
| parent | 79a486ead92e4493b2de1fedf0c8cb5de47003cd (diff) | |
Document the return type coding style.
As per discussion at [0] methods shouldn't use OpenGL return types, if
they're not part of the GL API.
[0] <http://marc.info/?l=mesa3d-dev&m=130754488901774&w=2>
Signed-off-by: Kai Wasserbäch <kai@dev.carbon-project.org>
Signed-off-by: Ian Romanick <ian.d.romanick@intel.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/devinfo.html | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/devinfo.html b/docs/devinfo.html index c0966480ab..d9e82e29d0 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -137,6 +137,16 @@ Function name examples: _mesa_foo_bar() - an internal non-static Mesa function </pre> +<p> +Places that are not directly visible to the GL API should prefer the use +of <tt>bool</tt>, <tt>true</tt>, and +<tt>false</tt> over <tt>GLboolean</tt>, <tt>GL_TRUE</tt>, and +<tt>GL_FALSE</tt>. In C code, this may mean that +<tt>#include <stdbool.h></tt> need to be added. The +<tt>try_emit_</tt>* methods in src/mesa/program/ir_to_mesa.cpp and +src/mesa/state_tracker/st_glsl_to_tgsi.cpp can serve as an example. +</p> + <H2>Making a New Mesa Release</H2> |