Skip to content

Commit

Permalink
Update README: remove credits, add camerakit association
Browse files Browse the repository at this point in the history
  • Loading branch information
emersoncloud committed Sep 14, 2018
1 parent 1f01f99 commit a7e1cba
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This results in an average work/frame time of 2-4ms, which will be a seamless ex
## Setup
Add __BlurKit__ to your dependencies block:
```groovy
compile 'com.wonderkiln:blurkit:1.0.0'
compile 'com.alterac.blurkit:blurkit-core:1.0.0'
```

You also need to add __RenderScript__ to your app module. Add these lines to the `defaultConfig` block of your __build.gradle__.
Expand Down Expand Up @@ -50,6 +50,28 @@ Add a `BlurLayout` to your layout just like any other view.

</com.wonderkiln.blurkit.BlurLayout>
```
In the `Main_Activity.java` you need to override the `onStart()` and `onStop()` methods to include the `BlurLayout`.
```java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
blurLayout = findViewById(R.id.blurLayout);
}

@Override
protected void onStart() {
super.onStart();
blurLayout.startBlur();

}

@Override
protected void onStop() {
super.onStop();
blurLayout.pauseBlur();
}
```

The layout background will continuously blur the content behind it. If you know your background content will be somewhat static, you can set the layout `fps` to `0`. At any time you can re-blur the background content by calling `invalidate()` on the `BlurLayout`.

Expand Down Expand Up @@ -119,8 +141,8 @@ If you use Proguard, add the following to your proguard-rules.pro:
- [ ] Support for use outside of an `Activity` (dialogs, etc.)
- [ ] Enhance retrieval of background content to only include views drawn behind the `BlurLayout`.

## Credits
Built by [Dylan McIntyre](https://github.com/dwillmc).

## License
BlurKit-Android is [MIT licensed](https://github.com/wonderkiln/blurkit-android/blob/master/LICENSE).
BlurKit is [MIT licensed](https://github.com/wonderkiln/blurkit-android/blob/master/LICENSE).

---
Blurkit is a sister project of [CameraKit](https://github.com/CameraKit/camerakit-android) and maintained by the CameraKit team.

0 comments on commit a7e1cba

Please sign in to comment.