YAML 101

我们使用的是符合 YAML 1.2 标准的解析器,这意味着首先它是与 JSON 完全兼容的,直接书写 JSON 完全不会有问题:

  1. "techniques":
  2. [{
  3. "passes":
  4. [{
  5. "vert": "skybox-vs",
  6. "frag": "skybox-fs",
  7. "rasterizerState":
  8. {
  9. "cullMode": "none"
  10. }
  11. # ...
  12. }]
  13. }]

当然这也意味着繁琐的语法,所以 YAML 提供了一些更简洁的数据表示方式:
(如有疑问可复制代码示例到任何 在线 YAML JSON 转换器 观察生成的数据)

  • 所有的引号和逗号都可以省略(但注意,冒号后的空格不可省略)
  1. key1: 1
  2. key2: unquoted string
  • 行首的空格缩进数量代表数据的层级1
  1. object1:
  2. key1: false
  3. object2:
  4. key2: 3.14
  5. key3: 0xdeadbeef
  6. nestedObject:
  7. key4: 'quoted string'
  • 以 连字符+空格 开头,表示数组元素
  1. - 42
  2. - "double-quoted string"
  3. - arrayElement3:
  4. key1: punctuations? sure.
  5. key2: you can even have {}s as long as they are not the first character
  6. key3: { nested1: 'but no unquoted string allowed inside brackets', nested2: 'also notice the comma is back too' }

综合这几点,上面的 effect 内容就可以很简洁地写成这样:

  1. techniques:
  2. - passes:
  3. - vert: skybox-vs
  4. frag: skybox-fs
  5. rasterizerState:
  6. cullMode: none
  7. # ...

另一个对我们的情况非常有用的 YAML 特性是数据间的引用与继承,先来看引用:

  1. object1: &o1
  2. key1: value1
  3. object2:
  4. key2: value2
  5. key3: *o1

这个数据解析出来是这样的:

  1. {
  2. "object1": {
  3. "key1": "value1"
  4. },
  5. "object2": {
  6. "key2": "value2",
  7. "key3": {
  8. "key1": "value1"
  9. }
  10. }
  11. }

再来看继承:

  1. object1: &o1
  2. key1: value1
  3. key2: value2
  4. object2:
  5. <<: *o1
  6. key3: value3

这个数据解析出来是这样的:

  1. {
  2. "object1": {
  3. "key1": "value1",
  4. "key2": "value2"
  5. },
  6. "object2": {
  7. "key1": "value1",
  8. "key2": "value2",
  9. "key3": "value3"
  10. }
  11. }

对应到我们的 effect 中,比如多个 pass 拥有相同的 property 内容,或很多其他情景下,都可以很方便地复用数据:

  1. techniques:
  2. - passes:
  3. - # pass 1 specifications...
  4. properties: &props # declare once...
  5. p1: { value: [ 1, 1, 1, 1 ] }
  6. p2: { sampler: { mipFilter: linear } }
  7. p3: { inspector: { type: color } }
  8. - # pass 2 specifications...
  9. properties: *props # reference anywhere

最后,在实际 effect 文件中任何流程声明都需要包在 CCEffect 语法块内:

  1. CCEffect %{
  2. # YAML starts here
  3. }%

更多参考资料

[1] 标准 YAML 并不支持制表符,但在解析 effect 数据时,我们会先尝试把其中所有的制表符替换为 2 个空格,以避免偶然插入制表符带来的琐碎的麻烦。但整体上,请一定尽量避免插入制表符来确保编译无误。