Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Scenario] Retro Terminal Effect Improvements #6191

Closed
ianhan opened this issue May 25, 2020 · 4 comments
Closed

[Scenario] Retro Terminal Effect Improvements #6191

ianhan opened this issue May 25, 2020 · 4 comments
Labels
Area-Rendering Text rendering, emoji, complex glyph & font-fallback issues Area-TerminalControl Issues pertaining to the terminal control (input, selection, keybindings, mouse interaction, etc.) Help Wanted We encourage anyone to jump in on these. Issue-Scenario Needs-Tag-Fix Doesn't match tag requirements Product-Terminal The new Windows Terminal.

Comments

@ianhan
Copy link

ianhan commented May 25, 2020

So, the glow effect is neat, but that is not what a CRT looks like. CRTs were not blurry. It looks more like a composite TV effect, and it's hard to use.

Check out this terminal and the effects it has - they are clearly a labor of love. Can we do something like that?
https://github.com/Swordfish90/cool-retro-term

image

image

Thanks!
@ianhan ianhan added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label May 25, 2020
@ghost ghost added Needs-Tag-Fix Doesn't match tag requirements Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels May 25, 2020
@zadjii-msft zadjii-msft changed the title Please make the effects a labor of love. [Scenario] Retro Terminal Effect Improvements May 27, 2020
@zadjii-msft
Copy link
Member

zadjii-msft commented May 27, 2020 •
edited

I mean, we're happy to accept more contributions in this area 😉 The retro effect was wholly a community contribution. At some point in the future, we'll probably move it to being an extension (#4000), but for now, it lives in this codebase, and we'd be happy to accept more improvements to it.

This is now the "retro terminal effects improvements" megathread.

Additional settings

Bugs

@zadjii-msft zadjii-msft added Area-Rendering Text rendering, emoji, complex glyph & font-fallback issues Area-TerminalControl Issues pertaining to the terminal control (input, selection, keybindings, mouse interaction, etc.) Issue-Scenario Product-Terminal The new Windows Terminal. and removed Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. labels May 27, 2020
@ghost ghost removed the Needs-Tag-Fix Doesn't match tag requirements label May 27, 2020
@zadjii-msft zadjii-msft added this to the Terminal Backlog milestone May 27, 2020
@zadjii-msft zadjii-msft added Help Wanted We encourage anyone to jump in on these. and removed Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels May 27, 2020
@ianhan
Copy link
Author

ianhan commented May 27, 2020

Thank you for considering!

This was referenced Jul 23, 2020
Closed
Closed
@zadjii-msft zadjii-msft mentioned this issue Dec 11, 2020
Merged
ghost pushed a commit that referenced this issue Dec 15, 2020
@zadjii-msft
Implement user-specified pixel shaders, redux (#8565)
b140299 
Co-authored-by: mrange <marten_range@hotmail.com>

I loved the pixel shaders in #7058, but that PR needed a bit of polish
to be ready for ingestion. This PR is almost _exactly_ that PR, with
some small changes.

* It adds a new pre-profile setting `"experimental.pixelShaderPath"`,
  which lets the user set a pixel shader to use with the Terminal.
    - CHANGED FROM #7058: It does _not_ add any built-in shaders.
    - CHANGED FROM #7058: it will _override_
      `experimental.retroTerminalEffect`
* It adds a bunch of sample shaders in `samples/shaders`. Included: 
    - A NOP shader as a base to build from.
    - An "invert" shader that inverts the colors, as a simple example
    - An "grayscale" shader that converts all colors to grayscale, as a
      simple example
    - An "raster bars" shader that draws some colored bars on the screen
      with a drop shadow, as a more involved example
    - The original retro terminal effects, as a more involved example
    - It also includes a broken shader, as an example of what heppens
      when the shader fails to compile
    - CHANGED FROM #7058: It does _not_ add the "retroII" shader we were
      all worried about.
* When a shader fails to be found or fails to compile, we'll display an
  error dialog to the user with a relevant error message.
    - CHANGED FROM #7058: Originally, #7058 would display "error bars"
      on the screen. I've removed that, and had the Terminal disable the
      shader entirely then.
* Renames the `toggleRetroEffect` action to `toggleShaderEffect`.
  (`toggleRetroEffect` is now an alias to `toggleShaderEffect`). This
  action will turn the shader OR the retro effects on/off. 

`toggleShaderEffect` works the way you'd expect it to, but the mental
math on _how_ is a little weird. The logic is basically:

```
useShader = shaderEffectsEnabled ? 
                (pixelShaderProvided ? 
                    pixelShader : 
                    (retroEffectEnabled ? 
                        retroEffect : null
                    )
                ) : 
                null
```

and `toggleShaderEffect` toggles `shaderEffectsEnabled`.

* If you've got both a shader and retro enabled, `toggleShaderEffect`
  will toggle between the shader on/off.
* If you've got a shader and retro disabled, `toggleShaderEffect` will
  toggle between the shader on/off.

References #6191
References #7058

Closes #7013

Closes #3930 "Add setting to retro terminal shader to control blur
radius, color" 
Closes #3929 "Add setting to retro terminal shader to enable drawing
scanlines" 
     - At this point, just roll your own version of the shader.
mpela81 pushed a commit to mpela81/terminal that referenced this issue Jan 28, 2021
@zadjii-msft @mpela81
Implement user-specified pixel shaders, redux (microsoft#8565)
62dcb7a 
Co-authored-by: mrange <marten_range@hotmail.com>

I loved the pixel shaders in microsoft#7058, but that PR needed a bit of polish
to be ready for ingestion. This PR is almost _exactly_ that PR, with
some small changes.

* It adds a new pre-profile setting `"experimental.pixelShaderPath"`,
  which lets the user set a pixel shader to use with the Terminal.
    - CHANGED FROM microsoft#7058: It does _not_ add any built-in shaders.
    - CHANGED FROM microsoft#7058: it will _override_
      `experimental.retroTerminalEffect`
* It adds a bunch of sample shaders in `samples/shaders`. Included: 
    - A NOP shader as a base to build from.
    - An "invert" shader that inverts the colors, as a simple example
    - An "grayscale" shader that converts all colors to grayscale, as a
      simple example
    - An "raster bars" shader that draws some colored bars on the screen
      with a drop shadow, as a more involved example
    - The original retro terminal effects, as a more involved example
    - It also includes a broken shader, as an example of what heppens
      when the shader fails to compile
    - CHANGED FROM microsoft#7058: It does _not_ add the "retroII" shader we were
      all worried about.
* When a shader fails to be found or fails to compile, we'll display an
  error dialog to the user with a relevant error message.
    - CHANGED FROM microsoft#7058: Originally, microsoft#7058 would display "error bars"
      on the screen. I've removed that, and had the Terminal disable the
      shader entirely then.
* Renames the `toggleRetroEffect` action to `toggleShaderEffect`.
  (`toggleRetroEffect` is now an alias to `toggleShaderEffect`). This
  action will turn the shader OR the retro effects on/off. 

`toggleShaderEffect` works the way you'd expect it to, but the mental
math on _how_ is a little weird. The logic is basically:

```
useShader = shaderEffectsEnabled ? 
                (pixelShaderProvided ? 
                    pixelShader : 
                    (retroEffectEnabled ? 
                        retroEffect : null
                    )
                ) : 
                null
```

and `toggleShaderEffect` toggles `shaderEffectsEnabled`.

* If you've got both a shader and retro enabled, `toggleShaderEffect`
  will toggle between the shader on/off.
* If you've got a shader and retro disabled, `toggleShaderEffect` will
  toggle between the shader on/off.

References microsoft#6191
References microsoft#7058

Closes microsoft#7013

Closes microsoft#3930 "Add setting to retro terminal shader to control blur
radius, color" 
Closes microsoft#3929 "Add setting to retro terminal shader to enable drawing
scanlines" 
     - At this point, just roll your own version of the shader.
@zadjii-msft
Copy link
Member

For folks following this thread: In Terminal 1.6 we've added support for "custom pixel shaders". This will let you do way more than just what the basic retro terminal effect does. I'm not a shader expert, so I don't know how to make something that looks like OP, but I'm sure it's possible somehow. The original PR had something that looked similar to OP in the "Retro II" shader.

Feel free to play around with that to see if you can't find something good, and share the results!

@zadjii-msft
Copy link
Member

Hey I'm gonna close this out now that #8565 and #8935 have landed. The custom pixel shaders will let you do this (and more), so I'm not sure there's a reason to leave this issue open any longer. Thanks!

P.S. If someone manages to whip up a shader that looks like OP (and you have the rights to contribute it), I'd love to throw it in the shader samples!

@ghost ghost added the Needs-Tag-Fix Doesn't match tag requirements label Feb 18, 2021
@zadjii-msft zadjii-msft removed this from the Terminal Backlog milestone Feb 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area-Rendering Text rendering, emoji, complex glyph & font-fallback issues Area-TerminalControl Issues pertaining to the terminal control (input, selection, keybindings, mouse interaction, etc.) Help Wanted We encourage anyone to jump in on these. Issue-Scenario Needs-Tag-Fix Doesn't match tag requirements Product-Terminal The new Windows Terminal.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ianhan @zadjii-msft