public static final class PixelCopy.Request
extends Object


Represents a PixelCopy request. To create a copy request, use either of the PixelCopy.Request.ofWindow or PixelCopy.Request.ofSurface factories to create a Request.Builder for the given source content. After setting any optional parameters, such as Builder.setSourceRect(Rect), build the request with Builder.build() and then execute it with PixelCopy.request(Request,Executor,Consumer)

Summary

Nested classes

class PixelCopy.Request.Builder

A builder to create the complete PixelCopy request, which is then executed by calling request(Request,Executor,Consumer) with the built request returned from build() 

Public methods

Bitmap getDestinationBitmap()
Rect getSourceRect()

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

getDestinationBitmap

Added in API level 34 

public Bitmap getDestinationBitmap ()
Returns
Bitmap The destination bitmap as set by Builder.setDestinationBitmap(Bitmap)
This value may be null.

getSourceRect

Added in API level 34 

public Rect getSourceRect ()
Returns
Rect The source rect to copy from as set by Builder.setSourceRect(Rect)
This value may be null.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-26 UTC.