Skip to content

Commit

Permalink
Bumped to v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hiulit committed Oct 20, 2020
1 parent e2e91c3 commit b09093f
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 10 deletions.
37 changes: 32 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,62 @@

* Up to date.

## [2.0.0] - 2020-10-20

**NOTE**: This release contains breaking changes.

The parameters are basically the same but with new names. Check the [documentation](https://github.com/hiulit/Godot-3-2D-CRT-Shader/tree/master#shader-parameters).

### Added

* `curvature_x_amount` - Controls the curvature on the X axis.
* `curvature_y_amount` - Controls the curvature on the Y axis.

### Changed

* Every mention to **grille** is now referred as **vertical scan lines**.

### Deprecated

* ~~`scanlines_speed`~~
* ~~`move_aberration`~~
* ~~`aberration_speed`~~

## [1.3.1] - 2020-10-19

### Fixed

* The scanlines and grille are now non-destructive. This allows to lower the opacity of the scanlines and grille without resulting in a completely black screen. Thanks to [Miltag](https://github.com/Miltage) for helping with this issue [#5](https://github.com/hiulit/Godot-3-2D-CRT-Shader/pull/5).

## [1.3.0] - 2019-09-13

## Added
### Added

* New parameter: `aberration_amount` - To control the amount of aberration.
* New parameter: `move_aberration` - To control the movement state of the aberration.
* New parameter: `aberration_speed` - To control the speed of the moving aberration.

## Changed
### Changed

* `boost` parameter now can go up to `2.0`.
* `vignette` now depends on the screen size.

## [1.2.0] - 2019-07-18

## Added
### Added

* Screen texture and scanlines are now affected by curvature.
* New parameter: `grille_opacity` - To control the opacity of the grille.
* New parameter: `scanlines_opacity` - To control the opacity of the scanlines.
* New parameter: `scanlines_speed` - To control the speed of the scanlines.
* New parameter: `screen_size` - To control how many grille lines and scanlines appear.

## Changed
### Changed

* `boost` and `vignette_opacity` steps are now `0.01`.
* `vignette_opacity` default value is now `0.2`.

## Deprecated
### Deprecated

* Parameter: `blend_color` - No longer needed.

Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,12 @@ Works best in `window/stretch/mode="2d"`.

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `horizontal_scan_lines_amount` | `float` | `180.0` | Controls how many horizontal scan lines appear. |
| `horizontal_scan_lines_amount` | `float` | `180.0` | Controls how many horizontal scan lines appear. Range from `0.0` to `180.0` with `0.1` steps. |

Setting it to your project's `windows/size/height` should work fine, but you can play with it to get the results best fitted to your liking.

Having fewer scan lines will make them larger, which makes it harder for the moire effect to appear.

### Horizontal scan lines opacity

| Name | Type | Default | Description |
Expand All @@ -91,10 +93,12 @@ Setting it to your project's `windows/size/height` should work fine, but you can

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `vertical_scan_lines_amount` | `float` | `320.0` | Controls how many vertical scan lines appear. |
| `vertical_scan_lines_amount` | `float` | `320.0` | Controls how many vertical scan lines appear. Range from `0.0` to `320.0` with `0.1` steps. |

Setting it to your project's `windows/size/width` should work fine, but you can play with it to get the results best fitted to your liking.

Having fewer scan lines will make them larger, which makes it harder for the moire effect to appear.

### Vertical scan lines opacity

| Name | Type | Default | Description |
Expand All @@ -111,7 +115,7 @@ Setting it to your project's `windows/size/width` should work fine, but you can

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `aberration_amount` | `float` | `0.0` | Controls the amount of chromatic aberration. Range from `0.0` to `10.0` with `1.0` steps. |
| `aberration_amount` | `float` | `0.0` | Controls the amount of chromatic aberration. Range from `0.0` to `10.0` with `0.01` steps. |

## Changelog

Expand All @@ -128,6 +132,7 @@ Thanks to:
* **knarkowicz** - For the orginal shader code, taken from https://www.shadertoy.com/view/XtlSD7.
* [CowThing](https://github.com/CowThing) - For helping **a lot** in bringing actual distortion and many other improvements to the shader with [#1](https://github.com/hiulit/Godot-3-2D-CRT-Shader/pull/1).
* [uheartbeast](https://twitter.com/uheartbeast) - For the amazing [chromatic aberration shader video tutorial](https://www.youtube.com/watch?v=-PJOHAsBcoI).
* [Miltag](https://github.com/Miltage) - For helping in fixing an issue with the scan lines opacity [#5](https://github.com/hiulit/Godot-3-2D-CRT-Shader/pull/5).
* [Tom (Let's GameDev)](https://twitter.com/letsgamedev) - For the amazing [CRT shader video tutorial](https://www.youtube.com/watch?v=Dn8joy4tP2Q), which I took the scan lines from.

## License
Expand Down
4 changes: 2 additions & 2 deletions crt_shader.shader
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ uniform vec4 corner_color : hint_color = vec4(0.0, 0.0, 0.0, 1.0);
uniform bool show_vignette = true;
uniform float vignette_opacity : hint_range(0.0, 1.0, 0.01) = 0.2;
uniform bool show_horizontal_scan_lines = true;
uniform float horizontal_scan_lines_amount : hint_range(0.0, 180.0) = 180.0;
uniform float horizontal_scan_lines_amount : hint_range(0.0, 180.0, 0.1) = 180.0;
uniform float horizontal_scan_lines_opacity : hint_range(0.0, 1.0, 0.01) = 1.0;
uniform bool show_vertical_scan_lines = false;
uniform float vertical_scan_lines_amount : hint_range(0.0, 320.0) = 320.0;
uniform float vertical_scan_lines_amount : hint_range(0.0, 320.0, 0.1) = 320.0;
uniform float vertical_scan_lines_opacity : hint_range(0.0, 1.0, 0.01) = 1.0;
uniform float boost : hint_range(1.0, 2.0, 0.01) = 1.2;
uniform float aberration_amount : hint_range(0.0, 10.0, 0.01) = 0.0;
Expand Down

0 comments on commit b09093f

Please sign in to comment.