2
0

SpriteMaterial.html 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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. [page:Material] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">A material for a use with a [page:Sprite].</p>
  13. <h2>Code Example</h2>
  14. <code>
  15. const map = new THREE.TextureLoader().load( 'textures/sprite.png' );
  16. const material = new THREE.SpriteMaterial( { map: map, color: 0xffffff } );
  17. const sprite = new THREE.Sprite( material );
  18. sprite.scale.set(200, 200, 1)
  19. scene.add( sprite );
  20. </code>
  21. <h2>Examples</h2>
  22. <p>
  23. [example:webgl_sprites webGL / sprites]<br />
  24. [example:software_sandbox software / sandbox]<br />
  25. [example:svg_sandbox svg / sandbox]<br />
  26. [example:webgl_materials_cubemap_dynamic webgl / materials / cubemap / dynamic]
  27. </p>
  28. <h2>Constructor</h2>
  29. <h3>[name]( [param:Object parameters] )</h3>
  30. <p>
  31. [page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
  32. Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
  33. The exception is the property [page:Hexadecimal color], which can be passed in as a hexadecimal
  34. string and is *0xffffff* (white) by default. [page:Color.set]( color ) is called internally.
  35. SpriteMaterials are not clipped by using [page:Material.clippingPlanes].
  36. </p>
  37. <h2>Properties</h2>
  38. <p>See the base [page:Material] class for common properties.</p>
  39. <h3>[property:Texture alphaMap]</h3>
  40. <p>The alpha map is a grayscale texture that controls the opacity across the surface
  41. (black: fully transparent; white: fully opaque). Default is null.<br /><br />
  42. Only the color of the texture is used, ignoring the alpha channel if one exists.
  43. For RGB and RGBA textures, the [page:WebGLRenderer WebGL] renderer will use the
  44. green channel when sampling this texture due to the extra bit of precision provided
  45. for green in DXT-compressed and uncompressed RGB 565 formats. Luminance-only and
  46. luminance/alpha textures will also still work as expected.
  47. </p>
  48. <h3>[property:Color color]</h3>
  49. <p>[page:Color] of the material, by default set to white (0xffffff). The [page:.map] is mutiplied by the color.</p>
  50. <h3>[property:Texture map]</h3>
  51. <p>The texture map. Default is null.</p>
  52. <h3>[property:Radians rotation]</h3>
  53. <p>The rotation of the sprite in radians. Default is 0.</p>
  54. <h3>[property:Boolean sizeAttenuation]</h3>
  55. <p>Whether the size of the sprite is attenuated by the camera depth. (Perspective camera only.) Default is *true*.</p>
  56. <h2>Methods</h2>
  57. <p>See the base [page:Material] class for common methods.</p>
  58. <h2>Source</h2>
  59. <p>
  60. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  61. </p>
  62. </body>
  63. </html>