WebGLProgram.js 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120
  1. import { WebGLUniforms } from './WebGLUniforms.js';
  2. import { WebGLShader } from './WebGLShader.js';
  3. import { ShaderChunk } from '../shaders/ShaderChunk.js';
  4. import { NoToneMapping, AddOperation, MixOperation, MultiplyOperation, CubeRefractionMapping, CubeUVReflectionMapping, CubeReflectionMapping, PCFSoftShadowMap, PCFShadowMap, VSMShadowMap, AgXToneMapping, ACESFilmicToneMapping, NeutralToneMapping, CineonToneMapping, CustomToneMapping, ReinhardToneMapping, LinearToneMapping, GLSL3, LinearSRGBColorSpace, SRGBColorSpace, LinearDisplayP3ColorSpace, DisplayP3ColorSpace, P3Primaries, Rec709Primaries } from '../../constants.js';
  5. import { ColorManagement } from '../../math/ColorManagement.js';
  6. // From https://www.khronos.org/registry/webgl/extensions/KHR_parallel_shader_compile/
  7. const COMPLETION_STATUS_KHR = 0x91B1;
  8. let programIdCount = 0;
  9. function handleSource( string, errorLine ) {
  10. const lines = string.split( '\n' );
  11. const lines2 = [];
  12. const from = Math.max( errorLine - 6, 0 );
  13. const to = Math.min( errorLine + 6, lines.length );
  14. for ( let i = from; i < to; i ++ ) {
  15. const line = i + 1;
  16. lines2.push( `${line === errorLine ? '>' : ' '} ${line}: ${lines[ i ]}` );
  17. }
  18. return lines2.join( '\n' );
  19. }
  20. function getEncodingComponents( colorSpace ) {
  21. const workingPrimaries = ColorManagement.getPrimaries( ColorManagement.workingColorSpace );
  22. const encodingPrimaries = ColorManagement.getPrimaries( colorSpace );
  23. let gamutMapping;
  24. if ( workingPrimaries === encodingPrimaries ) {
  25. gamutMapping = '';
  26. } else if ( workingPrimaries === P3Primaries && encodingPrimaries === Rec709Primaries ) {
  27. gamutMapping = 'LinearDisplayP3ToLinearSRGB';
  28. } else if ( workingPrimaries === Rec709Primaries && encodingPrimaries === P3Primaries ) {
  29. gamutMapping = 'LinearSRGBToLinearDisplayP3';
  30. }
  31. switch ( colorSpace ) {
  32. case LinearSRGBColorSpace:
  33. case LinearDisplayP3ColorSpace:
  34. return [ gamutMapping, 'LinearTransferOETF' ];
  35. case SRGBColorSpace:
  36. case DisplayP3ColorSpace:
  37. return [ gamutMapping, 'sRGBTransferOETF' ];
  38. default:
  39. console.warn( 'THREE.WebGLProgram: Unsupported color space:', colorSpace );
  40. return [ gamutMapping, 'LinearTransferOETF' ];
  41. }
  42. }
  43. function getShaderErrors( gl, shader, type ) {
  44. const status = gl.getShaderParameter( shader, gl.COMPILE_STATUS );
  45. const errors = gl.getShaderInfoLog( shader ).trim();
  46. if ( status && errors === '' ) return '';
  47. const errorMatches = /ERROR: 0:(\d+)/.exec( errors );
  48. if ( errorMatches ) {
  49. // --enable-privileged-webgl-extension
  50. // console.log( '**' + type + '**', gl.getExtension( 'WEBGL_debug_shaders' ).getTranslatedShaderSource( shader ) );
  51. const errorLine = parseInt( errorMatches[ 1 ] );
  52. return type.toUpperCase() + '\n\n' + errors + '\n\n' + handleSource( gl.getShaderSource( shader ), errorLine );
  53. } else {
  54. return errors;
  55. }
  56. }
  57. function getTexelEncodingFunction( functionName, colorSpace ) {
  58. const components = getEncodingComponents( colorSpace );
  59. return `vec4 ${functionName}( vec4 value ) { return ${components[ 0 ]}( ${components[ 1 ]}( value ) ); }`;
  60. }
  61. function getToneMappingFunction( functionName, toneMapping ) {
  62. let toneMappingName;
  63. switch ( toneMapping ) {
  64. case LinearToneMapping:
  65. toneMappingName = 'Linear';
  66. break;
  67. case ReinhardToneMapping:
  68. toneMappingName = 'Reinhard';
  69. break;
  70. case CineonToneMapping:
  71. toneMappingName = 'OptimizedCineon';
  72. break;
  73. case ACESFilmicToneMapping:
  74. toneMappingName = 'ACESFilmic';
  75. break;
  76. case AgXToneMapping:
  77. toneMappingName = 'AgX';
  78. break;
  79. case NeutralToneMapping:
  80. toneMappingName = 'Neutral';
  81. break;
  82. case CustomToneMapping:
  83. toneMappingName = 'Custom';
  84. break;
  85. default:
  86. console.warn( 'THREE.WebGLProgram: Unsupported toneMapping:', toneMapping );
  87. toneMappingName = 'Linear';
  88. }
  89. return 'vec3 ' + functionName + '( vec3 color ) { return ' + toneMappingName + 'ToneMapping( color ); }';
  90. }
  91. function generateExtensions( parameters ) {
  92. const chunks = [
  93. ( parameters.extensionDerivatives || !! parameters.envMapCubeUVHeight || parameters.bumpMap || parameters.normalMapTangentSpace || parameters.clearcoatNormalMap || parameters.flatShading || parameters.alphaToCoverage || parameters.shaderID === 'physical' ) ? '#extension GL_OES_standard_derivatives : enable' : '',
  94. ( parameters.extensionFragDepth || parameters.logarithmicDepthBuffer ) && parameters.rendererExtensionFragDepth ? '#extension GL_EXT_frag_depth : enable' : '',
  95. ( parameters.extensionDrawBuffers && parameters.rendererExtensionDrawBuffers ) ? '#extension GL_EXT_draw_buffers : require' : '',
  96. ( parameters.extensionShaderTextureLOD || parameters.envMap || parameters.transmission ) && parameters.rendererExtensionShaderTextureLod ? '#extension GL_EXT_shader_texture_lod : enable' : ''
  97. ];
  98. return chunks.filter( filterEmptyLine ).join( '\n' );
  99. }
  100. function generateVertexExtensions( parameters ) {
  101. const chunks = [
  102. parameters.extensionClipCullDistance ? '#extension GL_ANGLE_clip_cull_distance : require' : '',
  103. parameters.extensionMultiDraw ? '#extension GL_ANGLE_multi_draw : require' : '',
  104. ];
  105. return chunks.filter( filterEmptyLine ).join( '\n' );
  106. }
  107. function generateDefines( defines ) {
  108. const chunks = [];
  109. for ( const name in defines ) {
  110. const value = defines[ name ];
  111. if ( value === false ) continue;
  112. chunks.push( '#define ' + name + ' ' + value );
  113. }
  114. return chunks.join( '\n' );
  115. }
  116. function fetchAttributeLocations( gl, program ) {
  117. const attributes = {};
  118. const n = gl.getProgramParameter( program, gl.ACTIVE_ATTRIBUTES );
  119. for ( let i = 0; i < n; i ++ ) {
  120. const info = gl.getActiveAttrib( program, i );
  121. const name = info.name;
  122. let locationSize = 1;
  123. if ( info.type === gl.FLOAT_MAT2 ) locationSize = 2;
  124. if ( info.type === gl.FLOAT_MAT3 ) locationSize = 3;
  125. if ( info.type === gl.FLOAT_MAT4 ) locationSize = 4;
  126. // console.log( 'THREE.WebGLProgram: ACTIVE VERTEX ATTRIBUTE:', name, i );
  127. attributes[ name ] = {
  128. type: info.type,
  129. location: gl.getAttribLocation( program, name ),
  130. locationSize: locationSize
  131. };
  132. }
  133. return attributes;
  134. }
  135. function filterEmptyLine( string ) {
  136. return string !== '';
  137. }
  138. function replaceLightNums( string, parameters ) {
  139. const numSpotLightCoords = parameters.numSpotLightShadows + parameters.numSpotLightMaps - parameters.numSpotLightShadowsWithMaps;
  140. return string
  141. .replace( /NUM_DIR_LIGHTS/g, parameters.numDirLights )
  142. .replace( /NUM_SPOT_LIGHTS/g, parameters.numSpotLights )
  143. .replace( /NUM_SPOT_LIGHT_MAPS/g, parameters.numSpotLightMaps )
  144. .replace( /NUM_SPOT_LIGHT_COORDS/g, numSpotLightCoords )
  145. .replace( /NUM_RECT_AREA_LIGHTS/g, parameters.numRectAreaLights )
  146. .replace( /NUM_POINT_LIGHTS/g, parameters.numPointLights )
  147. .replace( /NUM_HEMI_LIGHTS/g, parameters.numHemiLights )
  148. .replace( /NUM_DIR_LIGHT_SHADOWS/g, parameters.numDirLightShadows )
  149. .replace( /NUM_SPOT_LIGHT_SHADOWS_WITH_MAPS/g, parameters.numSpotLightShadowsWithMaps )
  150. .replace( /NUM_SPOT_LIGHT_SHADOWS/g, parameters.numSpotLightShadows )
  151. .replace( /NUM_POINT_LIGHT_SHADOWS/g, parameters.numPointLightShadows );
  152. }
  153. function replaceClippingPlaneNums( string, parameters ) {
  154. return string
  155. .replace( /NUM_CLIPPING_PLANES/g, parameters.numClippingPlanes )
  156. .replace( /UNION_CLIPPING_PLANES/g, ( parameters.numClippingPlanes - parameters.numClipIntersection ) );
  157. }
  158. // Resolve Includes
  159. const includePattern = /^[ \t]*#include +<([\w\d./]+)>/gm;
  160. function resolveIncludes( string ) {
  161. return string.replace( includePattern, includeReplacer );
  162. }
  163. const shaderChunkMap = new Map( [
  164. [ 'encodings_fragment', 'colorspace_fragment' ], // @deprecated, r154
  165. [ 'encodings_pars_fragment', 'colorspace_pars_fragment' ], // @deprecated, r154
  166. [ 'output_fragment', 'opaque_fragment' ], // @deprecated, r154
  167. ] );
  168. function includeReplacer( match, include ) {
  169. let string = ShaderChunk[ include ];
  170. if ( string === undefined ) {
  171. const newInclude = shaderChunkMap.get( include );
  172. if ( newInclude !== undefined ) {
  173. string = ShaderChunk[ newInclude ];
  174. console.warn( 'THREE.WebGLRenderer: Shader chunk "%s" has been deprecated. Use "%s" instead.', include, newInclude );
  175. } else {
  176. throw new Error( 'Can not resolve #include <' + include + '>' );
  177. }
  178. }
  179. return resolveIncludes( string );
  180. }
  181. // Unroll Loops
  182. const unrollLoopPattern = /#pragma unroll_loop_start\s+for\s*\(\s*int\s+i\s*=\s*(\d+)\s*;\s*i\s*<\s*(\d+)\s*;\s*i\s*\+\+\s*\)\s*{([\s\S]+?)}\s+#pragma unroll_loop_end/g;
  183. function unrollLoops( string ) {
  184. return string.replace( unrollLoopPattern, loopReplacer );
  185. }
  186. function loopReplacer( match, start, end, snippet ) {
  187. let string = '';
  188. for ( let i = parseInt( start ); i < parseInt( end ); i ++ ) {
  189. string += snippet
  190. .replace( /\[\s*i\s*\]/g, '[ ' + i + ' ]' )
  191. .replace( /UNROLLED_LOOP_INDEX/g, i );
  192. }
  193. return string;
  194. }
  195. //
  196. function generatePrecision( parameters ) {
  197. let precisionstring = `precision ${parameters.precision} float;
  198. precision ${parameters.precision} int;
  199. precision ${parameters.precision} sampler2D;
  200. precision ${parameters.precision} samplerCube;
  201. `;
  202. if ( parameters.isWebGL2 ) {
  203. precisionstring += `precision ${parameters.precision} sampler3D;
  204. precision ${parameters.precision} sampler2DArray;
  205. precision ${parameters.precision} sampler2DShadow;
  206. precision ${parameters.precision} samplerCubeShadow;
  207. precision ${parameters.precision} sampler2DArrayShadow;
  208. precision ${parameters.precision} isampler2D;
  209. precision ${parameters.precision} isampler3D;
  210. precision ${parameters.precision} isamplerCube;
  211. precision ${parameters.precision} isampler2DArray;
  212. precision ${parameters.precision} usampler2D;
  213. precision ${parameters.precision} usampler3D;
  214. precision ${parameters.precision} usamplerCube;
  215. precision ${parameters.precision} usampler2DArray;
  216. `;
  217. }
  218. if ( parameters.precision === 'highp' ) {
  219. precisionstring += '\n#define HIGH_PRECISION';
  220. } else if ( parameters.precision === 'mediump' ) {
  221. precisionstring += '\n#define MEDIUM_PRECISION';
  222. } else if ( parameters.precision === 'lowp' ) {
  223. precisionstring += '\n#define LOW_PRECISION';
  224. }
  225. return precisionstring;
  226. }
  227. function generateShadowMapTypeDefine( parameters ) {
  228. let shadowMapTypeDefine = 'SHADOWMAP_TYPE_BASIC';
  229. if ( parameters.shadowMapType === PCFShadowMap ) {
  230. shadowMapTypeDefine = 'SHADOWMAP_TYPE_PCF';
  231. } else if ( parameters.shadowMapType === PCFSoftShadowMap ) {
  232. shadowMapTypeDefine = 'SHADOWMAP_TYPE_PCF_SOFT';
  233. } else if ( parameters.shadowMapType === VSMShadowMap ) {
  234. shadowMapTypeDefine = 'SHADOWMAP_TYPE_VSM';
  235. }
  236. return shadowMapTypeDefine;
  237. }
  238. function generateEnvMapTypeDefine( parameters ) {
  239. let envMapTypeDefine = 'ENVMAP_TYPE_CUBE';
  240. if ( parameters.envMap ) {
  241. switch ( parameters.envMapMode ) {
  242. case CubeReflectionMapping:
  243. case CubeRefractionMapping:
  244. envMapTypeDefine = 'ENVMAP_TYPE_CUBE';
  245. break;
  246. case CubeUVReflectionMapping:
  247. envMapTypeDefine = 'ENVMAP_TYPE_CUBE_UV';
  248. break;
  249. }
  250. }
  251. return envMapTypeDefine;
  252. }
  253. function generateEnvMapModeDefine( parameters ) {
  254. let envMapModeDefine = 'ENVMAP_MODE_REFLECTION';
  255. if ( parameters.envMap ) {
  256. switch ( parameters.envMapMode ) {
  257. case CubeRefractionMapping:
  258. envMapModeDefine = 'ENVMAP_MODE_REFRACTION';
  259. break;
  260. }
  261. }
  262. return envMapModeDefine;
  263. }
  264. function generateEnvMapBlendingDefine( parameters ) {
  265. let envMapBlendingDefine = 'ENVMAP_BLENDING_NONE';
  266. if ( parameters.envMap ) {
  267. switch ( parameters.combine ) {
  268. case MultiplyOperation:
  269. envMapBlendingDefine = 'ENVMAP_BLENDING_MULTIPLY';
  270. break;
  271. case MixOperation:
  272. envMapBlendingDefine = 'ENVMAP_BLENDING_MIX';
  273. break;
  274. case AddOperation:
  275. envMapBlendingDefine = 'ENVMAP_BLENDING_ADD';
  276. break;
  277. }
  278. }
  279. return envMapBlendingDefine;
  280. }
  281. function generateCubeUVSize( parameters ) {
  282. const imageHeight = parameters.envMapCubeUVHeight;
  283. if ( imageHeight === null ) return null;
  284. const maxMip = Math.log2( imageHeight ) - 2;
  285. const texelHeight = 1.0 / imageHeight;
  286. const texelWidth = 1.0 / ( 3 * Math.max( Math.pow( 2, maxMip ), 7 * 16 ) );
  287. return { texelWidth, texelHeight, maxMip };
  288. }
  289. function WebGLProgram( renderer, cacheKey, parameters, bindingStates ) {
  290. // TODO Send this event to Three.js DevTools
  291. // console.log( 'WebGLProgram', cacheKey );
  292. const gl = renderer.getContext();
  293. const defines = parameters.defines;
  294. let vertexShader = parameters.vertexShader;
  295. let fragmentShader = parameters.fragmentShader;
  296. const shadowMapTypeDefine = generateShadowMapTypeDefine( parameters );
  297. const envMapTypeDefine = generateEnvMapTypeDefine( parameters );
  298. const envMapModeDefine = generateEnvMapModeDefine( parameters );
  299. const envMapBlendingDefine = generateEnvMapBlendingDefine( parameters );
  300. const envMapCubeUVSize = generateCubeUVSize( parameters );
  301. const customExtensions = parameters.isWebGL2 ? '' : generateExtensions( parameters );
  302. const customVertexExtensions = generateVertexExtensions( parameters );
  303. const customDefines = generateDefines( defines );
  304. const program = gl.createProgram();
  305. let prefixVertex, prefixFragment;
  306. let versionString = parameters.glslVersion ? '#version ' + parameters.glslVersion + '\n' : '';
  307. if ( parameters.isRawShaderMaterial ) {
  308. prefixVertex = [
  309. '#define SHADER_TYPE ' + parameters.shaderType,
  310. '#define SHADER_NAME ' + parameters.shaderName,
  311. customDefines
  312. ].filter( filterEmptyLine ).join( '\n' );
  313. if ( prefixVertex.length > 0 ) {
  314. prefixVertex += '\n';
  315. }
  316. prefixFragment = [
  317. customExtensions,
  318. '#define SHADER_TYPE ' + parameters.shaderType,
  319. '#define SHADER_NAME ' + parameters.shaderName,
  320. customDefines
  321. ].filter( filterEmptyLine ).join( '\n' );
  322. if ( prefixFragment.length > 0 ) {
  323. prefixFragment += '\n';
  324. }
  325. } else {
  326. prefixVertex = [
  327. generatePrecision( parameters ),
  328. '#define SHADER_TYPE ' + parameters.shaderType,
  329. '#define SHADER_NAME ' + parameters.shaderName,
  330. customDefines,
  331. parameters.extensionClipCullDistance ? '#define USE_CLIP_DISTANCE' : '',
  332. parameters.batching ? '#define USE_BATCHING' : '',
  333. parameters.instancing ? '#define USE_INSTANCING' : '',
  334. parameters.instancingColor ? '#define USE_INSTANCING_COLOR' : '',
  335. parameters.instancingMorph ? '#define USE_INSTANCING_MORPH' : '',
  336. parameters.useFog && parameters.fog ? '#define USE_FOG' : '',
  337. parameters.useFog && parameters.fogExp2 ? '#define FOG_EXP2' : '',
  338. parameters.map ? '#define USE_MAP' : '',
  339. parameters.envMap ? '#define USE_ENVMAP' : '',
  340. parameters.envMap ? '#define ' + envMapModeDefine : '',
  341. parameters.lightMap ? '#define USE_LIGHTMAP' : '',
  342. parameters.aoMap ? '#define USE_AOMAP' : '',
  343. parameters.bumpMap ? '#define USE_BUMPMAP' : '',
  344. parameters.normalMap ? '#define USE_NORMALMAP' : '',
  345. parameters.normalMapObjectSpace ? '#define USE_NORMALMAP_OBJECTSPACE' : '',
  346. parameters.normalMapTangentSpace ? '#define USE_NORMALMAP_TANGENTSPACE' : '',
  347. parameters.displacementMap ? '#define USE_DISPLACEMENTMAP' : '',
  348. parameters.emissiveMap ? '#define USE_EMISSIVEMAP' : '',
  349. parameters.anisotropy ? '#define USE_ANISOTROPY' : '',
  350. parameters.anisotropyMap ? '#define USE_ANISOTROPYMAP' : '',
  351. parameters.clearcoatMap ? '#define USE_CLEARCOATMAP' : '',
  352. parameters.clearcoatRoughnessMap ? '#define USE_CLEARCOAT_ROUGHNESSMAP' : '',
  353. parameters.clearcoatNormalMap ? '#define USE_CLEARCOAT_NORMALMAP' : '',
  354. parameters.iridescenceMap ? '#define USE_IRIDESCENCEMAP' : '',
  355. parameters.iridescenceThicknessMap ? '#define USE_IRIDESCENCE_THICKNESSMAP' : '',
  356. parameters.specularMap ? '#define USE_SPECULARMAP' : '',
  357. parameters.specularColorMap ? '#define USE_SPECULAR_COLORMAP' : '',
  358. parameters.specularIntensityMap ? '#define USE_SPECULAR_INTENSITYMAP' : '',
  359. parameters.roughnessMap ? '#define USE_ROUGHNESSMAP' : '',
  360. parameters.metalnessMap ? '#define USE_METALNESSMAP' : '',
  361. parameters.alphaMap ? '#define USE_ALPHAMAP' : '',
  362. parameters.alphaHash ? '#define USE_ALPHAHASH' : '',
  363. parameters.transmission ? '#define USE_TRANSMISSION' : '',
  364. parameters.transmissionMap ? '#define USE_TRANSMISSIONMAP' : '',
  365. parameters.thicknessMap ? '#define USE_THICKNESSMAP' : '',
  366. parameters.sheenColorMap ? '#define USE_SHEEN_COLORMAP' : '',
  367. parameters.sheenRoughnessMap ? '#define USE_SHEEN_ROUGHNESSMAP' : '',
  368. //
  369. parameters.mapUv ? '#define MAP_UV ' + parameters.mapUv : '',
  370. parameters.alphaMapUv ? '#define ALPHAMAP_UV ' + parameters.alphaMapUv : '',
  371. parameters.lightMapUv ? '#define LIGHTMAP_UV ' + parameters.lightMapUv : '',
  372. parameters.aoMapUv ? '#define AOMAP_UV ' + parameters.aoMapUv : '',
  373. parameters.emissiveMapUv ? '#define EMISSIVEMAP_UV ' + parameters.emissiveMapUv : '',
  374. parameters.bumpMapUv ? '#define BUMPMAP_UV ' + parameters.bumpMapUv : '',
  375. parameters.normalMapUv ? '#define NORMALMAP_UV ' + parameters.normalMapUv : '',
  376. parameters.displacementMapUv ? '#define DISPLACEMENTMAP_UV ' + parameters.displacementMapUv : '',
  377. parameters.metalnessMapUv ? '#define METALNESSMAP_UV ' + parameters.metalnessMapUv : '',
  378. parameters.roughnessMapUv ? '#define ROUGHNESSMAP_UV ' + parameters.roughnessMapUv : '',
  379. parameters.anisotropyMapUv ? '#define ANISOTROPYMAP_UV ' + parameters.anisotropyMapUv : '',
  380. parameters.clearcoatMapUv ? '#define CLEARCOATMAP_UV ' + parameters.clearcoatMapUv : '',
  381. parameters.clearcoatNormalMapUv ? '#define CLEARCOAT_NORMALMAP_UV ' + parameters.clearcoatNormalMapUv : '',
  382. parameters.clearcoatRoughnessMapUv ? '#define CLEARCOAT_ROUGHNESSMAP_UV ' + parameters.clearcoatRoughnessMapUv : '',
  383. parameters.iridescenceMapUv ? '#define IRIDESCENCEMAP_UV ' + parameters.iridescenceMapUv : '',
  384. parameters.iridescenceThicknessMapUv ? '#define IRIDESCENCE_THICKNESSMAP_UV ' + parameters.iridescenceThicknessMapUv : '',
  385. parameters.sheenColorMapUv ? '#define SHEEN_COLORMAP_UV ' + parameters.sheenColorMapUv : '',
  386. parameters.sheenRoughnessMapUv ? '#define SHEEN_ROUGHNESSMAP_UV ' + parameters.sheenRoughnessMapUv : '',
  387. parameters.specularMapUv ? '#define SPECULARMAP_UV ' + parameters.specularMapUv : '',
  388. parameters.specularColorMapUv ? '#define SPECULAR_COLORMAP_UV ' + parameters.specularColorMapUv : '',
  389. parameters.specularIntensityMapUv ? '#define SPECULAR_INTENSITYMAP_UV ' + parameters.specularIntensityMapUv : '',
  390. parameters.transmissionMapUv ? '#define TRANSMISSIONMAP_UV ' + parameters.transmissionMapUv : '',
  391. parameters.thicknessMapUv ? '#define THICKNESSMAP_UV ' + parameters.thicknessMapUv : '',
  392. //
  393. parameters.vertexTangents && parameters.flatShading === false ? '#define USE_TANGENT' : '',
  394. parameters.vertexColors ? '#define USE_COLOR' : '',
  395. parameters.vertexAlphas ? '#define USE_COLOR_ALPHA' : '',
  396. parameters.vertexUv1s ? '#define USE_UV1' : '',
  397. parameters.vertexUv2s ? '#define USE_UV2' : '',
  398. parameters.vertexUv3s ? '#define USE_UV3' : '',
  399. parameters.pointsUvs ? '#define USE_POINTS_UV' : '',
  400. parameters.flatShading ? '#define FLAT_SHADED' : '',
  401. parameters.skinning ? '#define USE_SKINNING' : '',
  402. parameters.morphTargets ? '#define USE_MORPHTARGETS' : '',
  403. parameters.morphNormals && parameters.flatShading === false ? '#define USE_MORPHNORMALS' : '',
  404. ( parameters.morphColors && parameters.isWebGL2 ) ? '#define USE_MORPHCOLORS' : '',
  405. ( parameters.morphTargetsCount > 0 && parameters.isWebGL2 ) ? '#define MORPHTARGETS_TEXTURE' : '',
  406. ( parameters.morphTargetsCount > 0 && parameters.isWebGL2 ) ? '#define MORPHTARGETS_TEXTURE_STRIDE ' + parameters.morphTextureStride : '',
  407. ( parameters.morphTargetsCount > 0 && parameters.isWebGL2 ) ? '#define MORPHTARGETS_COUNT ' + parameters.morphTargetsCount : '',
  408. parameters.doubleSided ? '#define DOUBLE_SIDED' : '',
  409. parameters.flipSided ? '#define FLIP_SIDED' : '',
  410. parameters.shadowMapEnabled ? '#define USE_SHADOWMAP' : '',
  411. parameters.shadowMapEnabled ? '#define ' + shadowMapTypeDefine : '',
  412. parameters.sizeAttenuation ? '#define USE_SIZEATTENUATION' : '',
  413. parameters.numLightProbes > 0 ? '#define USE_LIGHT_PROBES' : '',
  414. parameters.useLegacyLights ? '#define LEGACY_LIGHTS' : '',
  415. parameters.logarithmicDepthBuffer ? '#define USE_LOGDEPTHBUF' : '',
  416. ( parameters.logarithmicDepthBuffer && parameters.rendererExtensionFragDepth ) ? '#define USE_LOGDEPTHBUF_EXT' : '',
  417. 'uniform mat4 modelMatrix;',
  418. 'uniform mat4 modelViewMatrix;',
  419. 'uniform mat4 projectionMatrix;',
  420. 'uniform mat4 viewMatrix;',
  421. 'uniform mat3 normalMatrix;',
  422. 'uniform vec3 cameraPosition;',
  423. 'uniform bool isOrthographic;',
  424. '#ifdef USE_INSTANCING',
  425. ' attribute mat4 instanceMatrix;',
  426. '#endif',
  427. '#ifdef USE_INSTANCING_COLOR',
  428. ' attribute vec3 instanceColor;',
  429. '#endif',
  430. '#ifdef USE_INSTANCING_MORPH',
  431. ' uniform sampler2D morphTexture;',
  432. '#endif',
  433. 'attribute vec3 position;',
  434. 'attribute vec3 normal;',
  435. 'attribute vec2 uv;',
  436. '#ifdef USE_UV1',
  437. ' attribute vec2 uv1;',
  438. '#endif',
  439. '#ifdef USE_UV2',
  440. ' attribute vec2 uv2;',
  441. '#endif',
  442. '#ifdef USE_UV3',
  443. ' attribute vec2 uv3;',
  444. '#endif',
  445. '#ifdef USE_TANGENT',
  446. ' attribute vec4 tangent;',
  447. '#endif',
  448. '#if defined( USE_COLOR_ALPHA )',
  449. ' attribute vec4 color;',
  450. '#elif defined( USE_COLOR )',
  451. ' attribute vec3 color;',
  452. '#endif',
  453. '#if ( defined( USE_MORPHTARGETS ) && ! defined( MORPHTARGETS_TEXTURE ) )',
  454. ' attribute vec3 morphTarget0;',
  455. ' attribute vec3 morphTarget1;',
  456. ' attribute vec3 morphTarget2;',
  457. ' attribute vec3 morphTarget3;',
  458. ' #ifdef USE_MORPHNORMALS',
  459. ' attribute vec3 morphNormal0;',
  460. ' attribute vec3 morphNormal1;',
  461. ' attribute vec3 morphNormal2;',
  462. ' attribute vec3 morphNormal3;',
  463. ' #else',
  464. ' attribute vec3 morphTarget4;',
  465. ' attribute vec3 morphTarget5;',
  466. ' attribute vec3 morphTarget6;',
  467. ' attribute vec3 morphTarget7;',
  468. ' #endif',
  469. '#endif',
  470. '#ifdef USE_SKINNING',
  471. ' attribute vec4 skinIndex;',
  472. ' attribute vec4 skinWeight;',
  473. '#endif',
  474. '\n'
  475. ].filter( filterEmptyLine ).join( '\n' );
  476. prefixFragment = [
  477. customExtensions,
  478. generatePrecision( parameters ),
  479. '#define SHADER_TYPE ' + parameters.shaderType,
  480. '#define SHADER_NAME ' + parameters.shaderName,
  481. customDefines,
  482. parameters.useFog && parameters.fog ? '#define USE_FOG' : '',
  483. parameters.useFog && parameters.fogExp2 ? '#define FOG_EXP2' : '',
  484. parameters.alphaToCoverage ? '#define ALPHA_TO_COVERAGE' : '',
  485. parameters.map ? '#define USE_MAP' : '',
  486. parameters.matcap ? '#define USE_MATCAP' : '',
  487. parameters.envMap ? '#define USE_ENVMAP' : '',
  488. parameters.envMap ? '#define ' + envMapTypeDefine : '',
  489. parameters.envMap ? '#define ' + envMapModeDefine : '',
  490. parameters.envMap ? '#define ' + envMapBlendingDefine : '',
  491. envMapCubeUVSize ? '#define CUBEUV_TEXEL_WIDTH ' + envMapCubeUVSize.texelWidth : '',
  492. envMapCubeUVSize ? '#define CUBEUV_TEXEL_HEIGHT ' + envMapCubeUVSize.texelHeight : '',
  493. envMapCubeUVSize ? '#define CUBEUV_MAX_MIP ' + envMapCubeUVSize.maxMip + '.0' : '',
  494. parameters.lightMap ? '#define USE_LIGHTMAP' : '',
  495. parameters.aoMap ? '#define USE_AOMAP' : '',
  496. parameters.bumpMap ? '#define USE_BUMPMAP' : '',
  497. parameters.normalMap ? '#define USE_NORMALMAP' : '',
  498. parameters.normalMapObjectSpace ? '#define USE_NORMALMAP_OBJECTSPACE' : '',
  499. parameters.normalMapTangentSpace ? '#define USE_NORMALMAP_TANGENTSPACE' : '',
  500. parameters.emissiveMap ? '#define USE_EMISSIVEMAP' : '',
  501. parameters.anisotropy ? '#define USE_ANISOTROPY' : '',
  502. parameters.anisotropyMap ? '#define USE_ANISOTROPYMAP' : '',
  503. parameters.clearcoat ? '#define USE_CLEARCOAT' : '',
  504. parameters.clearcoatMap ? '#define USE_CLEARCOATMAP' : '',
  505. parameters.clearcoatRoughnessMap ? '#define USE_CLEARCOAT_ROUGHNESSMAP' : '',
  506. parameters.clearcoatNormalMap ? '#define USE_CLEARCOAT_NORMALMAP' : '',
  507. parameters.iridescence ? '#define USE_IRIDESCENCE' : '',
  508. parameters.iridescenceMap ? '#define USE_IRIDESCENCEMAP' : '',
  509. parameters.iridescenceThicknessMap ? '#define USE_IRIDESCENCE_THICKNESSMAP' : '',
  510. parameters.specularMap ? '#define USE_SPECULARMAP' : '',
  511. parameters.specularColorMap ? '#define USE_SPECULAR_COLORMAP' : '',
  512. parameters.specularIntensityMap ? '#define USE_SPECULAR_INTENSITYMAP' : '',
  513. parameters.roughnessMap ? '#define USE_ROUGHNESSMAP' : '',
  514. parameters.metalnessMap ? '#define USE_METALNESSMAP' : '',
  515. parameters.alphaMap ? '#define USE_ALPHAMAP' : '',
  516. parameters.alphaTest ? '#define USE_ALPHATEST' : '',
  517. parameters.alphaHash ? '#define USE_ALPHAHASH' : '',
  518. parameters.sheen ? '#define USE_SHEEN' : '',
  519. parameters.sheenColorMap ? '#define USE_SHEEN_COLORMAP' : '',
  520. parameters.sheenRoughnessMap ? '#define USE_SHEEN_ROUGHNESSMAP' : '',
  521. parameters.transmission ? '#define USE_TRANSMISSION' : '',
  522. parameters.transmissionMap ? '#define USE_TRANSMISSIONMAP' : '',
  523. parameters.thicknessMap ? '#define USE_THICKNESSMAP' : '',
  524. parameters.vertexTangents && parameters.flatShading === false ? '#define USE_TANGENT' : '',
  525. parameters.vertexColors || parameters.instancingColor ? '#define USE_COLOR' : '',
  526. parameters.vertexAlphas ? '#define USE_COLOR_ALPHA' : '',
  527. parameters.vertexUv1s ? '#define USE_UV1' : '',
  528. parameters.vertexUv2s ? '#define USE_UV2' : '',
  529. parameters.vertexUv3s ? '#define USE_UV3' : '',
  530. parameters.pointsUvs ? '#define USE_POINTS_UV' : '',
  531. parameters.gradientMap ? '#define USE_GRADIENTMAP' : '',
  532. parameters.flatShading ? '#define FLAT_SHADED' : '',
  533. parameters.doubleSided ? '#define DOUBLE_SIDED' : '',
  534. parameters.flipSided ? '#define FLIP_SIDED' : '',
  535. parameters.shadowMapEnabled ? '#define USE_SHADOWMAP' : '',
  536. parameters.shadowMapEnabled ? '#define ' + shadowMapTypeDefine : '',
  537. parameters.premultipliedAlpha ? '#define PREMULTIPLIED_ALPHA' : '',
  538. parameters.numLightProbes > 0 ? '#define USE_LIGHT_PROBES' : '',
  539. parameters.useLegacyLights ? '#define LEGACY_LIGHTS' : '',
  540. parameters.decodeVideoTexture ? '#define DECODE_VIDEO_TEXTURE' : '',
  541. parameters.logarithmicDepthBuffer ? '#define USE_LOGDEPTHBUF' : '',
  542. ( parameters.logarithmicDepthBuffer && parameters.rendererExtensionFragDepth ) ? '#define USE_LOGDEPTHBUF_EXT' : '',
  543. 'uniform mat4 viewMatrix;',
  544. 'uniform vec3 cameraPosition;',
  545. 'uniform bool isOrthographic;',
  546. ( parameters.toneMapping !== NoToneMapping ) ? '#define TONE_MAPPING' : '',
  547. ( parameters.toneMapping !== NoToneMapping ) ? ShaderChunk[ 'tonemapping_pars_fragment' ] : '', // this code is required here because it is used by the toneMapping() function defined below
  548. ( parameters.toneMapping !== NoToneMapping ) ? getToneMappingFunction( 'toneMapping', parameters.toneMapping ) : '',
  549. parameters.dithering ? '#define DITHERING' : '',
  550. parameters.opaque ? '#define OPAQUE' : '',
  551. ShaderChunk[ 'colorspace_pars_fragment' ], // this code is required here because it is used by the various encoding/decoding function defined below
  552. getTexelEncodingFunction( 'linearToOutputTexel', parameters.outputColorSpace ),
  553. parameters.useDepthPacking ? '#define DEPTH_PACKING ' + parameters.depthPacking : '',
  554. '\n'
  555. ].filter( filterEmptyLine ).join( '\n' );
  556. }
  557. vertexShader = resolveIncludes( vertexShader );
  558. vertexShader = replaceLightNums( vertexShader, parameters );
  559. vertexShader = replaceClippingPlaneNums( vertexShader, parameters );
  560. fragmentShader = resolveIncludes( fragmentShader );
  561. fragmentShader = replaceLightNums( fragmentShader, parameters );
  562. fragmentShader = replaceClippingPlaneNums( fragmentShader, parameters );
  563. vertexShader = unrollLoops( vertexShader );
  564. fragmentShader = unrollLoops( fragmentShader );
  565. if ( parameters.isWebGL2 && parameters.isRawShaderMaterial !== true ) {
  566. // GLSL 3.0 conversion for built-in materials and ShaderMaterial
  567. versionString = '#version 300 es\n';
  568. prefixVertex = [
  569. customVertexExtensions,
  570. 'precision mediump sampler2DArray;',
  571. '#define attribute in',
  572. '#define varying out',
  573. '#define texture2D texture'
  574. ].join( '\n' ) + '\n' + prefixVertex;
  575. prefixFragment = [
  576. 'precision mediump sampler2DArray;',
  577. '#define varying in',
  578. ( parameters.glslVersion === GLSL3 ) ? '' : 'layout(location = 0) out highp vec4 pc_fragColor;',
  579. ( parameters.glslVersion === GLSL3 ) ? '' : '#define gl_FragColor pc_fragColor',
  580. '#define gl_FragDepthEXT gl_FragDepth',
  581. '#define texture2D texture',
  582. '#define textureCube texture',
  583. '#define texture2DProj textureProj',
  584. '#define texture2DLodEXT textureLod',
  585. '#define texture2DProjLodEXT textureProjLod',
  586. '#define textureCubeLodEXT textureLod',
  587. '#define texture2DGradEXT textureGrad',
  588. '#define texture2DProjGradEXT textureProjGrad',
  589. '#define textureCubeGradEXT textureGrad'
  590. ].join( '\n' ) + '\n' + prefixFragment;
  591. }
  592. const vertexGlsl = versionString + prefixVertex + vertexShader;
  593. const fragmentGlsl = versionString + prefixFragment + fragmentShader;
  594. // console.log( '*VERTEX*', vertexGlsl );
  595. // console.log( '*FRAGMENT*', fragmentGlsl );
  596. const glVertexShader = WebGLShader( gl, gl.VERTEX_SHADER, vertexGlsl );
  597. const glFragmentShader = WebGLShader( gl, gl.FRAGMENT_SHADER, fragmentGlsl );
  598. gl.attachShader( program, glVertexShader );
  599. gl.attachShader( program, glFragmentShader );
  600. // Force a particular attribute to index 0.
  601. if ( parameters.index0AttributeName !== undefined ) {
  602. gl.bindAttribLocation( program, 0, parameters.index0AttributeName );
  603. } else if ( parameters.morphTargets === true ) {
  604. // programs with morphTargets displace position out of attribute 0
  605. gl.bindAttribLocation( program, 0, 'position' );
  606. }
  607. gl.linkProgram( program );
  608. function onFirstUse( self ) {
  609. // check for link errors
  610. if ( renderer.debug.checkShaderErrors ) {
  611. const programLog = gl.getProgramInfoLog( program ).trim();
  612. const vertexLog = gl.getShaderInfoLog( glVertexShader ).trim();
  613. const fragmentLog = gl.getShaderInfoLog( glFragmentShader ).trim();
  614. let runnable = true;
  615. let haveDiagnostics = true;
  616. if ( gl.getProgramParameter( program, gl.LINK_STATUS ) === false ) {
  617. runnable = false;
  618. if ( typeof renderer.debug.onShaderError === 'function' ) {
  619. renderer.debug.onShaderError( gl, program, glVertexShader, glFragmentShader );
  620. } else {
  621. // default error reporting
  622. const vertexErrors = getShaderErrors( gl, glVertexShader, 'vertex' );
  623. const fragmentErrors = getShaderErrors( gl, glFragmentShader, 'fragment' );
  624. console.error(
  625. 'THREE.WebGLProgram: Shader Error ' + gl.getError() + ' - ' +
  626. 'VALIDATE_STATUS ' + gl.getProgramParameter( program, gl.VALIDATE_STATUS ) + '\n\n' +
  627. 'Material Name: ' + self.name + '\n' +
  628. 'Material Type: ' + self.type + '\n\n' +
  629. 'Program Info Log: ' + programLog + '\n' +
  630. vertexErrors + '\n' +
  631. fragmentErrors
  632. );
  633. }
  634. } else if ( programLog !== '' ) {
  635. console.warn( 'THREE.WebGLProgram: Program Info Log:', programLog );
  636. } else if ( vertexLog === '' || fragmentLog === '' ) {
  637. haveDiagnostics = false;
  638. }
  639. if ( haveDiagnostics ) {
  640. self.diagnostics = {
  641. runnable: runnable,
  642. programLog: programLog,
  643. vertexShader: {
  644. log: vertexLog,
  645. prefix: prefixVertex
  646. },
  647. fragmentShader: {
  648. log: fragmentLog,
  649. prefix: prefixFragment
  650. }
  651. };
  652. }
  653. }
  654. // Clean up
  655. // Crashes in iOS9 and iOS10. #18402
  656. // gl.detachShader( program, glVertexShader );
  657. // gl.detachShader( program, glFragmentShader );
  658. gl.deleteShader( glVertexShader );
  659. gl.deleteShader( glFragmentShader );
  660. cachedUniforms = new WebGLUniforms( gl, program );
  661. cachedAttributes = fetchAttributeLocations( gl, program );
  662. }
  663. // set up caching for uniform locations
  664. let cachedUniforms;
  665. this.getUniforms = function () {
  666. if ( cachedUniforms === undefined ) {
  667. // Populates cachedUniforms and cachedAttributes
  668. onFirstUse( this );
  669. }
  670. return cachedUniforms;
  671. };
  672. // set up caching for attribute locations
  673. let cachedAttributes;
  674. this.getAttributes = function () {
  675. if ( cachedAttributes === undefined ) {
  676. // Populates cachedAttributes and cachedUniforms
  677. onFirstUse( this );
  678. }
  679. return cachedAttributes;
  680. };
  681. // indicate when the program is ready to be used. if the KHR_parallel_shader_compile extension isn't supported,
  682. // flag the program as ready immediately. It may cause a stall when it's first used.
  683. let programReady = ( parameters.rendererExtensionParallelShaderCompile === false );
  684. this.isReady = function () {
  685. if ( programReady === false ) {
  686. programReady = gl.getProgramParameter( program, COMPLETION_STATUS_KHR );
  687. }
  688. return programReady;
  689. };
  690. // free resource
  691. this.destroy = function () {
  692. bindingStates.releaseStatesOfProgram( this );
  693. gl.deleteProgram( program );
  694. this.program = undefined;
  695. };
  696. //
  697. this.type = parameters.shaderType;
  698. this.name = parameters.shaderName;
  699. this.id = programIdCount ++;
  700. this.cacheKey = cacheKey;
  701. this.usedTimes = 1;
  702. this.program = program;
  703. this.vertexShader = glVertexShader;
  704. this.fragmentShader = glFragmentShader;
  705. return this;
  706. }
  707. export { WebGLProgram };