Wiki Page Content

Revision 9 as of 2014-11-20 18:54:10

Clear message

DRAFT

SDL_AndroidGetActivity

Use this function to retrieve the Java instance of the activity class in an Android application.

Syntax

void* SDL_AndroidGetActivity(void)

Return Value

Returns the jobject representing the instance of the Activity class of the Android application, or NULL on error.

The jobject returned by the function is a local reference and must be released by the caller. See the PushLocalFrame() and PopLocalFrame() or DeleteLocalRef() functions of the Java native interface (in Oracle's documentation).

Code Examples

#include "SDL.h"
#include <jni.h>

// Calls the void showHome() method of the Java instance of the activity.
void showHome(void)
{
    // retrieve the JNI environment.
    JNIEnv* env = (JNIEnv*)SDL_AndroidGetJNIEnv();

    // retrieve the Java instance of the SDLActivity
    jobject activity = (jobject)SDL_AndroidGetActivity();

    // find the Java class of the activity. It should be SDLActivity or a subclass of it.
    jclass clazz(env->GetObjectClass(activity));

    // find the identifier of the method to call
    jmethodID method_id = env->GetMethodID(clazz, "showHome", "()V");

    // effectively call the Java method
    env->CallVoidMethod(activity, method_id);

    // clean up the local references.
    env->DeleteLocalRef(activity);
    env->DeleteLocalRef(clazz);
}

Remarks

The prototype of the function in SDL's code actually declares a void* return type, even if the implementation returns a jobject. The rationale being that it allows not to include jni.h in the headers of the SDL.

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategorySystem

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit