Added in [API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/renderscript/Sampler#nestedclasses) \| [Methods](https://developer.android.com/reference/android/renderscript/Sampler#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/renderscript/Sampler#inhmethods)

# Sampler

*** ** * ** ***

` public class Sampler `   
` ` ` extends https://developer.android.com/reference/android/renderscript/BaseObj ` ` `

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.renderscript.BaseObj](https://developer.android.com/reference/android/renderscript/BaseObj) ||
|   | ↳ | android.renderscript.Sampler |

<br />

*** ** * ** ***

<br />

**This class was deprecated in API level 31.**   

Renderscript has been deprecated in API level 31. Please refer to the [migration guide](https://developer.android.com/guide/topics/renderscript/migration-guide) for the proposed alternatives.

Sampler object that defines how Allocations can be read as textures within a kernel. Samplers are used in conjunction with the `rsSample` runtime function to return values from normalized coordinates. Any Allocation used with a Sampler must have been created with `https://developer.android.com/reference/android/renderscript/Allocation#USAGE_GRAPHICS_TEXTURE`; using a Sampler on an `https://developer.android.com/reference/android/renderscript/Allocation` that was not created with `https://developer.android.com/reference/android/renderscript/Allocation#USAGE_GRAPHICS_TEXTURE` is undefined.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/renderscript/Sampler.Builder` Builder for creating non-standard samplers. |

| ### Public methods ||
|---|---|
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#CLAMP_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to linear and wrap modes set to clamp. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#CLAMP_LINEAR_MIP_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to clamp. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#CLAMP_NEAREST(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to nearest and wrap modes set to clamp. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#MIRRORED_REPEAT_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#MIRRORED_REPEAT_LINEAR_MIP_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#MIRRORED_REPEAT_NEAREST(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to nearest and wrap modes set to mirrored repeat. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#WRAP_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to linear and wrap modes set to wrap. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#WRAP_LINEAR_MIP_LINEAR(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to wrap. |
| ` static https://developer.android.com/reference/android/renderscript/Sampler` | ` https://developer.android.com/reference/android/renderscript/Sampler#WRAP_NEAREST(android.renderscript.RenderScript)(https://developer.android.com/reference/android/renderscript/RenderScript rs) ` Retrieve a sampler with min and mag set to nearest and wrap modes set to wrap. |
| ` float` | ` https://developer.android.com/reference/android/renderscript/Sampler#getAnisotropy()() ` |
| ` https://developer.android.com/reference/android/renderscript/Sampler.Value` | ` https://developer.android.com/reference/android/renderscript/Sampler#getMagnification()() ` |
| ` https://developer.android.com/reference/android/renderscript/Sampler.Value` | ` https://developer.android.com/reference/android/renderscript/Sampler#getMinification()() ` |
| ` https://developer.android.com/reference/android/renderscript/Sampler.Value` | ` https://developer.android.com/reference/android/renderscript/Sampler#getWrapS()() ` |
| ` https://developer.android.com/reference/android/renderscript/Sampler.Value` | ` https://developer.android.com/reference/android/renderscript/Sampler#getWrapT()() ` |

### Inherited methods

From class ` https://developer.android.com/reference/android/renderscript/BaseObj ` ` void` ` https://developer.android.com/reference/android/renderscript/BaseObj#destroy()() `

Frees any native resources associated with this object.
` boolean` ` https://developer.android.com/reference/android/renderscript/BaseObj#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Compare the current BaseObj with another BaseObj for equality.
` void` ` https://developer.android.com/reference/android/renderscript/BaseObj#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/renderscript/BaseObj#getName()() ` ` int` ` https://developer.android.com/reference/android/renderscript/BaseObj#hashCode()() `

Calculates the hash code value for a BaseObj.
` void` ` https://developer.android.com/reference/android/renderscript/BaseObj#setName(java.lang.String)(https://developer.android.com/reference/java/lang/String name) `

setName assigns a name to an object.
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` 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 https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` 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` ` 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` ` 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

### CLAMP_LINEAR

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

```
public static Sampler CLAMP_LINEAR (RenderScript rs)
```

Retrieve a sampler with min and mag set to linear and wrap modes set to clamp.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### CLAMP_LINEAR_MIP_LINEAR

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

```
public static Sampler CLAMP_LINEAR_MIP_LINEAR (RenderScript rs)
```

Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to clamp.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### CLAMP_NEAREST

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

```
public static Sampler CLAMP_NEAREST (RenderScript rs)
```

Retrieve a sampler with min and mag set to nearest and wrap modes set to clamp.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### MIRRORED_REPEAT_LINEAR

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

```
public static Sampler MIRRORED_REPEAT_LINEAR (RenderScript rs)
```

Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### MIRRORED_REPEAT_LINEAR_MIP_LINEAR

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

```
public static Sampler MIRRORED_REPEAT_LINEAR_MIP_LINEAR (RenderScript rs)
```

Retrieve a sampler with min and mag set to linear and wrap modes set to mirrored repeat.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### MIRRORED_REPEAT_NEAREST

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

```
public static Sampler MIRRORED_REPEAT_NEAREST (RenderScript rs)
```

Retrieve a sampler with min and mag set to nearest and wrap modes set to mirrored repeat.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### WRAP_LINEAR

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

```
public static Sampler WRAP_LINEAR (RenderScript rs)
```

Retrieve a sampler with min and mag set to linear and wrap modes set to wrap.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### WRAP_LINEAR_MIP_LINEAR

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

```
public static Sampler WRAP_LINEAR_MIP_LINEAR (RenderScript rs)
```

Retrieve a sampler with mag set to linear, min linear mipmap linear, and wrap modes set to wrap.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### WRAP_NEAREST

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

```
public static Sampler WRAP_NEAREST (RenderScript rs)
```

Retrieve a sampler with min and mag set to nearest and wrap modes set to wrap.

<br />

| Parameters ||
|---|---|
| `rs` | `RenderScript`: Context to which the sampler will belong. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler` | Sampler <br /> |

### getAnisotropy

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

```
public float getAnisotropy ()
```

<br />

<br />

| Returns ||
|---|---|
| `float` | anisotropy setting for the sampler <br /> |

### getMagnification

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

```
public Sampler.Value getMagnification ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler.Value` | magnification setting for the sampler <br /> |

### getMinification

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

```
public Sampler.Value getMinification ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler.Value` | minification setting for the sampler <br /> |

### getWrapS

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

```
public Sampler.Value getWrapS ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler.Value` | S wrapping mode for the sampler <br /> |

### getWrapT

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

```
public Sampler.Value getWrapT ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/renderscript/Sampler.Value` | T wrapping mode for the sampler <br /> |