define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE | TEST | VARIABLE | CACHED_VARIABLE> PROPERTY <name> [INHERITED] [BRIEF_DOCS <brief-doc> [docs...]] [FULL_DOCS <full-doc> [docs...]] [INITIALIZE_FROM_VARIABLE <variable>])
define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE | TEST | VARIABLE | CACHED_VARIABLE> PROPERTY <name> [INHERITED] [BRIEF_DOCS <brief-doc> [docs...]] [FULL_DOCS <full-doc> [docs...]] [INITIALIZE_FROM_VARIABLE <variable>])
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(TARGET PROPERTY LY_SYSTEM_LIBRARY
BRIEF_DOCS "Defines a 3rdParty library as a system library"
FULL_DOCS [[
Property which is set on third party targets that should be considered
as provided by the system. Such targets are excluded from the runtime
dependencies considerations, and are not distributed as part of the
O3DE SDK package. Instead, users of the SDK are expected to install
such a third party library themselves.
]]
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET PROPERTY SDL_NONINTERACTIVE BRIEF_DOCS "If true, target is a non-interactive test executable." FULL_DOCS "If true, target is a noninteractive test executable.")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
TARGET
PROPERTY RADIUM_TARGET_RESOURCES_DIRECTORIES
BRIEF_DOCS "Identify the optional resource directories associated with a target."
FULL_DOCS "Contains a list of directories that will be linked "
"or installed when building or installing the target."
)
define_property(GLOBAL PROPERTY ALL_SHADERS
BRIEF_DOCS "Aggregate shader list"
FULL_DOCS "GLOBAL shader list"
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(GLOBAL PROPERTY arrows_plugin_libraries
BRIEF_DOCS "Generated plugin libraries"
FULL_DOCS "List of generated shared plugin module libraries"
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET PROPERTY LEGATE_DEBUG_SYMBOLS_INSTALL_DIR)
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY ${prefix}_populated)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY "${package_name}_INCLUDE_DIRS"
BRIEF_DOCS "Global include directories used by all components."
FULL_DOCS "Global include directories used by all components."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET
PROPERTY NBL_PACKAGE_RUNTIME_DLL_DIR_PATH
BRIEF_DOCS "Relative path in CPack package to runtime DLL directory"
)
define_property(
SOURCE
PROPERTY EXCLUDE_UNITY_BUILD
BRIEF_DOCS "Whether to exclude the source file from unity builds"
FULL_DOCS "Specified whether a source file should be excluded from unity builds and should be built separately"
)
define_property(TARGET
PROPERTY
FILE_COPY_TARGET
BRIEF_DOCS
"File Copy target"
FULL_DOCS
"Is this a target created by add_file_copy_target?")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(TARGET PROPERTY O2_GPU_KERNELS)
define_property( TARGET
PROPERTY lemon_template
BRIEF_DOCS "Location of the template file for the lemon parser"
FULL_DOCS "Location of the template file for the lemon parser"
)
define_property(TARGET
PROPERTY
FILE_COPY_TARGET
BRIEF_DOCS
"File Copy target"
FULL_DOCS
"Is this a target created by add_file_copy_target?")
define_property(TARGET
PROPERTY
QT_ANDROID_MODULE_INSTALL_DIR
BRIEF_DOCS
"Recorded install location for a Qt Module."
FULL_DOCS
"Recorded install location for a Qt Module. Used by qt_internal_android_dependencies()."
)
define_property(TARGET
PROPERTY NAU_MODULES_LINKED_TARGETS
BRIEF_DOCS "Linked modules"
FULL_DOCS "All modules (tagets) that must be linked in"
)
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property (
TARGET
PROPERTY HDF5_VOL_TARGETS
BRIEF_DOCS "Generated targets of this connector"
FULL_DOCS "Generated targets of this connector"
)
define_property(TARGET
PROPERTY
FILE_COPY_TARGET
BRIEF_DOCS
"File Copy target"
FULL_DOCS
"Is this a target created by add_file_copy_target?")
define_property(TARGET PROPERTY SDL_NONINTERACTIVE BRIEF_DOCS "If true, target is a non-interactive test executable." FULL_DOCS "If true, target is a noninteractive test executable.")
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY SRCS_LIST
BRIEF_DOCS "List of source files"
FULL_DOCS "List of source files to be compiled in one library")
define_property(TEST PROPERTY install_dir
BRIEF_DOCS "Install-dir of the test"
FULL_DOCS "Just set because not optional (yet)")
define_property(GLOBAL PROPERTY USERGUIDES
BRIEF_DOCS "Global list of userguides"
FULL_DOCS "Global list of userguides")
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(TARGET PROPERTY Halide_RT_TARGETS
BRIEF_DOCS "On a Halide runtime target, lists the targets the runtime backs"
FULL_DOCS "On a Halide runtime target, lists the targets the runtime backs")
define_property(GLOBAL PROPERTY ALP_ALL_BENCHMARK_TARGETS
BRIEF_DOCS "Global list of elements"
FULL_DOCS "Global list of elements")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY NEO_OCL_COMPONENTS_LIST BRIEF_DOCS "List of components" FULL_DOCS "List of components to create packages")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(TARGET
PROPERTY SYSTEM
INHERITED
BRIEF_DOCS "Shim of built-in SYSTEM property for CMake versions less than 3.25"
FULL_DOCS "Non-functional, but allows the property to be inherited properly."
"See the CMake documentation at https://cmake.org/cmake/help/latest/prop_tgt/SYSTEM.html."
)
define_property(
TARGET PROPERTY pkg_config_REQUIRES INHERITED
BRIEF_DOCS "pkg-config 'Requires:' items"
FULL_DOCS "Specify 'Requires:' items for the targets' pkg-config file"
)
define_property(
TARGET
PROPERTY "BRISK_RESOURCES"
INHERITED
BRIEF_DOCS "List of Brisk resources per target"
FULL_DOCS "List of Brisk resources per target")
define_property(
TARGET
PROPERTY INTERFACE_LINK_LIBRARIES_PRIVATE
BRIEF_DOCS "List of direct link dependencies for object libraries."
FULL_DOCS "This property is a list of libraries and targets that are \
required for linking to the object library, but should not be passed down as \
dependencies further than the first link target."
)
define_property(GLOBAL PROPERTY FLS_ALL_BENCHMARK_TARGETS
BRIEF_DOCS "Global list of elements"
FULL_DOCS "Global list of elements")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET
PROPERTY AX_LUA_DEPEND
BRIEF_DOCS "axmol lua depend libs"
FULL_DOCS "use to save depend libs of axmol lua project"
)
define_property(TARGET
PROPERTY MAN_PAGES
BRIEF_DOCS "The man pages associated with the target"
FULL_DOCS "A list of the man pages associated with a target"
)
define_property(TARGET PROPERTY SOURCE_FILES
BRIEF_DOCS "Source files a flow target is built off"
FULL_DOCS "When compiling a flow target, this property contains a list of the non-generated source files. \
This property is set by the add_flow_target function")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL
PROPERTY KLEE_UNIT_TEST_TARGETS
BRIEF_DOCS "KLEE unit tests"
FULL_DOCS "KLEE unit tests"
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY "${package_name}_INCLUDE_DIRS"
BRIEF_DOCS "Global include directories used by all components."
FULL_DOCS "Global include directories used by all components."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(GLOBAL PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY ${target}_SRCS
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(TARGET PROPERTY "LIBLINPHONE_PLUGINS_DIR" BRIEF_DOCS "Stores the location of liblinphone plugins" FULL_DOCS "Stores the location of liblinphone plugins")
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET PROPERTY VS_DEBUGGER_PATHS
BRIEF_DOCS "List of paths that are added to the Visual Studio debugger environment PATH."
FULL_DOCS "List of paths that are added to the Visual Studio debugger environment PATH. Usually added by dependency scripts. Requires a call to 'TARGET_CREATE_VS_USER_SETTINGS' after adding all dependencies."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(GLOBAL PROPERTY "GEANT4_DATASETS"
BRIEF_DOCS "List of all defined Geant4 dataset names"
FULL_DOCS
"Each element of the list gives the name defined for the dataset.
This name can be used in other Geant4 Data API functions to
extract other properties of the dataset"
)
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY ${property_name}
BRIEF_DOCS "${property_name}"
FULL_DOCS "Global properties for ${property_name}"
)
define_property(GLOBAL PROPERTY EIGEN_CURRENT_SUBPROJECT BRIEF_DOCS " " FULL_DOCS " ")
define_property(TARGET PROPERTY EspressoResourceFiles
BRIEF_DOCS "List of resource files to be deployed with target")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(TARGET PROPERTY CGAL_TARGET_USES_ZLIB
BRIEF_DOCS "Tells if the target uses ZLIB as a dependency"
FULL_DOCS "Tells if the target uses ZLIB as a dependency")
define_property(GLOBAL PROPERTY Z3_LIBZ3_COMPONENTS
BRIEF_DOCS "List of Z3 components to use in libz3"
FULL_DOCS "List of Z3 components to use in libz3")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(GLOBAL PROPERTY DCMTK_MODERN_CXX_STANDARD
BRIEF_DOCS "TRUE when compiling C++11 (or newer) code."
FULL_DOCS "TRUE when the compiler does support and is configured for C++11 or a later C++ standard."
)
define_property(GLOBAL PROPERTY ${target}_SRCS
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
define_property(
CACHED_VARIABLE PROPERTY "COTIRE_ADDITIONAL_PREFIX_HEADER_IGNORE_PATH"
BRIEF_DOCS "Ignore headers from these directories when generating the prefix header."
FULL_DOCS
"The variable can be set to a semicolon separated list of include directories."
"If a header file is found in one of these directories or sub-directories, it will be excluded from the generated prefix header."
"If not defined, defaults to empty list."
)
define_property(
TARGET
PROPERTY LFS_IMAGE_LOCATION
BRIEF_DOCS "Target location of the .lfs binary image."
FULL_DOCS "The path to an image file created by a target made by add_lfs_image"
)
define_property(TARGET PROPERTY OSAL_EXPECTED_OSTYPE
BRIEF_DOCS
"The expected OS type for an OSAL BSP implementation"
FULL_DOCS
"This property is used to indicate the OS implementation layer that is intended to be paired with the BSP implementation"
)
define_property(
TARGET
PROPERTY "PUBLIC_INCLUDE_DIRECTORY"
BRIEF_DOCS "Header directory for a target"
FULL_DOCS
[[
Special traget specific property for storing a path to directory where PUBLIC HEADERS
live, typically the "include/package_name" one
]])
define_property (
GLOBAL
PROPERTY ${target}_SRCS
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
define_property(GLOBAL PROPERTY ${target}_SRCS
BRIEF_DOCS "Sources for the ${target} target"
FULL_DOCS "List of source files for the ${target} target")
define_property(
GLOBAL
PROPERTY ${propertyName}
BRIEF_DOCS "Internal implementation detail of FetchContent_Populate()"
FULL_DOCS "Details used by FetchContent_Populate() for ${contentName}"
)
define_property(${scope} PROPERTY "CXX_EXCEPTIONS" INHERITED
BRIEF_DOCS "Enable C++ exceptions, defaults to ON at global scope"
FULL_DOCS "Not choosing ON nor OFF with exact capitalisation will lead to misoperation!"
)
DEFINE_PROPERTY(
TARGET
PROPERTY "SPHINX_OUTPUT_DIRECTORY"
BRIEF_DOCS "output directory for documention generated by sphinx-build"
FULL_DOCS "Is the output directory associated with a target for documentation generated by sphinx-build. The path is a full one and is in CMake's format. The property reflects the directory configure into the target; changing the property won't affect the behavior of the target."
)
define_property(GLOBAL PROPERTY NANOEM_PROPERTY_INSTALL_PLUGINS BRIEF_DOCS "all installing plugins for nanoem binary bundle" FULL_DOCS "all installing plugins for nanoem binary bundle")