\nInternal Format<\/a>
\nEditing Presets<\/a>
\nTweaking<\/a>
\nImporting Existing Projects<\/a><\/p>\n
<\/a>Overview<\/h2>\nCMake Presets are essentially instructions how to build CMake projects stored in a consistent IDE-independent way. A project using presets can be opened and built using any preset-capable IDE with exactly the same results: ![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2024\/04\/interop.png\")
<\/a><\/p>\nPresets store parameters that would be otherwise passed to CMake via command line: toolchain to use, target system type, debug\/release configuration type, etc.<\/p>\n
<\/a>Internal Format<\/h2>\nPresets are stored in the CMakePresets.json<\/strong><\/a> file in the project directory. A simplified example of this file is provided below:<\/p>\n{\r\n \"configurePresets\": [\r\n {\r\n \"name\": \"RaspberryPi\",\r\n \"environment\": {\r\n \"TOOLCHAIN_ROOT\": \"C:\/SysGCC\/raspberry\",\r\n },\r\n \"cacheVariables\": {\r\n \"CMAKE_C_COMPILER\": \"$env{TOOLCHAIN_ROOT}\/bin\/arm-linux-gnueabihf-gcc.exe\",\r\n },\r\n \"binaryDir\": \"${sourceDir}\/build\/${presetName}\",\r\n \"generator\": \"Ninja\",\r\n \"hidden\": true\r\n }\r\n ]\r\n}<\/pre>\nInstead of manually setting TOOLCHAIN_ROOT<\/strong> via the environment and passing -DCMAKE_C_COMPILER=[…]<\/strong> to CMake, you can simply run CMake as follows:<\/p>\ncmake.exe --preset=RaspberryPi\r\ncmake.exe --build build\/RaspberryPi<\/pre>\n<\/a>Editing Presets<\/h2>\nVisualGDB automatically translates CMake presets into solution configurations (replacing the normal Debug\/Release) and provides GUI for managing them. You can switch between the classic configurations and CMake presets via the VisualGDB Project Properties -> CMake Build Settings -> Store build settings in<\/strong> setting (1)<\/strong>:![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2024\/04\/01-switch.png\")
<\/a>If you have enabled preset-based mode (you would need to click ‘Apply’ (2)<\/strong>), the Manage<\/strong> button (3)<\/strong> in the top right corner of the window will open the preset editor:![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2024\/04\/02-presets.png\")
<\/a>The editor allows creating (1)<\/strong> and deleting (2)<\/strong> presets, as well as editing settings within each preset.<\/p>\nNote that the presets can be inherited. E.g. it could be convenient to define a base RaspberryPi<\/strong> preset containing all toolchain settings, and then derive separate debug\/release presets from it:<\/p>\n\u00a0{\r\n \"name\": \"RaspberryPi-Debug\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"Debug\"\r\n }\r\n},\r\n{\r\n \"name\": \"RaspberryPi-Release\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"RelWithDebInfo\"\r\n }\r\n}<\/pre>\nVisualGDB fully supports preset inheritance, allowing you to select one or more base presets (3)<\/strong>. The inherited settings for each preset are initially grayed out, but can be easily copied into the currently edited preset and edited using the edit button (5)<\/strong>. Overridden settings can be reverted back to the inherited value via the revert button (4)<\/strong>.<\/p>\nYou can create new presets completely from scratch, inherit other presets, or let VisualGDB pre-fill the new preset with common values:
\n![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2024\/04\/03-new.png\")
<\/a>Selecting the “reference current toolchain<\/strong>” option (1)<\/strong> when creating a preset will automatically set variables like TOOLCHAIN_ROOT<\/strong>, CMAKE_SYSROOT<\/strong>, CMAKE_C_COMPILER<\/strong>, etc. based on the current toolchain. This is convenient when converting existing CMake projects to the preset model.<\/p>\nThe “create a pair of debug\/release presets<\/strong>” checkbox (2)<\/strong> will automatically mark the newly created preset as hidden and will create Debug<\/strong> and RelWithDebInfo<\/strong> presets inheriting it. This way, the actual toolchain settings will be shared between the debug and release presets instead of being duplicated between them.<\/p>\n<\/a>Tweaking<\/h2>\nVisualGDB only displays the most commonly used preset options. If you would like to set an option that is not shown in the list, you can manually edit CMakePresets.json<\/strong> file (VisualGDB will show the manually added setting) or edit the preset schema in the C:\\Program Files (x86)\\Sysprogs\\VisualGDB\\Rules\\CMakeData.xml<\/strong> file. The schema file simply lists all displayed properties for each preset type. E.g. the following element defines the “Installation directory” property for configuration presets:<\/p>\n<PresetEntry xsi:type=\"String\">\r\n <Key>installDir<\/Key>\r\n <Name>Installation Directory<\/Name>\r\n<\/PresetEntry><\/pre>\n<\/a>Importing Existing Projects<\/h2>\n
<\/a><\/p>\nPresets store parameters that would be otherwise passed to CMake via command line: toolchain to use, target system type, debug\/release configuration type, etc.<\/p>\n
<\/a>Internal Format<\/h2>\nPresets are stored in the CMakePresets.json<\/strong><\/a> file in the project directory. A simplified example of this file is provided below:<\/p>\n{\r\n \"configurePresets\": [\r\n {\r\n \"name\": \"RaspberryPi\",\r\n \"environment\": {\r\n \"TOOLCHAIN_ROOT\": \"C:\/SysGCC\/raspberry\",\r\n },\r\n \"cacheVariables\": {\r\n \"CMAKE_C_COMPILER\": \"$env{TOOLCHAIN_ROOT}\/bin\/arm-linux-gnueabihf-gcc.exe\",\r\n },\r\n \"binaryDir\": \"${sourceDir}\/build\/${presetName}\",\r\n \"generator\": \"Ninja\",\r\n \"hidden\": true\r\n }\r\n ]\r\n}<\/pre>\nInstead of manually setting TOOLCHAIN_ROOT<\/strong> via the environment and passing -DCMAKE_C_COMPILER=[…]<\/strong> to CMake, you can simply run CMake as follows:<\/p>\ncmake.exe --preset=RaspberryPi\r\ncmake.exe --build build\/RaspberryPi<\/pre>\n<\/a>Editing Presets<\/h2>\nVisualGDB automatically translates CMake presets into solution configurations (replacing the normal Debug\/Release) and provides GUI for managing them. You can switch between the classic configurations and CMake presets via the VisualGDB Project Properties -> CMake Build Settings -> Store build settings in<\/strong> setting (1)<\/strong>:<\/a>If you have enabled preset-based mode (you would need to click ‘Apply’ (2)<\/strong>), the Manage<\/strong> button (3)<\/strong> in the top right corner of the window will open the preset editor:<\/a>The editor allows creating (1)<\/strong> and deleting (2)<\/strong> presets, as well as editing settings within each preset.<\/p>\nNote that the presets can be inherited. E.g. it could be convenient to define a base RaspberryPi<\/strong> preset containing all toolchain settings, and then derive separate debug\/release presets from it:<\/p>\n\u00a0{\r\n \"name\": \"RaspberryPi-Debug\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"Debug\"\r\n }\r\n},\r\n{\r\n \"name\": \"RaspberryPi-Release\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"RelWithDebInfo\"\r\n }\r\n}<\/pre>\nVisualGDB fully supports preset inheritance, allowing you to select one or more base presets (3)<\/strong>. The inherited settings for each preset are initially grayed out, but can be easily copied into the currently edited preset and edited using the edit button (5)<\/strong>. Overridden settings can be reverted back to the inherited value via the revert button (4)<\/strong>.<\/p>\nYou can create new presets completely from scratch, inherit other presets, or let VisualGDB pre-fill the new preset with common values:
\n<\/a>Selecting the “reference current toolchain<\/strong>” option (1)<\/strong> when creating a preset will automatically set variables like TOOLCHAIN_ROOT<\/strong>, CMAKE_SYSROOT<\/strong>, CMAKE_C_COMPILER<\/strong>, etc. based on the current toolchain. This is convenient when converting existing CMake projects to the preset model.<\/p>\nThe “create a pair of debug\/release presets<\/strong>” checkbox (2)<\/strong> will automatically mark the newly created preset as hidden and will create Debug<\/strong> and RelWithDebInfo<\/strong> presets inheriting it. This way, the actual toolchain settings will be shared between the debug and release presets instead of being duplicated between them.<\/p>\n<\/a>Tweaking<\/h2>\nVisualGDB only displays the most commonly used preset options. If you would like to set an option that is not shown in the list, you can manually edit CMakePresets.json<\/strong> file (VisualGDB will show the manually added setting) or edit the preset schema in the C:\\Program Files (x86)\\Sysprogs\\VisualGDB\\Rules\\CMakeData.xml<\/strong> file. The schema file simply lists all displayed properties for each preset type. E.g. the following element defines the “Installation directory” property for configuration presets:<\/p>\n<PresetEntry xsi:type=\"String\">\r\n <Key>installDir<\/Key>\r\n <Name>Installation Directory<\/Name>\r\n<\/PresetEntry><\/pre>\n<\/a>Importing Existing Projects<\/h2>\n
{\r\n \"configurePresets\": [\r\n {\r\n \"name\": \"RaspberryPi\",\r\n \"environment\": {\r\n \"TOOLCHAIN_ROOT\": \"C:\/SysGCC\/raspberry\",\r\n },\r\n \"cacheVariables\": {\r\n \"CMAKE_C_COMPILER\": \"$env{TOOLCHAIN_ROOT}\/bin\/arm-linux-gnueabihf-gcc.exe\",\r\n },\r\n \"binaryDir\": \"${sourceDir}\/build\/${presetName}\",\r\n \"generator\": \"Ninja\",\r\n \"hidden\": true\r\n }\r\n ]\r\n}<\/pre>\nInstead of manually setting TOOLCHAIN_ROOT<\/strong> via the environment and passing -DCMAKE_C_COMPILER=[…]<\/strong> to CMake, you can simply run CMake as follows:<\/p>\ncmake.exe --preset=RaspberryPi\r\ncmake.exe --build build\/RaspberryPi<\/pre>\n<\/a>Editing Presets<\/h2>\nVisualGDB automatically translates CMake presets into solution configurations (replacing the normal Debug\/Release) and provides GUI for managing them. You can switch between the classic configurations and CMake presets via the VisualGDB Project Properties -> CMake Build Settings -> Store build settings in<\/strong> setting (1)<\/strong>:<\/a>If you have enabled preset-based mode (you would need to click ‘Apply’ (2)<\/strong>), the Manage<\/strong> button (3)<\/strong> in the top right corner of the window will open the preset editor:<\/a>The editor allows creating (1)<\/strong> and deleting (2)<\/strong> presets, as well as editing settings within each preset.<\/p>\nNote that the presets can be inherited. E.g. it could be convenient to define a base RaspberryPi<\/strong> preset containing all toolchain settings, and then derive separate debug\/release presets from it:<\/p>\n\u00a0{\r\n \"name\": \"RaspberryPi-Debug\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"Debug\"\r\n }\r\n},\r\n{\r\n \"name\": \"RaspberryPi-Release\",\r\n \"inherits\": \"RaspberryPi\",\r\n \"cacheVariables\": {\r\n \"CMAKE_BUILD_TYPE\": \"RelWithDebInfo\"\r\n }\r\n}<\/pre>\nVisualGDB fully supports preset inheritance, allowing you to select one or more base presets (3)<\/strong>. The inherited settings for each preset are initially grayed out, but can be easily copied into the currently edited preset and edited using the edit button (5)<\/strong>. Overridden settings can be reverted back to the inherited value via the revert button (4)<\/strong>.<\/p>\nYou can create new presets completely from scratch, inherit other presets, or let VisualGDB pre-fill the new preset with common values:
\n<\/a>Selecting the “reference current toolchain<\/strong>” option (1)<\/strong> when creating a preset will automatically set variables like TOOLCHAIN_ROOT<\/strong>, CMAKE_SYSROOT<\/strong>, CMAKE_C_COMPILER<\/strong>, etc. based on the current toolchain. This is convenient when converting existing CMake projects to the preset model.<\/p>\nThe “create a pair of debug\/release presets<\/strong>” checkbox (2)<\/strong> will automatically mark the newly created preset as hidden and will create Debug<\/strong> and RelWithDebInfo<\/strong> presets inheriting it. This way, the actual toolchain settings will be shared between the debug and release presets instead of being duplicated between them.<\/p>\n<\/a>Tweaking<\/h2>\nVisualGDB only displays the most commonly used preset options. If you would like to set an option that is not shown in the list, you can manually edit CMakePresets.json<\/strong> file (VisualGDB will show the manually added setting) or edit the preset schema in the C:\\Program Files (x86)\\Sysprogs\\VisualGDB\\Rules\\CMakeData.xml<\/strong> file. The schema file simply lists all displayed properties for each preset type. E.g. the following element defines the “Installation directory” property for configuration presets:<\/p>\n<PresetEntry xsi:type=\"String\">\r\n <Key>installDir<\/Key>\r\n <Name>Installation Directory<\/Name>\r\n<\/PresetEntry><\/pre>\n<\/a>Importing Existing Projects<\/h2>\n
![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2024\/04\/09-presets.png\")
<\/a>As long as this option is enabled during importing, VisualGDB will immediately map existing presets to solution configurations without the need to change anything in VisualGDB Project Properties.<\/p>\n","protected":false},"excerpt":{"rendered":"