Changes to make it easier to hide the Imath dependency #3322
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* `OPENIMAGEIO_IMATH_DEPENDENCY_VISIBILITY` is a new CMake cache variable at OIIO build time that controls whether the Imath library dependencies will be declared as PUBLIC (default) or PRIVATE target dependencies of libOpenImageIO and libOpenImageIO_Util. * For *downstream projects* that consume OIIO's exported cmake config files, setting CMake variable `OPENIMAGEIO_CONFIG_DO_NOT_FIND_IMATH` to true will skip the find_depencency() calls for Imath and OpenEXR. To clarify, this is not a variable that has any effect when building OIIO, it's something set in the downstream project itself. * Add a `OIIO_IMATH_H_INCLUDED` header guard in OpenImageIO/Imath.h, which allows something downstream to pre-define it to prevent OIIO headers it needs to read from using the contents of that header. Most builders of OIIO won't care and shouldn't change the defaults or use any of these. But here's the specific case it addresses: If you are building OIIO against static libraries of Imath & OpenEXR, but the libOpenImageIO will be consumed by a downstream project that wants to use a different Imath version, this can help you avoid some build-time conflicts in the downstream project.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OPENIMAGEIO_IMATH_DEPENDENCY_VISIBILITYis a new CMake cachevariable at OIIO build time that controls whether the Imath library
dependencies will be declared as PUBLIC (default) or PRIVATE target
dependencies of libOpenImageIO and libOpenImageIO_Util.
For downstream projects that consume OIIO's exported cmake config
files, setting CMake variable
OPENIMAGEIO_CONFIG_DO_NOT_FIND_IMATHto true will skip the find_depencency() calls for Imath and OpenEXR.
To clarify, this is not a variable that has any effect when building
OIIO, it's something set in the downstream project itself.
Add a
OIIO_IMATH_H_INCLUDEDheader guard in OpenImageIO/Imath.h,which allows something downstream to pre-define it to prevent OIIO
headers it needs to read from using the contents of that header.
Most builders of OIIO won't care and shouldn't change the defaults or
use any of these. But here's the specific case it addresses: If you
are building OIIO against static libraries of Imath & OpenEXR, but the
libOpenImageIO will be consumed by a downstream project that wants to
use a different Imath version, this can help you avoid some build-time
conflicts in the downstream project.