FileDocCategorySizeDatePackage
MffEnvironment.javaAPI DocAndroid 5.1 API3619Thu Mar 12 22:22:30 GMT 2015android.filterfw

MffEnvironment

public class MffEnvironment extends Object
Base class for mobile filter framework (MFF) frontend environments. These convenience classes allow using the filter framework without the requirement of performing manual setup of its required components.
hide

Fields Summary
private android.filterfw.core.FilterContext
mContext
Constructors Summary
protected MffEnvironment(android.filterfw.core.FrameManager frameManager)
Protected constructor to initialize the environment's essential components. These are the frame-manager and the filter-context. Passing in null for the frame-manager causes this to be auto-created.

param
frameManager The FrameManager to use or null to auto-create one.

        // Get or create the frame manager
        if (frameManager == null) {
            frameManager = new CachedFrameManager();
        }

        // Setup the environment
        mContext = new FilterContext();
        mContext.setFrameManager(frameManager);
Methods Summary
public voidactivateGLEnvironment()
Activate the GL environment for use in the current thread. A GL environment must have been previously set or created using setGLEnvironment() or createGLEnvironment()! Call this after having switched to a new thread for GL filter execution.

        GLEnvironment glEnv = mContext.getGLEnvironment();
        if (glEnv != null) {
            mContext.getGLEnvironment().activate();
        } else {
            throw new NullPointerException("No GLEnvironment in place to activate!");
        }
public voidcreateGLEnvironment()
Create and activate a new GL environment for use in this filter context.

        GLEnvironment glEnvironment = new GLEnvironment();
        glEnvironment.initWithNewContext();
        setGLEnvironment(glEnvironment);
public voiddeactivateGLEnvironment()
Deactivate the GL environment from use in the current thread. A GL environment must have been previously set or created using setGLEnvironment() or createGLEnvironment()! Call this before running GL filters in another thread.

        GLEnvironment glEnv = mContext.getGLEnvironment();
        if (glEnv != null) {
            mContext.getGLEnvironment().deactivate();
        } else {
            throw new NullPointerException("No GLEnvironment in place to deactivate!");
        }
public android.filterfw.core.FilterContextgetContext()
Returns the environment's filter-context.

        return mContext;
public voidsetGLEnvironment(android.filterfw.core.GLEnvironment glEnvironment)
Set the environment's GL environment to the specified environment. This does not activate the environment.

        mContext.initGLEnvironment(glEnvironment);