FindOpenGL: Organize and format module documentation

This commit is contained in:
Philipp Möller 2014-05-31 01:24:11 +02:00 committed by Brad King
parent 2336ec5140
commit 0496c4302e
1 changed files with 24 additions and 18 deletions

View File

@ -2,32 +2,38 @@
# FindOpenGL # 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_FOUND``
# OPENGL_XMESA_FOUND - system has XMESA # True, if the system has OpenGL.
# OPENGL_GLU_FOUND - system has GLU # ``OPENGL_XMESA_FOUND``
# OPENGL_INCLUDE_DIR - the GL include directory # True, if the system has XMESA.
# OPENGL_LIBRARIES - Link these to use OpenGL and GLU # ``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
# ^^^^^^^^^^^^
# #
# :: # On OSX default to using the framework version of OpenGL. People will
#
# 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
# have to change the cache values of OPENGL_glu_LIBRARY and # 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. # Copyright 2001-2009 Kitware, Inc.