DepthTexture2D.js

  1. 'use strict';
  3. const Texture2D = require('./Texture2D');
  5. const MAG_FILTERS = {
  6. 	NEAREST: true,
  7. 	LINEAR: true
  8. };
  9. const MIN_FILTERS = {
  10. 	NEAREST: true,
  11. 	LINEAR: true
  12. };
  13. const WRAP_MODES = {
  14. 	REPEAT: true,
  15. 	CLAMP_TO_EDGE: true,
  16. 	MIRRORED_REPEAT: true
  17. };
  18. const DEPTH_TYPES = {
  19. 	UNSIGNED_BYTE: true,
  20. 	UNSIGNED_SHORT: true,
  21. 	UNSIGNED_INT: true
  22. };
  23. const FORMATS = {
  24. 	DEPTH_COMPONENT: true,
  25. 	DEPTH_STENCIL: true
  26. };
  28. /**
  29.  * The default type for depth textures.
  30.  * @private
  31.  * @constant {string}
  32.  */
  33. const DEFAULT_TYPE = 'UNSIGNED_INT';
  35. /**
  36.  * The default format for depth textures.
  37.  * @private
  38.  * @constant {string}
  39.  */
  40. const DEFAULT_FORMAT = 'DEPTH_COMPONENT';
  42. /**
  43.  * The default wrap mode for depth textures.
  44.  * @private
  45.  * @constant {string}
  46.  */
  47. const DEFAULT_WRAP = 'CLAMP_TO_EDGE';
  49. /**
  50.  * The default min / mag filter for depth textures.
  51.  * @private
  52.  * @constant {string}
  53.  */
  54. const DEFAULT_FILTER = 'LINEAR';
  56. /**
  57.  * A texture class to represent a 2D depth texture.
  58.  * @augments Texture2D
  59.  */
  60. class DepthTexture2D extends Texture2D {
  62. 	/**
  63. 	 * Instantiates a DepthTexture2D object.
  64. 	 *
  65. 	 * @param {Object} spec - The specification arguments.
  66. 	 * @param {Uint8Array|Uint16Array|Uint32Array} spec.src - The data to buffer.
  67. 	 * @param {number} spec.width - The width of the texture.
  68. 	 * @param {number} spec.height - The height of the texture.
  69. 	 * @param {string} spec.wrap - The wrapping type over both S and T dimension.
  70. 	 * @param {string} spec.wrapS - The wrapping type over the S dimension.
  71. 	 * @param {string} spec.wrapT - The wrapping type over the T dimension.
  72. 	 * @param {string} spec.filter - The min / mag filter used during scaling.
  73. 	 * @param {string} spec.minFilter - The minification filter used during scaling.
  74. 	 * @param {string} spec.magFilter - The magnification filter used during scaling.
  75. 	 * @param {string} spec.format - The texture pixel format.
  76. 	 * @param {string} spec.type - The texture pixel component type.
  77. 	 */
  78. 	constructor(spec = {}) {
  79. 		// get specific params
  80. 		spec.wrapS = spec.wrapS || spec.wrap;
  81. 		spec.wrapT = spec.wrapT || spec.wrap;
  82. 		spec.minFilter = spec.minFilter || spec.filter;
  83. 		spec.magFilter = spec.magFilter || spec.filter;
  84. 		// set texture params
  85. 		spec.wrapS = WRAP_MODES[spec.wrapS] ? spec.wrapS : DEFAULT_WRAP;
  86. 		spec.wrapT = WRAP_MODES[spec.wrapT] ? spec.wrapT : DEFAULT_WRAP;
  87. 		spec.minFilter = MIN_FILTERS[spec.minFilter] ? spec.minFilter : DEFAULT_FILTER;
  88. 		spec.magFilter = MAG_FILTERS[spec.magFilter] ? spec.magFilter : DEFAULT_FILTER;
  89. 		// set mip-mapping and format
  90. 		spec.mipMap = false; // disable mip-mapping
  91. 		spec.invertY = false; // no need to invert-y
  92. 		spec.premultiplyAlpha = false; // no alpha to pre-multiply
  93. 		spec.format = FORMATS[spec.format] ? spec.format : DEFAULT_FORMAT;
  94. 		// check if stencil-depth, or just depth
  95. 		if (spec.format === 'DEPTH_STENCIL') {
  96. 			spec.type = 'UNSIGNED_INT_24_8_WEBGL';
  97. 		} else {
  98. 			spec.type = DEPTH_TYPES[spec.type] ? spec.type : DEFAULT_TYPE;
  99. 		}
  100. 		// call base constructor
  101. 		super(spec);
  102. 	}
  103. }
  105. module.exports = DepthTexture2D;