Engine

Engine

Engine()

Default constructor

getDesiredMinimumHeight

open fun getDesiredMinimumHeight(): Int

Convenience for WallpaperManager.getDesiredMinimumHeight(), returning the height that the system would like this wallpaper to run in.

getDesiredMinimumWidth

open fun getDesiredMinimumWidth(): Int

Convenience for WallpaperManager.getDesiredMinimumWidth(), returning the width that the system would like this wallpaper to run in.

getDisplayContext

open fun getDisplayContext(): Context?

The Context with resources that match the current display the wallpaper is on. For multiple display environment, multiple engines can be created to render on each display, but these displays may have different densities. Use this context to get the corresponding resources for currently display, avoiding the context of the service.

The display context will never be null after Engine#onCreate(SurfaceHolder) has been called.

getSurfaceHolder

open fun getSurfaceHolder(): SurfaceHolder!

Provides access to the surface in which this wallpaper is drawn.

getWallpaperFlags

open fun getWallpaperFlags(): Int

Returns the current wallpaper flags indicating which screen this Engine is rendering to.

isPreview

open fun isPreview(): Boolean

Returns true if this engine is running in preview mode -- that is, it is being shown to the user before they select it as the actual wallpaper.

isVisible

open fun isVisible(): Boolean

Return whether the wallpaper is currently visible to the user, this is the last value supplied to onVisibilityChanged(boolean).

notifyColorsChanged

open fun notifyColorsChanged(): Unit

Notifies the engine that wallpaper colors changed significantly. This will trigger a onComputeColors() call.

onApplyWindowInsets

open fun onApplyWindowInsets(insets: WindowInsets!): Unit

Called with the current insets that are in effect for the wallpaper. This gives you the part of the overall wallpaper surface that will generally be visible to the user (ignoring position offsets applied to it).
This method must be called from the main thread of your app.

onCommand

open fun onCommand(
    action: String!, 
    x: Int, 
    y: Int, 
    z: Int, 
    extras: Bundle!, 
    resultRequested: Boolean
): Bundle!

Process a command that was sent to the wallpaper with WallpaperManager#sendWallpaperCommand. The default implementation does nothing, and always returns null as the result.
This method must be called from the main thread of your app.

onComputeColors

open fun onComputeColors(): WallpaperColors?

Called by the system when it needs to know what colors the wallpaper is using. You might return null if no color information is available at the moment. In that case you might want to call notifyColorsChanged() when color information becomes available.

The simplest way of creating a android.app.WallpaperColors object is by using android.app.WallpaperColors#fromBitmap(Bitmap) or android.app.WallpaperColors#fromDrawable(Drawable), but you can also specify your main colors by constructing a android.app.WallpaperColors object manually.
This method must be called from the main thread of your app.

onCreate

open fun onCreate(surfaceHolder: SurfaceHolder!): Unit

Called once to initialize the engine. After returning, the engine's surface will be created by the framework.
This method must be called from the main thread of your app.

onDesiredSizeChanged

open fun onDesiredSizeChanged(
    desiredWidth: Int, 
    desiredHeight: Int
): Unit

Called when an application has changed the desired virtual size of the wallpaper.
This method must be called from the main thread of your app.

onDestroy

open fun onDestroy(): Unit

Called right before the engine is going away. After this the surface will be destroyed and this Engine object is no longer valid.
This method must be called from the main thread of your app.

onOffsetsChanged

open fun onOffsetsChanged(
    xOffset: Float, 
    yOffset: Float, 
    xOffsetStep: Float, 
    yOffsetStep: Float, 
    xPixelOffset: Int, 
    yPixelOffset: Int
): Unit

Called to inform you of the wallpaper's offsets changing within its contain, corresponding to the container's call to WallpaperManager.setWallpaperOffsets().
This method must be called from the main thread of your app.

onSurfaceChanged

open fun onSurfaceChanged(
    holder: SurfaceHolder!, 
    format: Int, 
    width: Int, 
    height: Int
): Unit

Convenience for SurfaceHolder.Callback.surfaceChanged().
This method must be called from the main thread of your app.

onSurfaceCreated

open fun onSurfaceCreated(holder: SurfaceHolder!): Unit

Convenience for SurfaceHolder.Callback.surfaceCreated().
This method must be called from the main thread of your app.

onSurfaceDestroyed

open fun onSurfaceDestroyed(holder: SurfaceHolder!): Unit

Convenience for SurfaceHolder.Callback.surfaceDestroyed().
This method must be called from the main thread of your app.

onSurfaceRedrawNeeded

open fun onSurfaceRedrawNeeded(holder: SurfaceHolder!): Unit

Convenience for SurfaceHolder.Callback.surfaceRedrawNeeded().
This method must be called from the main thread of your app.

onTouchEvent

open fun onTouchEvent(event: MotionEvent!): Unit

Called as the user performs touch-screen interaction with the window that is currently showing this wallpaper. Note that the events you receive here are driven by the actual application the user is interacting with, so if it is slow you will get fewer move events.
This method must be called from the main thread of your app.

onVisibilityChanged

open fun onVisibilityChanged(visible: Boolean): Unit

Called to inform you of the wallpaper becoming visible or hidden. It is very important that a wallpaper only use CPU while it is visible..
This method must be called from the main thread of your app.

onWallpaperFlagsChanged

open fun onWallpaperFlagsChanged(which: Int): Unit

Called when the current wallpaper flags change.
This method must be called from the main thread of your app.

onZoomChanged

open fun onZoomChanged(zoom: Float): Unit

Called when the zoom level of the wallpaper changed. This method will be called with the initial zoom level when the surface is created.
This method must be called from the main thread of your app.

setOffsetNotificationsEnabled

open fun setOffsetNotificationsEnabled(enabled: Boolean): Unit

Control whether this wallpaper will receive notifications when the wallpaper has been scrolled. By default, wallpapers will receive notifications, although the default static image wallpapers do not. It is a performance optimization to set this to false.

setTouchEventsEnabled

open fun setTouchEventsEnabled(enabled: Boolean): Unit

Control whether this wallpaper will receive raw touch events from the window manager as the user interacts with the window that is currently displaying the wallpaper. By default they are turned off. If enabled, the events will be received in onTouchEvent(android.view.MotionEvent).

dump

protected open fun dump(
    prefix: String!, 
    fd: FileDescriptor!, 
    out: PrintWriter!, 
    args: Array<String!>!
): Unit