Add documentation on fragment program API and usage #7902

jonahwilliams · 2022-12-03T19:07:01Z

Adds documentation on usage of the fragment program API.

Presubmit checklist

This PR doesn’t contain automatically generated corrections (Grammarly or similar).
This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
This PR uses semantic line breaks of 80 characters or fewer.

jonahwilliams · 2022-12-05T18:10:34Z

src/development/ui/advanced/shaders.md

@@ -0,0 +1,228 @@
+---
+title: Writing and using Fragment Shaders


TBD: how do I link this from elsewhere in the website?

To link TO this page, you would use the following text:

For more information, check out [Writing and using fragment shaders][fragment-shaders] [fragment-shaders]: {{site.url}}/development/ui/advanced/shaders

src/development/ui/advanced/shaders.md

zanderso · 2022-12-05T18:50:19Z

src/development/ui/advanced/shaders.md

+## Canvas API
+
+Fragment shaders can be used with most Canvas APIs that accept either solid
+colors or gradients via a [Paint] object. And will cover an area determined


Check the first two sentences here. Not sure what they're saying.

I think what I'm trying to say is:

You can use shaders with most canvas APIs.
The shader works in the same way that a solid color or gradient works when applied to a shape
It doesn't work with certain APIs, like how a LinearGradient is ignored if set on the paint passed to drawImage

Did you make this change, @jonahwilliams? The suggested text is clearer.

src/development/ui/advanced/shaders.md

zanderso · 2022-12-05T18:53:19Z

src/development/ui/advanced/shaders.md

+### Performance Considerations
+
+When targeting the Skia backend loading the shader may be expensive, since it
+must be compiled to the appropriate platform specific shader. If you intend to


Suggested change

must be compiled to the appropriate platform specific shader. If you intend to

must be compiled to the appropriate platform specific shader at runtime. If you intend to

zanderso · 2022-12-05T18:53:56Z

src/development/ui/advanced/shaders.md

+
+```
+
+## Authoring Shaders


Maybe frontload pointers to tutorials on writing shaders?

I believe this will get a generated table of contents

I'm wondering what kind of tutorials you mean, @zanderso

The ones listed down under "Other resources". My thought was to make it clear that this doc isn't intended to be a general tutorial on writing shaders.

src/development/ui/advanced/shaders.md

Co-authored-by: Zachary Anderson <[email protected]>

jonahwilliams · 2022-12-07T18:56:46Z

@sfshaza2 PTAL. I'd like to merge this change before the next stable so that I can update some class documentation in the flutter repo to point to it

sfshaza2

Phew! This one was a doozy!

src/development/ui/advanced/shaders.md

sfshaza2 · 2022-12-07T18:59:44Z

src/development/ui/advanced/shaders.md

@@ -0,0 +1,228 @@
+---
+title: Writing and using Fragment Shaders


To link TO this page, you would use the following text:

For more information, check out [Writing and using fragment shaders][fragment-shaders] [fragment-shaders]: {{site.url}}/development/ui/advanced/shaders

src/development/ui/advanced/shaders.md

sfshaza2

Also, as this is a new page, can you add it to the sidenav? To do that, edit src/_data/sidenav.yml.

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

jonahwilliams · 2022-12-08T18:52:51Z

@sfshaza2 I've updated this PR with most of your suggestions + a few comments/questions

src/development/ui/advanced/shaders.md

Co-authored-by: Loïc Sharma <[email protected]>

sfshaza2

I have a few minor quibbles, but nothing to hold up landing this, when you're ready. LGTM

src/development/ui/advanced/shaders.md

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

jonahwilliams · 2022-12-13T21:47:01Z

Thanks for all of the help on this one @sfshaza2 !

jonahwilliams added 3 commits December 3, 2022 11:06

Add documentation on fragment program API and usage

b013376

++

1f68f6b

++

924d471

jonahwilliams marked this pull request as ready for review December 5, 2022 18:07

jonahwilliams requested review from atsansone, domesticmouse, johnpryan, khanhnwin and sfshaza2 as code owners December 5, 2022 18:07

jonahwilliams commented Dec 5, 2022

View reviewed changes

src/development/ui/advanced/shaders.md Outdated Show resolved Hide resolved

Merge branch 'main' into add_shader_doc

0fc2def

zanderso reviewed Dec 5, 2022

View reviewed changes

jonahwilliams added 2 commits December 5, 2022 12:41

tweaks

f08d739

++

dd819c3

zanderso approved these changes Dec 5, 2022

View reviewed changes

src/development/ui/advanced/shaders.md Outdated Show resolved Hide resolved

Update src/development/ui/advanced/shaders.md

4d9ff4d

Co-authored-by: Zachary Anderson <[email protected]>

sfshaza2 requested changes Dec 7, 2022

View reviewed changes

sfshaza2 reviewed Dec 7, 2022

View reviewed changes

sfshaza2 and others added 9 commits December 7, 2022 14:12

Merge branch 'main' into add_shader_doc

78886d6

Update src/development/ui/advanced/shaders.md

e2512dc

Update src/development/ui/advanced/shaders.md

a5e04a7

Update src/development/ui/advanced/shaders.md

7f178fb

Apply suggestions from code review

6a0a156

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

more adjustments

d4a20ac

Apply suggestions from code review

6d85928

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

++

37fff4b

++

c8dce30

jonahwilliams requested a review from sfshaza2 December 9, 2022 00:14

loic-sharma reviewed Dec 10, 2022

View reviewed changes

src/development/ui/advanced/shaders.md Outdated Show resolved Hide resolved

Update src/development/ui/advanced/shaders.md

1702a81

Co-authored-by: Loïc Sharma <[email protected]>

sfshaza2 approved these changes Dec 12, 2022

View reviewed changes

src/development/ui/advanced/shaders.md Outdated Show resolved Hide resolved

Update src/development/ui/advanced/shaders.md

b8df2ee

Co-authored-by: Shams Zakhour (ignore Sfshaza) <[email protected]>

jonahwilliams merged commit 6605ead into main Dec 13, 2022

jonahwilliams deleted the add_shader_doc branch December 13, 2022 22:23

		@@ -0,0 +1,228 @@
		---
		title: Writing and using Fragment Shaders

	must be compiled to the appropriate platform specific shader. If you intend to
	must be compiled to the appropriate platform specific shader at runtime. If you intend to

Add documentation on fragment program API and usage #7902

Add documentation on fragment program API and usage #7902

Uh oh!

Conversation

jonahwilliams commented Dec 3, 2022 • edited by eliasyishak Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Presubmit checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jonahwilliams commented Dec 7, 2022

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

jonahwilliams commented Dec 8, 2022

Uh oh!

Uh oh!

sfshaza2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jonahwilliams commented Dec 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jonahwilliams commented Dec 3, 2022 •

edited by eliasyishak

Loading