# PixelCopy.Request

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary: [Nested Classes](https://developer.android.com/reference/android/view/PixelCopy.Request#nestedclasses) \| [Methods](https://developer.android.com/reference/android/view/PixelCopy.Request#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/PixelCopy.Request#inhmethods)  

# PixelCopy.Request

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/PixelCopy.Request "View this page in Kotlin") \|Java


`
public
static
final

class
PixelCopy.Request
`


`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


`

`


`

|---|--------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.PixelCopy.Request |

<br />

*** ** * ** ***

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](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder) for the
given source content. After setting any optional parameters, such as
[Builder.setSourceRect(Rect)](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder#setSourceRect(android.graphics.Rect)), build the request with [Builder.build()](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder#build()) and
then execute it with [PixelCopy.request(Request, Executor, Consumer)](https://developer.android.com/reference/android/view/PixelCopy#request(android.view.PixelCopy.Request,%20java.util.concurrent.Executor,%20java.util.function.Consumer<android.view.PixelCopy.Result>))

## Summary

|                                                                                                                                                                                                                                                                                                                            ### Nested classes                                                                                                                                                                                                                                                                                                                             ||
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [PixelCopy.Request.Builder](https://developer.android.com/reference/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)](https://developer.android.com/reference/android/view/PixelCopy#request(android.view.PixelCopy.Request,%20java.util.concurrent.Executor,%20java.util.function.Consumer<android.view.PixelCopy.Result>)) with the built request returned from [build()](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder#build()) |

|                                                                                             ### Public methods                                                                                              ||
|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| ` `[Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) | ` `[getDestinationBitmap](https://developer.android.com/reference/android/view/PixelCopy.Request#getDestinationBitmap())`() ` |
| ` `[Rect](https://developer.android.com/reference/android/graphics/Rect)     | ` `[getSourceRect](https://developer.android.com/reference/android/view/PixelCopy.Request#getSourceRect())`() `               |

| ### Inherited methods |
|-----------------------|---|
| From class ` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                        | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                             | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                            | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`.                                                                                                                                                 | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                   | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                              | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                           | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                              | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Bitmap getDestinationBitmap ()
```

<br />

<br />

|                                                                                                                                                      Returns                                                                                                                                                      ||
|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Bitmap](https://developer.android.com/reference/android/graphics/Bitmap) | The destination bitmap as set by [Builder.setDestinationBitmap(Bitmap)](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder#setDestinationBitmap(android.graphics.Bitmap)) This value may be `null`. <br /> |

### getSourceRect

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public Rect getSourceRect ()
```

<br />

<br />

|                                                                                                                                              Returns                                                                                                                                              ||
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Rect](https://developer.android.com/reference/android/graphics/Rect) | The source rect to copy from as set by [Builder.setSourceRect(Rect)](https://developer.android.com/reference/android/view/PixelCopy.Request.Builder#setSourceRect(android.graphics.Rect)) This value may be `null`. <br /> |