mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-11 08:20:18 -06:00
Code Issues Packages Projects Releases Wiki Activity

FindPhysFS: Update documentation

Browse Source 
- Synced the descriptions.
- Added basic example how to find the library.
This commit is contained in:
Peter Kokot
2025-03-30 20:12:32 +02:00
parent 5978c57c20
commit 7be6d88f24
1 changed files with 35 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
Modules/FindPhysFS.cmake
View File

@@ -5,20 +5,47 @@
FindPhysFS
----------
Locate PhysFS library This module defines:
Finds the PhysicsFS library (PhysFS) for file I/O abstraction.
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``PhysFS_FOUND``
Boolean indicating whether PhysicsFS library is found. For backward
compatibility, the ``PHYSFS_FOUND`` variable is also set to the same value.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``PHYSFS_LIBRARY``
the name of the library to link against
``PHYSFS_FOUND``
if false, do not try to link to PHYSFS
Path to the PhysicsFS library needed to link against.
``PHYSFS_INCLUDE_DIR``
where to find physfs.h
Directory containing the ``physfs.h`` and related headers needed for using
the library.
``$PHYSFSDIR`` is an environment variable that would correspond to::
Hints
^^^^^
./configure --prefix=$PHYSFSDIR
This module accepts the following variables:
used in building PHYSFS.
``PHYSFSDIR``
Environment variable that can be set to help locate a PhysicsFS library
installed in a custom location. It should point to the installation
destination that was used when configuring, building, and installing PhysicsFS
library: ``./configure --prefix=$PHYSFSDIR``.
Examples
^^^^^^^^
Finding the PhysicsFS library:
.. code-block:: cmake
find_package(PhysFS)
#]=======================================================================]
find_path(PHYSFS_INCLUDE_DIR physfs.h