EffectContext

Kotlin |Java

public class EffectContext
extends Object

java.lang.Object
↳	android.media.effect.EffectContext

An EffectContext keeps all necessary state information to run Effects within a Open GL ES 2.0 context.

Every EffectContext is bound to one GL context. The application is responsible for creating this EGL context, and making it current before applying any effect. If your EGL context is destroyed, the EffectContext becomes invalid and any effects bound to this context can no longer be used. If you switch to another EGL context, you must create a new EffectContext. Each Effect is bound to a single EffectContext, and can only be executed in that context.

Summary

Public methods
`static EffectContext`	`createWithCurrentGlContext()` Creates a context within the current GL context.
`EffectFactory`	`getFactory()` Returns the EffectFactory for this context.
`void`	`release()` Releases the context.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

createWithCurrentGlContext

Added in API level 14

public static EffectContext createWithCurrentGlContext ()

Creates a context within the current GL context.

Binds the EffectContext to the current OpenGL context. All subsequent calls to the EffectContext must be made in the GL context that was active during creation. When you have finished using a context, you must call release(). to dispose of all resources associated with this context.

Returns
`EffectContext`

getFactory

Added in API level 14

public EffectFactory getFactory ()

Returns the EffectFactory for this context.

The EffectFactory returned from this method allows instantiating new effects within this context.

Returns
`EffectFactory`	The EffectFactory instance for this context.

release

Added in API level 14

public void release ()

Releases the context.

Releases all the resources and effects associated with the EffectContext. This renders the context and all the effects bound to this context invalid. You must no longer use the context or any of its bound effects after calling release().

Note that this method must be called with the proper EGL context made current, as the EffectContext and its effects may release internal GL resources.