Before You Begin

The compiler integrates into the following versions of Microsoft Visual Studio*:

• Visual Studio 2022
• Visual Studio 2019

Visual Studio Community* or higher is required for full functionality within Visual Studio, including debugging and development. Visual Studio Express* allows only command-line builds. For all versions of Visual Studio, Microsoft C++ support must be selected as part of the Visual Studio install. For Visual Studio 2017 and later, you must use a custom install to select this option.

You typically do not need to set the environment variables on Windows, as the compiler command-line window sets these variables for you automatically. If you need to set the environment variables, run the environment script as described in Use the setvars and oneapi-vars Scripts with Windows.

You can develop oneAPI applications using C++ and SYCL* that run on Intel, AMD*, or NVIDIA* GPUs.

To develop and run applications for specific GPUs, you must first install the corresponding drivers or plug-ins:

• To use an Intel GPU, install the latest Intel GPU drivers.
• To use an NVIDIA GPU (Linux and Windows):
  • install the oneAPI for NVIDIA GPUs plugin from Codeplay.
  • Download oneAPI for NVIDIA® GPUs.

Option 1: Use the Command Line in Microsoft Visual Studio

The Intel® oneAPI DPC++/C++ Compiler provides multiple drivers that can be used to invoke the compiler from the command line. Use the driver appropriate for your specific project.

Invoke the compiler on the command line using the following syntax:

{compiler driver} [option] file1 [file2...]

icx hello-world.cpp

For SYCL compilation, use the -fsycl option with the C++ driver:

icx -fsycl hello-world.cpp

Option 2: Use Microsoft Visual Studio

Project Support for the Intel® DPC++/C++ Compiler in Microsoft Visual Studio

New Microsoft Visual Studio projects for DPC++ are automatically configured to use the Intel® oneAPI DPC++/C++ Compiler.

New Microsoft Visual C++* (MSVC) projects must be manually configured to use the Intel® oneAPI DPC++/C++ Compiler.

Use the Intel® DPC++/C++ Compiler in Microsoft Visual Studio

Exact steps may vary depending on the version of Microsoft Visual Studio in use.

1. Create a Microsoft Visual C++ (MSVC) project or open an existing project.
2. In Solution Explorer, select the project(s) to build with the Intel® oneAPI DPC++/C++ Compiler.
3. Open Project > Properties .
4. In the left pane, expand the Configuration Properties category and select the General property page.
5. In the right pane change the Platform Toolset to the compiler you want to use:
   • For C++ with SYCL, select Intel® oneAPI DPC++ Compiler.
   • For C/C++, there are two toolsets.

     Select Intel C++ Compiler <major version> (example 2021) to invoke icx.

     Select Intel C++ Compiler <major.minor> (example 19.2) to invoke icl.

     Alternatively, you can specify a compiler version as the toolset for all supported platforms and configurations of the selected project(s) by selecting Project > Intel Compiler > Use Intel oneAPI DPC++/C++ Compiler.

6. Rebuild, using either Build > Project only > Rebuild for a single project or Build > Rebuild Solution for a solution.

Select Compiler Version

If you have multiple versions of the Intel® oneAPI DPC++/C++ Compiler installed, you can select which version you want from the Compiler Selection dialog box:

1. Select a project, then go to Tools > Options > Intel Compilers and Libraries > <compiler> > Compilers, where <compiler> values are C++ or DPC++.
2. Use the Selected Compiler drop-down menu to select the appropriate version of the compiler.
3. Select OK.

Switch Back to the Microsoft Visual Studio C++ Compiler

If your project is using the Intel® oneAPI DPC++/C++ Compiler, you can choose to switch back to the Microsoft Visual C++ compiler:

1. Select your project in Microsoft Visual Studio.
2. Right-click and select Intel Compiler > Use Visual C++ from the context menu.

This action updates the solution file to use the Microsoft Visual Studio C++ compiler. All configurations of affected projects are automatically cleaned unless you select Do not clean project(s). If you choose not to clean projects, you will need to rebuild updated projects to ensure all source files are compiled with the new compiler.

Build a Program From the Command Line

Use the following steps to test your compiler installation and build a program.

1. Use a text editor to create a file called hello-world.cpp with the following contents:

   #include <iostream>
   
   int main()
   {
       std::cout << "Hello, world!\n";
   
       return 0;
   }
   			

2. Compile hello-world.cpp:

   icx hello-world.cpp

3. Now you have an executable called hello-world.exe which can be run and will give immediate feedback:

   hello-world.exe

   Which outputs:

   Hello, world!

You can direct and control compilation with compiler options. For example, you can create the object file and output the final binary in two steps:

1. Compile hello-world.cpp:

   icx hello-world.cpp /c /Fohello-world.obj 

   The /c option prevents linking at this step and /Fo specifies the name for the object file.
2. Use the icx compiler to link the resulting application object code and output an executable:

   icx hello-world.obj /Fehello-world.exe 

   The /Fe option specifies the generated executable file name.

Refer to Compiler Options for details about available options.