1
0

CompressedTexture.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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:Texture] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Creates a texture based on data in compressed form, for example from a
  14. [link:https://en.wikipedia.org/wiki/DirectDraw_Surface DDS] file.<br /><br />
  15. For use with the [page:CompressedTextureLoader CompressedTextureLoader].
  16. </p>
  17. <h2>Constructor</h2>
  18. <h3>
  19. [name]( [param:Array mipmaps], [param:Number width], [param:Number height],
  20. [param:Constant format], [param:Constant type], [param:Constant mapping],
  21. [param:Constant wrapS], [param:Constant wrapT], [param:Constant magFilter],
  22. [param:Constant minFilter], [param:Number anisotropy], [param:Constant colorSpace] )
  23. </h3>
  24. <p>
  25. [page:Array mipmaps] -- The mipmaps array should contain objects with
  26. data, width and height. The mipmaps should be of the correct format and
  27. type.<br />
  28. [page:Number width] -- The width of the biggest mipmap.<br />
  29. [page:Number height] -- The height of the biggest mipmap.<br />
  30. [page:Constant format] -- The format used in the mipmaps. See
  31. [page:Textures ST3C Compressed Texture Formats], [page:Textures PVRTC Compressed Texture Formats]
  32. and [page:Textures ETC Compressed Texture Format] for other choices.<br />
  33. [page:Constant type] -- Default is [page:Textures THREE.UnsignedByteType].
  34. See [page:Textures type constants] for other choices.<br />
  35. [page:Constant mapping] -- How the image is applied to the object. An
  36. object type of [page:Textures THREE.UVMapping]. See [page:Textures mapping constants] for other choices.<br />
  37. [page:Constant wrapS] -- The default is [page:Textures THREE.ClampToEdgeWrapping].
  38. See [page:Textures wrap mode constants] for
  39. other choices.<br />
  40. [page:Constant wrapT] -- The default is [page:Textures THREE.ClampToEdgeWrapping].
  41. See [page:Textures wrap mode constants] for
  42. other choices.<br />
  43. [page:Constant magFilter] -- How the texture is sampled when a texel
  44. covers more than one pixel. The default is [page:Textures THREE.LinearFilter].
  45. See [page:Textures magnification filter constants]
  46. for other choices.<br />
  47. [page:Constant minFilter] -- How the texture is sampled when a texel
  48. covers less than one pixel. The default is [page:Textures THREE.LinearMipmapLinearFilter].
  49. See [page:Textures minification filter constants] for other choices.<br />
  50. [page:Number anisotropy] -- The number of samples taken along the axis
  51. through the pixel that has the highest density of texels. By default, this
  52. value is `1`. A higher value gives a less blurry result than a basic mipmap,
  53. at the cost of more texture samples being used. Use
  54. renderer.getMaxAnisotropy() to find the maximum valid anisotropy value for
  55. the GPU; this value is usually a power of 2.<br />
  56. [page:Constant colorSpace] -- The default is [page:Textures THREE.NoColorSpace].
  57. See [page:Textures color space constants] for other
  58. choices.<br /><br />
  59. </p>
  60. <h2>Properties</h2>
  61. See the base [page:Texture Texture] class for common properties.
  62. <h3>[property:Boolean flipY]</h3>
  63. <p>
  64. False by default. Flipping textures does not work for compressed textures.
  65. </p>
  66. <h3>[property:Boolean generateMipmaps]</h3>
  67. <p>False by default. Mipmaps can't be generated for compressed textures</p>
  68. <h3>[property:Object image]</h3>
  69. <p>Overridden with a object containing width and height.</p>
  70. <h3>[property:Boolean isCompressedTexture]</h3>
  71. <p>Read-only flag to check if a given object is of type [name].</p>
  72. <h2>Methods</h2>
  73. <p>See the base [page:Texture Texture] class for common methods.</p>
  74. <h2>Source</h2>
  75. <p>
  76. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  77. </p>
  78. </body>
  79. </html>