Projects

A new Android project can be created using the File > New > Project menu. Normal Visual C++ projects are created and set to use a custom Android platform. Projects can be set to build in the Visual Studio environment or using external build files.

Project Templates

Eight project templates are available in the Android category.

1. Android Application

This template creates a basic Android application that contains only Java sources. The project is created with one defined Activity.

Package – Sets the package name for the application.
Min Target – Sets the minimum target API level for the application. The application will not run on a device using a lower API.
Namespace – Sets the namespace to use for the application.

2. Android Application with Native Library

This template creates a basic Android project that includes a Native library. The project includes both Java and native C sources. One Activity is defined and includes a native JNI method that is implemented in the C source.

Package – Sets the package name for the application.
Min Target – Sets the minimum target API level for the application. The application will not run on a device using a lower API.
Namespace – Sets the namespace to use for the application.

3. Android Hello World Demo

This project builds a sample “Hello World” application. It includes both Java and native C sources. The Java sources make JNI calls to the C sources to obtain text that is displayed on the screen. This project will build in the Visual Studio environment.

4. Android Native Application Project

This template creates a native activity application. The project does not contain Java sources and uses the NativeActivity class, http://developer.android.com/reference/android/app/NativeActivity.html.

Package – Sets the package name for the application.
Min Target – Sets the minimum target API level for the application. The application will not run on a device using a lower API.

5. Dynamic Library for Android Application

This template creates a basic dynamic native library for use in the Android applications. This project may contain only C/C++ code.

6. Import Android Project

This template creates a Visual Studio project for an existing Android SDK and/or NDK project. The sources for the existing project are imported into the Visual Studio project. The template includes a wizard to specify the location of the existing project and what files should be imported into the Visual Studio project.

The configuration type for this project will be set to Make Application. It will build with ANT and the NDK tools ndk-build.cmd script.

7. Import Android Project and Create JNI Library

This template creates a Visual Studio project for an existing Android SDK project. It is used when you want to add native C sources to an existing Android Java project. It will add template JNI C source files and build a native library.

8. Static Library for Android Application

This template creates a basic static native library for use in the Android applications. This project may contain only C/C++ code.

Project Properties

Project properties can be accessed through the normal means of right-clicking on the desired project and selecting the Properties menu.

General Properties

This page contains the general properties for the project.

Output Directory – Sets the directory where native output files are created. This setting is not available for Make Application projects.
Intermediate Directory – Sets the directory where native intermediate files are created. This setting is not available for Make Application projects.

Target Name – Sets the name of the native library that is created. This setting is not available for Make Application projects.

Note: If you are making an .so file, you must prefix the name with lib. However, when loading from Java System.loadLibrary(), then you pass in the name without the lib prefix. This is the standard Android convention.

Target Extension – Sets the extension of the native library. For Android platforms, this should be set to .so. This setting is not available for Make Application projects.
Extensions to Delete on Clean – Sets the extensions of files to delete when the project is cleaned.
Build Log File – Sets the location of the log file that is created with build results.
SD Card Files Directory - Sets the location of the SD Card files directory.
Configuration Type – Sets the type of build to perform.

The Configuration Type can be one of the following:
- Application – Builds the native C/C++ sources into a shared library. Java sources are built using the Android SDK ANT to produce the final application package (.apk) file. For debug builds, a copy of gdbserver is included in the application and a GDB initialization file, gdb.setup, is created.
- Make Application – Builds the native C/C++ sources using external make files and the ndk-build script. Java sources are built using the Android SDK ANT to produce the final application package file.
- Dynamic Library – Builds C/C++ sources into a dynamic shared library. No ANT build is performed and no application package file is produced.
- Static Library – Builds the C/C++ sources into a static library. No ANT build is performed and no application package file is produced.
- Debug Only – With this option, the user points the properties in the debug page at a .apk that is not built by this project. The .apk could be built by a different Nsight Tegra project, or a completely different build system (such as Eclipse or Unreal Build Tools). Not all systems may work, but if compatible, then you should be able to sync, launch, and debug with Nsight Tegra.
Min Android API Level – This is the minimum API level required for the application to run. The Android system will prevent the user from installing the application if the system's API level is lower than the value specified here.
Target Android API Level – Sets the Android API level to use for the project. The project output can only be installed to devices that support this level or higher. For Make Application projects, this setting ensures that the correct toolset header files are found for Intellisense.
Max Android API Level – If the application's maxSdkVersion attribute is lower than the API level used by the system itself, the system will not allow the application to be installed. Generally you should only set this attribute if you plan to make different versions of your app for different API ranges; otherwise, it's recommended to leave this setting blank, which provides no maximum limit.
Override Manifest API Levels – Choose whether or not to override API levels that had their values set in AndroidManifest.xml.
Target Architecture – Sets the target architecture for the project build. For Make Application projects, this setting ensures that the correct toolset header files are found for Intellisense.
STL Type – Sets the type of STL support for the project. For Make Application projects, this setting ensures that the correct toolset header files are found for Intellisense.

NDK Build Properties

This page displays properties for projects that build with NDK-BUILD. It is only available when the configuration type is set to Make Application.

Clean – Sets the arguments that will be passed to NDK-BUILD when the project is cleaned.
Build – Sets the arguments that will be passed to NDK-BUILD when the project is incrementally built.
Rebuild – Sets the arguments that will be passed to NDK-BUILD when the project is rebuilt.

Debugging Properties

This page selects the debugger and options. The Android Debugger is used to debug the projects.

Attach – Sets whether the debugger will install and run the project output or attach to an already running application on the Android device.
Clear User Data – Sets whether an application’s user data is deleted on the target when the application is launched.
Debug Mode – Sets the type of code to debug. One of the following can be selected:
- Java code – Only Java code will be debugged. Any native breakpoints will not be set.
- Native code – Only Native C/C++ code will be debugged. Any Java breakpoints will not be set.
- Java and Native code – Both Java code and Native C/C++ code will be debugged. All breakpoints will be set.
Suspend on Launch – Sets whether the Android application will be started in suspended mode.
GDB Location – Sets the location of the GDB debugger to use. By default, the GDB included with the toolset selected for the project will be used.
GDB Server Location – Sets the location of the GDB server. You can use $(PackagedGdbServerPath) to use the GDB Server that is included with Nsight Tegra.
Override APK Path – Sets the location of the .apk that will be debugged if you are using one that is not in build.xml.
Use Project Symbols – Sets whether or not project debug symbols will be used; the default setting is yes.
Additional Library Symbols Directories – Sets one or more directories which should be used to search for library debug symbols.
Additional GDB Directories – Sets any source code directories that cannot be added automatically to the build system. This property is only used by non NDK-build projects.
build.xml File Location – Sets the path to the build.xml file folder.
AndroidManifest.xml File Location – Sets the path to the AndroidManifest.xml file folder.
gdb.setup File Location – Sets the path to the gdb.setup file folder. If one is not specified, the default path will be used.
Java Source Directory – Sets the path to the Java source code root folder. If empty, this will use the path from the Ant Build page. (If Ant Build is disabled, then the src relative to the build.xml path will be used.)
Java Classes Directory – Sets the path to the Java classes folder. If empty, then bin\classes relative to the build.xml path will be used.
Use Hardware Watchpoints in GDB – Sets whether or not the debugger should use hardware watchpoints (if supported by GDB).

C/C++ Properties

This category contains pages for C/C++ compiler options.

Linker Properties

This category contains pages for linker options.

VC++ Directories

This page contains settings for the directories to search for include files and libraries.

Ant Build Properties

This page contains options for the Android SDK ANT build.

Skip Ant Step – Sets whether or not to skip the Ant build step.
Ant Build Root Path – Sets the root directory for the ANT build.
Ant Build Type – Sets the ANT build type: Debug or Release. Debug builds are signed with a debug key.
Copy APK to Output – The options here are: (a) copy the APK to the Output folder, (b) move the APK to the Output folder, (c) create a hard link to the APK, or (d) do nothing.
Android Manifest Location – States the path to the Android manifest file. This should either be absolute or relative to the project directory.
Secure Properties Location – States the location of the secure properties file. Either use an existing one, or use the Signing Options context menu command to generate it and set this property automatically.
Java Source Directory – Sets the path to the Java source directory.
Deploy To Device – Sets whether the application is installed to the device and/or run after a successful build of the project.
Ant JVM Heap Initial Size – Sets the VM initial heap size used for the build.
Ant JVM Heap Maximum Size – Sets the VM maximum heap sized used for the build.
Allow Debugging in Release – States whether or not to allow debugging projects with Ant Build Type set to Release. This does not affect ndk-build projects, as it sets the NDK_APP_DEBUGGABLE variable in the *.mk file instead.

Controlling Android Devices

NVIDIA Tegra Device Toolbar

Android devices can be controlled using the NVIDIA Tegra Device Toolbar. The toolbar is displayed automatically after the extension is installed.

All connected Android devices and emulators are displayed in the drop-down menu. The first available device will be selected by default. The toolbar will remember the device selected in a previous session.

If no devices are available, <No Device> will be displayed. Device selection is disabled when debugging.

The Device toolbar lets you select the Android device for the following:

Launching
Logging
Profiling
Deployment of an application

Device Information

The device information button opens a dialog that displays information for the selected device.

The dialog displays properties found in the /system/build.prop file. The dialog also displays a name for the device along with the serial number. By default, the name is set to the serial number, but you can change this to help you better identify the device.

Reboot Device

The Reboot device button will prompt to reboot the selected device.

Deploy APK on Debug

By selecting this option, the application package file (APK) will be deployed and installed on your Android device when you begin debugging your application.

Installing Applications

There are two ways to install a project application on a device. The project can be set to automatically install and run applications after a successful build. This can be set in the project properties (see Ant Build Properties).

The project can also be launched using the Visual Studio Start Debugging button. This will install the application on the currently selected device and start a debug session.