diff options
| author | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-12 14:37:05 (GMT) |
|---|---|---|
| committer | Bartosz Kosiorek <bartosz.kosiorek@tomtom.com> | 2019-04-23 08:39:34 (GMT) |
| commit | cb811d11cee1e2873cc2bf506cd081769e894ac3 (patch) | |
| tree | 6fa97b0fb931bfbc6faaf866c3e745a0fd5ea430 /Modules/FindosgDB.cmake | |
| parent | 4ff7706f2d7eaaffe3970da5f77d18f67771a4a8 (diff) | |
| download | CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.zip CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.gz CMake-cb811d11cee1e2873cc2bf506cd081769e894ac3.tar.bz2 | |
Help: Improve description of modules
Diffstat (limited to 'Modules/FindosgDB.cmake')
| -rw-r--r-- | Modules/FindosgDB.cmake | 32 |
1 files changed, 20 insertions, 12 deletions
diff --git a/Modules/FindosgDB.cmake b/Modules/FindosgDB.cmake index d0789ba..a28f650 100644 --- a/Modules/FindosgDB.cmake +++ b/Modules/FindosgDB.cmake @@ -7,30 +7,38 @@ FindosgDB -This is part of the Findosg* suite used to find OpenSceneGraph +This is part of the ``Findosg*`` suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular -module (perhaps because the default FindOpenGL.cmake module doesn't +module (perhaps because the default :module:`FindOpenGL` module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the -FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules. +:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules. -Locate osgDB This module defines +Locate osgDB This module defines: -OSGDB_FOUND - Was osgDB found? OSGDB_INCLUDE_DIR - Where to find the -headers OSGDB_LIBRARIES - The libraries to link against for the osgDB -(use this) +``OSGDB_FOUND`` + Was osgDB found? -OSGDB_LIBRARY - The osgDB library OSGDB_LIBRARY_DEBUG - The osgDB -debug library +``OSGDB_INCLUDE_DIR`` + Where to find the headers -$OSGDIR is an environment variable that would correspond to the -./configure --prefix=$OSGDIR used in building osg. +``OSGDB_LIBRARIES`` + The libraries to link against for the osgDB + +``OSGDB_LIBRARY`` + The osgDB library + +``OSGDB_LIBRARY_DEBUG`` + The osgDB debug library + +``$OSGDIR`` is an environment variable that would correspond to:: + + ./configure --prefix=$OSGDIR used in building osg. -Created by Eric Wing. #]=======================================================================] # Header files are presumed to be included like |