diff options
| author | Philipp Möller <bootsarehax@googlemail.com> | 2014-05-30 23:24:11 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-06-05 13:58:40 (GMT) |
| commit | 0496c4302e43f8b4297a905e9083db08786c4e7b (patch) | |
| tree | 8a18f7e6dece6764ce551d67d79c9c342a188d03 /Modules/FindOpenGL.cmake | |
| parent | 2336ec514080014430589166287e076c7e5608d8 (diff) | |
| download | CMake-0496c4302e43f8b4297a905e9083db08786c4e7b.zip CMake-0496c4302e43f8b4297a905e9083db08786c4e7b.tar.gz CMake-0496c4302e43f8b4297a905e9083db08786c4e7b.tar.bz2 | |
FindOpenGL: Organize and format module documentation
Diffstat (limited to 'Modules/FindOpenGL.cmake')
| -rw-r--r-- | Modules/FindOpenGL.cmake | 42 |
1 files changed, 24 insertions, 18 deletions
diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index 21c2198..a83a6c3 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -2,32 +2,38 @@ # FindOpenGL # ---------- # -# Try to find OpenGL +# FindModule for OpenGL and GLU. # -# Once done this will define +# Result Variables +# ^^^^^^^^^^^^^^^^ # -# :: +# This module sets the following variables: # -# OPENGL_FOUND - system has OpenGL -# OPENGL_XMESA_FOUND - system has XMESA -# OPENGL_GLU_FOUND - system has GLU -# OPENGL_INCLUDE_DIR - the GL include directory -# OPENGL_LIBRARIES - Link these to use OpenGL and GLU +# ``OPENGL_FOUND`` +# True, if the system has OpenGL. +# ``OPENGL_XMESA_FOUND`` +# True, if the system has XMESA. +# ``OPENGL_GLU_FOUND`` +# True, if the system has GLU. +# ``OPENGL_INCLUDE_DIR`` +# Path to the OpenGL include directory. +# ``OPENGL_LIBRARIES`` +# Paths to the OpenGL and GLU libraries. # +# If you want to use just GL you can use these values: # +# ``OPENGL_gl_LIBRARY`` +# Path to the OpenGL library. +# ``OPENGL_glu_LIBRARY`` +# Path to the GLU library. # -# If you want to use just GL you can use these values +# OSX Specific +# ^^^^^^^^^^^^ # -# :: -# -# OPENGL_gl_LIBRARY - Path to OpenGL Library -# OPENGL_glu_LIBRARY - Path to GLU Library -# -# -# -# On OSX default to using the framework version of opengl People will +# On OSX default to using the framework version of OpenGL. People will # have to change the cache values of OPENGL_glu_LIBRARY and -# OPENGL_gl_LIBRARY to use OpenGL with X11 on OSX +# OPENGL_gl_LIBRARY to use OpenGL with X11 on OSX. + #============================================================================= # Copyright 2001-2009 Kitware, Inc. |