FindosgFX¶
Finds the osgFX NodeKit from the OpenSceneGraph toolkit.
Note
In most cases, it's recommended to use the FindOpenSceneGraph
module
instead and list osgFX as a component. This will automatically handle
dependencies such as the OpenThreads and core osg libraries:
find_package(OpenSceneGraph COMPONENTS osgFX)
This module is used internally by FindOpenSceneGraph
to find the
osgFX NodeKit. It is not intended to be included directly during typical
use of the find_package()
command. However, it is available as a
standalone module for advanced use cases where finer control over detection is
needed. For example, to find the osgFX explicitly or bypass automatic
component detection:
find_package(osgFX)
OpenSceneGraph and osgFX headers are intended to be included in C++ project source code as:
example.cxx
¶#include <osg/PositionAttitudeTransform>
#include <osgFX/BumpMapping>
// ...
When working with the OpenSceneGraph toolkit, other libraries such as OpenGL may also be required.
Result Variables¶
This module defines the following variables:
osgFX_FOUND
Boolean indicating whether the osgFX NodeKit of the OpenSceneGraph toolkit is found. For backward compatibility, the
OSGFX_FOUND
variable is also set to the same value.OSGFX_LIBRARIES
The libraries needed to link against to use osgFX.
OSGFX_LIBRARY
A result variable that is set to the same value as the
OSGFX_LIBRARIES
variable.
Cache Variables¶
The following cache variables may also be set:
OSGFX_INCLUDE_DIR
The include directory containing headers needed to use osgFX.
OSGFX_LIBRARY_DEBUG
The path to the osgFX debug library.
Hints¶
This module accepts the following variables:
OSGDIR
Environment variable that can be set to help locate the OpenSceneGraph toolkit, including its osgFX NodeKit, when installed in a custom location. It should point to the OpenSceneGraph installation prefix used when it was configured, built, and installed:
./configure --prefix=$OSGDIR
.
Examples¶
Finding osgFX explicitly with this module and creating an interface imported target that encapsulates its usage requirements for linking it to a project target:
find_package(osgFX)
if(osgFX_FOUND AND NOT TARGET osgFX::osgFX)
add_library(osgFX::osgFX INTERFACE IMPORTED)
set_target_properties(
osgFX::osgFX
PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES "${OSGFX_INCLUDE_DIR}"
INTERFACE_LINK_LIBRARIES "${OSGFX_LIBRARIES}"
)
endif()
target_link_libraries(example PRIVATE osgFX::osgFX)
See Also¶
The
FindOpenSceneGraph
module to find OpenSceneGraph toolkit.