mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-09 23:34:20 +00:00
Code Activity

CMake: Add docs about preprocessor definitions

Browse source
This commit is contained in:
reuk 2020-05-04 13:17:09 +01:00
parent bf51d2c076
commit 56100600b8
No known key found for this signature in database
GPG key ID: 9ADCD339CFC98A11
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
examples/CMake/readme.md
View file

@ -101,6 +101,31 @@ provisioning profiles, which is achieved by passing the `-allowProvisioningUpdat
cmake --build build-ios --target <targetName> -- -allowProvisioningUpdates
```
### A note about compile definitions
Module options and plugin options that would previously have been set in the Projucer can be set on
a target-by-target basis in CMake, via `target_compile_definitions`. To find the options exposed by
a particular module, check its module header for sections with the following structure:
```
/** Config: NAME_OF_KEY
Docs go here...
*/
#ifndef NAME_OF_KEY
#define NAME_OF_KEY ...
#edif
```
To override the default config option, use the following CMake code, replacing `<value>` as
appropriate:
```
target_compile_definitions(my_target PUBLIC NAME_OF_KEY=<value>)
```
The `JucePlugin_PreferredChannelConfig` preprocessor definition for plugins is difficult to specify
in a portable way due to its use of curly braces, which may be misinterpreted in Linux/Mac builds
using the Ninja/Makefile generators. It is recommended to avoid this option altogether, and to use
the newer buses API to specify the desired plugin inputs and outputs.
## API Reference
### `juce_add_<target>`