code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindXercesC — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindXMLRPC" href="FindXMLRPC.html" />
    <link rel="prev" title="FindXCTest" href="FindXCTest.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindXercesC

FindXercesC¶

New in version 3.1.

Find the Apache Xerces-C++ validating XML parser headers and libraries.

Imported targets¶

New in version 3.5.

This module defines the following IMPORTED targets:

XercesC::XercesC

The Xerces-C++ xerces-c library, if found.

Result variables¶

This module will set the following variables in your project:

XercesC_FOUND

true if the Xerces headers and libraries were found

XercesC_VERSION

Xerces release version

XercesC_INCLUDE_DIRS

the directory containing the Xerces headers

XercesC_LIBRARIES

Xerces libraries to be linked

Cache variables¶

The following cache variables may also be set:

XercesC_INCLUDE_DIR

the directory containing the Xerces headers

XercesC_LIBRARY

the Xerces library

New in version 3.4: Debug and Release variants are found separately.

Table of Contents

FindXercesC

Imported targets

Result variables

Cache variables

Previous topic

FindXCTest

Next topic

FindXMLRPC

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindXercesC

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindZLIB — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="AddFileDependencies" href="AddFileDependencies.html" />
    <link rel="prev" title="FindXMLRPC" href="FindXMLRPC.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindZLIB

FindZLIB¶

Find the native ZLIB includes and library.

IMPORTED Targets¶

New in version 3.1.

This module defines IMPORTED target ZLIB::ZLIB, if
ZLIB has been found.

Result Variables¶

This module defines the following variables:

ZLIB_INCLUDE_DIRS

where to find zlib.h, etc.

ZLIB_LIBRARIES

List of libraries when using zlib.

ZLIB_FOUND

True if zlib found.

ZLIB_VERSION

New in version 3.26: the version of Zlib found.

See also legacy variable ZLIB_VERSION_STRING.

New in version 3.4: Debug and Release variants are found separately.

Legacy Variables¶

The following variables are provided for backward compatibility:

ZLIB_VERSION_MAJOR

The major version of zlib.

Changed in version 3.26: Superseded by ZLIB_VERSION.

ZLIB_VERSION_MINOR

The minor version of zlib.

Changed in version 3.26: Superseded by ZLIB_VERSION.

ZLIB_VERSION_PATCH

The patch version of zlib.

Changed in version 3.26: Superseded by ZLIB_VERSION.

ZLIB_VERSION_TWEAK

The tweak version of zlib.

Changed in version 3.26: Superseded by ZLIB_VERSION.

ZLIB_VERSION_STRING

The version of zlib found (x.y.z)

Changed in version 3.26: Superseded by ZLIB_VERSION.

ZLIB_MAJOR_VERSION

The major version of zlib.  Superseded by ZLIB_VERSION_MAJOR.

ZLIB_MINOR_VERSION

The minor version of zlib.  Superseded by ZLIB_VERSION_MINOR.

ZLIB_PATCH_VERSION

The patch version of zlib.  Superseded by ZLIB_VERSION_PATCH.

Hints¶

A user may set ZLIB_ROOT to a zlib installation root to tell this
module where to look.

New in version 3.24: Set ZLIB_USE_STATIC_LIBS to ON to look for static libraries.
Default is OFF.

Table of Contents

FindZLIB

IMPORTED Targets

Result Variables

Legacy Variables

Hints

Previous topic

FindXMLRPC

Next topic

AddFileDependencies

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindZLIB

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.

repo_name: lazytadpole/codenamesilverfish

license: mit


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>Findosg — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Findosg_functions" href="Findosg_functions.html" />
    <link rel="prev" title="FindOpenThreads" href="FindOpenThreads.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

Findosg

Findosg¶

Note

It is highly recommended that you use the new
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
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 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 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.

Previous topic

FindOpenThreads

Next topic

Findosg_functions

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

Findosg

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgAnimation — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgDB" href="FindosgDB.html" />
    <link rel="prev" title="Findosg_functions" href="Findosg_functions.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgAnimation

FindosgAnimation¶

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 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 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.

Previous topic

Findosg_functions

Next topic

FindosgDB

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgAnimation

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgDB — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgFX" href="FindosgFX.html" />
    <link rel="prev" title="FindosgAnimation" href="FindosgAnimation.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgDB

FindosgDB¶

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 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 instead of the Findosg*.cmake modules.

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

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.

Previous topic

FindosgAnimation

Next topic

FindosgFX

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgDB

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgFX — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgGA" href="FindosgGA.html" />
    <link rel="prev" title="FindosgDB" href="FindosgDB.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgFX

FindosgFX¶

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 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 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.

Previous topic

FindosgDB

Next topic

FindosgGA

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgFX

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgGA — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgIntrospection" href="FindosgIntrospection.html" />
    <link rel="prev" title="FindosgFX" href="FindosgFX.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgGA

FindosgGA¶

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 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 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.

Previous topic

FindosgFX

Next topic

FindosgIntrospection

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgGA

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgIntrospection — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgManipulator" href="FindosgManipulator.html" />
    <link rel="prev" title="FindosgGA" href="FindosgGA.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgIntrospection

FindosgIntrospection¶

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 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 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.

Previous topic

FindosgGA

Next topic

FindosgManipulator

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgIntrospection

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgManipulator — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgParticle" href="FindosgParticle.html" />
    <link rel="prev" title="FindosgIntrospection" href="FindosgIntrospection.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgManipulator

FindosgManipulator¶

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 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 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.

Previous topic

FindosgIntrospection

Next topic

FindosgParticle

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgManipulator

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgParticle — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgPresentation" href="FindosgPresentation.html" />
    <link rel="prev" title="FindosgManipulator" href="FindosgManipulator.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgParticle

FindosgParticle¶

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 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 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.

Previous topic

FindosgManipulator

Next topic

FindosgPresentation

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgParticle

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgPresentation — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgProducer" href="FindosgProducer.html" />
    <link rel="prev" title="FindosgParticle" href="FindosgParticle.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgPresentation

FindosgPresentation¶

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 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 instead of the Findosg*.cmake modules.

Locate osgPresentation This module defines:

OSGPRESENTATION_FOUND

Was osgPresentation found?

OSGPRESENTATION_INCLUDE_DIR

Where to find the headers

OSGPRESENTATION_LIBRARIES

The libraries to link for osgPresentation (use this)

OSGPRESENTATION_LIBRARY

The osgPresentation library

OSGPRESENTATION_LIBRARY_DEBUG

The osgPresentation debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.
Created by Eric Wing.  Modified to work with osgPresentation by Robert
Osfield, January 2012.

Previous topic

FindosgParticle

Next topic

FindosgProducer

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgPresentation

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgProducer — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgQt" href="FindosgQt.html" />
    <link rel="prev" title="FindosgPresentation" href="FindosgPresentation.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgProducer

FindosgProducer¶

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 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 instead of the Findosg*.cmake modules.

Locate osgProducer This module defines:

OSGPRODUCER_FOUND

Was osgProducer found?

OSGPRODUCER_INCLUDE_DIR

Where to find the headers

OSGPRODUCER_LIBRARIES

The libraries to link for osgProducer (use this)

OSGPRODUCER_LIBRARY

The osgProducer library

OSGPRODUCER_LIBRARY_DEBUG

The osgProducer debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgPresentation

Next topic

FindosgQt

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgProducer

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgQt — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgShadow" href="FindosgShadow.html" />
    <link rel="prev" title="FindosgProducer" href="FindosgProducer.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgQt

FindosgQt¶

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 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 instead of the Findosg*.cmake modules.

Locate osgQt This module defines:

OSGQT_FOUND

Was osgQt found?

OSGQT_INCLUDE_DIR

Where to find the headers

OSGQT_LIBRARIES

The libraries to link for osgQt (use this)

OSGQT_LIBRARY

The osgQt library

OSGQT_LIBRARY_DEBUG

The osgQt debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.  Modified to work with osgQt by Robert Osfield,
January 2012.

Previous topic

FindosgProducer

Next topic

FindosgShadow

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgQt

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgShadow — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgSim" href="FindosgSim.html" />
    <link rel="prev" title="FindosgQt" href="FindosgQt.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgShadow

FindosgShadow¶

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 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 instead of the Findosg*.cmake modules.

Locate osgShadow This module defines:

OSGSHADOW_FOUND

Was osgShadow found?

OSGSHADOW_INCLUDE_DIR

Where to find the headers

OSGSHADOW_LIBRARIES

The libraries to link for osgShadow (use this)

OSGSHADOW_LIBRARY

The osgShadow library

OSGSHADOW_LIBRARY_DEBUG

The osgShadow debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgQt

Next topic

FindosgSim

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgShadow

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgSim — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgTerrain" href="FindosgTerrain.html" />
    <link rel="prev" title="FindosgShadow" href="FindosgShadow.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgSim

FindosgSim¶

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 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 instead of the Findosg*.cmake modules.

Locate osgSim This module defines:

OSGSIM_FOUND

Was osgSim found?

OSGSIM_INCLUDE_DIR

Where to find the headers

OSGSIM_LIBRARIES

The libraries to link for osgSim (use this)

OSGSIM_LIBRARY

The osgSim library

OSGSIM_LIBRARY_DEBUG

The osgSim debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgShadow

Next topic

FindosgTerrain

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgSim

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgTerrain — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgText" href="FindosgText.html" />
    <link rel="prev" title="FindosgSim" href="FindosgSim.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgTerrain

FindosgTerrain¶

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 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 instead of the Findosg*.cmake modules.

Locate osgTerrain This module defines:

OSGTERRAIN_FOUND

Was osgTerrain found?

OSGTERRAIN_INCLUDE_DIR

Where to find the headers

OSGTERRAIN_LIBRARIES

The libraries to link for osgTerrain (use this)

OSGTERRAIN_LIBRARY

The osgTerrain library

OSGTERRAIN_LIBRARY_DEBUG

The osgTerrain debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgSim

Next topic

FindosgText

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgTerrain

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgText — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgUtil" href="FindosgUtil.html" />
    <link rel="prev" title="FindosgTerrain" href="FindosgTerrain.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgText

FindosgText¶

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 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 instead of the Findosg*.cmake modules.

Locate osgText This module defines:

OSGTEXT_FOUND

Was osgText found?

OSGTEXT_INCLUDE_DIR

Where to find the headers

OSGTEXT_LIBRARIES

The libraries to link for osgText (use this)

OSGTEXT_LIBRARY

The osgText library

OSGTEXT_LIBRARY_DEBUG

The osgText debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgTerrain

Next topic

FindosgUtil

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgText

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgUtil — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgViewer" href="FindosgViewer.html" />
    <link rel="prev" title="FindosgText" href="FindosgText.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgUtil

FindosgUtil¶

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 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 instead of the Findosg*.cmake modules.

Locate osgUtil This module defines:

OSGUTIL_FOUND

Was osgUtil found?

OSGUTIL_INCLUDE_DIR

Where to find the headers

OSGUTIL_LIBRARIES

The libraries to link for osgUtil (use this)

OSGUTIL_LIBRARY

The osgUtil library

OSGUTIL_LIBRARY_DEBUG

The osgUtil debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgText

Next topic

FindosgViewer

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgUtil

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgViewer — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgVolume" href="FindosgVolume.html" />
    <link rel="prev" title="FindosgUtil" href="FindosgUtil.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgViewer

FindosgViewer¶

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 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 instead of the Findosg*.cmake modules.

Locate osgViewer This module defines:

OSGVIEWER_FOUND

Was osgViewer found?

OSGVIEWER_INCLUDE_DIR

Where to find the headers

OSGVIEWER_LIBRARIES

The libraries to link for osgViewer (use this)

OSGVIEWER_LIBRARY

The osgViewer library

OSGVIEWER_LIBRARY_DEBUG

The osgViewer debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgUtil

Next topic

FindosgVolume

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgViewer

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgVolume — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgWidget" href="FindosgWidget.html" />
    <link rel="prev" title="FindosgViewer" href="FindosgViewer.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgVolume

FindosgVolume¶

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 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 instead of the Findosg*.cmake modules.

Locate osgVolume This module defines:

OSGVOLUME_FOUND

Was osgVolume found?

OSGVOLUME_INCLUDE_DIR

Where to find the headers

OSGVOLUME_LIBRARIES

The libraries to link for osgVolume (use this)

OSGVOLUME_LIBRARY

The osgVolume library

OSGVOLUME_LIBRARY_DEBUG

The osgVolume debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

Created by Eric Wing.

Previous topic

FindosgViewer

Next topic

FindosgWidget

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgVolume

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindosgWidget — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindPatch" href="FindPatch.html" />
    <link rel="prev" title="FindosgVolume" href="FindosgVolume.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgWidget

FindosgWidget¶

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 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 instead of the Findosg*.cmake modules.

Locate osgWidget This module defines:

OSGWIDGET_FOUND

Was osgWidget found?

OSGWIDGET_INCLUDE_DIR

Where to find the headers

OSGWIDGET_LIBRARIES

The libraries to link for osgWidget (use this)

OSGWIDGET_LIBRARY

The osgWidget library

OSGWIDGET_LIBRARY_DEBUG

The osgWidget debug library

$OSGDIR is an environment variable that would correspond to:

./configure --prefix=$OSGDIR

used in building osg.

FindosgWidget.cmake tweaked from Findosg* suite as created by Eric
Wing.

Previous topic

FindosgVolume

Next topic

FindPatch

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindosgWidget

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>Findosg_functions — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindosgAnimation" href="FindosgAnimation.html" />
    <link rel="prev" title="Findosg" href="Findosg.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

Findosg_functions

Findosg_functions¶

This CMake file contains two macros to assist with searching for OSG
libraries and nodekits.  Please see FindOpenSceneGraph for full
documentation.

Previous topic

Findosg

Next topic

FindosgAnimation

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

Findosg_functions

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindwxWidgets — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="FindX11" href="FindX11.html" />
    <link rel="prev" title="FindWish" href="FindWish.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindwxWidgets

FindwxWidgets¶

Find a wxWidgets (a.k.a., wxWindows) installation.

This module finds if wxWidgets is installed and selects a default
configuration to use.  wxWidgets is a modular library.  To specify the
modules that you will use, you need to name them as components to the
package:

find_package(wxWidgets COMPONENTS core base ... OPTIONAL_COMPONENTS net ...)

New in version 3.4: Support for find_package() version argument; webview component.

New in version 3.14: OPTIONAL_COMPONENTS support.

There are two search branches: a windows style and a unix style.  For
windows, the following variables are searched for and set to defaults
in case of multiple choices.  Change them if the defaults are not
desired (i.e., these are the only variables you should change to
select a configuration):

wxWidgets_ROOT_DIR      - Base wxWidgets directory
                          (e.g., C:/wxWidgets-3.2.0).
wxWidgets_LIB_DIR       - Path to wxWidgets libraries
                          (e.g., C:/wxWidgets-3.2.0/lib/vc_x64_lib).
wxWidgets_CONFIGURATION - Configuration to use
                          (e.g., msw, mswd, mswu, mswunivud, etc.)
wxWidgets_EXCLUDE_COMMON_LIBRARIES
                        - Set to TRUE to exclude linking of
                          commonly required libs (e.g., png tiff
                          jpeg zlib regex expat scintilla lexilla).

For unix style it uses the wx-config utility.  You can select between
debug/release, unicode/ansi, universal/non-universal, and
static/shared in the QtDialog or ccmake interfaces by turning ON/OFF
the following variables:

wxWidgets_USE_DEBUG
wxWidgets_USE_UNICODE
wxWidgets_USE_UNIVERSAL
wxWidgets_USE_STATIC

There is also a wxWidgets_CONFIG_OPTIONS variable for all other
options that need to be passed to the wx-config utility.  For example,
to use the base toolkit found in the /usr/local path, set the variable
(before calling the FIND_PACKAGE command) as such:

set(wxWidgets_CONFIG_OPTIONS --toolkit=base --prefix=/usr)

The following are set after the configuration is done for both windows
and unix style:

wxWidgets_FOUND            - Set to TRUE if wxWidgets was found.
wxWidgets_INCLUDE_DIRS     - Include directories for WIN32
                             i.e., where to find "wx/wx.h" and
                             "wx/setup.h"; possibly empty for unices.
wxWidgets_LIBRARIES        - Path to the wxWidgets libraries.
wxWidgets_LIBRARY_DIRS     - compile time link dirs, useful for
                             rpath on UNIX. Typically an empty string
                             in WIN32 environment.
wxWidgets_DEFINITIONS      - Contains defines required to compile/link
                             against WX, e.g. WXUSINGDLL
wxWidgets_DEFINITIONS_DEBUG- Contains defines required to compile/link
                             against WX debug builds, e.g. __WXDEBUG__
wxWidgets_CXX_FLAGS        - Include dirs and compiler flags for
                             unices, empty on WIN32. Essentially
                             "`wx-config --cxxflags`".
wxWidgets_USE_FILE         - Convenience include file.

New in version 3.11: The following environment variables can be used as hints: WX_CONFIG,
WXRC_CMD.

Sample usage:

# Note that for MinGW users the order of libs is important!
find_package(wxWidgets COMPONENTS gl core base OPTIONAL_COMPONENTS net)
if(wxWidgets_FOUND)
  include(${wxWidgets_USE_FILE})
  # and for each of your dependent executable/library targets:
  target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES})
endif()

If wxWidgets is required (i.e., not an optional part):

find_package(wxWidgets REQUIRED gl core base OPTIONAL_COMPONENTS net)
include(${wxWidgets_USE_FILE})
# and for each of your dependent executable/library targets:
target_link_libraries(<YourTarget> ${wxWidgets_LIBRARIES})

Imported targets¶

New in version 3.27.

This module defines the following IMPORTED targets:

wxWidgets::wxWidgets

An interface library providing usage requirements for the found components.

Table of Contents

FindwxWidgets

Imported targets

Previous topic

FindWish

Next topic

FindX11

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindwxWidgets

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FindwxWindows — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="CPackArchive" href="CPackArchive.html" />
    <link rel="prev" title="FindVTK" href="FindVTK.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindwxWindows

FindwxWindows¶

Deprecated since version 3.0: Replaced by FindwxWidgets.

Find wxWindows (wxWidgets) installation

This module finds if wxWindows/wxWidgets is installed and determines
where the include files and libraries are.  It also determines what
the name of the library is.  This code sets the following variables:

WXWINDOWS_FOUND     = system has WxWindows
WXWINDOWS_LIBRARIES = path to the wxWindows libraries
                      on Unix/Linux with additional
                      linker flags from
                      "wx-config --libs"
CMAKE_WXWINDOWS_CXX_FLAGS  = Compiler flags for wxWindows,
                             essentially "`wx-config --cxxflags`"
                             on Linux
WXWINDOWS_INCLUDE_DIR      = where to find "wx/wx.h" and "wx/setup.h"
WXWINDOWS_LINK_DIRECTORIES = link directories, useful for rpath on
                              Unix
WXWINDOWS_DEFINITIONS      = extra defines

OPTIONS If you need OpenGL support please

set(WXWINDOWS_USE_GL 1)

in your CMakeLists.txt before you include this file.

HAVE_ISYSTEM      - true required to replace -I by -isystem on g++

For convenience include Use_wxWindows.cmake in your project's
CMakeLists.txt using
include(${CMAKE_CURRENT_LIST_DIR}/Use_wxWindows.cmake).

USAGE

set(WXWINDOWS_USE_GL 1)
find_package(wxWindows)

NOTES wxWidgets 2.6.x is supported for monolithic builds e.g.
compiled in wx/build/msw dir as:

nmake -f makefile.vc BUILD=debug SHARED=0 USE_OPENGL=1 MONOLITHIC=1

DEPRECATED

CMAKE_WX_CAN_COMPILE
WXWINDOWS_LIBRARY
CMAKE_WX_CXX_FLAGS
WXWINDOWS_INCLUDE_PATH

AUTHOR Jan Woetzel (07/2003-01/2006)

Previous topic

FindVTK

Next topic

CPackArchive

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FindwxWindows

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>FortranCInterface — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="GenerateExportHeader" href="GenerateExportHeader.html" />
    <link rel="prev" title="FindPackageMessage" href="FindPackageMessage.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FortranCInterface

FortranCInterface¶

Fortran/C Interface Detection

This module automatically detects the API by which C and Fortran
languages interact.

Module Variables¶

Variables that indicate if the mangling is found:

FortranCInterface_GLOBAL_FOUND

Global subroutines and functions.

FortranCInterface_MODULE_FOUND

Module subroutines and functions (declared by "MODULE PROCEDURE").

This module also provides the following variables to specify
the detected mangling, though a typical use case does not need
to reference them and can use the Module Functions below.

FortranCInterface_GLOBAL_PREFIX

Prefix for a global symbol without an underscore.

FortranCInterface_GLOBAL_SUFFIX

Suffix for a global symbol without an underscore.

FortranCInterface_GLOBAL_CASE

The case for a global symbol without an underscore,
either UPPER or LOWER.

FortranCInterface_GLOBAL__PREFIX

Prefix for a global symbol with an underscore.

FortranCInterface_GLOBAL__SUFFIX

Suffix for a global symbol with an underscore.

FortranCInterface_GLOBAL__CASE

The case for a global symbol with an underscore,
either UPPER or LOWER.

FortranCInterface_MODULE_PREFIX

Prefix for a module symbol without an underscore.

FortranCInterface_MODULE_MIDDLE

Middle of a module symbol without an underscore that appears
between the name of the module and the name of the symbol.

FortranCInterface_MODULE_SUFFIX

Suffix for a module symbol without an underscore.

FortranCInterface_MODULE_CASE

The case for a module symbol without an underscore,
either UPPER or LOWER.

FortranCInterface_MODULE__PREFIX

Prefix for a module symbol with an underscore.

FortranCInterface_MODULE__MIDDLE

Middle of a module symbol with an underscore that appears
between the name of the module and the name of the symbol.

FortranCInterface_MODULE__SUFFIX

Suffix for a module symbol with an underscore.

FortranCInterface_MODULE__CASE

The case for a module symbol with an underscore,
either UPPER or LOWER.

Module Functions¶

FortranCInterface_HEADER¶

The FortranCInterface_HEADER function is provided to generate a
C header file containing macros to mangle symbol names:

FortranCInterface_HEADER(<file>
                         [MACRO_NAMESPACE <macro-ns>]
                         [SYMBOL_NAMESPACE <ns>]
                         [SYMBOLS [<module>:]<function> ...])

It generates in <file> definitions of the following macros:

#define FortranCInterface_GLOBAL (name,NAME) ...
#define FortranCInterface_GLOBAL_(name,NAME) ...
#define FortranCInterface_MODULE (mod,name, MOD,NAME) ...
#define FortranCInterface_MODULE_(mod,name, MOD,NAME) ...

These macros mangle four categories of Fortran symbols, respectively:

Global symbols without '_': call mysub()

Global symbols with '_'   : call my_sub()

Module symbols without '_': use mymod; call mysub()

Module symbols with '_'   : use mymod; call my_sub()

If mangling for a category is not known, its macro is left undefined.
All macros require raw names in both lower case and upper case.

The options are:

MACRO_NAMESPACE

Replace the default FortranCInterface_ prefix with a given
namespace <macro-ns>.

SYMBOLS

List symbols to mangle automatically with C preprocessor definitions:

<function>          ==> #define <ns><function> ...
<module>:<function> ==> #define <ns><module>_<function> ...

If the mangling for some symbol is not known then no preprocessor
definition is created, and a warning is displayed.

SYMBOL_NAMESPACE

Prefix all preprocessor definitions generated by the SYMBOLS
option with a given namespace <ns>.

FortranCInterface_VERIFY¶

The FortranCInterface_VERIFY function is provided to verify
that the Fortran and C/C++ compilers work together:

FortranCInterface_VERIFY([CXX] [QUIET])

It tests whether a simple test executable using Fortran and C (and C++
when the CXX option is given) compiles and links successfully.  The
result is stored in the cache entry FortranCInterface_VERIFIED_C
(or FortranCInterface_VERIFIED_CXX if CXX is given) as a boolean.
If the check fails and QUIET is not given the function terminates with a
fatal error message describing the problem.  The purpose of this check
is to stop a build early for incompatible compiler combinations.  The
test is built in the Release configuration.

Example Usage¶

include(FortranCInterface)
FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_")

This creates a "FC.h" header that defines mangling macros FC_GLOBAL(),
FC_GLOBAL_(), FC_MODULE(), and FC_MODULE_().

include(FortranCInterface)
FortranCInterface_HEADER(FCMangle.h
                         MACRO_NAMESPACE "FC_"
                         SYMBOL_NAMESPACE "FC_"
                         SYMBOLS mysub mymod:my_sub)

This creates a "FCMangle.h" header that defines the same FC_*()
mangling macros as the previous example plus preprocessor symbols
FC_mysub and FC_mymod_my_sub.

Additional Manglings¶

FortranCInterface is aware of possible GLOBAL and MODULE manglings
for many Fortran compilers, but it also provides an interface to specify
new possible manglings.  Set the variables:

FortranCInterface_GLOBAL_SYMBOLS
FortranCInterface_MODULE_SYMBOLS

before including FortranCInterface to specify manglings of the symbols
MySub, My_Sub, MyModule:MySub, and My_Module:My_Sub.
For example, the code:

set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_)
  #                                  ^^^^^  ^^^^^^   ^^^^^
set(FortranCInterface_MODULE_SYMBOLS
    __mymodule_MOD_mysub __my_module_MOD_my_sub)
  #   ^^^^^^^^     ^^^^^   ^^^^^^^^^     ^^^^^^
include(FortranCInterface)

tells FortranCInterface to try given GLOBAL and MODULE manglings.
(The carets point at raw symbol names for clarity in this example but
are not needed.)

Table of Contents

FortranCInterface

Module Variables

Module Functions

Example Usage

Additional Manglings

Previous topic

FindPackageMessage

Next topic

GenerateExportHeader

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

FortranCInterface

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>GNUInstallDirs — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="GoogleTest" href="GoogleTest.html" />
    <link rel="prev" title="GenerateExportHeader" href="GenerateExportHeader.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GNUInstallDirs

GNUInstallDirs¶

Define GNU standard installation directories

Provides install directory variables as defined by the
GNU Coding Standards.

Result Variables¶

Inclusion of this module defines the following variables:

CMAKE_INSTALL_<dir>

Destination for files of a given type.  This value may be passed to
the DESTINATION options of  install() commands for the
corresponding file type.  It should be a path relative to the installation
prefix so that it can be converted to an absolute path in a relocatable way.

While absolute paths are allowed, they are not recommended as they
do not work with the cmake --install command's
--prefix option, or with the
cpack installer generators. In particular, there is no
need to make paths absolute by prepending CMAKE_INSTALL_PREFIX;
this prefix is used by default if the DESTINATION is a relative path.

CMAKE_INSTALL_FULL_<dir>

The absolute path generated from the corresponding CMAKE_INSTALL_<dir>
value.  If the value is not already an absolute path, an absolute path
is constructed typically by prepending the value of the
CMAKE_INSTALL_PREFIX variable.  However, there are some
special cases as documented below.

These variables shouldn't be used in install() commands
as they do not work with the cmake --install command's
--prefix option, or with the
cpack installer generators.

where <dir> is one of:

BINDIR

user executables (bin)

SBINDIR

system admin executables (sbin)

LIBEXECDIR

program executables (libexec)

SYSCONFDIR

read-only single-machine data (etc)

SHAREDSTATEDIR

modifiable architecture-independent data (com)

LOCALSTATEDIR

modifiable single-machine data (var)

RUNSTATEDIR

New in version 3.9: run-time variable data (LOCALSTATEDIR/run)

LIBDIR

object code libraries (lib or lib64)

On Debian, this may be lib/<multiarch-tuple> when
CMAKE_INSTALL_PREFIX is /usr.

INCLUDEDIR

C header files (include)

OLDINCLUDEDIR

C header files for non-gcc (/usr/include)

DATAROOTDIR

read-only architecture-independent data root (share)

DATADIR

read-only architecture-independent data (DATAROOTDIR)

INFODIR

info documentation (DATAROOTDIR/info)

LOCALEDIR

locale-dependent data (DATAROOTDIR/locale)

MANDIR

man documentation (DATAROOTDIR/man)

DOCDIR

documentation root (DATAROOTDIR/doc/PROJECT_NAME)

If the includer does not define a value the above-shown default will be
used and the value will appear in the cache for editing by the user.

Special Cases¶

New in version 3.4.

The following values of CMAKE_INSTALL_PREFIX are special:

/

For <dir> other than the SYSCONFDIR, LOCALSTATEDIR and
RUNSTATEDIR, the value of CMAKE_INSTALL_<dir> is prefixed
with usr/ if it is not user-specified as an absolute path.
For example, the INCLUDEDIR value include becomes usr/include.
This is required by the GNU Coding Standards, which state:

When building the complete GNU system, the prefix will be empty
and /usr will be a symbolic link to /.

/usr

For <dir> equal to SYSCONFDIR, LOCALSTATEDIR or
RUNSTATEDIR, the CMAKE_INSTALL_FULL_<dir> is computed by
prepending just / to the value of CMAKE_INSTALL_<dir>
if it is not user-specified as an absolute path.
For example, the SYSCONFDIR value etc becomes /etc.
This is required by the GNU Coding Standards.

/opt/...

For <dir> equal to SYSCONFDIR, LOCALSTATEDIR or
RUNSTATEDIR, the CMAKE_INSTALL_FULL_<dir> is computed by
appending the prefix to the value of CMAKE_INSTALL_<dir>
if it is not user-specified as an absolute path.
For example, the SYSCONFDIR value etc becomes /etc/opt/....
This is defined by the Filesystem Hierarchy Standard.

This behavior does not apply to paths under /opt/homebrew/....

Macros¶

GNUInstallDirs_get_absolute_install_dir¶

GNUInstallDirs_get_absolute_install_dir(absvar var dirname)

New in version 3.7.

Set the given variable absvar to the absolute path contained
within the variable var.  This is to allow the computation of an
absolute path, accounting for all the special cases documented
above.  While this macro is used to compute the various
CMAKE_INSTALL_FULL_<dir> variables, it is exposed publicly to
allow users who create additional path variables to also compute
absolute paths where necessary, using the same logic.  dirname is
the directory name to get, e.g. BINDIR.

Changed in version 3.20: Added the <dirname> parameter.  Previous versions of CMake passed
this value through the variable ${dir}.

Table of Contents

GNUInstallDirs

Result Variables

Special Cases

Macros

Previous topic

GenerateExportHeader

Next topic

GoogleTest

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GNUInstallDirs

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>GenerateExportHeader — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="GNUInstallDirs" href="GNUInstallDirs.html" />
    <link rel="prev" title="FortranCInterface" href="FortranCInterface.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GenerateExportHeader

GenerateExportHeader¶

Function for generation of export macros for libraries

This module provides the function GENERATE_EXPORT_HEADER().

New in version 3.12: Added support for C projects.  Previous versions supported C++ project only.

The GENERATE_EXPORT_HEADER function can be used to generate a file
suitable for preprocessor inclusion which contains EXPORT macros to be
used in library classes:

GENERATE_EXPORT_HEADER( LIBRARY_TARGET
          [BASE_NAME <base_name>]
          [EXPORT_MACRO_NAME <export_macro_name>]
          [EXPORT_FILE_NAME <export_file_name>]
          [DEPRECATED_MACRO_NAME <deprecated_macro_name>]
          [NO_EXPORT_MACRO_NAME <no_export_macro_name>]
          [INCLUDE_GUARD_NAME <include_guard_name>]
          [STATIC_DEFINE <static_define>]
          [NO_DEPRECATED_MACRO_NAME <no_deprecated_macro_name>]
          [DEFINE_NO_DEPRECATED]
          [PREFIX_NAME <prefix_name>]
          [CUSTOM_CONTENT_FROM_VARIABLE <variable>]
)

The target properties CXX_VISIBILITY_PRESET
and VISIBILITY_INLINES_HIDDEN can be used to add the appropriate
compile flags for targets.  See the documentation of those target properties,
and the convenience variables
CMAKE_CXX_VISIBILITY_PRESET and
CMAKE_VISIBILITY_INLINES_HIDDEN.

By default GENERATE_EXPORT_HEADER() generates macro names in a file
name determined by the name of the library.  This means that in the
simplest case, users of GenerateExportHeader will be equivalent to:

set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_VISIBILITY_INLINES_HIDDEN 1)
add_library(somelib someclass.cpp)
generate_export_header(somelib)
install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR})
install(FILES
 someclass.h
 ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR}
)

And in the ABI header files:

#include "somelib_export.h"
class SOMELIB_EXPORT SomeClass {
  ...
};

The CMake fragment will generate a file in the
${CMAKE_CURRENT_BINARY_DIR} called somelib_export.h containing the
macros SOMELIB_EXPORT, SOMELIB_NO_EXPORT, SOMELIB_DEPRECATED,
SOMELIB_DEPRECATED_EXPORT and SOMELIB_DEPRECATED_NO_EXPORT.
They will be followed by content taken from the variable specified by
the CUSTOM_CONTENT_FROM_VARIABLE option, if any.
The resulting file should be installed with other headers in the library.

The BASE_NAME argument can be used to override the file name and the
names used for the macros:

add_library(somelib someclass.cpp)
generate_export_header(somelib
  BASE_NAME other_name
)

Generates a file called other_name_export.h containing the macros
OTHER_NAME_EXPORT, OTHER_NAME_NO_EXPORT and OTHER_NAME_DEPRECATED
etc.

The BASE_NAME may be overridden by specifying other options in the
function.  For example:

add_library(somelib someclass.cpp)
generate_export_header(somelib
  EXPORT_MACRO_NAME OTHER_NAME_EXPORT
)

creates the macro OTHER_NAME_EXPORT instead of SOMELIB_EXPORT, but
other macros and the generated file name is as default:

add_library(somelib someclass.cpp)
generate_export_header(somelib
  DEPRECATED_MACRO_NAME KDE_DEPRECATED
)

creates the macro KDE_DEPRECATED instead of SOMELIB_DEPRECATED.

If LIBRARY_TARGET is a static library, macros are defined without
values.

If the same sources are used to create both a shared and a static
library, the uppercased symbol ${BASE_NAME}_STATIC_DEFINE should be
used when building the static library:

add_library(shared_variant SHARED ${lib_SRCS})
add_library(static_variant ${lib_SRCS})
generate_export_header(shared_variant BASE_NAME libshared_and_static)
set_target_properties(static_variant PROPERTIES
  COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE)

This will cause the export macros to expand to nothing when building
the static library.

If DEFINE_NO_DEPRECATED is specified, then a macro
${BASE_NAME}_NO_DEPRECATED will be defined This macro can be used to
remove deprecated code from preprocessor output:

option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE)
if (EXCLUDE_DEPRECATED)
  set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED)
endif()
generate_export_header(somelib ${NO_BUILD_DEPRECATED})

And then in somelib:

class SOMELIB_EXPORT SomeClass
{
public:
#ifndef SOMELIB_NO_DEPRECATED
  SOMELIB_DEPRECATED void oldMethod();
#endif
};

#ifndef SOMELIB_NO_DEPRECATED
void SomeClass::oldMethod() {  }
#endif

If PREFIX_NAME is specified, the argument will be used as a prefix to
all generated macros.

For example:

generate_export_header(somelib PREFIX_NAME VTK_)

Generates the macros VTK_SOMELIB_EXPORT etc.

New in version 3.1: Library target can be an OBJECT library.

New in version 3.7: Added the CUSTOM_CONTENT_FROM_VARIABLE option.

New in version 3.11: Added the INCLUDE_GUARD_NAME option.

ADD_COMPILER_EXPORT_FLAGS( [<output_variable>] )

Deprecated since version 3.0: Set the target properties
CXX_VISIBILITY_PRESET and
VISIBILITY_INLINES_HIDDEN instead.

The ADD_COMPILER_EXPORT_FLAGS function adds -fvisibility=hidden to
CMAKE_CXX_FLAGS if supported, and is a no-op
on Windows which does not need extra compiler flags for exporting support.
You may optionally pass a single argument to ADD_COMPILER_EXPORT_FLAGS
that will be populated with the CXX_FLAGS required to enable visibility
support for the compiler/architecture in use.

Previous topic

FortranCInterface

Next topic

GNUInstallDirs

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GenerateExportHeader

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.


code:
<!DOCTYPE html>

    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

  <title>GetPrerequisites — CMake 3.29.0-rc3 Documentation</title>

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

    <link rel="icon" href="../_static/cmake-favicon.ico"/>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="MacroAddFileDependencies" href="MacroAddFileDependencies.html" />
    <link rel="prev" title="Documentation" href="Documentation.html" />

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GetPrerequisites

GetPrerequisites¶

Deprecated since version 3.16: Use file(GET_RUNTIME_DEPENDENCIES) instead.

Functions to analyze and list executable file prerequisites.

This module provides functions to list the .dll, .dylib or .so files
that an executable or shared library file depends on.  (Its
prerequisites.)

It uses various tools to obtain the list of required shared library
files:

dumpbin (Windows)
objdump (MinGW on Windows)
ldd (Linux/Unix)
otool (Mac OSX)

Changed in version 3.16: The tool specified by CMAKE_OBJDUMP will be used, if set.

The following functions are provided by this module:

get_prerequisites
list_prerequisites
list_prerequisites_by_glob
gp_append_unique
is_file_executable
gp_item_default_embedded_path
  (projects can override with gp_item_default_embedded_path_override)
gp_resolve_item
  (projects can override with gp_resolve_item_override)
gp_resolved_file_type
  (projects can override with gp_resolved_file_type_override)
gp_file_type

GET_PREREQUISITES(<target> <prerequisites_var> <exclude_system> <recurse>
                  <exepath> <dirs> [<rpaths>])

Get the list of shared library files required by <target>.  The list
in the variable named <prerequisites_var> should be empty on first
entry to this function.  On exit, <prerequisites_var> will contain the
list of required shared library files.

<target> is the full path to an executable file.  <prerequisites_var>
is the name of a CMake variable to contain the results.
<exclude_system> must be 0 or 1 indicating whether to include or
exclude "system" prerequisites.  If <recurse> is set to 1 all
prerequisites will be found recursively, if set to 0 only direct
prerequisites are listed.  <exepath> is the path to the top level
executable used for @executable_path replacement on the Mac.  <dirs> is
a list of paths where libraries might be found: these paths are
searched first when a target without any path info is given.  Then
standard system locations are also searched: PATH, Framework
locations, /usr/lib...

New in version 3.14: The variable GET_PREREQUISITES_VERBOSE can be set to true to enable verbose
output.

LIST_PREREQUISITES(<target> [<recurse> [<exclude_system> [<verbose>]]])

Print a message listing the prerequisites of <target>.

<target> is the name of a shared library or executable target or the
full path to a shared library or executable file.  If <recurse> is set
to 1 all prerequisites will be found recursively, if set to 0 only
direct prerequisites are listed.  <exclude_system> must be 0 or 1
indicating whether to include or exclude "system" prerequisites.  With
<verbose> set to 0 only the full path names of the prerequisites are
printed, set to 1 extra information will be displayed.

LIST_PREREQUISITES_BY_GLOB(<glob_arg> <glob_exp>)

Print the prerequisites of shared library and executable files
matching a globbing pattern.  <glob_arg> is GLOB or GLOB_RECURSE and
<glob_exp> is a globbing expression used with "file(GLOB" or
"file(GLOB_RECURSE" to retrieve a list of matching files.  If a
matching file is executable, its prerequisites are listed.

Any additional (optional) arguments provided are passed along as the
optional arguments to the list_prerequisites calls.

GP_APPEND_UNIQUE(<list_var> <value>)

Append <value> to the list variable <list_var> only if the value is
not already in the list.

IS_FILE_EXECUTABLE(<file> <result_var>)

Return 1 in <result_var> if <file> is a binary executable, 0
otherwise.

GP_ITEM_DEFAULT_EMBEDDED_PATH(<item> <default_embedded_path_var>)

Return the path that others should refer to the item by when the item
is embedded inside a bundle.

Override on a per-project basis by providing a project-specific
gp_item_default_embedded_path_override function.

GP_RESOLVE_ITEM(<context> <item> <exepath> <dirs> <resolved_item_var>
                [<rpaths>])

Resolve an item into an existing full path file.

Override on a per-project basis by providing a project-specific
gp_resolve_item_override function.

GP_RESOLVED_FILE_TYPE(<original_file> <file> <exepath> <dirs> <type_var>
                      [<rpaths>])

Return the type of <file> with respect to <original_file>.  String
describing type of prerequisite is returned in variable named
<type_var>.

Use <exepath> and <dirs> if necessary to resolve non-absolute <file>
values -- but only for non-embedded items.

Possible types are:

system
local
embedded
other

Override on a per-project basis by providing a project-specific
gp_resolved_file_type_override function.

GP_FILE_TYPE(<original_file> <file> <type_var>)

Return the type of <file> with respect to <original_file>.  String
describing type of prerequisite is returned in variable named
<type_var>.

Possible types are:

system
local
embedded
other

Previous topic

Documentation

Next topic

MacroAddFileDependencies

This Page

Show Source

Quick search

    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
      <input type="submit" value="Go" />
    </form>

Navigation

          index

          next |

          previous |

    CMake »

    3.29.0-rc3 Documentation »

cmake-modules(7) »

GetPrerequisites

        © Copyright 2000-2024 Kitware, Inc. and Contributors.
      Created using Sphinx 6.2.1.