From 0829ab1577878a8a5ae070a5672a71b15b8282a5 Mon Sep 17 00:00:00 2001 From: Robert Ly Date: Wed, 24 Nov 2010 11:38:19 -0800 Subject: Doc change: updating ndk download and overview page Change-Id: Icbd578958d7a20c19f60827988a8893785b40851 --- docs/html/sdk/ndk/index.jd | 326 ++++++++---------------------------------- docs/html/sdk/ndk/overview.jd | 277 +++++++++++++++++++++++++++++++---- 2 files changed, 308 insertions(+), 295 deletions(-) (limited to 'docs') diff --git a/docs/html/sdk/ndk/index.jd b/docs/html/sdk/ndk/index.jd index 0f36345..2c8e4c2 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)
-
-
NDK r5 notes:
- -
-

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. +

General notes:
-
    - -
  • A new toolchain (based on GCC 4.4.3), which generates better code, and can also now -be used as a standalone cross-compiler, for people who want to build their stuff with -./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.
    • - -
  • Support for prebuilt static and shared libraries (docs/PREBUILTS.html), module -exports and imports to make sharing and reuse of third-party modules much easier -(docs/IMPORT-MODULE.html explains why).
    • - -
  • A C++ STL implementation (based on STLport) is now provided as a helper module. It -can be used either as a static or shared library (details and usage exemple under -sources/android/stlport/README). Note: For now, C++ Exceptions and RTTI are still -not supported.
    • - -
  • Improvements to the 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.
    • - -
  • Adds support for native activities, which allows you to write completely native - applications.
    • - -
  • Adds an EGL library that lets you create and manage OpenGL ES textures and - services.
    • +
  • Adds support for native activities, which allows you to implement the + Android application lifecycle in native code.
  • Adds native support for the following:
      +
    • Input subsystem (such as the keyboard and touch screen)
      • +
    • Access to sensor data (accelerometer, compass, gyroscope, etc).
      • + +
    • Event loop APIs to wait for things such as input and sensor events.
      • +
    • Window and surface subsystem
    • Audio APIs based on the OpenSL ES standard that support playback and recording as well as control over platform audio effects
      • -
    • Event loop APIs to wait for things such as input and sensor events
      • - -
    • Access to assets packaged in the .apk
      • - -
    • Access to sensor data (accelerometer, compass, gyroscope, etc.)
      • +
    • Access to assets packaged in an .apk file.
      • +
    • -
  • New sample applications, native-plasma and - native-activity, to demonstrate how to write a native activity.
    • - -
  • Plus many bugfixes and other small improvements; see docs/CHANGES.html for a more -detailed list of changes.
    • +
  • Includes a new toolchain (based on GCC 4.4.3), which generates better code, and can also now + be used as a standalone cross-compiler, for people who want to build their stuff with + ./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.
    • + +
  • Adds support for prebuilt static and shared libraries (docs/PREBUILTS.html) and module + exports and imports to make sharing and reuse of third-party modules much easier + (docs/IMPORT-MODULE.html explains why).
    • + +
  • Provides a default C++ STL implementation (based on STLport) as a helper module. It can be used either + as a static or shared library (details and usage examples are in sources/android/stlport/README). Prebuilt + binaries for STLport (static or shared) and GNU libstdc++ (static only) are also provided if you choose to + compile against those libraries instead of the default C++ STL implementation. + C++ Exceptions and RTTI are not supported in the default STL implementation. For more information, see + docs/CPLUSPLUS-SUPPORT.HTML.
    • + +
  • Includes improvements to the 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.
    • + +
  • Adds an EGL library that lets you create and manage OpenGL ES textures and + services.
    • + +
  • Adds new sample applications, native-plasma and native-activity, + to demonstrate how to write a native activity.
    • + +
  • Includes many bugfixes and other small improvements; see docs/CHANGES.html for a more + detailed list of changes.
@@ -296,14 +294,13 @@ detailed list of changes.

Installing the NDK

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.

Getting Started with the NDK

@@ -342,8 +339,7 @@ detailed list of changes.
  • Build your native code by running the 'ndk-build' script from your project's directory. It is located in the top-level NDK directory: - 
    -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:
    
-
-  
      
-    
    • 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 activity
      • 
-
-    
    • native-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:
    
-
-  
      
-    
    • If you are developing in Eclipse with ADT, use the New Project Wizard to create a new
-    Android project for each sample, using the "Import from Existing Source" option and importing
-    the source from <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.
      • 
-
-    
    • If you are developing with Ant, use the 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.
      • 
-  
    
-
-  
    Exploring the hello-jni Sample
    
-
-  
    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:
    
-
-  
      
-    
    • The familiar basic structure of an Android application (an AndroidManifest.xml
-    file, a src/ and res directories, and a main activity)
      • 
-
-    
    • A jni/ directory that includes the implemented source file for the native code
-    as well as the Android.mk file
      • 
-
-    
    • A tests/ directory that contains unit test code.
      • 
-  
    
-
-  
      
-    
    1. Create a new project in Eclipse from the existing sample source or use the
-    android tool to update the project so it generates a build.xml file that you can
-    use to build the sample.
-
-      
        
-        
      • In Eclipse:
-
-          
          
-            
        1. Click File > New Android Project...
          2. 
+  
          The NDK includes sample Android applications that illustrate how to use native code in your
+  Android applications. For more information, see Sample Applications.
          
 
-            
        2. Select the Create project from existing source radio button.
          3. 
-
-            
        3. Select any API level above Android 1.5.
          4. 
-
-            
        4. In the Location field, click Browse... and select
-            the <ndk-root>/samples/hello-jni directory.
          5. 
-
-            
        5. Click Finish.
          6. 
-          
        
-        
        • 
-
-        
      • On the command line:
-
-          
          
-            
        1. Change to the <ndk-root>/samples/hello-jni directory.
          2. 
-
-            
        2. Run the following command to generate a build.xml file:
-              
          -android update project -p . -s
-
          
-            
          3. 
-          
        
-        
        • 
-      
      
-    
      2. 
-
-    
    2. Compile the native code using the ndk-build command.
-      
      -cd <ndk-root>/samples/hello-jni
-<ndk_root>/ndk-build
-
      
-    
      3. 
-
-    
    3. Build and install the application as you would a normal Android application. If you are
-    using Eclipse, run the application to build and install it on a device. If you are using Ant,
-    run the following commands from the project directory:
-      
      -ant debug
-adb install bin/HelloJni-debug.apk
-
      
-    
      4. 
-  
    
-
-  
    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.
    
-
-  
    Exploring the native-activity Sample Application
    
-
-  
    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:
    
-
-  
      
-    
    • The familiar basic structure of an Android application (an 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.
      • 
-
-    
    • A 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:
    
-
-  
      
-    
    1. Create a new project in Eclipse from the existing sample source or use the
-    android tool to update the project so it generates a build.xml file that you can
-    use to build the sample.
-
-      
        
-        
      • In Eclipse:
-
-          
          
-            
        1. Click File > New Android Project...
          2. 
-
-            
        2. Select the Create project from existing source radio button.
          3. 
-
-            
        3. Select any API level above Android 2.3.
          4. 
-
-            
        4. In the Location field, click Browse... and select
-            the <ndk-root>/samples/native-activity directory.
          5. 
-
-            
        5. Click Finish.
          6. 
-          
        
-        
        • 
-
-        
      • On the command line:
-
-          
          
-            
        1. Change to the <ndk-root>/samples/native-activity directory.
          2. 
-
-            
        2. Run the following command to generate a build.xml file:
-              
          -android update project -p . -s
-
          
-            
          3. 
-          
        
-        
        • 
-      
      
-    
      2. 
-
-    
    2. Compile the native code using the ndk-build command.
-      
      -cd <ndk-root>/platforms/samples/android-9/samples/native-activity
-<ndk_root>/ndk-build
-
      
-    
      3. 
-
-    
    3. Build and install the application as you would a normal Android application. If you are
-    using Eclipse, run the application to build and install it on a device. If you are using Ant,
-    run the following commands in the project directory, then run the application on the device:
-      
      -ant debug
-adb install bin/NativeActivity-debug.apk
-
      
-    
      4. 
-  
    
-  
   
    Discussion Forum and Mailing List
    
 
   
    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 a7ec5d4..f6d148a 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?
 
       
      
         
    1. When to Develop in Native Code
      2. 
-
         
    2. 
           Contents of the NDK
-
           
        
             
      1. Development tools
        2. 
 
@@ -19,9 +17,7 @@ page.title=What is the NDK?
             
      2. Sample applications
        3. 
           
      
         
      3. 
-
         
    3. System and Software Requirements
      4. 
-
    • @@ -102,9 +98,8 @@ page.title=What is the NDK? later.
  • -

    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?

  • libjnigraphics (Pixel buffer access) header (for Android 2.2 and above).
  • A Minimal set of headers for C++ support
    • + +
  • OpenSL ES native audio libraries
    • + +
  • Android native application APIS

    • 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?

    Sample applications

    -

    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:

    + + + +

    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:

    + + + +

    Exploring the hello-jni Sample

    + +

    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:

    + + + +
      +
    1. Create a new project in Eclipse from the existing sample source or use the + android tool to update the project so it generates a build.xml file that you can + use to build the sample. + +
        +
      • In Eclipse: + +
          +
        1. Click File > New Android Project...
          2. + +
        2. Select the Create project from existing source radio button.
          3. + +
        3. Select any API level above Android 1.5.
          4. + +
        4. In the Location field, click Browse... and select + the <ndk-root>/samples/hello-jni directory.
          5. + +
        5. Click Finish.
          6. +
        +
        • + +
      • On the command line: + +
          +
        1. Change to the <ndk-root>/samples/hello-jni directory.
          2. + +
        2. Run the following command to generate a build.xml file: + 
          android update project -p . -s
          +
          3. +
        +
        • +
      +
      2. + +
    2. Compile the native code using the ndk-build command. + 
      +cd <ndk-root>/samples/hello-jni
+<ndk_root>/ndk-build
+
      +
      3. + +
    3. Build and install the application as you would a normal Android application. If you are + using Eclipse, run the application to build and install it on a device. If you are using Ant, + run the following commands from the project directory: + 
      +ant debug
+adb install bin/HelloJni-debug.apk
+
      +
      4. +
    + +

    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.

    + +

    Exploring the native-activity Sample Application

    + +

    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:

    + + + +

    To build this sample application:

    + +
      +
    1. Create a new project in Eclipse from the existing sample source or use the + android tool to update the project so it generates a build.xml file that you can + use to build the sample. + +
        +
      • In Eclipse: + +
          +
        1. Click File > New Android Project...
          2. + +
        2. Select the Create project from existing source radio button.
          3. + +
        3. Select any API level above Android 2.3.
          4. + +
        4. In the Location field, click Browse... and select + the <ndk-root>/samples/native-activity directory.
          5. + +
        5. Click Finish.
          6. +
        +
        • + +
      • On the command line: + +
          +
        1. Change to the <ndk-root>/samples/native-activity directory.
          2. + +
        2. Run the following command to generate a build.xml file: + 
          +android update project -p . -s
+
          +
          3. +
        +
        • +
      +
      2. + +
    2. Compile the native code using the ndk-build command. + 
      +cd <ndk-root>/platforms/samples/android-9/samples/native-activity
+<ndk_root>/ndk-build
+
      +
      3. + +
    3. Build and install the application as you would a normal Android application. If you are + using Eclipse, run the application to build and install it on a device. If you are using Ant, + run the following commands in the project directory, then run the application on the device: + 
      +ant debug
+adb install bin/NativeActivity-debug.apk
+
      +
      4. +
    +

    System and Software Requirements

    @@ -313,7 +540,7 @@ page.title=What is the NDK? to users whose devices are capable of supporting your application. For example: 
     <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
+  
-- 
cgit v1.1