Skip to content

Commit

Permalink
更新Findosg*系列文檔。
Browse files Browse the repository at this point in the history
  • Loading branch information
gwankyun committed Sep 13, 2023
1 parent af386c5 commit d1d1ff6
Show file tree
Hide file tree
Showing 20 changed files with 404 additions and 277 deletions.
44 changes: 26 additions & 18 deletions Modules/Findosg.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,40 @@ Findosg



NOTE: It is highly recommended that you use the new
FindOpenSceneGraph.cmake introduced in CMake 2.6.3 and not use this
Find module directly.
.. note::
It is highly recommended that you use the new
:module:`FindOpenSceneGraph` introduced in CMake 2.6.3 and not use this
Find module directly.

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.

Locate osg This module defines

OSG_FOUND - Was the Osg found? OSG_INCLUDE_DIR - Where to find the
headers OSG_LIBRARIES - The libraries to link against for the OSG (use
this)

OSG_LIBRARY - The OSG library OSG_LIBRARY_DEBUG - The OSG debug
library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osg This module defines:

``OSG_FOUND``
Was the Osg found?
``OSG_INCLUDE_DIR``
Where to find theheaders
``OSG_LIBRARIES``
The libraries to link against for the OSG (use this)
``OSG_LIBRARY``
The OSG library
``OSG_LIBRARY_DEBUG``
The OSG debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
37 changes: 22 additions & 15 deletions Modules/FindosgAnimation.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,35 @@ FindosgAnimation



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.

Locate osgAnimation This module defines

OSGANIMATION_FOUND - Was osgAnimation found? OSGANIMATION_INCLUDE_DIR
- Where to find the headers OSGANIMATION_LIBRARIES - The libraries to
link against for the OSG (use this)

OSGANIMATION_LIBRARY - The OSG library OSGANIMATION_LIBRARY_DEBUG -
The OSG debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgAnimation This module defines:

``OSGANIMATION_FOUND``
Was osgAnimation found?
``OSGANIMATION_INCLUDE_DIR``
Where to find the headers
``OSGANIMATION_LIBRARIES``
The libraries to link against for the OSG (use this)
``OSGANIMATION_LIBRARY``
The OSG library
``OSGANIMATION_LIBRARY_DEBUG``
The OSG debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
4 changes: 3 additions & 1 deletion Modules/FindosgDB.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ Locate osgDB This module defines:

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR used in building osg.
./configure --prefix=$OSGDIR

used in building osg.

#]=======================================================================]

Expand Down
37 changes: 22 additions & 15 deletions Modules/FindosgFX.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,35 @@ FindosgFX



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.

Locate osgFX This module defines

OSGFX_FOUND - Was osgFX found? OSGFX_INCLUDE_DIR - Where to find the
headers OSGFX_LIBRARIES - The libraries to link against for the osgFX
(use this)

OSGFX_LIBRARY - The osgFX library OSGFX_LIBRARY_DEBUG - The osgFX
debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgFX This module defines:

``OSGFX_FOUND``
Was osgFX found?
``OSGFX_INCLUDE_DIR``
Where to find the headers
``OSGFX_LIBRARIES``
The libraries to link against for the osgFX (use this)
``OSGFX_LIBRARY``
The osgFX library
``OSGFX_LIBRARY_DEBUG``
The osgFX debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
37 changes: 22 additions & 15 deletions Modules/FindosgGA.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,35 @@ FindosgGA



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.

Locate osgGA This module defines

OSGGA_FOUND - Was osgGA found? OSGGA_INCLUDE_DIR - Where to find the
headers OSGGA_LIBRARIES - The libraries to link against for the osgGA
(use this)

OSGGA_LIBRARY - The osgGA library OSGGA_LIBRARY_DEBUG - The osgGA
debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgGA This module defines:

``OSGGA_FOUND``
Was osgGA found?
``OSGGA_INCLUDE_DIR``
Where to find the headers
``OSGGA_LIBRARIES``
The libraries to link against for the osgGA (use this)
``OSGGA_LIBRARY``
The osgGA library
``OSGGA_LIBRARY_DEBUG``
The osgGA debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
38 changes: 22 additions & 16 deletions Modules/FindosgIntrospection.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,35 @@ FindosgIntrospection



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.

Locate osgINTROSPECTION This module defines

OSGINTROSPECTION_FOUND - Was osgIntrospection found?
OSGINTROSPECTION_INCLUDE_DIR - Where to find the headers
OSGINTROSPECTION_LIBRARIES - The libraries to link for
osgIntrospection (use this)

OSGINTROSPECTION_LIBRARY - The osgIntrospection library
OSGINTROSPECTION_LIBRARY_DEBUG - The osgIntrospection debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgINTROSPECTION This module defines:

``OSGINTROSPECTION_FOUND``
Was osgIntrospection found?
``OSGINTROSPECTION_INCLUDE_DIR``
Where to find the headers
``OSGINTROSPECTION_LIBRARIES``
The libraries to link for osgIntrospection (use this)
``OSGINTROSPECTION_LIBRARY``
The osgIntrospection library
``OSGINTROSPECTION_LIBRARY_DEBUG``
The osgIntrospection debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
38 changes: 22 additions & 16 deletions Modules/FindosgManipulator.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,35 @@ FindosgManipulator



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.

Locate osgManipulator This module defines

OSGMANIPULATOR_FOUND - Was osgManipulator found?
OSGMANIPULATOR_INCLUDE_DIR - Where to find the headers
OSGMANIPULATOR_LIBRARIES - The libraries to link for osgManipulator
(use this)

OSGMANIPULATOR_LIBRARY - The osgManipulator library
OSGMANIPULATOR_LIBRARY_DEBUG - The osgManipulator debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgManipulator This module defines:

``OSGMANIPULATOR_FOUND``
Was osgManipulator found?
``OSGMANIPULATOR_INCLUDE_DIR``
Where to find the headers
``OSGMANIPULATOR_LIBRARIES``
The libraries to link for osgManipulator (use this)
``OSGMANIPULATOR_LIBRARY``
The osgManipulator library
``OSGMANIPULATOR_LIBRARY_DEBUG``
The osgManipulator debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
37 changes: 22 additions & 15 deletions Modules/FindosgParticle.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,35 @@ FindosgParticle



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.

Locate osgParticle This module defines

OSGPARTICLE_FOUND - Was osgParticle found? OSGPARTICLE_INCLUDE_DIR -
Where to find the headers OSGPARTICLE_LIBRARIES - The libraries to
link for osgParticle (use this)

OSGPARTICLE_LIBRARY - The osgParticle library
OSGPARTICLE_LIBRARY_DEBUG - The osgParticle debug library

$OSGDIR is an environment variable that would correspond to the
./configure --prefix=$OSGDIR used in building osg.
:module:`FindOpenSceneGraph` instead of the ``Findosg*.cmake`` modules.

Locate osgParticle This module defines:

``OSGPARTICLE_FOUND``
Was osgParticle found?
``OSGPARTICLE_INCLUDE_DIR``
Where to find the headers
``OSGPARTICLE_LIBRARIES``
The libraries to link for osgParticle (use this)
``OSGPARTICLE_LIBRARY``
The osgParticle library
``OSGPARTICLE_LIBRARY_DEBUG``
The osgParticle debug library

``$OSGDIR`` is an environment variable that would correspond to::

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.
#]=======================================================================]
Expand Down
Loading

0 comments on commit d1d1ff6

Please sign in to comment.