mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-24 07:08:38 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Add .. versionadded directives to module docs

Browse Source 
Issue: #19715
This commit is contained in:
Nikita Nemkin
2020-11-12 13:40:33 +05:00
parent 8634561dca
commit 8fea95319b
108 changed files with 1300 additions and 364 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/FindOpenGL.cmake
+33 -11
View File
@@ -7,27 +7,41 @@ FindOpenGL
FindModule for OpenGL and OpenGL Utility Library (GLU).
.. versionchanged:: 3.2
X11 is no longer added as a dependency on Unix/Linux systems.
.. versionadded:: 3.10
GLVND support on Linux. See the :ref:`Linux Specific` section below.
Optional COMPONENTS
^^^^^^^^^^^^^^^^^^^
.. versionadded:: 3.10
This module respects several optional COMPONENTS: ``EGL``, ``GLX``, and
``OpenGL``. There are corresponding import targets for each of these flags.
IMPORTED Targets
^^^^^^^^^^^^^^^^
.. versionadded:: 3.8
This module defines the :prop_tgt:`IMPORTED` targets:
``OpenGL::GL``
Defined to the platform-specific OpenGL libraries if the system has OpenGL.
``OpenGL::OpenGL``
Defined to libOpenGL if the system is GLVND-based.
Defined to the platform-specific OpenGL libraries if the system has OpenGL.
``OpenGL::GLU``
Defined if the system has OpenGL Utility Library (GLU).
Defined if the system has OpenGL Utility Library (GLU).
.. versionadded:: 3.10
Additionally, the following GLVND-specific library targets are defined:
``OpenGL::OpenGL``
Defined to libOpenGL if the system is GLVND-based.
``OpenGL::GLX``
Defined if the system has OpenGL Extension to the X Window System (GLX).
Defined if the system has OpenGL Extension to the X Window System (GLX).
``OpenGL::EGL``
Defined if the system has EGL.
Defined if the system has EGL.
Result Variables
^^^^^^^^^^^^^^^^
@@ -55,6 +69,9 @@ This module sets the following variables:
On Linux, this assumes GLX and is never correct for EGL-based targets.
Clients are encouraged to use the ``OpenGL::*`` import targets instead.
.. versionadded:: 3.10
Variables for GLVND-specific libraries ``OpenGL``, ``EGL`` and ``GLX``.
Cache variables
^^^^^^^^^^^^^^^
@@ -72,6 +89,11 @@ The following cache variables may also be set:
Path to the OpenGL library. New code should prefer the ``OpenGL::*`` import
targets.
.. versionadded:: 3.10
Variables for GLVND-specific libraries ``OpenGL``, ``EGL`` and ``GLX``.
.. _`Linux Specific`:
Linux-specific
^^^^^^^^^^^^^^
@@ -97,14 +119,14 @@ The value may be one of:
``GLVND``
If the GLVND OpenGL and GLX libraries are available, prefer them.
This forces ``OPENGL_gl_LIBRARY`` to be empty.
This is the default if components were requested (since components
correspond to GLVND libraries) or if policy :policy:`CMP0072` is
set to ``NEW``.
.. versionchanged:: 3.11
This is the default, unless policy :policy:`CMP0072` is set to ``OLD``
and no components are requeted (since components
correspond to GLVND libraries).
``LEGACY``
Prefer to use the legacy libGL library, if available.
This is the default if no components were requested and
policy :policy:`CMP0072` is not set to ``NEW``.
For EGL targets the client must rely on GLVND support on the user's system.
Linking should use the ``OpenGL::OpenGL OpenGL::EGL`` targets. Using GLES*