Skip to content

Most visited

Recently visited

navigation

Native Activity

Files

file  native_activity.h
 
file  native_window.h
 API for accessing a native window.
 
file  native_window_jni.h
 
file  rect.h
 
file  window.h
 

Data Structures

struct  ANativeActivity
 
struct  ANativeActivityCallbacks
 
struct  ANativeWindow_Buffer
 
struct  ARect
 

Typedefs

typedef struct ANativeActivity ANativeActivity
 
typedef struct ANativeActivityCallbacks ANativeActivityCallbacks
 
typedef void ANativeActivity_createFunc(ANativeActivity *activity, void *savedState, size_t savedStateSize)
 
typedef struct ANativeWindow ANativeWindow
 
typedef struct ANativeWindow_Buffer ANativeWindow_Buffer
 
typedef struct ARect ARect
 

Enumerations

enum  { ANATIVEACTIVITY_SHOW_SOFT_INPUT_IMPLICIT = 0x0001, ANATIVEACTIVITY_SHOW_SOFT_INPUT_FORCED = 0x0002 }
 
enum  { ANATIVEACTIVITY_HIDE_SOFT_INPUT_IMPLICIT_ONLY = 0x0001, ANATIVEACTIVITY_HIDE_SOFT_INPUT_NOT_ALWAYS = 0x0002 }
 
enum  { WINDOW_FORMAT_RGBA_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8A8_UNORM, WINDOW_FORMAT_RGBX_8888 = AHARDWAREBUFFER_FORMAT_R8G8B8X8_UNORM, WINDOW_FORMAT_RGB_565 = AHARDWAREBUFFER_FORMAT_R5G6B5_UNORM }
 
enum  ANativeWindowTransform {
  ANATIVEWINDOW_TRANSFORM_IDENTITY = 0x00, ANATIVEWINDOW_TRANSFORM_MIRROR_HORIZONTAL = 0x01, ANATIVEWINDOW_TRANSFORM_MIRROR_VERTICAL = 0x02, ANATIVEWINDOW_TRANSFORM_ROTATE_90 = 0x04,
  ANATIVEWINDOW_TRANSFORM_ROTATE_180, ANATIVEWINDOW_TRANSFORM_ROTATE_270
}
 
enum  {
  AWINDOW_FLAG_ALLOW_LOCK_WHILE_SCREEN_ON = 0x00000001, AWINDOW_FLAG_DIM_BEHIND = 0x00000002, AWINDOW_FLAG_BLUR_BEHIND = 0x00000004, AWINDOW_FLAG_NOT_FOCUSABLE = 0x00000008,
  AWINDOW_FLAG_NOT_TOUCHABLE = 0x00000010, AWINDOW_FLAG_NOT_TOUCH_MODAL = 0x00000020, AWINDOW_FLAG_TOUCHABLE_WHEN_WAKING = 0x00000040, AWINDOW_FLAG_KEEP_SCREEN_ON = 0x00000080,
  AWINDOW_FLAG_LAYOUT_IN_SCREEN = 0x00000100, AWINDOW_FLAG_LAYOUT_NO_LIMITS = 0x00000200, AWINDOW_FLAG_FULLSCREEN = 0x00000400, AWINDOW_FLAG_FORCE_NOT_FULLSCREEN = 0x00000800,
  AWINDOW_FLAG_DITHER = 0x00001000, AWINDOW_FLAG_SECURE = 0x00002000, AWINDOW_FLAG_SCALED = 0x00004000, AWINDOW_FLAG_IGNORE_CHEEK_PRESSES = 0x00008000,
  AWINDOW_FLAG_LAYOUT_INSET_DECOR = 0x00010000, AWINDOW_FLAG_ALT_FOCUSABLE_IM = 0x00020000, AWINDOW_FLAG_WATCH_OUTSIDE_TOUCH = 0x00040000, AWINDOW_FLAG_SHOW_WHEN_LOCKED = 0x00080000,
  AWINDOW_FLAG_SHOW_WALLPAPER = 0x00100000, AWINDOW_FLAG_TURN_SCREEN_ON = 0x00200000, AWINDOW_FLAG_DISMISS_KEYGUARD = 0x00400000
}
 

Functions

void ANativeActivity_finish (ANativeActivity *activity)
 
void ANativeActivity_setWindowFormat (ANativeActivity *activity, int32_t format)
 
void ANativeActivity_setWindowFlags (ANativeActivity *activity, uint32_t addFlags, uint32_t removeFlags)
 
void ANativeActivity_showSoftInput (ANativeActivity *activity, uint32_t flags)
 
void ANativeActivity_hideSoftInput (ANativeActivity *activity, uint32_t flags)
 
void ANativeWindow_acquire (ANativeWindow *window)
 
void ANativeWindow_release (ANativeWindow *window)
 
int32_t ANativeWindow_getWidth (ANativeWindow *window)
 
int32_t ANativeWindow_getHeight (ANativeWindow *window)
 
int32_t ANativeWindow_getFormat (ANativeWindow *window)
 
int32_t ANativeWindow_setBuffersGeometry (ANativeWindow *window, int32_t width, int32_t height, int32_t format)
 
int32_t ANativeWindow_lock (ANativeWindow *window, ANativeWindow_Buffer *outBuffer, ARect *inOutDirtyBounds)
 
int32_t ANativeWindow_unlockAndPost (ANativeWindow *window)
 
int32_t ANativeWindow_setBuffersTransform (ANativeWindow *window, int32_t transform)
 
int32_t ANativeWindow_setBuffersDataSpace (ANativeWindow *window, int32_t dataSpace)
 
int32_t ANativeWindow_getBuffersDataSpace (ANativeWindow *window)
 
ANativeWindowANativeWindow_fromSurface (JNIEnv *env, jobject surface)
 
ANativeWindowANativeWindow_fromSurfaceTexture (JNIEnv *env, jobject surfaceTexture)
 
jobject ANativeWindow_toSurface (JNIEnv *env, ANativeWindow *window)
 

Variables

ANativeActivity_createFunc ANativeActivity_onCreate
 

Detailed Description

Typedef Documentation

◆ ANativeActivity

This structure defines the native side of an android.app.NativeActivity. It is created by the framework, and handed to the application's native code as it is being launched.

◆ ANativeActivity_createFunc

typedef void ANativeActivity_createFunc(ANativeActivity *activity, void *savedState, size_t savedStateSize)

This is the function that must be in the native code to instantiate the application's native activity. It is called with the activity instance (see above); if the code is being instantiated from a previously saved instance, the savedState will be non-NULL and point to the saved data. You must make any copy of this data you need – it will be released after you return from this function.

◆ ANativeActivityCallbacks

These are the callbacks the framework makes into a native application. All of these callbacks happen on the main thread of the application. By default, all callbacks are NULL; set to a pointer to your own function to have it called.

◆ ANativeWindow

typedef struct ANativeWindow ANativeWindow

Opaque type that provides access to a native window.

A pointer can be obtained using ANativeWindow_fromSurface().

◆ ANativeWindow_Buffer

Struct that represents a windows buffer.

A pointer can be obtained using ANativeWindow_lock().

◆ ARect

typedef struct ARect ARect

ARect is a struct that represents a rectangular window area.

It is used with ANativeActivityCallbacks::onContentRectChanged event callback and ANativeWindow_lock() function.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Flags for ANativeActivity_showSoftInput; see the Java InputMethodManager API for documentation.

Enumerator
ANATIVEACTIVITY_SHOW_SOFT_INPUT_IMPLICIT 

Implicit request to show the input window, not as the result of a direct request by the user.

ANATIVEACTIVITY_SHOW_SOFT_INPUT_FORCED 

The user has forced the input method open (such as by long-pressing menu) so it should not be closed until they explicitly do so.

◆ anonymous enum

anonymous enum

Flags for ANativeActivity_hideSoftInput; see the Java InputMethodManager API for documentation.

Enumerator
ANATIVEACTIVITY_HIDE_SOFT_INPUT_IMPLICIT_ONLY 

The soft input window should only be hidden if it was not explicitly shown by the user.

ANATIVEACTIVITY_HIDE_SOFT_INPUT_NOT_ALWAYS 

The soft input window should normally be hidden, unless it was originally shown with ANATIVEACTIVITY_SHOW_SOFT_INPUT_FORCED.

◆ anonymous enum

anonymous enum

Legacy window pixel format names, kept for backwards compatibility. New code and APIs should use AHARDWAREBUFFER_FORMAT_*.

Enumerator
WINDOW_FORMAT_RGBA_8888 

Red: 8 bits, Green: 8 bits, Blue: 8 bits, Alpha: 8 bits.

WINDOW_FORMAT_RGBX_8888 

Red: 8 bits, Green: 8 bits, Blue: 8 bits, Unused: 8 bits.

WINDOW_FORMAT_RGB_565 

Red: 5 bits, Green: 6 bits, Blue: 5 bits.

◆ anonymous enum

anonymous enum

Window flags, as per the Java API at android.view.WindowManager.LayoutParams.

Enumerator
AWINDOW_FLAG_ALLOW_LOCK_WHILE_SCREEN_ON 

As long as this window is visible to the user, allow the lock screen to activate while the screen is on. This can be used independently, or in combination with AWINDOW_FLAG_KEEP_SCREEN_ON and/or AWINDOW_FLAG_SHOW_WHEN_LOCKED

AWINDOW_FLAG_DIM_BEHIND 

Everything behind this window will be dimmed.

AWINDOW_FLAG_BLUR_BEHIND 

Blur everything behind this window.

Deprecated:
Blurring is no longer supported.
AWINDOW_FLAG_NOT_FOCUSABLE 

This window won't ever get key input focus, so the user can not send key or other button events to it. Those will instead go to whatever focusable window is behind it. This flag will also enable AWINDOW_FLAG_NOT_TOUCH_MODAL whether or not that is explicitly set.

Setting this flag also implies that the window will not need to interact with a soft input method, so it will be Z-ordered and positioned independently of any active input method (typically this means it gets Z-ordered on top of the input method, so it can use the full screen for its content and cover the input method if needed. You can use AWINDOW_FLAG_ALT_FOCUSABLE_IM to modify this behavior.

AWINDOW_FLAG_NOT_TOUCHABLE 

this window can never receive touch events.

AWINDOW_FLAG_NOT_TOUCH_MODAL 

Even when this window is focusable (its AWINDOW_FLAG_NOT_FOCUSABLE is not set), allow any pointer events outside of the window to be sent to the windows behind it. Otherwise it will consume all pointer events itself, regardless of whether they are inside of the window.

AWINDOW_FLAG_TOUCHABLE_WHEN_WAKING 

When set, if the device is asleep when the touch screen is pressed, you will receive this first touch event. Usually the first touch event is consumed by the system since the user can not see what they are pressing on.

Deprecated:
This flag has no effect.
AWINDOW_FLAG_KEEP_SCREEN_ON 

As long as this window is visible to the user, keep the device's screen turned on and bright.

AWINDOW_FLAG_LAYOUT_IN_SCREEN 

Place the window within the entire screen, ignoring decorations around the border (such as the status bar). The window must correctly position its contents to take the screen decoration into account.

AWINDOW_FLAG_LAYOUT_NO_LIMITS 

allow window to extend outside of the screen.

AWINDOW_FLAG_FULLSCREEN 

Hide all screen decorations (such as the status bar) while this window is displayed. This allows the window to use the entire display space for itself – the status bar will be hidden when an app window with this flag set is on the top layer. A fullscreen window will ignore a value of AWINDOW_SOFT_INPUT_ADJUST_RESIZE; the window will stay fullscreen and will not resize.

AWINDOW_FLAG_FORCE_NOT_FULLSCREEN 

Override AWINDOW_FLAG_FULLSCREEN and force the screen decorations (such as the status bar) to be shown.

AWINDOW_FLAG_DITHER 

Turn on dithering when compositing this window to the screen.

Deprecated:
This flag is no longer used.
AWINDOW_FLAG_SECURE 

Treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.

AWINDOW_FLAG_SCALED 

A special mode where the layout parameters are used to perform scaling of the surface when it is composited to the screen.

AWINDOW_FLAG_IGNORE_CHEEK_PRESSES 

Intended for windows that will often be used when the user is holding the screen against their face, it will aggressively filter the event stream to prevent unintended presses in this situation that may not be desired for a particular window, when such an event stream is detected, the application will receive a AMOTION_EVENT_ACTION_CANCEL to indicate this so applications can handle this accordingly by taking no action on the event until the finger is released.

AWINDOW_FLAG_LAYOUT_INSET_DECOR 

A special option only for use in combination with AWINDOW_FLAG_LAYOUT_IN_SCREEN. When requesting layout in the screen your window may appear on top of or behind screen decorations such as the status bar. By also including this flag, the window manager will report the inset rectangle needed to ensure your content is not covered by screen decorations.

AWINDOW_FLAG_ALT_FOCUSABLE_IM 

Invert the state of AWINDOW_FLAG_NOT_FOCUSABLE with respect to how this window interacts with the current method. That is, if FLAG_NOT_FOCUSABLE is set and this flag is set, then the window will behave as if it needs to interact with the input method and thus be placed behind/away from it; if AWINDOW_FLAG_NOT_FOCUSABLE is not set and this flag is set, then the window will behave as if it doesn't need to interact with the input method and can be placed to use more space and cover the input method.

AWINDOW_FLAG_WATCH_OUTSIDE_TOUCH 

If you have set AWINDOW_FLAG_NOT_TOUCH_MODAL, you can set this flag to receive a single special MotionEvent with the action AMOTION_EVENT_ACTION_OUTSIDE for touches that occur outside of your window. Note that you will not receive the full down/move/up gesture, only the location of the first down as an AMOTION_EVENT_ACTION_OUTSIDE.

AWINDOW_FLAG_SHOW_WHEN_LOCKED 

Special flag to let windows be shown when the screen is locked. This will let application windows take precedence over key guard or any other lock screens. Can be used with AWINDOW_FLAG_KEEP_SCREEN_ON to turn screen on and display windows directly before showing the key guard window. Can be used with AWINDOW_FLAG_DISMISS_KEYGUARD to automatically fully dismisss non-secure keyguards. This flag only applies to the top-most full-screen window.

AWINDOW_FLAG_SHOW_WALLPAPER 

Ask that the system wallpaper be shown behind your window. The window surface must be translucent to be able to actually see the wallpaper behind it; this flag just ensures that the wallpaper surface will be there if this window actually has translucent regions.

AWINDOW_FLAG_TURN_SCREEN_ON 

When set as a window is being added or made visible, once the window has been shown then the system will poke the power manager's user activity (as if the user had woken up the device) to turn the screen on.

AWINDOW_FLAG_DISMISS_KEYGUARD 

When set the window will cause the keyguard to be dismissed, only if it is not a secure lock keyguard. Because such a keyguard is not needed for security, it will never re-appear if the user navigates to another window (in contrast to AWINDOW_FLAG_SHOW_WHEN_LOCKED, which will only temporarily hide both secure and non-secure keyguards but ensure they reappear when the user moves to another UI that doesn't hide them). If the keyguard is currently active and is secure (requires an unlock pattern) than the user will still need to confirm it before seeing this window, unless AWINDOW_FLAG_SHOW_WHEN_LOCKED has also been set.

◆ ANativeWindowTransform

Transforms that can be applied to buffers as they are displayed to a window.

Supported transforms are any combination of horizontal mirror, vertical mirror, and clockwise 90 degree rotation, in that order. Rotations of 180 and 270 degrees are made up of those basic transforms.

Enumerator
ANATIVEWINDOW_TRANSFORM_IDENTITY 
ANATIVEWINDOW_TRANSFORM_MIRROR_HORIZONTAL 
ANATIVEWINDOW_TRANSFORM_MIRROR_VERTICAL 
ANATIVEWINDOW_TRANSFORM_ROTATE_90 
ANATIVEWINDOW_TRANSFORM_ROTATE_180 
ANATIVEWINDOW_TRANSFORM_ROTATE_270 

Function Documentation

◆ ANativeActivity_finish()

void ANativeActivity_finish ( ANativeActivity activity)

Finish the given activity. Its finish() method will be called, causing it to be stopped and destroyed. Note that this method can be called from any thread; it will send a message to the main thread of the process where the Java finish call will take place.

◆ ANativeActivity_hideSoftInput()

void ANativeActivity_hideSoftInput ( ANativeActivity activity,
uint32_t  flags 
)

Hide the IME while in the given activity. Calls InputMethodManager.hideSoftInput() for the given activity. Note that this method can be called from any thread; it will send a message to the main thread of the process where the Java finish call will take place.

◆ ANativeActivity_setWindowFlags()

void ANativeActivity_setWindowFlags ( ANativeActivity activity,
uint32_t  addFlags,
uint32_t  removeFlags 
)

Change the window flags of the given activity. Calls getWindow().setFlags() of the given activity. Note that this method can be called from any thread; it will send a message to the main thread of the process where the Java finish call will take place. See window.h for flag constants.

◆ ANativeActivity_setWindowFormat()

void ANativeActivity_setWindowFormat ( ANativeActivity activity,
int32_t  format 
)

Change the window format of the given activity. Calls getWindow().setFormat() of the given activity. Note that this method can be called from any thread; it will send a message to the main thread of the process where the Java finish call will take place.

◆ ANativeActivity_showSoftInput()

void ANativeActivity_showSoftInput ( ANativeActivity activity,
uint32_t  flags 
)

Show the IME while in the given activity. Calls InputMethodManager.showSoftInput() for the given activity. Note that this method can be called from any thread; it will send a message to the main thread of the process where the Java finish call will take place.

◆ ANativeWindow_acquire()

void ANativeWindow_acquire ( ANativeWindow window)

Acquire a reference on the given ANativeWindow object. This prevents the object from being deleted until the reference is removed.

◆ ANativeWindow_fromSurface()

ANativeWindow* ANativeWindow_fromSurface ( JNIEnv *  env,
jobject  surface 
)

Return the ANativeWindow associated with a Java Surface object, for interacting with it through native code. This acquires a reference on the ANativeWindow that is returned; be sure to use ANativeWindow_release() when done with it so that it doesn't leak.

◆ ANativeWindow_fromSurfaceTexture()

ANativeWindow* ANativeWindow_fromSurfaceTexture ( JNIEnv *  env,
jobject  surfaceTexture 
)

Return the ANativeWindow associated with a Java SurfaceTexture object, for interacting with it through native code. This acquires a reference on the ANativeWindow that is returned; be sure to use ANativeWindow_release() when done with it so that it doesn't leak.

◆ ANativeWindow_getBuffersDataSpace()

int32_t ANativeWindow_getBuffersDataSpace ( ANativeWindow window)

Get the dataspace of the buffers in window.

Returns
the dataspace of buffers in window, ADATASPACE_UNKNOWN is returned if dataspace is unknown, or -EINVAL if window is invalid.

◆ ANativeWindow_getFormat()

int32_t ANativeWindow_getFormat ( ANativeWindow window)

Return the current pixel format (AHARDWAREBUFFER_FORMAT_*) of the window surface.

Returns
a negative value on error.

◆ ANativeWindow_getHeight()

int32_t ANativeWindow_getHeight ( ANativeWindow window)

Return the current height in pixels of the window surface.

Returns
a negative value on error.

◆ ANativeWindow_getWidth()

int32_t ANativeWindow_getWidth ( ANativeWindow window)

Return the current width in pixels of the window surface.

Returns
negative value on error.

◆ ANativeWindow_lock()

int32_t ANativeWindow_lock ( ANativeWindow window,
ANativeWindow_Buffer outBuffer,
ARect inOutDirtyBounds 
)

Lock the window's next drawing surface for writing. inOutDirtyBounds is used as an in/out parameter, upon entering the function, it contains the dirty region, that is, the region the caller intends to redraw. When the function returns, inOutDirtyBounds is updated with the actual area the caller needs to redraw – this region is often extended by ANativeWindow_lock.

Returns
0 for success, or a negative value on error.

◆ ANativeWindow_release()

void ANativeWindow_release ( ANativeWindow window)

Remove a reference that was previously acquired with ANativeWindow_acquire().

◆ ANativeWindow_setBuffersDataSpace()

int32_t ANativeWindow_setBuffersDataSpace ( ANativeWindow window,
int32_t  dataSpace 
)

All buffers queued after this call will be associated with the dataSpace parameter specified.

dataSpace specifies additional information about the buffer. For example, it can be used to convey the color space of the image data in the buffer, or it can be used to indicate that the buffers contain depth measurement data instead of color images. The default dataSpace is 0, ADATASPACE_UNKNOWN, unless it has been overridden by the producer.

Parameters
dataSpacedata space of all buffers queued after this call.
Returns
0 for success, -EINVAL if window is invalid or the dataspace is not supported.

◆ ANativeWindow_setBuffersGeometry()

int32_t ANativeWindow_setBuffersGeometry ( ANativeWindow window,
int32_t  width,
int32_t  height,
int32_t  format 
)

Change the format and size of the window buffers.

The width and height control the number of pixels in the buffers, not the dimensions of the window on screen. If these are different than the window's physical size, then its buffer will be scaled to match that size when compositing it to the screen. The width and height must be either both zero or both non-zero.

For all of these parameters, if 0 is supplied then the window's base value will come back in force.

Parameters
widthwidth of the buffers in pixels.
heightheight of the buffers in pixels.
formatone of AHARDWAREBUFFER_FORMAT_* constants.
Returns
0 for success, or a negative value on error.

◆ ANativeWindow_setBuffersTransform()

int32_t ANativeWindow_setBuffersTransform ( ANativeWindow window,
int32_t  transform 
)

Set a transform that will be applied to future buffers posted to the window.

Parameters
transformcombination of ANativeWindowTransform flags
Returns
0 for success, or -EINVAL if transform is invalid

◆ ANativeWindow_toSurface()

jobject ANativeWindow_toSurface ( JNIEnv *  env,
ANativeWindow window 
)

Return a Java Surface object derived from the ANativeWindow, for interacting with it through Java code. The returned Java object acquires a reference on the ANativeWindow; maintains it through general Java object's life cycle; and will automatically release the reference when the Java object gets garbage collected.

◆ ANativeWindow_unlockAndPost()

int32_t ANativeWindow_unlockAndPost ( ANativeWindow window)

Unlock the window's drawing surface after previously locking it, posting the new buffer to the display.

Returns
0 for success, or a negative value on error.

Variable Documentation

◆ ANativeActivity_onCreate

ANativeActivity_createFunc ANativeActivity_onCreate

The name of the function that NativeInstance looks for when launching its native code. This is the default function that is used, you can specify "android.app.func_name" string meta-data in your manifest to use a different function.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (April 2018 — Developer Survey)