AndroidJetpack/ShaderShowcaseApp/README.md

![GitHub Cards Preview](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/banner.png?raw=true)


![GitHub](https://img.shields.io/github/license/thelumiereguy/ShaderShowcaseApp?color=blue&style=for-the-badge) [![API](https://img.shields.io/badge/API-21%2B-orange?style=for-the-badge)](https://android-arsenal.com/api?level=21) [![Twitter](https://img.shields.io/badge/twitter-thelumiereguy-blue?style=for-the-badge)](https://twitter.com/thelumiereguy) [![API](https://img.shields.io/github/v/release/thelumiereguy/ShaderShowcaseApp?logo=android&style=for-the-badge)](https://github.com/thelumiereguy/ShaderShowcaseApp/releases/download/v1.0.0/Shader_Showcase_v1_0_0.apk)



# 🎨 Shader Showcase

Shader Showcase is a minimal Android app made with **Jetpack Compose**, to showcase all the beautiful OpenGL* based **Fragment shaders** I have written so far. You can set them as **Live Wallpapers** too. 

(GLSurfaceView has been used here to render a simple Quad and the Shaders.)

_*Minimum requirement is OpenGL 2.0._

<br />

## Features
- List of included Shaders rendered in realtime
- A detail page to show more options regarding the Shader
- Set the Shader as Live Wallpaper
- UI palette of Detail Page components is computed dynamically using Androidx Palette API

<br />

## Screenshots

### 🌞 Light Mode

|   Splash    | Shader Listing Page 
|---	|---
|  ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/light_splash.png)    |  ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/home_light.png)   

|   Shader Detailed Page |   Device Home Screen |
|---  |---
|   ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/detail_page_expanded.png)  | ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/device_home_wallpaper.png)

<br />

### 🌚 Dark Mode

|   Splash    | Shader Listing Page 
|---	|---
|  ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/dark_splash.png)    |  ![](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/screenshots/home_dark.png)   

<br />

## Built With

- [Jetpack Compose](https://developer.android.com/jetpack/compose)
- [Accompanist](https://github.com/google/accompanist)
- [Kotlin](https://kotlinlang.org/)
- [Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
- [Jetpack DataStore](https://developer.android.com/topic/libraries/architecture/datastore)
- [Material Components for Android](https://github.com/material-components/material-components-android)

<br />

## Installation  
  _You can find the latest apk in the Release section_
  
<br />

## Credits  

- [LearnOpenGLES](https://www.learnopengles.com/) and [LearnOpenGL](https://learnopengl.com/) for helping me learn more about OpenGL.
- [Accompanist](https://github.com/google/accompanist) for the bunch of libraries - Surely made my life easier :)
 
 ## 🔖 License
 
 ```
                      GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007
                       
    Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
    Everyone is permitted to copy and distribute verbatim copies
    of this license document, but changing it is not allowed.
    
 ```
 [GNU GENERAL PUBLIC LICENSE](https://github.com/thelumiereguy/ShaderShowcaseApp/blob/master/LICENSE)