blob: d18367f8d278015b1d89bf9db2c0a9f4babca75f [file] [log] [blame]
ethannicholas5961bc92016-10-12 06:39:56 -07001Overview
2========
3
4SkSL ("Skia Shading Language") is a variant of GLSL which is used as Skia's
5internal shading language. SkSL is, at its heart, a single standardized version
6of GLSL which avoids all of the various version and dialect differences found
7in GLSL "in the wild", but it does bring a few of its own changes to the table.
8
9Skia uses the SkSL compiler to convert SkSL code to GLSL, GLSL ES, or SPIR-V
10before handing it over to the graphics driver.
11
12Differences from GLSL
13=====================
14
15SkSL is based on GLSL 4.5. For the most part, write SkSL exactly as you would
16desktop GLSL, and the SkSL compiler will take care of version and dialect
17differences (for instance, you always use "in" and "out", and skslc will handle
18translating them to "varying" and "attribute" as appropriate). Be aware of the
19following differences between SkSL and GLSL:
20
Ethan Nicholas3605ace2016-11-21 15:59:48 -050021* GLSL caps can be referenced via the syntax 'sk_Caps.<name>', e.g.
22 sk_Caps.sampleVariablesSupport. The value will be a constant boolean or int,
23 as appropriate. As SkSL supports constant folding and branch elimination, this
24 means that an 'if' statement which statically queries a cap will collapse down
25 to the chosen branch, meaning that:
26
27 if (sk_Caps.externalTextureSupport)
28 do_something();
29 else
30 do_something_else();
31
32 will compile as if you had written either 'do_something();' or
33 'do_something_else();', depending on whether that cap is enabled or not.
ethannicholas22f939e2016-10-13 13:25:34 -070034* no #version statement is required, and will be ignored if present
ethannicholas5961bc92016-10-12 06:39:56 -070035* the output color is sk_FragColor (do not declare it)
36* lowp, mediump, and highp are always permitted (but will only be respected if
Ethan Nicholascae3a4c2017-02-02 10:43:58 -050037 you run on a GLES device)
ethannicholas5961bc92016-10-12 06:39:56 -070038* you do not need to include ".0" to make a number a float (meaning that
39 "vec2(x, y) * 4" is perfectly legal in SkSL, unlike GLSL where it would often
40 have to be expressed "vec2(x, y) * 4.0". There is no performance penalty for
41 this, as the number is converted to a float at compile time)
42* type suffixes on numbers (1.0f, 0xFFu) are both unnecessary and unsupported
Ethan Nicholas2b3dab62016-11-28 12:03:26 -050043* Use texture() instead of textureProj(), e.g. texture(sampler2D, vec3) is
44 equivalent to GLSL's textureProj(sampler2D, vec3)
ethannicholas5961bc92016-10-12 06:39:56 -070045* some built-in functions and one or two rarely-used language features are not
46 yet supported (sorry!)
47
48SkSL is still under development, and is expected to diverge further from GLSL
49over time.