DOC-1818 Writing URP shaders #550

oleks-k · 2020-05-19T13:33:18Z

DOC-1818
New pages with guidelines on writing shaders in URP.
Please review the texts for technical correctness.
To make the review more convenient, I've created the preview here:
https://docs-mizu.unity.com/oleks-k/manual/writing-custom-shaders-urp.html

On the page, the examples will go in this order: Basic - Color - Normal - Texture.

Changed the format to tutorial style.

…amples.md into smaller pages.

...unity.render-pipelines.universal/Documentation~/writing-shaders-urp-basic-unlit-structure.md

ellioman · 2020-06-22T19:07:28Z

...unity.render-pipelines.universal/Documentation~/writing-shaders-urp-basic-unlit-structure.md

+            {
+                // Declaring the output object (OUT) with the Varyings struct.
+                Varyings OUT;
+                // The TransformObjectToHClip function transforms vertex positions from


Same overflow issue here

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-color.md

ellioman · 2020-06-22T19:14:33Z

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-color.md

+            // To make the shader SRP Batcher compatible, declare all properties related to
+            // a Material in a a single CBUFFER block with the name UnityPerMaterial.
+            CBUFFER_START(UnityPerMaterial)
+                // The following line declares the _BaseColor variable, so that you can use


Overflow :)

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-texture.md

ellioman

I think this is a fine start to the shader docs.
I've added some comments mostly regarding formatting.

reallyfancy

Terminology pass - if I missed any instances, please update them to the correct term according to the other examples/the updated shader glossary. Any questions, let me know!

...unity.render-pipelines.universal/Documentation~/writing-shaders-urp-basic-unlit-structure.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-color.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-normals.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-texture.md

com.unity.render-pipelines.universal/Documentation~/shaders-in-universalrp.md

siobhan-gibson

Looks good, mostly just grammatical fixes! Pre-approving the suggested changes.

com.unity.render-pipelines.universal/Documentation~/shaders-in-universalrp.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-basic-prerequisites.md

...unity.render-pipelines.universal/Documentation~/writing-shaders-urp-basic-unlit-structure.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-normals.md

com.unity.render-pipelines.universal/Documentation~/writing-shaders-urp-unlit-texture.md

* backported #550. * Backported #1166. * Backported #1169 * backported #247 * backported #383 * backported #655 * backported #1066 * backported #234 * backported #1114

) * Applied PR #550 * Replaced jpg with png. * Backported PR #1431 * Deleted the .shader files (backported a wrong commit).

Added the shader code examples for review.

b7849bb

On the page, the examples will go in this order: Basic - Color - Normal - Texture.

sebastienlagarde added the universal label May 22, 2020

oleks-k added 9 commits June 10, 2020 12:18

DOC-1818 Created the draft.

7fbadf8

DOC-1818 Trying a different structure.

d802f1b

DOC-1818 Added code examples to md, some more descriptions.

552bc9a

DOC-1818 The part about CBUFFER.

8defec8

Added extended descriptions for the Color and the Texture parts.

d65ada2

Changed the format to tutorial style.

DOC-1818 Described all examples. Now I'm going to split urp-shader-ex…

76ed09f

…amples.md into smaller pages.

DOC-1818 Split the huge file into separate topics. Some minor edits.

ff376df

DOC-1818 Updated the TOC.

33c3963

DOC-1818 Some minor edits.

b079415

oleks-k changed the title ~~Added the shader code examples for review.~~ DOC-1818 Writing URP shaders Jun 18, 2020

oleks-k marked this pull request as ready for review June 18, 2020 05:34

oleks-k requested a review from a team as a code owner June 18, 2020 05:34

oleks-k requested a review from phi-lira June 18, 2020 05:34

oleks-k added needs-backport-8.x needs-backport-7.x labels Jun 18, 2020

oleks-k requested a review from ellioman June 18, 2020 05:36

DOC-1818 Added the _BaseMap screenshot, minor related edit.

a4c3550