CompressedArrayTexture.html 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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:CompressedTexture] &rarr;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Creates an texture 2D array based on data in compressed form, for example
  14. from a [link:https://en.wikipedia.org/wiki/DirectDraw_Surface DDS]
  15. file.<br /><br />
  16. For use with the [page:CompressedTextureLoader CompressedTextureLoader].
  17. </p>
  18. <h2>Constructor</h2>
  19. <h3>
  20. [name]( [param:Array mipmaps], [param:Number width], [param:Number height], [param:Constant format], [param:Constant type] )
  21. </h3>
  22. <p>
  23. [page:Array mipmaps] -- The mipmaps array should contain objects with
  24. data, width and height. The mipmaps should be of the correct format and
  25. type.<br />
  26. [page:Number width] -- The width of the biggest mipmap.<br />
  27. [page:Number height] -- The height of the biggest mipmap.<br />
  28. [page:Number depth] -- The number of layers of the 2D array texture.<br />
  29. [page:Constant format] -- The format used in the mipmaps. See
  30. [page:Textures ST3C Compressed Texture Formats], [page:Textures PVRTC Compressed Texture Formats]
  31. and [page:Textures ETC Compressed Texture Format] for other choices.<br />
  32. [page:Constant type] -- Default is [page:Textures THREE.UnsignedByteType].
  33. See [page:Textures type constants] for other choices.<br />
  34. </p>
  35. <h2>Properties</h2>
  36. See the base [page:CompressedTexture CompressedTexture] class for common
  37. properties.
  38. <h3>[property:number wrapR]</h3>
  39. <p>
  40. This defines how the texture is wrapped in the depth direction.<br />
  41. The default is [page:Textures THREE.ClampToEdgeWrapping], where the edge
  42. is clamped to the outer edge texels. The other two choices are
  43. [page:Textures THREE.RepeatWrapping] and [page:Textures THREE.MirroredRepeatWrapping].
  44. See the [page:Textures texture constants]
  45. page for details.
  46. </p>
  47. <h3>[property:Object image]</h3>
  48. <p>Overridden with a object containing width, height, and depth.</p>
  49. <h3>[property:Boolean isCompressedArrayTexture]</h3>
  50. <p>Read-only flag to check if a given object is of type [name].</p>
  51. <h2>Methods</h2>
  52. <p>
  53. See the base [page:CompressedTexture CompressedTexture] class for common
  54. methods.
  55. </p>
  56. <h2>Source</h2>
  57. <p>
  58. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  59. </p>
  60. </body>
  61. </html>