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
Update material.md
  • Loading branch information
@machenmusik @ngokevin
machenmusik authored and ngokevin committed Oct 18, 2017
commit a451ab439c6f062f16a1e19f2b69dc082830ba11
9 changes: 9 additions & 0 deletions docs/components/material.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,6 +558,15 @@ Finally, here is the HTML markup to put it all together:
* [Live demo](https://aframe-simpler-shader.glitch.me/)
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.

All the Glitch demos can be listed in the examples array in the header:

examples:
  - title: Grid Glitch Shader
    url: https://glitch.com/edit/#!/aframe-simpler-shader?path=client/shader-grid-glitch.js:1:0

For ease of copy/pasting, I'd remove the GLSLify build step and use multiline strings.
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.

It was that way originally (using GLSL-ify) so I left it that way; you can see that the new one I added as walkthrough does, in fact, use multi-line strings. Are you asking to make changes to the existing example instances that will retroactively alter documentation for prior versions?
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.

You can remix the Glitch and not alter the old one.
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.

FYI - current examples header looks pretty unattractive, and no other good examples to follow?
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.

It's a data structure, it gets rendered underneath the table of contents as a list. I think there are two Glitches you listed, can add more as we go.
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.

Just checked, there are more than two. Good list!
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.

updated the Glitches I made, just the page and script, no more extraneous server and files
* [Remix this on Glitch](https://glitch.com/edit/#!/aframe-simpler-shader)

![5093034e-97f2-40dc-8cb9-28ca75bfd75b-8043-00000dbc2e00268d](https://cloud.githubusercontent.com/assets/1848368/24825516/abb98abe-1bd4-11e7-8262-93d3efb6056f.gif)

***

For a more advanced example, [try realtime vertex displacement](https://glitch.com/edit/#!/aframe-displacement-registershader).

![b19320eb-802a-462a-afcd-3d0dd9480aee-861-000004c2a8504498](https://cloud.githubusercontent.com/assets/1848368/24825518/b52e5bf6-1bd4-11e7-8eb2-9a9c1ff82ce9.gif)


## Register a Custom Component Using THREE Material

For those cases where the `registerShader` API lacks needed functionality
Expand Down