Preparing Tasks

This extension enables the ability to prepare tasks from make or cmake files:

1. Using the VS Code explorer, click File>Open Folder.

2. Navigate to the folder where your project is located and click OK.

   

3. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.

4. Type Intel oneAPI and select Intel oneAPI: Generate tasks.

   

5. Follow the prompts to add targets from your make/cmake oneAPI project.

6. Run the target by selecting Terminal > Run task….

7. Select the task to run.

   

Prepare Launch Configuration

This extension enables the ability to prepare launch configurations for running and debugging projects created using Intel oneAPI toolkits:

1. Using the VS Code explorer, click File>Open Folder.

2. Navigate to the folder where your project is located and click OK.

   

3. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.

4. Type Intel oneAPI and select Intel oneAPI: Generate launch configurations.

   

5. Follow the prompts to add launch configurations.

6. Using the VS Code Explorer, open the C++ file for your project.

   

7. The configuration is now available to debug and run using the gdb-oneapi debugger. To debug and run, click on the Run icon or press Ctrl+Shift+D.

Building a Single cpp File

1. Open the cpp file you want to build.

2. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.

3. Type Intel oneAPI and select Intel oneAPI: Quick build current file with ICPX.

4. If you want to build a file with SYCL enabled, choose the option Intel oneAPI: Quick build current file with ICPX and SYCL enabled.

Using Intel Analysis Tools

You need to have at least one of the above Intel analysis tools installed for this extension to work and be useful.

1. Open a Visual Studio Code project.

2. Build your project to create the executable you plan to analyze.

3. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.

4. Type Intel oneAPI and select Intel oneAPI:Launch Advisor or Intel oneAPI: Launch VTune Profiler. Select one of the options displayed:

   

   • Change binary: show the list of all executable files in your working directory. Select an executable and select Save to save this path to in your workspace or select Once to make the change for this session only.

     To see your changes, you can open File-> Preferences -> Settings, select the extensions tab and click on Analysis Configurator.

   • Open settings: change the default path to the binary.

   • Exit: take no action and exit the command pallette.

5. Select the executable you want to analyze. This needs to be done once for a workspace unless you want to analyze a different executable.

6. Select the installation path of Intel Advisor or Intel VTune Profiler. This needs to be done once for a workspace.

7. Enter the name of the project folder for the tool, or press enter to accept the default. This needs to be done once for a workspace.

8. The extension will open the analyzer tool and pass the appropriate project parameters to the tool.

How to Use IntelliSense for Code Developed with Intel oneAPI Toolkits

1. Make sure that the C/C++ extension is already installed.

2. Press Ctrl+Shift+P and and type C/C++ Edit Configurations (JSON). Press Enter. As a result, a c_cpp_properties.json file will be created in the .vscode folder.

3. Edit the file so that it looks like in the example:

   {
   "configurations": [
           {
               "name": "Linux",
               "includePath": [
                   "${workspaceFolder}/**",
                   "/opt/intel/oneapi/**"
               ],
               "defines": [],
               "compilerPath": /opt/intel/oneapi/compiler/latest/linux/bin/dpcpp",
               "cStandard": "c17",
               "cppStandard": "c++17",
               "intelliSenseMode": "linux-clang-x64"
           }
       ],
       "version": 4
           }

Configure C++ Properties

This extension provides the ability to configure the cpp properties includePath, defines, and compilerPath.

1. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.

2. Type Intel oneAPI: configure cpp properties configuration and select it from the palette.

   

3. Select cpp standard.

4. Select c standard.

5. A message will appear in the lower right corner to confirm the properties have been configured.

1. To view or change the properties, open settings.json from the VS Code Explorer.

2. To make changes to the configuration, edit the default path in settings.json.

   

Display Tool Tips

To learn more about the tool tips function, see Working with Code.