Materials.html 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. <h1>Material Constants</h1>
  11. <p class="desc">
  12. These constants define properties common to all material types,
  13. with the exception of Texture Combine Operations which only apply to [page:MeshBasicMaterial.combine MeshBasicMaterial], [page:MeshLambertMaterial.combine MeshLambertMaterial] and [page:MeshPhongMaterial.combine MeshPhongMaterial].<br />
  14. </p>
  15. <h2>Side</h2>
  16. <code>
  17. THREE.FrontSide
  18. THREE.BackSide
  19. THREE.DoubleSide
  20. </code>
  21. <p>
  22. Defines which side of faces will be rendered - front, back or both.
  23. Default is [page:Constant FrontSide].
  24. </p>
  25. <h2>Blending Mode</h2>
  26. <code>
  27. THREE.NoBlending
  28. THREE.NormalBlending
  29. THREE.AdditiveBlending
  30. THREE.SubtractiveBlending
  31. THREE.MultiplyBlending
  32. THREE.CustomBlending
  33. </code>
  34. <p>
  35. These control the source and destination blending equations for the material's RGB and Alpha sent to the WebGLRenderer for use by WebGL.<br />
  36. [page:Constant NormalBlending] is the default.<br />
  37. Note that [page:Constant CustomBlending] must be set to use [page:CustomBlendingEquation Custom Blending Equations].<br />
  38. See the [example:webgl_materials_blending materials / blending] example.<br />
  39. </p>
  40. <h2>Depth Mode</h2>
  41. <code>
  42. THREE.NeverDepth
  43. THREE.AlwaysDepth
  44. THREE.LessDepth
  45. THREE.LessEqualDepth
  46. THREE.GreaterEqualDepth
  47. THREE.GreaterDepth
  48. THREE.NotEqualDepth
  49. </code>
  50. <p>
  51. Which depth function the material uses to compare incoming pixels Z-depth against the current Z-depth buffer value. If the result of the comparison is true, the pixel will be drawn.<br />
  52. [page:Materials NeverDepth] will never return true.<br />
  53. [page:Materials AlwaysDepth] will always return true.<br />
  54. [page:Materials LessDepth] will return true if the incoming pixel Z-depth is less than the current buffer Z-depth.<br />
  55. [page:Materials LessEqualDepth] is the default and will return true if the incoming pixel Z-depth is less than or equal to the current buffer Z-depth.<br />
  56. [page:Materials GreaterEqualDepth] will return true if the incoming pixel Z-depth is greater than or equal to the current buffer Z-depth.<br />
  57. [page:Materials GreaterDepth] will return true if the incoming pixel Z-depth is greater than the current buffer Z-depth.<br />
  58. [page:Materials NotEqualDepth] will return true if the incoming pixel Z-depth is not equal to the current buffer Z-depth.<br />
  59. </p>
  60. <h2>Texture Combine Operations</h2>
  61. <code>
  62. THREE.MultiplyOperation
  63. THREE.MixOperation
  64. THREE.AddOperation
  65. </code>
  66. <p>
  67. These define how the result of the surface's color is combined with the environment map (if present), for [page:MeshBasicMaterial.combine MeshBasicMaterial], [page:MeshLambertMaterial.combine MeshLambertMaterial] and [page:MeshPhongMaterial.combine MeshPhongMaterial]. <br />
  68. [page:Constant MultiplyOperation] is the default and multiplies the environment map color with the surface color.<br />
  69. [page:Constant MixOperation] uses reflectivity to blend between the two colors.<br />
  70. [page:Constant AddOperation] adds the two colors.
  71. </p>
  72. <h2>Stencil Functions</h2>
  73. <code>
  74. THREE.NeverStencilFunc
  75. THREE.LessStencilFunc
  76. THREE.EqualStencilFunc
  77. THREE.LessEqualStencilFunc
  78. THREE.GreaterStencilFunc
  79. THREE.NotEqualStencilFunc
  80. THREE.GreaterEqualStencilFunc
  81. THREE.AlwaysStencilFunc
  82. </code>
  83. <p>
  84. Which stencil function the material uses to determine whether or not to perform a stencil operation.<br />
  85. [page:Materials NeverStencilFunc] will never return true.<br />
  86. [page:Materials LessStencilFunc] will return true if the stencil reference value is less than the current stencil value.<br />
  87. [page:Materials EqualStencilFunc] will return true if the stencil reference value is equal to the current stencil value.<br />
  88. [page:Materials LessEqualStencilFunc] will return true if the stencil reference value is less than or equal to the current stencil value.<br />
  89. [page:Materials GreaterStencilFunc] will return true if the stencil reference value is greater than the current stencil value.<br />
  90. [page:Materials NotEqualStencilFunc] will return true if the stencil reference value is not equal to the current stencil value.<br />
  91. [page:Materials GreaterEqualStencilFunc] will return true if the stencil reference value is greater than or equal to the current stencil value.<br />
  92. [page:Materials AlwaysStencilFunc] will always return true.<br />
  93. </p>
  94. <h2>Stencil Operations</h2>
  95. <code>
  96. THREE.ZeroStencilOp
  97. THREE.KeepStencilOp
  98. THREE.ReplaceStencilOp
  99. THREE.IncrementStencilOp
  100. THREE.DecrementStencilOp
  101. THREE.IncrementWrapStencilOp
  102. THREE.DecrementWrapStencilOp
  103. THREE.InvertStencilOp
  104. </code>
  105. <p>
  106. Which stencil operation the material will perform on the stencil buffer pixel if the provided stencil function passes.<br />
  107. [page:Materials ZeroStencilOp] will set the stencil value to 0.<br />
  108. [page:Materials KeepStencilOp] will not change the current stencil value.<br />
  109. [page:Materials ReplaceStencilOp] will replace the stencil value with the specified stencil reference value.<br />
  110. [page:Materials IncrementStencilOp] will increment the current stencil value by 1.<br />
  111. [page:Materials DecrementStencilOp] will decrement the current stencil value by 1.<br />
  112. [page:Materials IncrementWrapStencilOp] will increment the current stencil value by 1. If the value increments past 255 it will be set to 0.<br />
  113. [page:Materials DecrementWrapStencilOp] will increment the current stencil value by 1. If the value decrements below 0 it will be set to 255.<br />
  114. [page:Materials InvertStencilOp] will perform a bitwise iversion of the current stencil value.<br />
  115. </p>
  116. <h2>Source</h2>
  117. <p>
  118. [link:https://github.com/mrdoob/three.js/blob/master/src/constants.js src/constants.js]
  119. </p>
  120. </body>
  121. </html>