Skip to content

Better shader docs #3154

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

Merged
merged 19 commits into from
Oct 18, 2017
Merged

Better shader docs #3154

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c024413
Update material.md
machenmusik Oct 11, 2017
2f67e5a
Update material.md
machenmusik Oct 11, 2017
47e22ec
Update material.md
machenmusik Oct 11, 2017
6a370ca
Update material.md
machenmusik Oct 11, 2017
8d0c325
Update material.md
machenmusik Oct 11, 2017
948b2e2
Update material.md
machenmusik Oct 11, 2017
a387b47
Create shaders.md
machenmusik Oct 11, 2017
d6ac66a
Update shaders.md
machenmusik Oct 11, 2017
d0c268d
Update shaders.md
machenmusik Oct 11, 2017
b2459d1
Update shaders.md
machenmusik Oct 11, 2017
c3fc4d2
Update shaders.md
machenmusik Oct 11, 2017
a451ab4
Update material.md
machenmusik Oct 11, 2017
072cda2
Update material.md
machenmusik Oct 12, 2017
50966cd
Update material.md
machenmusik Oct 12, 2017
392f796
Update material.md
machenmusik Oct 12, 2017
9653524
remove separate shaders section per discussion on PR
machenmusik Oct 17, 2017
948b3d1
aframe-shadertoy-gallery is gone
machenmusik Oct 17, 2017
16ae6e5
add examples in header
machenmusik Oct 17, 2017
27c6ddb
[docs] add don's displacement shader example to material docs
ngokevin Oct 11, 2017
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Create shaders.md 
Could use more links!
  • Loading branch information
@machenmusik @ngokevin
machenmusik authored and ngokevin committed Oct 18, 2017
commit a387b47c7918081d32e6aa971cbab79ef8c66aaf
22 changes: 22 additions & 0 deletions docs/introduction/shaders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
Copy link
Member

@ngokevin ngokevin Oct 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this part is too thin for a separate section. I think it's OK to be contained in the material section for now. Perhaps as the API and the ecosystem around shaders possibly matures, we move it out a separate section?
Copy link
Contributor Author

@machenmusik machenmusik Oct 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The non-duplicated part here that seems worth keeping is the reference to shader repositories like ShaderToy and/or ShaderFrog (there are probably others too) and pointers toward components that help with reusing those. Where would you suggest that appear in material documentation?
Copy link
Member

@ngokevin ngokevin Oct 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps when shaders are first introduced.
Copy link
Contributor Author

@machenmusik machenmusik Oct 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like your shaderfrog gallery went away, was that intentional? Changed reference to just the shaderfrog site.
Copy link
Member

@ngokevin ngokevin Oct 17, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it was an empty repo 🙄
title: "Shaders"
type: introduction
layout: docs
parent_section: introduction
order: 8.775
examples: []
---

[shaders]: ../../components/material
[shadertoy]: https://github.com/ngokevin/aframe-shadertoy-gallery
[shaderfrog]: https://github.com/chenzlabs/aframe-import-shaderfrog
Shaders are a powerful technique to implement visual effects.

A-Frame provides support for custom shaders as discussed [here][shaders].

In addition, there are components developed by the A-Frame developer community
that allow the use of existing shaders from repositories such as [ShaderToy][shadertoy] and [ShaderFrog][shaderfrog].

Note however that these shaders can be quite demanding in terms of
computational and graphics power, and some more complex shaders may not function
well on lower-performance devices such as smartphones.