SurfaceHolder

SURFACE_TYPE_GPU

static val SURFACE_TYPE_GPU: Int

Deprecated: this is ignored, this value is set automatically when needed.

Value: 2

SURFACE_TYPE_HARDWARE

static val SURFACE_TYPE_HARDWARE: Int

Deprecated: this is ignored, this value is set automatically when needed.

Value: 1

SURFACE_TYPE_NORMAL

static val SURFACE_TYPE_NORMAL: Int

Deprecated: this is ignored, this value is set automatically when needed.

Value: 0

SURFACE_TYPE_PUSH_BUFFERS

static val SURFACE_TYPE_PUSH_BUFFERS: Int

Deprecated: this is ignored, this value is set automatically when needed.

Value: 3

addCallback

abstract fun addCallback(callback: SurfaceHolder.Callback!): Unit

Add a Callback interface for this holder. There can several Callback interfaces associated with a holder.

getSurface

abstract fun getSurface(): Surface!

Direct access to the surface object. The Surface may not always be available -- for example when using a SurfaceView the holder's Surface is not created until the view has been attached to the window manager and performed a layout in order to determine the dimensions and screen position of the Surface. You will thus usually need to implement Callback.surfaceCreated to find out when the Surface is available for use.

Note that if you directly access the Surface from another thread, it is critical that you correctly implement Callback.surfaceCreated and Callback.surfaceDestroyed to ensure that thread only accesses the Surface while it is valid, and that the Surface does not get destroyed while the thread is using it.

This method is intended to be used by frameworks which often need direct access to the Surface object (usually to pass it to native code).

getSurfaceFrame

abstract fun getSurfaceFrame(): Rect!

Retrieve the current size of the surface. Note: do not modify the returned Rect. This is only safe to call from the thread of SurfaceView's window, or while inside of lockCanvas().

isCreating

abstract fun isCreating(): Boolean

Use this method to find out if the surface is in the process of being created from Callback methods. This is intended to be used with Callback#surfaceChanged.

lockCanvas

abstract fun lockCanvas(): Canvas!

Start editing the pixels in the surface. The returned Canvas can be used to draw into the surface's bitmap. A null is returned if the surface has not been created or otherwise cannot be edited. You will usually need to implement Callback.surfaceCreated to find out when the Surface is available for use.

The content of the Surface is never preserved between unlockCanvas() and lockCanvas(), for this reason, every pixel within the Surface area must be written. The only exception to this rule is when a dirty rectangle is specified, in which case, non-dirty pixels will be preserved.

If you call this repeatedly when the Surface is not ready (before Callback.surfaceCreated or after Callback.surfaceDestroyed), your calls will be throttled to a slow rate in order to avoid consuming CPU.

If null is not returned, this function internally holds a lock until the corresponding unlockCanvasAndPost call, preventing SurfaceView from creating, destroying, or modifying the surface while it is being drawn. This can be more convenient than accessing the Surface directly, as you do not need to do special synchronization with a drawing thread in Callback.surfaceDestroyed.

lockCanvas

abstract fun lockCanvas(dirty: Rect!): Canvas!

Just like lockCanvas() but allows specification of a dirty rectangle. Every pixel within that rectangle must be written; however pixels outside the dirty rectangle will be preserved by the next call to lockCanvas().

lockHardwareCanvas

open fun lockHardwareCanvas(): Canvas!

Just like lockCanvas() but the returned canvas is hardware-accelerated.

See the unsupported drawing operations for a list of what is and isn't supported in a hardware-accelerated canvas.

removeCallback

abstract fun removeCallback(callback: SurfaceHolder.Callback!): Unit

Removes a previously added Callback interface from this holder.

setFixedSize

abstract fun setFixedSize(
    width: Int, 
    height: Int
): Unit

Make the surface a fixed size. It will never change from this size. When working with a SurfaceView, this must be called from the same thread running the SurfaceView's window.

setFormat

abstract fun setFormat(format: Int): Unit

Set the desired PixelFormat of the surface. The default is OPAQUE. When working with a SurfaceView, this must be called from the same thread running the SurfaceView's window.

setKeepScreenOn

abstract fun setKeepScreenOn(screenOn: Boolean): Unit

Enable or disable option to keep the screen turned on while this surface is displayed. The default is false, allowing it to turn off. This is safe to call from any thread.

setSizeFromLayout

abstract fun setSizeFromLayout(): Unit

Allow the surface to resized based on layout of its container (this is the default). When this is enabled, you should monitor Callback#surfaceChanged for changes to the size of the surface. When working with a SurfaceView, this must be called from the same thread running the SurfaceView's window.

setType

abstract fun setType(type: Int): Unit

Deprecated: this is ignored, this value is set automatically when needed.

Sets the surface's type.

unlockCanvasAndPost

abstract fun unlockCanvasAndPost(canvas: Canvas!): Unit

Finish editing pixels in the surface. After this call, the surface's current pixels will be shown on the screen, but its content is lost, in particular there is no guarantee that the content of the Surface will remain unchanged when lockCanvas() is called again.