libtinyexr/1.0.7

This project builds and defines the build2 package for tinyexr. It is a small, single-header-only library to load and save OpenEXR (.exr) images, that is written in portable C++ (no library dependency except for STL).

Usage

Make sure to add the stable section of the cppget.org repository to your project's repositories.manifest to be able to fetch this package.

:
role: prerequisite
location: https://pkg.cppget.org/1/stable
# trust: ...

If the stable section of cppget.org is not an option then add this Git repository itself instead as a prerequisite.

:
role: prerequisite
location: https://github.com/build2-packaging/tinyexr.git

Add the respective dependency in your project's manifest file to make the package available for import.

depends: libtinyexr ^1.0.6

The library can be imported by the following declaration in a buildfile.

import tinyexr = libtinyexr%lib{tinyexr}

Configuration

There are no configuration options available.

Issues and Notes

• The test data in the libtinyexr-tests package is more than 240 MiB in size and, as a consequence, not publishable on cppget.org because it is too large. Thus, it is not declared as the mandatory external tests package of libtinyexr. It can and should still be used for local testing and for CI runs.
• By using the macros TINYEXR_USE_THREAD or TINYEXR_USE_OPENMP, tinyexr is able to support multithreading by either using C++11 threads or OpenMP. Please note that the package's build system is not automatically adding dependencies and flags for pthread or OpenMP.
• Currently, the configuration of dependencies for tinyexr is not handled by the package's build system. tinyexr uses miniz by default and it does not provide specific tests for other configurations. Furthermore, support for zlib and stb's implementation of zlib only seems to be useful when using tinyexr without a build system as drop-in header file. So, for now, please refrain from using the following macros.
  • TINYEXR_USE_MINIZ
  • TINYEXR_USE_STB_ZLIB
• tinyexr adds ZFP compression only as an experimental support on Linux and MacOS. Currently, it is not supported by the packgage's build system. Hence, please, refrain from using the following macro.
  • TINYEXR_USE_ZFP
• The compilation of the tests package libtinyexr-tests is not supported on target configurations windows*-clang** due to the wrong encoding of win32-filelist-utf16le.inc. Presumably, this will not be fixed as it is an upstream issue. Please note that the compilation and execution of the basic tests still works on these configurations. Thus, the library should work without flaws on those platforms.
• For Windows, the file '日本語.exr' and the test utf8filename had to be removed from distribution and execution, respectively. Please, see this issue for more information.
• Emscripten is not supported.
• The examples are not supported by the package's build system, yet.
• For now, the fuzzers are not compiled and run.

Contributing

Thanks in advance for your help and contribution to keep this package up-to-date. For now, please, file an issue on GitHub for everything that is not described below.

Recommend Updating Version

Please, file an issue on GitHub with the new recommended version.

Update Version by Pull Request

1. Fork the repository on GitHub and clone it to your local machine.
2. Run git submodule init and git submodule update to get the current upstream directory.
3. Inside the upstream directory, checkout the new library version X.Y.Z by calling git checkout vX.Y.Z that you want to be packaged.
4. If needed, change source files, buildfiles, and symbolic links accordingly to create a working build2 package. Make sure not to directly depend on the upstream directory inside the build system but use symbolic links instead.
5. Update library version in manifest file if it has changed or add package update by using +n for the n-th update.
6. Make an appropriate commit message by using imperative mood and a capital letter at the start and push the new commit to the master branch.
7. Run bdep ci and test for errors.
8. If everything works fine, make a pull request on GitHub and write down the bdep ci link to your CI tests.
9. After a successful pull request, we will run the appropriate commands to publish a new package version.

Update Version Directly if You Have Permissions

1. Inside the upstream directory, checkout the new library version X.Y.Z by calling git checkout vX.Y.Z that you want to be packaged.
2. If needed, change source files, buildfiles, and symbolic links accordingly to create a working build2 package. Make sure not to directly depend on the upstream directory inside the build system but use symbolic links instead.
3. Update library version in manifest file if it has changed or add package update by using +n for the n-th update.
4. Make an appropriate commit message by using imperative mood and a capital letter at the start and push the new commit to the master branch.
5. Run bdep ci and test for errors and warnings.
6. When successful, run bdep release --tag --push to push new tag version to repository.
7. Run bdep publish -d libtinyexr/ to publish the package to cppget.org.