diff --git a/docs/html/sdk/ndk/index.jd b/docs/html/sdk/ndk/index.jd index 0f36345614010..2c8e4c206fed7 100644 --- a/docs/html/sdk/ndk/index.jd +++ b/docs/html/sdk/ndk/index.jd @@ -67,73 +67,71 @@ padding: .25em 1em; width="9px" /> Android NDK, Revision 5 (November 2010)
The r5 release of the NDK includes many new APIs, many of which are introduced to - support native game development and applications that require similar requirements. Most - notably, native activities are now supported, which allow you to write an application - entirely with native code. For detailed information describing the changes in this - release, read the CHANGES.HTML document included in the downloaded NDK package.
-This release of the NDK includes many new APIs, most of which are introduced to + support the development of games and similar applications that make extensive use + of native code. Using the APIs, developers have direct native access to events, audio, + graphics and window management, assets, and storage. Developers can also implement the + Android application lifecycle in native code with help from the new + {@link android.app.NativeActivity} class. For detailed information describing the changes in this + release, read the CHANGES.HTML document included in the downloaded NDK package. +
./configure && make. See
-docs/STANDALONE-TOOLCHAIN.html for the details. The binaries for GCC 4.4.0 are still provided,
-but the 4.2.1 binaries were removed.cpufeatures helper library to deal with buggy
-kernel that incorrectly report they run on an ARMv7 CPU (while the device really is an ARMv6). We
-recommend developers that use it to simply rebuild their applications to benefit from it, then
-upload to Market..apk.apk file.native-plasma and
- native-activity, to demonstrate how to write a native activity../configure && make. See
+ docs/STANDALONE-TOOLCHAIN.html for the details. The binaries for GCC 4.4.0 are still provided,
+ but the 4.2.1 binaries were removed.cpufeatures helper library that improves reporting
+ of the CPU type (some devices previously reported ARMv7 CPU when the device really was an ARMv6). We
+ recommend developers that use this library to rebuild their applications then
+ upload to Market to benefit from the improvements.native-plasma and native-activity,
+ to demonstrate how to write a native activity.Installing the NDK on your development computer is straightforward and involves extracting the - NDK from its download package. Unlike previous releases, there is no need to run a host-setup - script.
+ NDK from its download package.Before you get started make sure that you have downloaded the latest Android SDK and upgraded your applications and environment as - needed. The NDK will not work with older versions of the Android SDK. Also, take a moment to - review the System and Software Requirements for the - NDK, if you haven't already.
+ needed. The NDK is compatible with older platform versions but not older versions of the SDK tools. + Also, take a moment to review the System and Software Requirements + for the NDK, if you haven't already.To install the NDK, follow these steps:
@@ -318,7 +315,7 @@ detailed list of changes.<ndk>.
- You are now ready start working with the NDK.
+You are now ready to start working with the NDK.
-cd <project> +cd <project> <ndk>/ndk-build@@ -360,220 +356,10 @@ cd <project>Sample Applications
-The NDK includes sample applications that illustrate how to use native code in your Android - applications:
+The NDK includes sample Android applications that illustrate how to use native code in your + Android applications. For more information, see Sample Applications.
-
hello-jni — a simple application that loads a string from a native
- method implemented in a shared library and then displays it in the application UI.two-libs — a simple application that loads a shared library dynamically
- and calls a native method provided by the library. In this case, the method is implemented in a
- static library imported by the shared library.san-angeles — a simple application that renders 3D graphics through the
- native OpenGL ES APIs, while managing activity lifecycle with a {@link
- android.opengl.GLSurfaceView} object.hello-gl2 — a simple application that renders a triangle using OpenGL ES
- 2.0 vertex and fragment shaders.hello-neon — a simple application that shows how to use the
- cpufeatures library to check CPU capabilities at runtime, then use NEON intrinsics
- if supported by the CPU. Specifically, the application implements two versions of a tiny
- benchmark for a FIR filter loop, a C version and a NEON-optimized version for devices that
- support it.bitmap-plasma — a simple application that demonstrates how to access the
- pixel buffers of Android {@link android.graphics.Bitmap} objects from native code, and uses
- this to generate an old-school "plasma" effect.native-activity — a simple application that demonstrates how to use the
- native-app-glue static library to create a native activitynative-plasma — a version of bitmap-plasma implemented with a native
- activity.For each sample, the NDK includes the corresponding C source code and the necessary Android.mk
- and Application.mk files. There are located under <ndk>/samples/<name>/
- and their source code can be found under <ndk>/samples/<name>/jni/.
You can build the shared libraries for the sample apps by going into
- <ndk>/samples/<name>/ then calling the ndk-build command.
- The generated shared libraries will be located under
- <ndk>/samples/<name>/libs/armeabi/ for (ARMv5TE machine code) and/or
- <ndk>/samples/<name>/libs/armeabi-v7a/ for (ARMv7 machine code).
Next, build the sample Android applications that use the shared libraries:
- -<ndk>/apps/<app_name>/project/. Then, set up an AVD,
- if necessary, and build/run the application in the emulator. For more information about
- creating a new Android project in Eclipse, see Developing in Eclipse.android tool to create the build file
- for each of the sample projects at <ndk>/apps/<app_name>/project/.
- Then set up an AVD, if necessary, build your project in the usual way, and run it in the
- emulator. For more information, see Developing in Other IDEs.The hello-jni sample is a simple demonstration on how to use JNI from an Android application. - The HelloJni activity receives a string from a simple C function and displays it in a - TextView.
- -The main components of the sample include:
- -AndroidManifest.xml
- file, a src/ and res directories, and a main activity)jni/ directory that includes the implemented source file for the native code
- as well as the Android.mk filetests/ directory that contains unit test code.android tool to update the project so it generates a build.xml file that you can
- use to build the sample.
-
- <ndk-root>/samples/hello-jni directory.<ndk-root>/samples/hello-jni directory.-android update project -p . -s --
ndk-build command.
- -cd <ndk-root>/samples/hello-jni -<ndk_root>/ndk-build --
-ant debug -adb install bin/HelloJni-debug.apk --
When you run the application on the device, the string Hello JNI should appear on
- your device. You can explore the rest of the samples that are located in the
- <ndk-root>/samples directory for more examples on how to use the JNI.
The native-activity sample provided with the Android NDK demonstrates how to use the - android_native_app_glue static library. This static library makes creating a native activity - easier by providing you with an implementation that handles your callbacks in another thread, so - you do not have to worry about them blocking your main UI thread. The main parts of the sample - are described below:
- -AndroidManifest.xml
- file, a src/ and res directories). The AndroidManifest.xml declares
- that the application is native and specifies the .so file of the native activity. See {@link
- android.app.NativeActivity} for the source or see the
- <ndk_root>/platforms/samples/native-activity/AndroidManifest.xml file.jni/ directory contains the native activity, main.c, which uses the
- android_native_app_glue.h interface to implement the activity. The Android.mk that
- describes the native module to the build system also exists here.To build this sample application:
- -android tool to update the project so it generates a build.xml file that you can
- use to build the sample.
-
- <ndk-root>/samples/native-activity directory.<ndk-root>/samples/native-activity directory.-android update project -p . -s --
ndk-build command.
- -cd <ndk-root>/platforms/samples/android-9/samples/native-activity -<ndk_root>/ndk-build --
-ant debug -adb install bin/NativeActivity-debug.apk --
If you have questions about the NDK or would like to read or contribute to discussions about diff --git a/docs/html/sdk/ndk/overview.jd b/docs/html/sdk/ndk/overview.jd index a7ec5d42a1103..f6d148a85fab9 100644 --- a/docs/html/sdk/ndk/overview.jd +++ b/docs/html/sdk/ndk/overview.jd @@ -7,10 +7,8 @@ page.title=What is the NDK?
Write a native activity, which allows you to potentially create an application completely in native - code, because you can implement the lifecycle callbacks natively. The Android SDK provides - the {@link android.app.NativeActivity} class, which is a convenience class that notifies your +
Write a native activity, which allows you to implement the lifecycle callbacks in native
+ code. The Android SDK provides the {@link android.app.NativeActivity} class, which is a convenience class that notifies your
native code of any activity lifecycle callbacks (onCreate(), onPause(),
onResume(), etc). You can implement the callbacks in your native code to handle
these events when they occur. Applications that use native activities must be run on Android
@@ -142,6 +137,10 @@ page.title=What is the NDK?
The NDK also provides a build system that lets you work efficiently with your sources, without
@@ -163,25 +162,18 @@ page.title=What is the NDK?
the <ndk>/docs/ directory. Included are these files:
Additionally, the package includes detailed information about the "bionic" C library provided @@ -206,9 +224,218 @@ page.title=What is the NDK?
The NDK includes sample Android applications that illustrate how to use native code in your - Android applications. For more information, see Sample Applications.
+The NDK includes sample applications that illustrate how to use native code in your Android + applications:
+ +hello-jni — a simple application that loads a string from a native
+ method implemented in a shared library and then displays it in the application UI.two-libs — a simple application that loads a shared library dynamically
+ and calls a native method provided by the library. In this case, the method is implemented in a
+ static library imported by the shared library.san-angeles — a simple application that renders 3D graphics through the
+ native OpenGL ES APIs, while managing activity lifecycle with a {@link
+ android.opengl.GLSurfaceView} object.hello-gl2 — a simple application that renders a triangle using OpenGL ES
+ 2.0 vertex and fragment shaders.hello-neon — a simple application that shows how to use the
+ cpufeatures library to check CPU capabilities at runtime, then use NEON intrinsics
+ if supported by the CPU. Specifically, the application implements two versions of a tiny
+ benchmark for a FIR filter loop, a C version and a NEON-optimized version for devices that
+ support it.bitmap-plasma — a simple application that demonstrates how to access the
+ pixel buffers of Android {@link android.graphics.Bitmap} objects from native code, and uses
+ this to generate an old-school "plasma" effect.native-activity — a simple application that demonstrates how to use the
+ native-app-glue static library to create a native activitynative-plasma — a version of bitmap-plasma implemented with a native
+ activity.For each sample, the NDK includes the corresponding C source code and the necessary Android.mk
+ and Application.mk files. There are located under <ndk>/samples/<name>/
+ and their source code can be found under <ndk>/samples/<name>/jni/.
You can build the shared libraries for the sample apps by going into
+ <ndk>/samples/<name>/ then calling the ndk-build command.
+ The generated shared libraries will be located under
+ <ndk>/samples/<name>/libs/armeabi/ for (ARMv5TE machine code) and/or
+ <ndk>/samples/<name>/libs/armeabi-v7a/ for (ARMv7 machine code).
Next, build the sample Android applications that use the shared libraries:
+ +<ndk>/apps/<app_name>/project/. Then, set up an AVD,
+ if necessary, and build/run the application in the emulator. For more information about
+ creating a new Android project in Eclipse, see Developing in Eclipse.android tool to create the build file
+ for each of the sample projects at <ndk>/apps/<app_name>/project/.
+ Then set up an AVD, if necessary, build your project in the usual way, and run it in the
+ emulator. For more information, see Developing in Other IDEs.The hello-jni sample is a simple demonstration on how to use JNI from an Android application. + The HelloJni activity receives a string from a simple C function and displays it in a + TextView.
+ +The main components of the sample include:
+ +AndroidManifest.xml
+ file, a src/ and res directories, and a main activity)jni/ directory that includes the implemented source file for the native code
+ as well as the Android.mk filetests/ directory that contains unit test code.android tool to update the project so it generates a build.xml file that you can
+ use to build the sample.
+
+ <ndk-root>/samples/hello-jni directory.<ndk-root>/samples/hello-jni directory.android update project -p . -s+
ndk-build command.
+ +cd <ndk-root>/samples/hello-jni +<ndk_root>/ndk-build ++
+ant debug +adb install bin/HelloJni-debug.apk ++
When you run the application on the device, the string Hello JNI should appear on
+ your device. You can explore the rest of the samples that are located in the
+ <ndk-root>/samples directory for more examples on how to use the JNI.
The native-activity sample provided with the Android NDK demonstrates how to use the + android_native_app_glue static library. This static library makes creating a native activity + easier by providing you with an implementation that handles your callbacks in another thread, so + you do not have to worry about them blocking your main UI thread. The main parts of the sample + are described below:
+ +AndroidManifest.xml
+ file, a src/ and res directories). The AndroidManifest.xml declares
+ that the application is native and specifies the .so file of the native activity. See {@link
+ android.app.NativeActivity} for the source or see the
+ <ndk_root>/platforms/samples/native-activity/AndroidManifest.xml file.jni/ directory contains the native activity, main.c, which uses the
+ android_native_app_glue.h interface to implement the activity. The Android.mk that
+ describes the native module to the build system also exists here.To build this sample application:
+ +android tool to update the project so it generates a build.xml file that you can
+ use to build the sample.
+
+ <ndk-root>/samples/native-activity directory.<ndk-root>/samples/native-activity directory.+android update project -p . -s ++
ndk-build command.
+ +cd <ndk-root>/platforms/samples/android-9/samples/native-activity +<ndk_root>/ndk-build ++
+ant debug +adb install bin/NativeActivity-debug.apk ++
<manifest>
- ...
+ ...
<uses-feature android:glEsVersion="0x00020000" />
@@ -331,4 +558,4 @@ page.title=What is the NDK?
containing the library can be deployed only to devices running Android 2.2 (API level 8) or
higher. To ensure compatibility, make sure that your application declares <uses-sdk
android:minSdkVersion="8" /> attribute value in its manifest.
-
\ No newline at end of file
+