Uniform.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <p class="desc">Uniforms 是 [link:https://www.opengl.org/documentation/glsl/ GLSL] 着色器中的全局变量。
  13. </p>
  14. <h3>示例</h3>
  15. <p>
  16. 在声明一个 [page:ShaderMaterial] 的 Uniform 变量时,该变量被值或对象声明。
  17. When declaring a uniform of a [page:ShaderMaterial], it is declared by value or by object.
  18. </p>
  19. <code>
  20. uniforms: {
  21. time: { value: 1.0 },
  22. resolution: new THREE.Uniform(new THREE.Vector2())
  23. }
  24. </code>
  25. <h3>Uniform 种类</h3>
  26. <p>
  27. 每个 Uniform 必须包括一个 *value* 属性。value 的类型必须和下表中 GLSL 的基本类型相对应。同样,Uniform 的结构体和队列
  28. 也是支持的。 GLSL基本类型队列必须要么被显示声明为一个 THREE 对象的队列,要么被声明为一个包含所有对象数据的队列。这就是说,
  29. 队列中的 GLSL 基础类型不能再是一个队列。举例,一个有 5 个 *vec2* 元素的队列,必须是一个包含 5 个 [page:Vector2] 的队列数组,
  30. 或包含 10 个 *number* 的队列。
  31. </p>
  32. <table>
  33. <caption><a id="uniform-types">Uniform 类型</a></caption>
  34. <thead>
  35. <tr>
  36. <th>GLSL 类型</th>
  37. <th>JavaScript 类型</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td>int</td>
  43. <td>[page:Number]</td>
  44. </tr>
  45. <tr>
  46. <td>float</td>
  47. <td>[page:Number]</td>
  48. </tr>
  49. <tr>
  50. <td>bool</td>
  51. <td>[page:Boolean]</td>
  52. </tr>
  53. <tr>
  54. <td>bool</td>
  55. <td>[page:Number]</td>
  56. </tr>
  57. <tr>
  58. <td>vec2</td>
  59. <td>[page:Vector2 THREE.Vector2]</td>
  60. </tr>
  61. <tr>
  62. <td>vec2</td>
  63. <td>[page:Float32Array Float32Array] (*)</td>
  64. </tr>
  65. <tr>
  66. <td>vec2</td>
  67. <td>[page:Array Array] (*)</td>
  68. </tr>
  69. <tr>
  70. <td>vec3</td>
  71. <td>[page:Vector3 THREE.Vector3]</td>
  72. </tr>
  73. <tr>
  74. <td>vec3</td>
  75. <td>[page:Color THREE.Color]</td>
  76. </tr>
  77. <tr>
  78. <td>vec3</td>
  79. <td>[page:Float32Array Float32Array] (*)</td>
  80. </tr>
  81. <tr>
  82. <td>vec3</td>
  83. <td>[page:Array Array] (*)</td>
  84. </tr>
  85. <tr>
  86. <td>vec4</td>
  87. <td>[page:Vector4 THREE.Vector4]</td>
  88. </tr>
  89. <tr>
  90. <td>vec4</td>
  91. <td>[page:Quaternion THREE.Quaternion]</td>
  92. </tr>
  93. <tr>
  94. <td>vec4</td>
  95. <td>[page:Float32Array Float32Array] (*)</td>
  96. </tr>
  97. <tr>
  98. <td>vec4</td>
  99. <td>[page:Array Array] (*)</td>
  100. </tr>
  101. <tr>
  102. <td>mat2</td>
  103. <td>[page:Float32Array Float32Array] (*)</td>
  104. </tr>
  105. <tr>
  106. <td>mat2</td>
  107. <td>[page:Array Array] (*)</td>
  108. </tr>
  109. <tr>
  110. <td>mat3</td>
  111. <td>[page:Matrix3 THREE.Matrix3]</td>
  112. </tr>
  113. <tr>
  114. <td>mat3</td>
  115. <td>[page:Float32Array Float32Array] (*)</td>
  116. </tr>
  117. <tr>
  118. <td>mat3</td>
  119. <td>[page:Array Array] (*)</td>
  120. </tr>
  121. <tr>
  122. <td>mat4</td>
  123. <td>[page:Matrix3 THREE.Matrix4]</td>
  124. </tr>
  125. <tr>
  126. <td>mat4</td>
  127. <td>[page:Float32Array Float32Array] (*)</td>
  128. </tr>
  129. <tr>
  130. <td>mat4</td>
  131. <td>[page:Array Array] (*)</td>
  132. </tr>
  133. <tr>
  134. <td>ivec2, bvec2</td>
  135. <td>[page:Float32Array Float32Array] (*)</td>
  136. </tr>
  137. <tr>
  138. <td>ivec2, bvec2</td>
  139. <td>[page:Array Array] (*)</td>
  140. </tr>
  141. <tr>
  142. <td>ivec3, bvec3</td>
  143. <td>[page:Int32Array Int32Array] (*)</td>
  144. </tr>
  145. <tr>
  146. <td>ivec3, bvec3</td>
  147. <td>[page:Array Array] (*)</td>
  148. </tr>
  149. <tr>
  150. <td>ivec4, bvec4</td>
  151. <td>[page:Int32Array Int32Array] (*)</td>
  152. </tr>
  153. <tr>
  154. <td>ivec4, bvec4</td>
  155. <td>[page:Array Array] (*)</td>
  156. </tr>
  157. <tr>
  158. <td>sampler2D</td>
  159. <td>[page:Texture THREE.Texture]</td>
  160. </tr>
  161. <tr>
  162. <td>samplerCube</td>
  163. <td>[page:CubeTexture THREE.CubeTexture]</td>
  164. </tr>
  165. </tbody>
  166. </table>
  167. <p>
  168. (*) 与最内层队列中 GSLS 的类型保持一致。包含队列中所有矢量的元素或矩阵中的元素。
  169. </p>
  170. <h2>构造函数</h2>
  171. <h3>[name]( [param:Object value] )</h3>
  172. <p>
  173. value -- 包含需要设置 Uniform 数据的对象。 数据类型必须是上述类型中的一种。
  174. </p>
  175. <h2>属性</h2>
  176. <h3>[property:Object value]</h3>
  177. <p>
  178. 当前 uniform 的值。
  179. </p>
  180. <h2>方法</h2>
  181. <h3>[method:Uniform clone]()</h3>
  182. <p>
  183. 返回该 Uniform 的克隆。<br />
  184. 如果 Uniform 的 value 属性是一个带 clone() 方法的 [page:Object],则克隆该对象时,value 的 clone() 方法也会被调用,否则克隆时只会使用赋值语句。
  185. 队列中的值会在该 Uniform 和 被克隆对象间共享。<br /><br />
  186. 该方法的使用示例详见 [example:webgldeferred_animation WebGL deferred animation]。
  187. </p>
  188. <h2>源代码</h2>
  189. <p>
  190. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  191. </p>
  192. </body>
  193. </html>