# NoiseView [![](https://jitpack.io/v/hypeapps/NoiseView.svg)](https://jitpack.io/#hypeapps/NoiseView) [![Platform](https://img.shields.io/badge/platform-Android-yellow.svg)](https://www.android.com) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
NoiseView will let you easily add a noise effect.

![Banner](https://github.com/hypeapps/NoiseView/blob/master/img/noise_view_banner_gif.gif?raw=true)
<a href="https://play.google.com/store/apps/details?id=pl.hypeapp.sample" target="_blank">

[See demo on YouTube](https://www.youtube.com/watch?v=UMyPszKGa7o)


# Setup

### Step 1: Add JitPack Repository

Add the JitPack repository to your **root** `settings.gradle` file:

```kotlin

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url = uri("https://jitpack.io") }
    }
}
```


### Step 2: Add Dependency

Add the dependency to your **module** `build.gradle.kts`:

```kotlin
dependencies {
    implementation("com.github.hypeapps:NoiseView:1.0.1")
}
```


# Usage

#### In your xml layout add:
```xml
<pl.hypeapp.noiseview.NoiseView
        android:id="@+id/noise_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:src="@drawable/wheel" <!-- Specify your drawable-->
        app:grainFps="90"
        app:noiseIntensity="0.1"
        app:noiseScale="0.6"
        app:paused="false"/>
```
#### or programatically:
```kotlin
val noiseView: NoiseView = findViewById(R.id.noise_view)
noiseView.grainFps = 120 // Default 90
noiseView.noiseIntensity = 0.3f // Default 0.1f
noiseView.noiseScale = 0.3f // Default 0.6f
noiseView.paused = true // Default false
noiseView.setImageDrawable(ContextCompat.getDrawable(this, R.drawable.wheel))
```
NoiseView extends from ImageView, so it has all of its possibilities.

[Sample that demonstrates usage of the library](https://github.com/hypeapps/NoiseView/tree/master/sample/src/main)

[Project where NoiseView is used in the production app](https://github.com/hypeapps/episodie)

#### Acknowledgements
Thanks to [danielzeller/Depth](https://github.com/danielzeller/Depth-LIB-Android-) for his awesome demo :)
# License
<b>NoiseView</b> is licensed under `MIT license`. View [license](https://github.com/hypeapps/NoiseView/blob/master/LICENSE).

```
Authors:
Przemysław Szymkowiak <pszem.szym@gmail.com>
Daniel Zeller <daniel@agens.no>

The MIT License (MIT)
Copyright (c) 2016 Agens AS (http://agens.no/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```