EffectContext
open class EffectContext
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| open static EffectContext! |
Creates a context within the current GL context. |
| open EffectFactory! |
Returns the EffectFactory for this context. |
| open Unit |
release()Releases the context. |
Public methods
createWithCurrentGlContext
open static fun createWithCurrentGlContext(): EffectContext!
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.
getFactory
open fun getFactory(): EffectFactory!
Returns the EffectFactory for this context.
The EffectFactory returned from this method allows instantiating new effects within this context.
| Return | |
|---|---|
EffectFactory! |
The EffectFactory instance for this context. |
release
open fun release(): Unit
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.