Extensions for Visual Studio Code Users

To watch a video presentation of how to install extensions and use them to set up your environment, explore sample code, and connect to the Intel® Developer Cloud using Visual Studio Code, see oneAPI Visual Studio Code Extensions.

You can use VS Code extensions to set your environment, create launch configurations, and browse and download samples:

1. From Visual Studio Code, click on the Extensions logo in the left navigation.

   
2. Locate the extension titled Sample Browser for Intel oneAPI Toolkits, or visit https://marketplace.visualstudio.com/publishers/intel-corporation to browse available extensions.
3. Click Install.
4. Next, locate the extension titled Environment Configurator for Intel oneAPI Toolkits.
5. Click Install.

For more information about VS Code extensions for Intel oneAPI Toolkits, see Using Visual Studio Code* to Develop Intel® oneAPI Applications.

Create a Project Using Visual Studio Code

1. Click on the oneAPI button on the left navigation to view samples.

   To watch a video presentation of how to install extensions and use them to set up your environment, explore sample code, and connect to the Intel® Developer Cloud using Visual Studio Code, see oneAPI Visual Studio Code Extensions.

   

2. A list of available samples will open in the left navigation.
3. To view the readme for the sample, click the next to the sample. If you choose to build and run the sample, the readme will also be downloaded with the sample.
4. Find the sample you want to build and run. Click the to the right of the sample name.

   

5. Create a new folder for the sample. The sample will load in a new window:

   

Set the oneAPI Environment

1. Press Ctrl+Shift+P ( or View -> Command Palette… ) to open the Command Palette.
2. Type Intel oneAPI: Initialize environment variables. Click on Intel oneAPI: Initialize environment variables.

   

3. From the left navigation, click README.md to view instructions for the sample.

Prepare Build Tasks from Make / CMake Files

1. Press Ctrl+Shift+P or View -> Command Palette… to open the Command Pallette.
2. Type Intel oneAPI and select Intel oneAPI: Generate tasks.

   

3. Select the build tasks (target) from your Make/CMake oneAPI project that you want to use.

   

4. Run the task/target by selecting Terminal -> Run task... .

5. Select the task to run.

Build the Project

The oneAPI extensions enable the ability to prepare launch configurations for running and debugging projects created using Intel oneAPI toolkits:

1. Press Ctrl+Shift+B or Terminal -> Run Build Task... to set the default build task.
2. Select the task from the command prompt list to build your project.
3. Press Ctrl+Shift+B or Terminal -> Run Build Task... again to build your project.

Prepare Launch Configuration for Debugging

To following section describes how to use the Intel oneAPI FPGA compiler with Visual Studio Code, and use your native debugger to debug device code in emulation.

1. Press Ctrl+Shift+P or View -> Command Palette... to open the Command Palette.
2. Type Intel oneAPI and select Intel oneAPI: Generate launch configurations .

   

3. Select the executable (target) you want to debug.

   Optional: select any task you want to run before and/or after launching the debugger (for example, build the project before debug, clean the project after debug).

4. The configuration is now available to debug and run using the gdb-oneapi debugger. You can find it in .vscode/launch.json. To debug and run, click on the Run icon or press Ctrl+Shift+D.

Debug, Analyze, Develop with More Extensions

There are more oneAPI extensions for Visual Studio Code which enable:

• debugging
• remote development
• connection to Intel Developer Cloud
• analysis configuration

To learn more about the extensions, see Intel® oneAPI Extensions for Visual Studio Code*.

To learn more about more capabilities and options, see Using Visual Studio Code with Intel® oneAPI Toolkits.