Added in API level 34

PixelCopy.Request.Builder


public static final class PixelCopy.Request.Builder
extends Object

java.lang.Object
   ↳ android.view.PixelCopy.Request.Builder


A builder to create the complete PixelCopy request, which is then executed by calling PixelCopy.request(android.view.PixelCopy.Request, java.util.concurrent.Executor, java.util.function.Consumer) with the built request returned from build()

Summary

Public methods

PixelCopy.Request build()
static PixelCopy.Request.Builder ofSurface(SurfaceView source)

Creates a PixelCopy Builder for the Surface belonging to the given SurfaceView

static PixelCopy.Request.Builder ofSurface(Surface source)

Creates a PixelCopy Builder for the given Surface

static PixelCopy.Request.Builder ofWindow(Window source)

Creates a PixelCopy Builder for the given Window

static PixelCopy.Request.Builder ofWindow(View source)

Creates a PixelCopy Builder for the Window that the given View is attached to.

PixelCopy.Request.Builder setDestinationBitmap(Bitmap destination)

Specifies the output bitmap in which to store the result.

PixelCopy.Request.Builder setSourceRect(Rect srcRect)

Sets the region of the source to copy from.

Inherited methods

Public methods

build

Added in API level 34
public PixelCopy.Request build ()

Returns
PixelCopy.Request The built PixelCopy.Request This value cannot be null.

ofSurface

Added in API level 34
public static PixelCopy.Request.Builder ofSurface (SurfaceView source)

Creates a PixelCopy Builder for the Surface belonging to the given SurfaceView

Parameters
source SurfaceView: The SurfaceView to copy from. The backing surface must be valid This value cannot be null.

Returns
PixelCopy.Request.Builder A Builder builder to set the optional params & build the request This value cannot be null.

ofSurface

Added in API level 34
public static PixelCopy.Request.Builder ofSurface (Surface source)

Creates a PixelCopy Builder for the given Surface

Parameters
source Surface: The Surface to copy from. Must be valid. This value cannot be null.

Returns
PixelCopy.Request.Builder A Builder builder to set the optional params & build the request This value cannot be null.

ofWindow

Added in API level 34
public static PixelCopy.Request.Builder ofWindow (Window source)

Creates a PixelCopy Builder for the given Window

Parameters
source Window: The Window to copy from This value cannot be null.

Returns
PixelCopy.Request.Builder A Builder builder to set the optional params & build the request This value cannot be null.

ofWindow

Added in API level 34
public static PixelCopy.Request.Builder ofWindow (View source)

Creates a PixelCopy Builder for the Window that the given View is attached to. Note that this copy request is not cropped to the area the View occupies by default. If that behavior is desired, use View#getLocationInWindow(int[]) combined with Builder#setSourceRect(Rect) to set a crop area to restrict the copy operation.

Parameters
source View: A View that is attached to a window that will be used to retrieve the window to copy from. This value cannot be null.

Returns
PixelCopy.Request.Builder A Builder builder to set the optional params & build the request This value cannot be null.

setDestinationBitmap

Added in API level 34
public PixelCopy.Request.Builder setDestinationBitmap (Bitmap destination)

Specifies the output bitmap in which to store the result. By default, a Bitmap of format Bitmap.Config.ARGB_8888 with a width & height matching that of the source area will be created to place the result.

Parameters
destination Bitmap: The bitmap to store the result, or null to have a bitmap automatically created of the appropriate size. If not null, must not be recycled and must be mutable.

Returns
PixelCopy.Request.Builder this This value cannot be null.

setSourceRect

Added in API level 34
public PixelCopy.Request.Builder setSourceRect (Rect srcRect)

Sets the region of the source to copy from. By default, the entire source is copied to the output. If only a subset of the source is necessary to be copied, specifying a srcRect will improve performance by reducing the amount of data being copied.

Parameters
srcRect Rect: The area of the source to read from. Null or empty will be treated to mean the entire source This value may be null.

Returns
PixelCopy.Request.Builder this This value cannot be null.