2
0

ShaderMaterial.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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. [page:Material] &rarr;
  12. <h1>着色器材质([name])</h1>
  13. <p class="desc"> 使用自定义shader渲染的材质。
  14. shader是一个用[link:https://www.khronos.org/files/opengles_shading_language.pdf GLSL]编写的小程序 ,在GPU上运行。
  15. 您可能需要使用自定义shader,如果你要:
  16. <ul>
  17. <li>要实现内置 [page:Material materials] 之外的效果。</li>
  18. <li>将许多对象组合成单个[page:Geometry]或[page:BufferGeometry]以提高性能。</li>
  19. </ul>
  20. 使用*ShaderMaterial*时需要注意以下注意事项:
  21. <ul>
  22. <li>*ShaderMaterial* 只有使用 [page:WebGLRenderer] 才可以绘制正常,
  23. 因为 [link:https://en.wikipedia.org/wiki/Shader#Vertex_shaders vertexShader]
  24. 和 [link:https://en.wikipedia.org/wiki/Shader#Pixel_shaders fragmentShader]
  25. 属性中GLSL代码必须使用WebGL来编译并运行在GPU中。
  26. </li>
  27. <li> 从 THREE r72开始,不再支持在ShaderMaterial中直接分配属性。
  28. 必须使用 [page:BufferGeometry]实例 (而不是 [page:Geometry] 实例),使用[page:BufferAttribute]实例来定义自定义属性。
  29. </li>
  30. <li> 从 THREE r77开始,[page:WebGLRenderTarget] 或 [page:WebGLRenderTargetCube] 实例不再被用作uniforms。
  31. 必须使用它们的[page:Texture texture] 属性。
  32. </li>
  33. <li> 内置attributes和uniforms与代码一起传递到shaders。
  34. 如果您不希望[page:WebGLProgram]向shader代码添加任何内容,则可以使用[page:RawShaderMaterial]而不是此类。
  35. </li>
  36. <li> 您可以使用指令#pragma unroll_loop,以便通过shader预处理器在GLSL中展开for循环。
  37. 该指令必须放在循环的正上方。循环格式必须与定义的标准相对应。
  38. <ul>
  39. <li> 循环必须标准化[link:https://en.wikipedia.org/wiki/Normalized_loop normalized]。
  40. </li>
  41. <li>
  42. 循环变量必须是*i*。
  43. </li>
  44. <li>
  45. 循环必须使用某种空格格式。
  46. </li>
  47. </ul>
  48. <code>
  49. #pragma unroll_loop
  50. for ( int i = 0; i < 10; i ++ ) {
  51. // ...
  52. }
  53. </code>
  54. </li>
  55. </ul>
  56. </p>
  57. <h2>例子(Examples)</h2>
  58. <p>
  59. [example:webgl_animation_cloth webgl / animation / cloth ]<br />
  60. [example:webgl_buffergeometry_custom_attributes_particles webgl / buffergeometry / custom / attributes / particles]<br />
  61. [example:webgl_buffergeometry_selective_draw webgl / buffergeometry / selective / draw]<br />
  62. [example:webgl_custom_attributes webgl / custom / attributes]<br />
  63. [example:webgl_custom_attributes_lines webgl / custom / attributes / lines]<br />
  64. [example:webgl_custom_attributes_points webgl / custom / attributes / points]<br />
  65. [example:webgl_custom_attributes_points2 webgl / custom / attributes / points2]<br />
  66. [example:webgl_custom_attributes_points3 webgl / custom / attributes / points3]<br />
  67. [example:webgl_depth_texture webgl / depth / texture]<br />
  68. [example:webgl_gpgpu_birds webgl / gpgpu / birds]<br />
  69. [example:webgl_gpgpu_protoplanet webgl / gpgpu / protoplanet]<br />
  70. [example:webgl_gpgpu_water webgl / gpgpu / water]<br />
  71. [example:webgl_hdr webgl / hdr]<br />
  72. [example:webgl_interactive_points webgl / interactive / points]<br />
  73. [example:webgl_kinect webgl / kinect]<br />
  74. [example:webgl_lights_hemisphere webgl / lights / hemisphere]<br />
  75. [example:webgl_marchingcubes webgl / marchingcubes]<br />
  76. [example:webgl_materials_bumpmap_skin webgl / materials / bumpmap / skin]<br />
  77. [example:webgl_materials_envmaps webgl / materials / envmaps]<br />
  78. [example:webgl_materials_lightmap webgl / materials / lightmap]<br />
  79. [example:webgl_materials_parallaxmap webgl / materials / parallaxmap]<br />
  80. [example:webgl_materials_shaders_fresnel webgl / materials / shaders / fresnel]<br />
  81. [example:webgl_materials_skin webgl / materials / skin]<br />
  82. [example:webgl_materials_texture_hdr webgl / materials / texture / hdr]<br />
  83. [example:webgl_materials_wireframe webgl / materials / wireframe]<br />
  84. [example:webgl_modifier_tessellation webgl / modifier / tessellation]<br />
  85. [example:webgl_nearestneighbour webgl / nearestneighbour]<br />
  86. [example:webgl_postprocessing_dof2 webgl / postprocessing / dof2]<br />
  87. [example:webgl_postprocessing_godrays webgl / postprocessing / godrays]
  88. </p>
  89. <code>
  90. var material = new THREE.ShaderMaterial( {
  91. uniforms: {
  92. time: { value: 1.0 },
  93. resolution: { value: new THREE.Vector2() }
  94. },
  95. vertexShader: document.getElementById( 'vertexShader' ).textContent,
  96. fragmentShader: document.getElementById( 'fragmentShader' ).textContent
  97. } );
  98. </code>
  99. <h2>顶点着色器和片元着色器(Vertex shaders and fragment shaders)</h2>
  100. <div>
  101. <p>您可以为每种材质指定两种不同类型的shaders::</p>
  102. <ul>
  103. <li> 顶点着色器首先运行; 它接收*attributes*,
  104. 计算/操纵每个单独顶点的位置,并将其他数据(*varying*s)传递给片元着色器。
  105. </li>
  106. <li>
  107. 片元(或像素)着色器后运行; 它设置渲染到屏幕的每个单独的“片元”(像素)的颜色。
  108. </li>
  109. </ul>
  110. <p>shader中有三种类型的变量: uniforms, attributes, 和 varyings:</p>
  111. <ul>
  112. <li>*Uniforms*是所有顶点都具有相同的值的变量。
  113. 比如灯光,雾,和阴影贴图就是被储存在uniforms中的数据。
  114. uniforms可以通过顶点着色器和片元着色器来访问。
  115. </li>
  116. <li> *Attributes* 与每个顶点关联的变量。例如,顶点位置,法线和顶点颜色都是存储在attributes中的数据。attributes <em>只</em>
  117. 可以在顶点着色器中访问。
  118. </li>
  119. <li> *Varyings* 是从顶点着色器传递到片元着色器的变量。对于每一个片元,每一个varying的值将是相邻顶点值的平滑插值。
  120. </li>
  121. </ul>
  122. <p> 注意:在shader <em>内部</em>,uniforms和attributes就像常量;你只能使用JavaScript代码通过缓冲区来修改它们的值。
  123. </p>
  124. </div>
  125. <h2>内置attributes 和 uniforms(Built-in attributes and uniforms)</h2>
  126. <div>
  127. <p>
  128. [page:WebGLRenderer]默认情况下为shader提供了许多attributes和uniforms;
  129. 这些变量定义在shader程序编译时被自动添加到*片元着色器*和*顶点着色器*代码的前面,你不需要自己声明它们。
  130. 这些变量的描述请参见[page:WebGLProgram]。
  131. </p>
  132. <p>
  133. 这些uniforms或attributes(例如,那些和照明,雾等相关的)要求属性设置在材质上,
  134. 以便 [page:WebGLRenderer]来拷贝合适的值到GPU中。
  135. 如果你想在自己的shader中使用这些功能,请确保设置这些标志。
  136. </p>
  137. <p>
  138. 如果你不希望[page:WebGLProgram] 向你的shader代码中添加任何东西,
  139. 你可以使用[page:RawShaderMaterial] 而不是这个类。
  140. </p>
  141. </div>
  142. <h2>自定义 attributes 和 uniforms(Custom attributes and uniforms)</h2>
  143. <div>
  144. <p>
  145. 自定义attributes和uniforms必须在GLSL着色器代码中声明(在 *vertexShader* 和/或 *fragmentShader* 中)。
  146. 自定义uniforms必须定义为 *ShaderMaterial* 的 *uniforms* 属性,
  147. 而任何自定义attribtes必须通过[page:BufferAttribute]实例来定义。
  148. 注意 *varying*s 只需要在shader代码中声明(而不必在材质中)。
  149. </p>
  150. <p> 要声明一个自定义属性,更多细节请参考[page:BufferGeometry]页面,
  151. 以及 [page:BufferAttribute] 页面关于*BufferAttribute* 接口。
  152. </p>
  153. <p>
  154. 当创建attributes时,您创建的用来保存属性数据的每个类型化数组(typed array)必须是您的数据类型大小的倍数。
  155. 比如,如果你的属性是一个[page:Vector3 THREE.Vector3]类型,并且在你的缓存几何模型[page:BufferGeometry]中有3000个顶点,
  156. 那么你的类型化数组的长度必须是3000 * 3,或者9000(一个顶点一个值)。每个数据类型的尺寸如下表所示:
  157. </p>
  158. <table>
  159. <caption><a id="attribute-sizes">属性尺寸</a></caption>
  160. <thead>
  161. <tr>
  162. <th>GLSL 类型</th>
  163. <th>JavaScript 类型</th>
  164. <th>尺寸</th>
  165. </tr>
  166. </thead>
  167. <tbody>
  168. <tr>
  169. <td>float</td>
  170. <td>[page:Number]</td>
  171. <td>1</td>
  172. </tr>
  173. <tr>
  174. <td>vec2</td>
  175. <td>[page:Vector2 THREE.Vector2]</td>
  176. <td>2</td>
  177. </tr>
  178. <tr>
  179. <td>vec3</td>
  180. <td>[page:Vector3 THREE.Vector3]</td>
  181. <td>3</td>
  182. </tr>
  183. <tr>
  184. <td>vec3</td>
  185. <td>[page:Color THREE.Color]</td>
  186. <td>3</td>
  187. </tr>
  188. <tr>
  189. <td>vec4</td>
  190. <td>[page:Vector4 THREE.Vector4]</td>
  191. <td>4</td>
  192. </tr>
  193. </tbody>
  194. </table>
  195. <p>
  196. 请注意,属性缓冲区 <em>不会</em> 在其值更改时自动刷新。要更新自定义属性,
  197. 需要在模型的[page:BufferAttribute]中设置*needsUpdate*为true。
  198. (查看[page:BufferGeometry]了解细节)。
  199. </p>
  200. <p>
  201. 要声明一个自定义的[page:Uniform],使用*uniforms*属性:
  202. <code>
  203. uniforms: {
  204. time: { value: 1.0 },
  205. resolution: { value: new THREE.Vector2() }
  206. }
  207. </code>
  208. </p>
  209. <p>
  210. 在[page:Object3D.onBeforeRender]中,建议根据[page:Object3D object]和[page:Camera camera]来更新自定义[page:Uniform]的值。
  211. 因为 [page:Material] 可以被[page:Mesh meshes],[page:Scene]的[page:Matrix4 matrixWorld]以及[page:Camera]共享,
  212. 会在[page:WebGLRenderer.render]中更新,并会对拥有私有[page:Camera cameras]的[page:Scene scene]的渲染造成影响。
  213. </p>
  214. </div>
  215. <h2>构造函数(Constructor)</h2>
  216. <h3>[name]( [param:Object parameters] )</h3>
  217. <p> [page:Object parameters] - (可选)用于定义材质外观的对象,具有一个或多个属性。
  218. 材质的任何属性都可以从此处传入(包括从[page:Material]继承的任何属性)。
  219. </p>
  220. <h2>属性(Properties)</h2>
  221. <p>常用属性请参见基类[page:Material]。</p>
  222. <h3>[property:Boolean clipping]</h3>
  223. <p> 定义此材质是否支持剪裁; 如果渲染器传递clippingPlanes uniform,则为true。默认值为false。
  224. </p>
  225. <h3>[property:Object defaultAttributeValues]</h3>
  226. <p> 当渲染的几何体不包含这些属性但材质包含这些属性时,这些默认值将传递给shaders。这可以避免在缓冲区数据丢失时出错。
  227. <code>
  228. this.defaultAttributeValues = {
  229. 'color': [ 1, 1, 1 ],
  230. 'uv': [ 0, 0 ],
  231. 'uv2': [ 0, 0 ]
  232. };
  233. </code>
  234. </p>
  235. <h3>[property:Object defines]</h3>
  236. <p> 使用 #define 指令在GLSL代码为顶点着色器和片段着色器定义自定义常量;每个键/值对产生一行定义语句:
  237. <code>
  238. defines: {
  239. FOO: 15,
  240. BAR: true
  241. }
  242. </code>
  243. 这将在GLSL代码中产生如下定义语句:
  244. <code>
  245. #define FOO 15
  246. #define BAR true
  247. </code>
  248. </p>
  249. <h3>[property:Object extensions]</h3>
  250. <p> 一个有如下属性的对象:
  251. <code>
  252. this.extensions = {
  253. derivatives: false, // set to use derivatives
  254. fragDepth: false, // set to use fragment depth values
  255. drawBuffers: false, // set to use draw buffers
  256. shaderTextureLOD: false // set to use shader texture LOD
  257. };
  258. </code>
  259. </p>
  260. <h3>[property:Boolean fog]</h3>
  261. <p> 定义材质颜色是否受全局雾设置的影响; 如果将fog uniforms传递给shader,则为true。默认值为false。
  262. </p>
  263. <h3>[property:String fragmentShader]</h3>
  264. <p>
  265. 片元着色器的GLSL代码。这是shader程序的实际代码。在上面的例子中,
  266. *vertexShader* 和 *fragmentShader* 代码是从DOM(HTML文档)中获取的;
  267. 它也可以作为一个字符串直接传递或者通过AJAX加载。
  268. </p>
  269. <h3>[property:String index0AttributeName]</h3>
  270. <p> 如果设置,则调用[link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bindAttribLocation gl.bindAttribLocation]
  271. 将通用顶点索引绑定到属性变量。默认值未定义。
  272. </p>
  273. <h3>[property:Boolean isShaderMaterial]</h3>
  274. <p> 用于检查此类或派生类是否为着色器材质。默认值为 *true*。<br /><br />
  275. 因为其通常用在内部优化,所以不应该更改该属性值。
  276. </p>
  277. <h3>[property:Boolean lights]</h3>
  278. <p> 材质是否受到光照的影响。默认值为 *false*。如果传递与光照相关的uniform数据到这个材质,则为true。默认是false。
  279. </p>
  280. <h3>[property:Float linewidth]</h3>
  281. <p>控制线框宽度。默认值为1。<br /><br />
  282. 由于[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]与大多数平台上[page:WebGLRenderer WebGL]渲染器的限制,无论如何设置该值,线宽始终为1。
  283. </p>
  284. <h3>[property:Boolean morphTargets]</h3>
  285. <p> 定义材质是否使用 morphTargets。如果将morphTarget attributes传递到此shader,则为true。
  286. </p>
  287. <h3>[property:boolean morphNormals]</h3>
  288. <p> 定义材质是否使用 morphNormals。设置为true,将从[page:Geometry]传递morphNormal属性给shader。默认值是*false*。
  289. </p>
  290. <h3>[property:WebGLProgram program]</h3>
  291. <p> 与此材质相关联的编译后的shader程序,由[page:WebGLRenderer]生成。您应该不需要访问此属性。
  292. </p>
  293. <h3>[property:Boolean flatShading]</h3>
  294. <p> 定义材质是否使用平面着色进行渲染。默认值为false。
  295. </p>
  296. <h3>[property:Boolean skinning]</h3>
  297. <p> 定义材质是否使用蒙皮; 如果将蒙皮属性传递给shader,则为true。默认值为false。
  298. </p>
  299. <h3>[property:Object uniforms]</h3>
  300. <p> 如下形式的对象:
  301. <code>
  302. { "uniform1": { value: 1.0 }, "uniform2": { value: 2 } }
  303. </code>
  304. 指定要传递给shader代码的uniforms;键为uniform的名称,值(value)是如下形式:
  305. <code>
  306. { value: 1.0 }
  307. </code>
  308. 这里 *value* 是uniform的值。名称必须匹配 uniform 的name,和GLSL代码中的定义一样。
  309. 注意,uniforms逐帧被刷新,所以更新uniform值将立即更新GLSL代码中的相应值。
  310. </p>
  311. <h3>[property:Number vertexColors]</h3>
  312. <p> 通过定义*colors*属性的生成方式来定义顶点是如何着色的。
  313. 可选值为[page:Materials THREE.NoColors], [page:Materials THREE.FaceColors] 和
  314. [page:Materials THREE.VertexColors]。 缺省为 THREE.NoColors。
  315. </p>
  316. <h3>[property:String vertexShader]</h3>
  317. <p> 顶点着色器的GLSL代码。这是shader程序的实际代码。
  318. 在上面的例子中,*vertexShader* 和 *fragmentShader* 代码是从DOM(HTML文档)中获取的;
  319. 它也可以作为一个字符串直接传递或者通过AJAX加载。
  320. </p>
  321. <h3>[property:Boolean wireframe]</h3>
  322. <p> 将几何体渲染为线框(通过GL_LINES而不是GL_TRIANGLES)。默认值为*false*(即渲染为平面多边形)。
  323. </p>
  324. <h3>[property:Float wireframeLinewidth]</h3>
  325. <p>控制线框宽度。默认值为1。<br /><br />
  326. 由于[link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]与大多数平台上[page:WebGLRenderer WebGL]渲染器的限制,无论如何设置该值,线宽始终为1。
  327. </p>
  328. <h2>方法(Methods)</h2>
  329. <p>常用方法请参见基类[page:Material]。</p>
  330. <h3>[method:ShaderMaterial clone]() [param:ShaderMaterial this]</h3>
  331. <p> 创建该材质的一个浅拷贝。需要注意的是,vertexShader和fragmentShader使用<em>引用拷贝</em>;
  332. *attributes*的定义也是如此;
  333. 这意味着,克隆的材质将共享相同的编译[page:WebGLProgram];
  334. 但是,*uniforms* 是 <em>值拷贝</em>,这样对不同的材质我们可以有不同的uniforms变量。
  335. </p>
  336. <h2>源码(Source)</h2>
  337. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  338. </body>
  339. </html>