thinEngine.ts 173 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322
  1. import { EngineStore } from './engineStore';
  2. import { IInternalTextureLoader } from '../Materials/Textures/internalTextureLoader';
  3. import { Effect, IEffectCreationOptions } from '../Materials/effect';
  4. import { _DevTools } from '../Misc/devTools';
  5. import { IShaderProcessor } from './Processors/iShaderProcessor';
  6. import { UniformBuffer } from '../Materials/uniformBuffer';
  7. import { Nullable, DataArray, IndicesArray } from '../types';
  8. import { EngineCapabilities } from './engineCapabilities';
  9. import { Observable } from '../Misc/observable';
  10. import { DepthCullingState } from '../States/depthCullingState';
  11. import { StencilState } from '../States/stencilState';
  12. import { AlphaState } from '../States/alphaCullingState';
  13. import { Constants } from './constants';
  14. import { InternalTexture, InternalTextureSource } from '../Materials/Textures/internalTexture';
  15. import { IViewportLike, IColor4Like } from '../Maths/math.like';
  16. import { DataBuffer } from '../Meshes/dataBuffer';
  17. import { IFileRequest } from '../Misc/fileRequest';
  18. import { Logger } from '../Misc/logger';
  19. import { DomManagement } from '../Misc/domManagement';
  20. import { WebGL2ShaderProcessor } from './WebGL/webGL2ShaderProcessors';
  21. import { WebGLDataBuffer } from '../Meshes/WebGL/webGLDataBuffer';
  22. import { IPipelineContext } from './IPipelineContext';
  23. import { WebGLPipelineContext } from './WebGL/webGLPipelineContext';
  24. import { VertexBuffer } from '../Meshes/buffer';
  25. import { InstancingAttributeInfo } from './instancingAttributeInfo';
  26. import { FileTools } from '../Misc/fileTools';
  27. import { BaseTexture } from '../Materials/Textures/baseTexture';
  28. import { IOfflineProvider } from '../Offline/IOfflineProvider';
  29. import { IEffectFallbacks } from '../Materials/iEffectFallbacks';
  30. import { IWebRequest } from '../Misc/interfaces/iWebRequest';
  31. import { CanvasGenerator } from '../Misc/canvasGenerator';
  32. declare type Observer<T> = import("../Misc/observable").Observer<T>;
  33. declare type VideoTexture = import("../Materials/Textures/videoTexture").VideoTexture;
  34. declare type RenderTargetTexture = import("../Materials/Textures/renderTargetTexture").RenderTargetTexture;
  35. declare type Texture = import("../Materials/Textures/texture").Texture;
  36. /**
  37. * Defines the interface used by objects working like Scene
  38. * @hidden
  39. */
  40. interface ISceneLike {
  41. _addPendingData(data: any): void;
  42. _removePendingData(data: any): void;
  43. offlineProvider: IOfflineProvider;
  44. }
  45. /**
  46. * Keeps track of all the buffer info used in engine.
  47. */
  48. class BufferPointer {
  49. public active: boolean;
  50. public index: number;
  51. public size: number;
  52. public type: number;
  53. public normalized: boolean;
  54. public stride: number;
  55. public offset: number;
  56. public buffer: WebGLBuffer;
  57. }
  58. /** Interface defining initialization parameters for Engine class */
  59. export interface EngineOptions extends WebGLContextAttributes {
  60. /**
  61. * Defines if the engine should no exceed a specified device ratio
  62. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  63. */
  64. limitDeviceRatio?: number;
  65. /**
  66. * Defines if webvr should be enabled automatically
  67. * @see http://doc.babylonjs.com/how_to/webvr_camera
  68. */
  69. autoEnableWebVR?: boolean;
  70. /**
  71. * Defines if webgl2 should be turned off even if supported
  72. * @see http://doc.babylonjs.com/features/webgl2
  73. */
  74. disableWebGL2Support?: boolean;
  75. /**
  76. * Defines if webaudio should be initialized as well
  77. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  78. */
  79. audioEngine?: boolean;
  80. /**
  81. * Defines if animations should run using a deterministic lock step
  82. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  83. */
  84. deterministicLockstep?: boolean;
  85. /** Defines the maximum steps to use with deterministic lock step mode */
  86. lockstepMaxSteps?: number;
  87. /** Defines the seconds between each deterministic lock step */
  88. timeStep?: number;
  89. /**
  90. * Defines that engine should ignore context lost events
  91. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  92. */
  93. doNotHandleContextLost?: boolean;
  94. /**
  95. * Defines that engine should ignore modifying touch action attribute and style
  96. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  97. */
  98. doNotHandleTouchAction?: boolean;
  99. /**
  100. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  101. */
  102. useHighPrecisionFloats?: boolean;
  103. }
  104. /**
  105. * The base engine class (root of all engines)
  106. */
  107. export class ThinEngine {
  108. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  109. public static ExceptionList = [
  110. { key: "Chrome\/63\.0", capture: "63\\.0\\.3239\\.(\\d+)", captureConstraint: 108, targets: ["uniformBuffer"] },
  111. { key: "Firefox\/58", capture: null, captureConstraint: null, targets: ["uniformBuffer"] },
  112. { key: "Firefox\/59", capture: null, captureConstraint: null, targets: ["uniformBuffer"] },
  113. { key: "Chrome\/72.+?Mobile", capture: null, captureConstraint: null, targets: ["vao"] },
  114. { key: "Chrome\/73.+?Mobile", capture: null, captureConstraint: null, targets: ["vao"] },
  115. { key: "Chrome\/74.+?Mobile", capture: null, captureConstraint: null, targets: ["vao"] },
  116. { key: "Mac OS.+Chrome\/71", capture: null, captureConstraint: null, targets: ["vao"] },
  117. { key: "Mac OS.+Chrome\/72", capture: null, captureConstraint: null, targets: ["vao"] }
  118. ];
  119. /** @hidden */
  120. public static _TextureLoaders: IInternalTextureLoader[] = [];
  121. /**
  122. * Returns the current npm package of the sdk
  123. */
  124. // Not mixed with Version for tooling purpose.
  125. public static get NpmPackage(): string {
  126. return "babylonjs@4.1.0-beta.9";
  127. }
  128. /**
  129. * Returns the current version of the framework
  130. */
  131. public static get Version(): string {
  132. return "4.1.0-beta.9";
  133. }
  134. /**
  135. * Returns a string describing the current engine
  136. */
  137. public get description(): string {
  138. let description = "WebGL" + this.webGLVersion;
  139. if (this._caps.parallelShaderCompile) {
  140. description += " - Parallel shader compilation";
  141. }
  142. return description;
  143. }
  144. // Updatable statics so stick with vars here
  145. /**
  146. * Gets or sets the epsilon value used by collision engine
  147. */
  148. public static CollisionsEpsilon = 0.001;
  149. /**
  150. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  151. */
  152. public static get ShadersRepository(): string {
  153. return Effect.ShadersRepository;
  154. }
  155. public static set ShadersRepository(value: string) {
  156. Effect.ShadersRepository = value;
  157. }
  158. /**
  159. * Gets or sets the textures that the engine should not attempt to load as compressed
  160. */
  161. protected _excludedCompressedTextures: string[] = [];
  162. /**
  163. * Filters the compressed texture formats to only include
  164. * files that are not included in the skippable list
  165. *
  166. * @param url the current extension
  167. * @param textureFormatInUse the current compressed texture format
  168. * @returns "format" string
  169. */
  170. public excludedCompressedTextureFormats(url: Nullable<string>, textureFormatInUse: Nullable<string>): Nullable<string> {
  171. const skipCompression = (): boolean => {
  172. return this._excludedCompressedTextures.some((entry) => {
  173. const strRegExPattern: string = '\\b' + entry + '\\b';
  174. return (url && (url === entry || url.match(new RegExp(strRegExPattern, 'g'))));
  175. });
  176. };
  177. return skipCompression() ? null : textureFormatInUse;
  178. }
  179. // Public members
  180. /** @hidden */
  181. public _shaderProcessor: IShaderProcessor;
  182. /**
  183. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  184. */
  185. public forcePOTTextures = false;
  186. /**
  187. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  188. */
  189. public isFullscreen = false;
  190. /**
  191. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  192. */
  193. public cullBackFaces = true;
  194. /**
  195. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  196. */
  197. public renderEvenInBackground = true;
  198. /**
  199. * Gets or sets a boolean indicating that cache can be kept between frames
  200. */
  201. public preventCacheWipeBetweenFrames = false;
  202. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  203. public validateShaderPrograms = false;
  204. /**
  205. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  206. * This can provide greater z depth for distant objects.
  207. */
  208. public useReverseDepthBuffer = false;
  209. // Uniform buffers list
  210. /**
  211. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  212. */
  213. public disableUniformBuffers = false;
  214. /** @hidden */
  215. public _uniformBuffers = new Array<UniformBuffer>();
  216. /**
  217. * Gets a boolean indicating that the engine supports uniform buffers
  218. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  219. */
  220. public get supportsUniformBuffers(): boolean {
  221. return this.webGLVersion > 1 && !this.disableUniformBuffers;
  222. }
  223. // Private Members
  224. /** @hidden */
  225. public _gl: WebGLRenderingContext;
  226. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  227. protected _windowIsBackground = false;
  228. protected _webGLVersion = 1.0;
  229. protected _creationOptions: EngineOptions;
  230. protected _highPrecisionShadersAllowed = true;
  231. /** @hidden */
  232. public get _shouldUseHighPrecisionShader(): boolean {
  233. return !!(this._caps.highPrecisionShaderSupported && this._highPrecisionShadersAllowed);
  234. }
  235. /**
  236. * Gets a boolean indicating that only power of 2 textures are supported
  237. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  238. */
  239. public get needPOTTextures(): boolean {
  240. return this._webGLVersion < 2 || this.forcePOTTextures;
  241. }
  242. /** @hidden */
  243. public _badOS = false;
  244. /** @hidden */
  245. public _badDesktopOS = false;
  246. private _hardwareScalingLevel: number;
  247. /** @hidden */
  248. public _caps: EngineCapabilities;
  249. private _isStencilEnable: boolean;
  250. private _glVersion: string;
  251. private _glRenderer: string;
  252. private _glVendor: string;
  253. /** @hidden */
  254. public _videoTextureSupported: boolean;
  255. protected _renderingQueueLaunched = false;
  256. protected _activeRenderLoops = new Array<() => void>();
  257. // Lost context
  258. /**
  259. * Observable signaled when a context lost event is raised
  260. */
  261. public onContextLostObservable = new Observable<ThinEngine>();
  262. /**
  263. * Observable signaled when a context restored event is raised
  264. */
  265. public onContextRestoredObservable = new Observable<ThinEngine>();
  266. private _onContextLost: (evt: Event) => void;
  267. private _onContextRestored: (evt: Event) => void;
  268. protected _contextWasLost = false;
  269. /** @hidden */
  270. public _doNotHandleContextLost = false;
  271. /**
  272. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  273. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  274. */
  275. public get doNotHandleContextLost(): boolean {
  276. return this._doNotHandleContextLost;
  277. }
  278. public set doNotHandleContextLost(value: boolean) {
  279. this._doNotHandleContextLost = value;
  280. }
  281. /**
  282. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  283. */
  284. public disableVertexArrayObjects = false;
  285. // States
  286. /** @hidden */
  287. protected _colorWrite = true;
  288. /** @hidden */
  289. protected _colorWriteChanged = true;
  290. /** @hidden */
  291. protected _depthCullingState = new DepthCullingState();
  292. /** @hidden */
  293. protected _stencilState = new StencilState();
  294. /** @hidden */
  295. public _alphaState = new AlphaState();
  296. /** @hidden */
  297. public _alphaMode = Constants.ALPHA_ADD;
  298. /** @hidden */
  299. public _alphaEquation = Constants.ALPHA_DISABLE;
  300. // Cache
  301. /** @hidden */
  302. public _internalTexturesCache = new Array<InternalTexture>();
  303. /** @hidden */
  304. protected _activeChannel = 0;
  305. private _currentTextureChannel = -1;
  306. /** @hidden */
  307. protected _boundTexturesCache: { [key: string]: Nullable<InternalTexture> } = {};
  308. /** @hidden */
  309. protected _currentEffect: Nullable<Effect>;
  310. /** @hidden */
  311. protected _currentProgram: Nullable<WebGLProgram>;
  312. private _compiledEffects: { [key: string]: Effect } = {};
  313. private _vertexAttribArraysEnabled: boolean[] = [];
  314. /** @hidden */
  315. protected _cachedViewport: Nullable<IViewportLike>;
  316. private _cachedVertexArrayObject: Nullable<WebGLVertexArrayObject>;
  317. /** @hidden */
  318. protected _cachedVertexBuffers: any;
  319. /** @hidden */
  320. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  321. /** @hidden */
  322. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  323. /** @hidden */
  324. public _currentRenderTarget: Nullable<InternalTexture>;
  325. private _uintIndicesCurrentlySet = false;
  326. protected _currentBoundBuffer = new Array<Nullable<WebGLBuffer>>();
  327. /** @hidden */
  328. protected _currentFramebuffer: Nullable<WebGLFramebuffer> = null;
  329. private _currentBufferPointers = new Array<BufferPointer>();
  330. private _currentInstanceLocations = new Array<number>();
  331. private _currentInstanceBuffers = new Array<DataBuffer>();
  332. private _textureUnits: Int32Array;
  333. /** @hidden */
  334. public _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  335. /** @hidden */
  336. public _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  337. /** @hidden */
  338. public _boundRenderFunction: any;
  339. private _vaoRecordInProgress = false;
  340. private _mustWipeVertexAttributes = false;
  341. private _emptyTexture: Nullable<InternalTexture>;
  342. private _emptyCubeTexture: Nullable<InternalTexture>;
  343. private _emptyTexture3D: Nullable<InternalTexture>;
  344. private _emptyTexture2DArray: Nullable<InternalTexture>;
  345. /** @hidden */
  346. public _frameHandler: number;
  347. private _nextFreeTextureSlots = new Array<number>();
  348. private _maxSimultaneousTextures = 0;
  349. private _activeRequests = new Array<IFileRequest>();
  350. // Hardware supported Compressed Textures
  351. protected _texturesSupported = new Array<string>();
  352. /** @hidden */
  353. public _textureFormatInUse: Nullable<string>;
  354. protected get _supportsHardwareTextureRescaling() {
  355. return false;
  356. }
  357. /**
  358. * Gets the list of texture formats supported
  359. */
  360. public get texturesSupported(): Array<string> {
  361. return this._texturesSupported;
  362. }
  363. /**
  364. * Gets the list of texture formats in use
  365. */
  366. public get textureFormatInUse(): Nullable<string> {
  367. return this._textureFormatInUse;
  368. }
  369. /**
  370. * Gets the current viewport
  371. */
  372. public get currentViewport(): Nullable<IViewportLike> {
  373. return this._cachedViewport;
  374. }
  375. /**
  376. * Gets the default empty texture
  377. */
  378. public get emptyTexture(): InternalTexture {
  379. if (!this._emptyTexture) {
  380. this._emptyTexture = this.createRawTexture(new Uint8Array(4), 1, 1, Constants.TEXTUREFORMAT_RGBA, false, false, Constants.TEXTURE_NEAREST_SAMPLINGMODE);
  381. }
  382. return this._emptyTexture;
  383. }
  384. /**
  385. * Gets the default empty 3D texture
  386. */
  387. public get emptyTexture3D(): InternalTexture {
  388. if (!this._emptyTexture3D) {
  389. this._emptyTexture3D = this.createRawTexture3D(new Uint8Array(4), 1, 1, 1, Constants.TEXTUREFORMAT_RGBA, false, false, Constants.TEXTURE_NEAREST_SAMPLINGMODE);
  390. }
  391. return this._emptyTexture3D;
  392. }
  393. /**
  394. * Gets the default empty 2D array texture
  395. */
  396. public get emptyTexture2DArray(): InternalTexture {
  397. if (!this._emptyTexture2DArray) {
  398. this._emptyTexture2DArray = this.createRawTexture2DArray(new Uint8Array(4), 1, 1, 1, Constants.TEXTUREFORMAT_RGBA, false, false, Constants.TEXTURE_NEAREST_SAMPLINGMODE);
  399. }
  400. return this._emptyTexture2DArray;
  401. }
  402. /**
  403. * Gets the default empty cube texture
  404. */
  405. public get emptyCubeTexture(): InternalTexture {
  406. if (!this._emptyCubeTexture) {
  407. var faceData = new Uint8Array(4);
  408. var cubeData = [faceData, faceData, faceData, faceData, faceData, faceData];
  409. this._emptyCubeTexture = this.createRawCubeTexture(cubeData, 1, Constants.TEXTUREFORMAT_RGBA, Constants.TEXTURETYPE_UNSIGNED_INT, false, false, Constants.TEXTURE_NEAREST_SAMPLINGMODE);
  410. }
  411. return this._emptyCubeTexture;
  412. }
  413. /**
  414. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  415. */
  416. public readonly premultipliedAlpha: boolean = true;
  417. /**
  418. * Observable event triggered before each texture is initialized
  419. */
  420. public onBeforeTextureInitObservable = new Observable<Texture>();
  421. /**
  422. * Creates a new engine
  423. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  424. * @param antialias defines enable antialiasing (default: false)
  425. * @param options defines further options to be sent to the getContext() function
  426. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  427. */
  428. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio: boolean = false) {
  429. let canvas: Nullable<HTMLCanvasElement> = null;
  430. if (!canvasOrContext) {
  431. return;
  432. }
  433. options = options || {};
  434. if ((<HTMLCanvasElement>canvasOrContext).getContext) {
  435. canvas = <HTMLCanvasElement>canvasOrContext;
  436. this._renderingCanvas = canvas;
  437. if (antialias != null) {
  438. options.antialias = antialias;
  439. }
  440. if (options.deterministicLockstep === undefined) {
  441. options.deterministicLockstep = false;
  442. }
  443. if (options.lockstepMaxSteps === undefined) {
  444. options.lockstepMaxSteps = 4;
  445. }
  446. if (options.timeStep === undefined) {
  447. options.timeStep = 1 / 60;
  448. }
  449. if (options.preserveDrawingBuffer === undefined) {
  450. options.preserveDrawingBuffer = false;
  451. }
  452. if (options.audioEngine === undefined) {
  453. options.audioEngine = true;
  454. }
  455. if (options.stencil === undefined) {
  456. options.stencil = true;
  457. }
  458. if (options.premultipliedAlpha === false) {
  459. this.premultipliedAlpha = false;
  460. }
  461. this._doNotHandleContextLost = options.doNotHandleContextLost ? true : false;
  462. // Exceptions
  463. if (navigator && navigator.userAgent) {
  464. let ua = navigator.userAgent;
  465. for (var exception of ThinEngine.ExceptionList) {
  466. let key = exception.key;
  467. let targets = exception.targets;
  468. let check = new RegExp(key);
  469. if (check.test(ua)) {
  470. if (exception.capture && exception.captureConstraint) {
  471. let capture = exception.capture;
  472. let constraint = exception.captureConstraint;
  473. let regex = new RegExp(capture);
  474. let matches = regex.exec(ua);
  475. if (matches && matches.length > 0) {
  476. let capturedValue = parseInt(matches[matches.length - 1]);
  477. if (capturedValue >= constraint) {
  478. continue;
  479. }
  480. }
  481. }
  482. for (var target of targets) {
  483. switch (target) {
  484. case "uniformBuffer":
  485. this.disableUniformBuffers = true;
  486. break;
  487. case "vao":
  488. this.disableVertexArrayObjects = true;
  489. break;
  490. }
  491. }
  492. }
  493. }
  494. }
  495. // Context lost
  496. if (!this._doNotHandleContextLost) {
  497. this._onContextLost = (evt: Event) => {
  498. evt.preventDefault();
  499. this._contextWasLost = true;
  500. Logger.Warn("WebGL context lost.");
  501. this.onContextLostObservable.notifyObservers(this);
  502. };
  503. this._onContextRestored = () => {
  504. // Adding a timeout to avoid race condition at browser level
  505. setTimeout(() => {
  506. // Rebuild gl context
  507. this._initGLContext();
  508. // Rebuild effects
  509. this._rebuildEffects();
  510. // Rebuild textures
  511. this._rebuildInternalTextures();
  512. // Rebuild buffers
  513. this._rebuildBuffers();
  514. // Cache
  515. this.wipeCaches(true);
  516. Logger.Warn("WebGL context successfully restored.");
  517. this.onContextRestoredObservable.notifyObservers(this);
  518. this._contextWasLost = false;
  519. }, 0);
  520. };
  521. canvas.addEventListener("webglcontextlost", this._onContextLost, false);
  522. canvas.addEventListener("webglcontextrestored", this._onContextRestored, false);
  523. options.powerPreference = "high-performance";
  524. }
  525. // GL
  526. if (!options.disableWebGL2Support) {
  527. try {
  528. this._gl = <any>(canvas.getContext("webgl2", options) || canvas.getContext("experimental-webgl2", options));
  529. if (this._gl) {
  530. this._webGLVersion = 2.0;
  531. // Prevent weird browsers to lie :-)
  532. if (!this._gl.deleteQuery) {
  533. this._webGLVersion = 1.0;
  534. }
  535. }
  536. } catch (e) {
  537. // Do nothing
  538. }
  539. }
  540. if (!this._gl) {
  541. if (!canvas) {
  542. throw new Error("The provided canvas is null or undefined.");
  543. }
  544. try {
  545. this._gl = <WebGLRenderingContext>(canvas.getContext("webgl", options) || canvas.getContext("experimental-webgl", options));
  546. } catch (e) {
  547. throw new Error("WebGL not supported");
  548. }
  549. }
  550. if (!this._gl) {
  551. throw new Error("WebGL not supported");
  552. }
  553. } else {
  554. this._gl = <WebGLRenderingContext>canvasOrContext;
  555. this._renderingCanvas = this._gl.canvas as HTMLCanvasElement;
  556. if (this._gl.renderbufferStorageMultisample) {
  557. this._webGLVersion = 2.0;
  558. }
  559. const attributes = this._gl.getContextAttributes();
  560. if (attributes) {
  561. options.stencil = attributes.stencil;
  562. }
  563. }
  564. // Ensures a consistent color space unpacking of textures cross browser.
  565. this._gl.pixelStorei(this._gl.UNPACK_COLORSPACE_CONVERSION_WEBGL, this._gl.NONE);
  566. if (options.useHighPrecisionFloats !== undefined) {
  567. this._highPrecisionShadersAllowed = options.useHighPrecisionFloats;
  568. }
  569. // Viewport
  570. const devicePixelRatio = DomManagement.IsWindowObjectExist() ? (window.devicePixelRatio || 1.0) : 1.0;
  571. var limitDeviceRatio = options.limitDeviceRatio || devicePixelRatio;
  572. this._hardwareScalingLevel = adaptToDeviceRatio ? 1.0 / Math.min(limitDeviceRatio, devicePixelRatio) : 1.0;
  573. this.resize();
  574. this._isStencilEnable = options.stencil ? true : false;
  575. this._initGLContext();
  576. // Prepare buffer pointers
  577. for (var i = 0; i < this._caps.maxVertexAttribs; i++) {
  578. this._currentBufferPointers[i] = new BufferPointer();
  579. }
  580. // Shader processor
  581. if (this.webGLVersion > 1) {
  582. this._shaderProcessor = new WebGL2ShaderProcessor();
  583. }
  584. // Detect if we are running on a faulty buggy OS.
  585. this._badOS = /iPad/i.test(navigator.userAgent) || /iPhone/i.test(navigator.userAgent);
  586. // Detect if we are running on a faulty buggy desktop OS.
  587. this._badDesktopOS = /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
  588. this._creationOptions = options;
  589. console.log(`Babylon.js v${ThinEngine.Version} - ${this.description}`);
  590. }
  591. private _rebuildInternalTextures(): void {
  592. let currentState = this._internalTexturesCache.slice(); // Do a copy because the rebuild will add proxies
  593. for (var internalTexture of currentState) {
  594. internalTexture._rebuild();
  595. }
  596. }
  597. private _rebuildEffects(): void {
  598. for (var key in this._compiledEffects) {
  599. let effect = <Effect>this._compiledEffects[key];
  600. effect._prepareEffect();
  601. }
  602. Effect.ResetCache();
  603. }
  604. /**
  605. * Gets a boolean indicating if all created effects are ready
  606. * @returns true if all effects are ready
  607. */
  608. public areAllEffectsReady(): boolean {
  609. for (var key in this._compiledEffects) {
  610. let effect = <Effect>this._compiledEffects[key];
  611. if (!effect.isReady()) {
  612. return false;
  613. }
  614. }
  615. return true;
  616. }
  617. protected _rebuildBuffers(): void {
  618. // Uniforms
  619. for (var uniformBuffer of this._uniformBuffers) {
  620. uniformBuffer._rebuild();
  621. }
  622. }
  623. private _initGLContext(): void {
  624. // Caps
  625. this._caps = {
  626. maxTexturesImageUnits: this._gl.getParameter(this._gl.MAX_TEXTURE_IMAGE_UNITS),
  627. maxCombinedTexturesImageUnits: this._gl.getParameter(this._gl.MAX_COMBINED_TEXTURE_IMAGE_UNITS),
  628. maxVertexTextureImageUnits: this._gl.getParameter(this._gl.MAX_VERTEX_TEXTURE_IMAGE_UNITS),
  629. maxTextureSize: this._gl.getParameter(this._gl.MAX_TEXTURE_SIZE),
  630. maxSamples: this._webGLVersion > 1 ? this._gl.getParameter(this._gl.MAX_SAMPLES) : 1,
  631. maxCubemapTextureSize: this._gl.getParameter(this._gl.MAX_CUBE_MAP_TEXTURE_SIZE),
  632. maxRenderTextureSize: this._gl.getParameter(this._gl.MAX_RENDERBUFFER_SIZE),
  633. maxVertexAttribs: this._gl.getParameter(this._gl.MAX_VERTEX_ATTRIBS),
  634. maxVaryingVectors: this._gl.getParameter(this._gl.MAX_VARYING_VECTORS),
  635. maxFragmentUniformVectors: this._gl.getParameter(this._gl.MAX_FRAGMENT_UNIFORM_VECTORS),
  636. maxVertexUniformVectors: this._gl.getParameter(this._gl.MAX_VERTEX_UNIFORM_VECTORS),
  637. parallelShaderCompile: this._gl.getExtension('KHR_parallel_shader_compile'),
  638. standardDerivatives: this._webGLVersion > 1 || (this._gl.getExtension('OES_standard_derivatives') !== null),
  639. maxAnisotropy: 1,
  640. astc: this._gl.getExtension('WEBGL_compressed_texture_astc') || this._gl.getExtension('WEBKIT_WEBGL_compressed_texture_astc'),
  641. s3tc: this._gl.getExtension('WEBGL_compressed_texture_s3tc') || this._gl.getExtension('WEBKIT_WEBGL_compressed_texture_s3tc'),
  642. pvrtc: this._gl.getExtension('WEBGL_compressed_texture_pvrtc') || this._gl.getExtension('WEBKIT_WEBGL_compressed_texture_pvrtc'),
  643. etc1: this._gl.getExtension('WEBGL_compressed_texture_etc1') || this._gl.getExtension('WEBKIT_WEBGL_compressed_texture_etc1'),
  644. etc2: this._gl.getExtension('WEBGL_compressed_texture_etc') || this._gl.getExtension('WEBKIT_WEBGL_compressed_texture_etc') ||
  645. this._gl.getExtension('WEBGL_compressed_texture_es3_0'), // also a requirement of OpenGL ES 3
  646. textureAnisotropicFilterExtension: this._gl.getExtension('EXT_texture_filter_anisotropic') || this._gl.getExtension('WEBKIT_EXT_texture_filter_anisotropic') || this._gl.getExtension('MOZ_EXT_texture_filter_anisotropic'),
  647. uintIndices: this._webGLVersion > 1 || this._gl.getExtension('OES_element_index_uint') !== null,
  648. fragmentDepthSupported: this._webGLVersion > 1 || this._gl.getExtension('EXT_frag_depth') !== null,
  649. highPrecisionShaderSupported: false,
  650. timerQuery: this._gl.getExtension('EXT_disjoint_timer_query_webgl2') || this._gl.getExtension("EXT_disjoint_timer_query"),
  651. canUseTimestampForTimerQuery: false,
  652. drawBuffersExtension: false,
  653. maxMSAASamples: 1,
  654. colorBufferFloat: this._webGLVersion > 1 && this._gl.getExtension('EXT_color_buffer_float'),
  655. textureFloat: (this._webGLVersion > 1 || this._gl.getExtension('OES_texture_float')) ? true : false,
  656. textureHalfFloat: (this._webGLVersion > 1 || this._gl.getExtension('OES_texture_half_float')) ? true : false,
  657. textureHalfFloatRender: false,
  658. textureFloatLinearFiltering: false,
  659. textureFloatRender: false,
  660. textureHalfFloatLinearFiltering: false,
  661. vertexArrayObject: false,
  662. instancedArrays: false,
  663. textureLOD: (this._webGLVersion > 1 || this._gl.getExtension('EXT_shader_texture_lod')) ? true : false,
  664. blendMinMax: false,
  665. multiview: this._gl.getExtension('OVR_multiview2'),
  666. oculusMultiview: this._gl.getExtension('OCULUS_multiview'),
  667. depthTextureExtension: false
  668. };
  669. // Infos
  670. this._glVersion = this._gl.getParameter(this._gl.VERSION);
  671. var rendererInfo: any = this._gl.getExtension("WEBGL_debug_renderer_info");
  672. if (rendererInfo != null) {
  673. this._glRenderer = this._gl.getParameter(rendererInfo.UNMASKED_RENDERER_WEBGL);
  674. this._glVendor = this._gl.getParameter(rendererInfo.UNMASKED_VENDOR_WEBGL);
  675. }
  676. if (!this._glVendor) {
  677. this._glVendor = "Unknown vendor";
  678. }
  679. if (!this._glRenderer) {
  680. this._glRenderer = "Unknown renderer";
  681. }
  682. // Constants
  683. this._gl.HALF_FLOAT_OES = 0x8D61; // Half floating-point type (16-bit).
  684. if (this._gl.RGBA16F !== 0x881A) {
  685. this._gl.RGBA16F = 0x881A; // RGBA 16-bit floating-point color-renderable internal sized format.
  686. }
  687. if (this._gl.RGBA32F !== 0x8814) {
  688. this._gl.RGBA32F = 0x8814; // RGBA 32-bit floating-point color-renderable internal sized format.
  689. }
  690. if (this._gl.DEPTH24_STENCIL8 !== 35056) {
  691. this._gl.DEPTH24_STENCIL8 = 35056;
  692. }
  693. // Extensions
  694. if (this._caps.timerQuery) {
  695. if (this._webGLVersion === 1) {
  696. this._gl.getQuery = (<any>this._caps.timerQuery).getQueryEXT.bind(this._caps.timerQuery);
  697. }
  698. this._caps.canUseTimestampForTimerQuery = this._gl.getQuery(this._caps.timerQuery.TIMESTAMP_EXT, this._caps.timerQuery.QUERY_COUNTER_BITS_EXT) > 0;
  699. }
  700. this._caps.maxAnisotropy = this._caps.textureAnisotropicFilterExtension ? this._gl.getParameter(this._caps.textureAnisotropicFilterExtension.MAX_TEXTURE_MAX_ANISOTROPY_EXT) : 0;
  701. this._caps.textureFloatLinearFiltering = this._caps.textureFloat && this._gl.getExtension('OES_texture_float_linear') ? true : false;
  702. this._caps.textureFloatRender = this._caps.textureFloat && this._canRenderToFloatFramebuffer() ? true : false;
  703. this._caps.textureHalfFloatLinearFiltering = (this._webGLVersion > 1 || (this._caps.textureHalfFloat && this._gl.getExtension('OES_texture_half_float_linear'))) ? true : false;
  704. // Checks if some of the format renders first to allow the use of webgl inspector.
  705. if (this._webGLVersion > 1) {
  706. this._gl.HALF_FLOAT_OES = 0x140B;
  707. }
  708. this._caps.textureHalfFloatRender = this._caps.textureHalfFloat && this._canRenderToHalfFloatFramebuffer();
  709. // Draw buffers
  710. if (this._webGLVersion > 1) {
  711. this._caps.drawBuffersExtension = true;
  712. this._caps.maxMSAASamples = this._gl.getParameter(this._gl.MAX_SAMPLES);
  713. } else {
  714. var drawBuffersExtension = this._gl.getExtension('WEBGL_draw_buffers');
  715. if (drawBuffersExtension !== null) {
  716. this._caps.drawBuffersExtension = true;
  717. this._gl.drawBuffers = drawBuffersExtension.drawBuffersWEBGL.bind(drawBuffersExtension);
  718. this._gl.DRAW_FRAMEBUFFER = this._gl.FRAMEBUFFER;
  719. for (var i = 0; i < 16; i++) {
  720. (<any>this._gl)["COLOR_ATTACHMENT" + i + "_WEBGL"] = (<any>drawBuffersExtension)["COLOR_ATTACHMENT" + i + "_WEBGL"];
  721. }
  722. }
  723. }
  724. // Depth Texture
  725. if (this._webGLVersion > 1) {
  726. this._caps.depthTextureExtension = true;
  727. } else {
  728. var depthTextureExtension = this._gl.getExtension('WEBGL_depth_texture');
  729. if (depthTextureExtension != null) {
  730. this._caps.depthTextureExtension = true;
  731. this._gl.UNSIGNED_INT_24_8 = depthTextureExtension.UNSIGNED_INT_24_8_WEBGL;
  732. }
  733. }
  734. // Vertex array object
  735. if (this.disableVertexArrayObjects) {
  736. this._caps.vertexArrayObject = false;
  737. } else if (this._webGLVersion > 1) {
  738. this._caps.vertexArrayObject = true;
  739. } else {
  740. var vertexArrayObjectExtension = this._gl.getExtension('OES_vertex_array_object');
  741. if (vertexArrayObjectExtension != null) {
  742. this._caps.vertexArrayObject = true;
  743. this._gl.createVertexArray = vertexArrayObjectExtension.createVertexArrayOES.bind(vertexArrayObjectExtension);
  744. this._gl.bindVertexArray = vertexArrayObjectExtension.bindVertexArrayOES.bind(vertexArrayObjectExtension);
  745. this._gl.deleteVertexArray = vertexArrayObjectExtension.deleteVertexArrayOES.bind(vertexArrayObjectExtension);
  746. }
  747. }
  748. // Instances count
  749. if (this._webGLVersion > 1) {
  750. this._caps.instancedArrays = true;
  751. } else {
  752. var instanceExtension = <ANGLE_instanced_arrays>this._gl.getExtension('ANGLE_instanced_arrays');
  753. if (instanceExtension != null) {
  754. this._caps.instancedArrays = true;
  755. this._gl.drawArraysInstanced = instanceExtension.drawArraysInstancedANGLE.bind(instanceExtension);
  756. this._gl.drawElementsInstanced = instanceExtension.drawElementsInstancedANGLE.bind(instanceExtension);
  757. this._gl.vertexAttribDivisor = instanceExtension.vertexAttribDivisorANGLE.bind(instanceExtension);
  758. } else {
  759. this._caps.instancedArrays = false;
  760. }
  761. }
  762. // Intelligently add supported compressed formats in order to check for.
  763. // Check for ASTC support first as it is most powerful and to be very cross platform.
  764. // Next PVRTC & DXT, which are probably superior to ETC1/2.
  765. // Likely no hardware which supports both PVR & DXT, so order matters little.
  766. // ETC2 is newer and handles ETC1 (no alpha capability), so check for first.
  767. if (this._caps.astc) { this.texturesSupported.push('-astc.ktx'); }
  768. if (this._caps.s3tc) { this.texturesSupported.push('-dxt.ktx'); }
  769. if (this._caps.pvrtc) { this.texturesSupported.push('-pvrtc.ktx'); }
  770. if (this._caps.etc2) { this.texturesSupported.push('-etc2.ktx'); }
  771. if (this._caps.etc1) { this.texturesSupported.push('-etc1.ktx'); }
  772. if (this._gl.getShaderPrecisionFormat) {
  773. var vertex_highp = this._gl.getShaderPrecisionFormat(this._gl.VERTEX_SHADER, this._gl.HIGH_FLOAT);
  774. var fragment_highp = this._gl.getShaderPrecisionFormat(this._gl.FRAGMENT_SHADER, this._gl.HIGH_FLOAT);
  775. if (vertex_highp && fragment_highp) {
  776. this._caps.highPrecisionShaderSupported = vertex_highp.precision !== 0 && fragment_highp.precision !== 0;
  777. }
  778. }
  779. if (this._webGLVersion > 1) {
  780. this._caps.blendMinMax = true;
  781. }
  782. else {
  783. const blendMinMaxExtension = this._gl.getExtension('EXT_blend_minmax');
  784. if (blendMinMaxExtension != null) {
  785. this._caps.blendMinMax = true;
  786. this._gl.MAX = blendMinMaxExtension.MAX_EXT;
  787. this._gl.MIN = blendMinMaxExtension.MIN_EXT;
  788. }
  789. }
  790. // Depth buffer
  791. this._depthCullingState.depthTest = true;
  792. this._depthCullingState.depthFunc = this._gl.LEQUAL;
  793. this._depthCullingState.depthMask = true;
  794. // Texture maps
  795. this._maxSimultaneousTextures = this._caps.maxCombinedTexturesImageUnits;
  796. for (let slot = 0; slot < this._maxSimultaneousTextures; slot++) {
  797. this._nextFreeTextureSlots.push(slot);
  798. }
  799. }
  800. /**
  801. * Gets version of the current webGL context
  802. */
  803. public get webGLVersion(): number {
  804. return this._webGLVersion;
  805. }
  806. /**
  807. * Gets a string idenfifying the name of the class
  808. * @returns "Engine" string
  809. */
  810. public getClassName(): string {
  811. return "ThinEngine";
  812. }
  813. /**
  814. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  815. */
  816. public get isStencilEnable(): boolean {
  817. return this._isStencilEnable;
  818. }
  819. /** @hidden */
  820. public _prepareWorkingCanvas(): void {
  821. if (this._workingCanvas) {
  822. return;
  823. }
  824. this._workingCanvas = CanvasGenerator.CreateCanvas(1, 1);
  825. let context = this._workingCanvas.getContext("2d");
  826. if (context) {
  827. this._workingContext = context;
  828. }
  829. }
  830. /**
  831. * Reset the texture cache to empty state
  832. */
  833. public resetTextureCache() {
  834. for (var key in this._boundTexturesCache) {
  835. if (!this._boundTexturesCache.hasOwnProperty(key)) {
  836. continue;
  837. }
  838. this._boundTexturesCache[key] = null;
  839. }
  840. this._currentTextureChannel = -1;
  841. }
  842. /**
  843. * Gets an object containing information about the current webGL context
  844. * @returns an object containing the vender, the renderer and the version of the current webGL context
  845. */
  846. public getGlInfo() {
  847. return {
  848. vendor: this._glVendor,
  849. renderer: this._glRenderer,
  850. version: this._glVersion
  851. };
  852. }
  853. /**
  854. * Defines the hardware scaling level.
  855. * By default the hardware scaling level is computed from the window device ratio.
  856. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  857. * @param level defines the level to use
  858. */
  859. public setHardwareScalingLevel(level: number): void {
  860. this._hardwareScalingLevel = level;
  861. this.resize();
  862. }
  863. /**
  864. * Gets the current hardware scaling level.
  865. * By default the hardware scaling level is computed from the window device ratio.
  866. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  867. * @returns a number indicating the current hardware scaling level
  868. */
  869. public getHardwareScalingLevel(): number {
  870. return this._hardwareScalingLevel;
  871. }
  872. /**
  873. * Gets the list of loaded textures
  874. * @returns an array containing all loaded textures
  875. */
  876. public getLoadedTexturesCache(): InternalTexture[] {
  877. return this._internalTexturesCache;
  878. }
  879. /**
  880. * Gets the object containing all engine capabilities
  881. * @returns the EngineCapabilities object
  882. */
  883. public getCaps(): EngineCapabilities {
  884. return this._caps;
  885. }
  886. /**
  887. * stop executing a render loop function and remove it from the execution array
  888. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  889. */
  890. public stopRenderLoop(renderFunction?: () => void): void {
  891. if (!renderFunction) {
  892. this._activeRenderLoops = [];
  893. return;
  894. }
  895. var index = this._activeRenderLoops.indexOf(renderFunction);
  896. if (index >= 0) {
  897. this._activeRenderLoops.splice(index, 1);
  898. }
  899. }
  900. /** @hidden */
  901. public _renderLoop(): void {
  902. if (!this._contextWasLost) {
  903. var shouldRender = true;
  904. if (!this.renderEvenInBackground && this._windowIsBackground) {
  905. shouldRender = false;
  906. }
  907. if (shouldRender) {
  908. // Start new frame
  909. this.beginFrame();
  910. for (var index = 0; index < this._activeRenderLoops.length; index++) {
  911. var renderFunction = this._activeRenderLoops[index];
  912. renderFunction();
  913. }
  914. // Present
  915. this.endFrame();
  916. }
  917. }
  918. if (this._activeRenderLoops.length > 0) {
  919. this._frameHandler = this._queueNewFrame(this._boundRenderFunction, this.getHostWindow());
  920. } else {
  921. this._renderingQueueLaunched = false;
  922. }
  923. }
  924. /**
  925. * Gets the HTML canvas attached with the current webGL context
  926. * @returns a HTML canvas
  927. */
  928. public getRenderingCanvas(): Nullable<HTMLCanvasElement> {
  929. return this._renderingCanvas;
  930. }
  931. /**
  932. * Gets host window
  933. * @returns the host window object
  934. */
  935. public getHostWindow(): Nullable<Window> {
  936. if (!DomManagement.IsWindowObjectExist()) {
  937. return null;
  938. }
  939. if (this._renderingCanvas && this._renderingCanvas.ownerDocument && this._renderingCanvas.ownerDocument.defaultView) {
  940. return this._renderingCanvas.ownerDocument.defaultView;
  941. }
  942. return window;
  943. }
  944. /**
  945. * Gets the current render width
  946. * @param useScreen defines if screen size must be used (or the current render target if any)
  947. * @returns a number defining the current render width
  948. */
  949. public getRenderWidth(useScreen = false): number {
  950. if (!useScreen && this._currentRenderTarget) {
  951. return this._currentRenderTarget.width;
  952. }
  953. return this._gl.drawingBufferWidth;
  954. }
  955. /**
  956. * Gets the current render height
  957. * @param useScreen defines if screen size must be used (or the current render target if any)
  958. * @returns a number defining the current render height
  959. */
  960. public getRenderHeight(useScreen = false): number {
  961. if (!useScreen && this._currentRenderTarget) {
  962. return this._currentRenderTarget.height;
  963. }
  964. return this._gl.drawingBufferHeight;
  965. }
  966. /**
  967. * Can be used to override the current requestAnimationFrame requester.
  968. * @hidden
  969. */
  970. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number {
  971. return ThinEngine.QueueNewFrame(bindedRenderFunction, requester);
  972. }
  973. /**
  974. * Register and execute a render loop. The engine can have more than one render function
  975. * @param renderFunction defines the function to continuously execute
  976. */
  977. public runRenderLoop(renderFunction: () => void): void {
  978. if (this._activeRenderLoops.indexOf(renderFunction) !== -1) {
  979. return;
  980. }
  981. this._activeRenderLoops.push(renderFunction);
  982. if (!this._renderingQueueLaunched) {
  983. this._renderingQueueLaunched = true;
  984. this._boundRenderFunction = this._renderLoop.bind(this);
  985. this._frameHandler = this._queueNewFrame(this._boundRenderFunction, this.getHostWindow());
  986. }
  987. }
  988. /**
  989. * Clear the current render buffer or the current render target (if any is set up)
  990. * @param color defines the color to use
  991. * @param backBuffer defines if the back buffer must be cleared
  992. * @param depth defines if the depth buffer must be cleared
  993. * @param stencil defines if the stencil buffer must be cleared
  994. */
  995. public clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil: boolean = false): void {
  996. this.applyStates();
  997. var mode = 0;
  998. if (backBuffer && color) {
  999. this._gl.clearColor(color.r, color.g, color.b, color.a !== undefined ? color.a : 1.0);
  1000. mode |= this._gl.COLOR_BUFFER_BIT;
  1001. }
  1002. if (depth) {
  1003. if (this.useReverseDepthBuffer) {
  1004. this._depthCullingState.depthFunc = this._gl.GREATER;
  1005. this._gl.clearDepth(0.0);
  1006. } else {
  1007. this._gl.clearDepth(1.0);
  1008. }
  1009. mode |= this._gl.DEPTH_BUFFER_BIT;
  1010. }
  1011. if (stencil) {
  1012. this._gl.clearStencil(0);
  1013. mode |= this._gl.STENCIL_BUFFER_BIT;
  1014. }
  1015. this._gl.clear(mode);
  1016. }
  1017. private _viewportCached = { x: 0, y: 0, z: 0, w: 0 };
  1018. /** @hidden */
  1019. public _viewport(x: number, y: number, width: number, height: number): void {
  1020. if (x !== this._viewportCached.x ||
  1021. y !== this._viewportCached.y ||
  1022. width !== this._viewportCached.z ||
  1023. height !== this._viewportCached.w) {
  1024. this._viewportCached.x = x;
  1025. this._viewportCached.y = y;
  1026. this._viewportCached.z = width;
  1027. this._viewportCached.w = height;
  1028. this._gl.viewport(x, y, width, height);
  1029. }
  1030. }
  1031. /**
  1032. * Set the WebGL's viewport
  1033. * @param viewport defines the viewport element to be used
  1034. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  1035. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  1036. */
  1037. public setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void {
  1038. var width = requiredWidth || this.getRenderWidth();
  1039. var height = requiredHeight || this.getRenderHeight();
  1040. var x = viewport.x || 0;
  1041. var y = viewport.y || 0;
  1042. this._cachedViewport = viewport;
  1043. this._viewport(x * width, y * height, width * viewport.width, height * viewport.height);
  1044. }
  1045. /**
  1046. * Begin a new frame
  1047. */
  1048. public beginFrame(): void {
  1049. }
  1050. /**
  1051. * Enf the current frame
  1052. */
  1053. public endFrame(): void {
  1054. // Force a flush in case we are using a bad OS.
  1055. if (this._badOS) {
  1056. this.flushFramebuffer();
  1057. }
  1058. }
  1059. /**
  1060. * Resize the view according to the canvas' size
  1061. */
  1062. public resize(): void {
  1063. let width: number;
  1064. let height: number;
  1065. if (DomManagement.IsWindowObjectExist()) {
  1066. width = this._renderingCanvas ? this._renderingCanvas.clientWidth : window.innerWidth;
  1067. height = this._renderingCanvas ? this._renderingCanvas.clientHeight : window.innerHeight;
  1068. } else {
  1069. width = this._renderingCanvas ? this._renderingCanvas.width : 100;
  1070. height = this._renderingCanvas ? this._renderingCanvas.height : 100;
  1071. }
  1072. this.setSize(width / this._hardwareScalingLevel, height / this._hardwareScalingLevel);
  1073. }
  1074. /**
  1075. * Force a specific size of the canvas
  1076. * @param width defines the new canvas' width
  1077. * @param height defines the new canvas' height
  1078. */
  1079. public setSize(width: number, height: number): void {
  1080. if (!this._renderingCanvas) {
  1081. return;
  1082. }
  1083. width = width | 0;
  1084. height = height | 0;
  1085. if (this._renderingCanvas.width === width && this._renderingCanvas.height === height) {
  1086. return;
  1087. }
  1088. this._renderingCanvas.width = width;
  1089. this._renderingCanvas.height = height;
  1090. }
  1091. /**
  1092. * Binds the frame buffer to the specified texture.
  1093. * @param texture The texture to render to or null for the default canvas
  1094. * @param faceIndex The face of the texture to render to in case of cube texture
  1095. * @param requiredWidth The width of the target to render to
  1096. * @param requiredHeight The height of the target to render to
  1097. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  1098. * @param depthStencilTexture The depth stencil texture to use to render
  1099. * @param lodLevel defines le lod level to bind to the frame buffer
  1100. */
  1101. public bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel = 0): void {
  1102. if (this._currentRenderTarget) {
  1103. this.unBindFramebuffer(this._currentRenderTarget);
  1104. }
  1105. this._currentRenderTarget = texture;
  1106. this._bindUnboundFramebuffer(texture._MSAAFramebuffer ? texture._MSAAFramebuffer : texture._framebuffer);
  1107. var gl = this._gl;
  1108. if (texture.isCube) {
  1109. if (faceIndex === undefined) {
  1110. faceIndex = 0;
  1111. }
  1112. gl.framebufferTexture2D(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0, gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex, texture._webGLTexture, lodLevel);
  1113. if (depthStencilTexture) {
  1114. if (depthStencilTexture._generateStencilBuffer) {
  1115. gl.framebufferTexture2D(gl.FRAMEBUFFER, gl.DEPTH_STENCIL_ATTACHMENT, gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex, depthStencilTexture._webGLTexture, lodLevel);
  1116. }
  1117. else {
  1118. gl.framebufferTexture2D(gl.FRAMEBUFFER, gl.DEPTH_ATTACHMENT, gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex, depthStencilTexture._webGLTexture, lodLevel);
  1119. }
  1120. }
  1121. }
  1122. if (this._cachedViewport && !forceFullscreenViewport) {
  1123. this.setViewport(this._cachedViewport, requiredWidth, requiredHeight);
  1124. } else {
  1125. if (!requiredWidth) {
  1126. requiredWidth = texture.width;
  1127. if (lodLevel) {
  1128. requiredWidth = requiredWidth / Math.pow(2, lodLevel);
  1129. }
  1130. }
  1131. if (!requiredHeight) {
  1132. requiredHeight = texture.height;
  1133. if (lodLevel) {
  1134. requiredHeight = requiredHeight / Math.pow(2, lodLevel);
  1135. }
  1136. }
  1137. this._viewport(0, 0, requiredWidth, requiredHeight);
  1138. }
  1139. this.wipeCaches();
  1140. }
  1141. /** @hidden */
  1142. public _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>) {
  1143. if (this._currentFramebuffer !== framebuffer) {
  1144. this._gl.bindFramebuffer(this._gl.FRAMEBUFFER, framebuffer);
  1145. this._currentFramebuffer = framebuffer;
  1146. }
  1147. }
  1148. /**
  1149. * Unbind the current render target texture from the webGL context
  1150. * @param texture defines the render target texture to unbind
  1151. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  1152. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  1153. */
  1154. public unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps = false, onBeforeUnbind?: () => void): void {
  1155. this._currentRenderTarget = null;
  1156. // If MSAA, we need to bitblt back to main texture
  1157. var gl = this._gl;
  1158. if (texture._MSAAFramebuffer) {
  1159. gl.bindFramebuffer(gl.READ_FRAMEBUFFER, texture._MSAAFramebuffer);
  1160. gl.bindFramebuffer(gl.DRAW_FRAMEBUFFER, texture._framebuffer);
  1161. gl.blitFramebuffer(0, 0, texture.width, texture.height,
  1162. 0, 0, texture.width, texture.height,
  1163. gl.COLOR_BUFFER_BIT, gl.NEAREST);
  1164. }
  1165. if (texture.generateMipMaps && !disableGenerateMipMaps && !texture.isCube) {
  1166. this._bindTextureDirectly(gl.TEXTURE_2D, texture, true);
  1167. gl.generateMipmap(gl.TEXTURE_2D);
  1168. this._bindTextureDirectly(gl.TEXTURE_2D, null);
  1169. }
  1170. if (onBeforeUnbind) {
  1171. if (texture._MSAAFramebuffer) {
  1172. // Bind the correct framebuffer
  1173. this._bindUnboundFramebuffer(texture._framebuffer);
  1174. }
  1175. onBeforeUnbind();
  1176. }
  1177. this._bindUnboundFramebuffer(null);
  1178. }
  1179. /**
  1180. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  1181. */
  1182. public flushFramebuffer(): void {
  1183. this._gl.flush();
  1184. }
  1185. /**
  1186. * Unbind the current render target and bind the default framebuffer
  1187. */
  1188. public restoreDefaultFramebuffer(): void {
  1189. if (this._currentRenderTarget) {
  1190. this.unBindFramebuffer(this._currentRenderTarget);
  1191. } else {
  1192. this._bindUnboundFramebuffer(null);
  1193. }
  1194. if (this._cachedViewport) {
  1195. this.setViewport(this._cachedViewport);
  1196. }
  1197. this.wipeCaches();
  1198. }
  1199. // VBOs
  1200. /** @hidden */
  1201. protected _resetVertexBufferBinding(): void {
  1202. this.bindArrayBuffer(null);
  1203. this._cachedVertexBuffers = null;
  1204. }
  1205. /**
  1206. * Creates a vertex buffer
  1207. * @param data the data for the vertex buffer
  1208. * @returns the new WebGL static buffer
  1209. */
  1210. public createVertexBuffer(data: DataArray): DataBuffer {
  1211. return this._createVertexBuffer(data, this._gl.STATIC_DRAW);
  1212. }
  1213. private _createVertexBuffer(data: DataArray, usage: number): DataBuffer {
  1214. var vbo = this._gl.createBuffer();
  1215. if (!vbo) {
  1216. throw new Error("Unable to create vertex buffer");
  1217. }
  1218. let dataBuffer = new WebGLDataBuffer(vbo);
  1219. this.bindArrayBuffer(dataBuffer);
  1220. if (data instanceof Array) {
  1221. this._gl.bufferData(this._gl.ARRAY_BUFFER, new Float32Array(data), this._gl.STATIC_DRAW);
  1222. } else {
  1223. this._gl.bufferData(this._gl.ARRAY_BUFFER, <ArrayBuffer>data, this._gl.STATIC_DRAW);
  1224. }
  1225. this._resetVertexBufferBinding();
  1226. dataBuffer.references = 1;
  1227. return dataBuffer;
  1228. }
  1229. /**
  1230. * Creates a dynamic vertex buffer
  1231. * @param data the data for the dynamic vertex buffer
  1232. * @returns the new WebGL dynamic buffer
  1233. */
  1234. public createDynamicVertexBuffer(data: DataArray): DataBuffer {
  1235. return this._createVertexBuffer(data, this._gl.DYNAMIC_DRAW);
  1236. }
  1237. protected _resetIndexBufferBinding(): void {
  1238. this.bindIndexBuffer(null);
  1239. this._cachedIndexBuffer = null;
  1240. }
  1241. /**
  1242. * Creates a new index buffer
  1243. * @param indices defines the content of the index buffer
  1244. * @param updatable defines if the index buffer must be updatable
  1245. * @returns a new webGL buffer
  1246. */
  1247. public createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer {
  1248. var vbo = this._gl.createBuffer();
  1249. let dataBuffer = new WebGLDataBuffer(vbo!);
  1250. if (!vbo) {
  1251. throw new Error("Unable to create index buffer");
  1252. }
  1253. this.bindIndexBuffer(dataBuffer);
  1254. const data = this._normalizeIndexData(indices);
  1255. this._gl.bufferData(this._gl.ELEMENT_ARRAY_BUFFER, data, updatable ? this._gl.DYNAMIC_DRAW : this._gl.STATIC_DRAW);
  1256. this._resetIndexBufferBinding();
  1257. dataBuffer.references = 1;
  1258. dataBuffer.is32Bits = (data.BYTES_PER_ELEMENT === 4);
  1259. return dataBuffer;
  1260. }
  1261. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array {
  1262. if (indices instanceof Uint16Array) {
  1263. return indices;
  1264. }
  1265. // Check 32 bit support
  1266. if (this._caps.uintIndices) {
  1267. if (indices instanceof Uint32Array) {
  1268. return indices;
  1269. } else {
  1270. // number[] or Int32Array, check if 32 bit is necessary
  1271. for (var index = 0; index < indices.length; index++) {
  1272. if (indices[index] >= 65535) {
  1273. return new Uint32Array(indices);
  1274. }
  1275. }
  1276. return new Uint16Array(indices);
  1277. }
  1278. }
  1279. // No 32 bit support, force conversion to 16 bit (values greater 16 bit are lost)
  1280. return new Uint16Array(indices);
  1281. }
  1282. /**
  1283. * Bind a webGL buffer to the webGL context
  1284. * @param buffer defines the buffer to bind
  1285. */
  1286. public bindArrayBuffer(buffer: Nullable<DataBuffer>): void {
  1287. if (!this._vaoRecordInProgress) {
  1288. this._unbindVertexArrayObject();
  1289. }
  1290. this.bindBuffer(buffer, this._gl.ARRAY_BUFFER);
  1291. }
  1292. /**
  1293. * Bind a specific block at a given index in a specific shader program
  1294. * @param pipelineContext defines the pipeline context to use
  1295. * @param blockName defines the block name
  1296. * @param index defines the index where to bind the block
  1297. */
  1298. public bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void {
  1299. let program = (pipelineContext as WebGLPipelineContext).program!;
  1300. var uniformLocation = this._gl.getUniformBlockIndex(program, blockName);
  1301. this._gl.uniformBlockBinding(program, uniformLocation, index);
  1302. }
  1303. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void {
  1304. if (!this._vaoRecordInProgress) {
  1305. this._unbindVertexArrayObject();
  1306. }
  1307. this.bindBuffer(buffer, this._gl.ELEMENT_ARRAY_BUFFER);
  1308. }
  1309. private bindBuffer(buffer: Nullable<DataBuffer>, target: number): void {
  1310. if (this._vaoRecordInProgress || this._currentBoundBuffer[target] !== buffer) {
  1311. this._gl.bindBuffer(target, buffer ? buffer.underlyingResource : null);
  1312. this._currentBoundBuffer[target] = buffer;
  1313. }
  1314. }
  1315. /**
  1316. * update the bound buffer with the given data
  1317. * @param data defines the data to update
  1318. */
  1319. public updateArrayBuffer(data: Float32Array): void {
  1320. this._gl.bufferSubData(this._gl.ARRAY_BUFFER, 0, data);
  1321. }
  1322. private _vertexAttribPointer(buffer: DataBuffer, indx: number, size: number, type: number, normalized: boolean, stride: number, offset: number): void {
  1323. var pointer = this._currentBufferPointers[indx];
  1324. var changed = false;
  1325. if (!pointer.active) {
  1326. changed = true;
  1327. pointer.active = true;
  1328. pointer.index = indx;
  1329. pointer.size = size;
  1330. pointer.type = type;
  1331. pointer.normalized = normalized;
  1332. pointer.stride = stride;
  1333. pointer.offset = offset;
  1334. pointer.buffer = buffer;
  1335. } else {
  1336. if (pointer.buffer !== buffer) { pointer.buffer = buffer; changed = true; }
  1337. if (pointer.size !== size) { pointer.size = size; changed = true; }
  1338. if (pointer.type !== type) { pointer.type = type; changed = true; }
  1339. if (pointer.normalized !== normalized) { pointer.normalized = normalized; changed = true; }
  1340. if (pointer.stride !== stride) { pointer.stride = stride; changed = true; }
  1341. if (pointer.offset !== offset) { pointer.offset = offset; changed = true; }
  1342. }
  1343. if (changed || this._vaoRecordInProgress) {
  1344. this.bindArrayBuffer(buffer);
  1345. this._gl.vertexAttribPointer(indx, size, type, normalized, stride, offset);
  1346. }
  1347. }
  1348. private _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void {
  1349. if (indexBuffer == null) {
  1350. return;
  1351. }
  1352. if (this._cachedIndexBuffer !== indexBuffer) {
  1353. this._cachedIndexBuffer = indexBuffer;
  1354. this.bindIndexBuffer(indexBuffer);
  1355. this._uintIndicesCurrentlySet = indexBuffer.is32Bits;
  1356. }
  1357. }
  1358. private _bindVertexBuffersAttributes(vertexBuffers: { [key: string]: Nullable<VertexBuffer> }, effect: Effect): void {
  1359. var attributes = effect.getAttributesNames();
  1360. if (!this._vaoRecordInProgress) {
  1361. this._unbindVertexArrayObject();
  1362. }
  1363. this.unbindAllAttributes();
  1364. for (var index = 0; index < attributes.length; index++) {
  1365. var order = effect.getAttributeLocation(index);
  1366. if (order >= 0) {
  1367. var vertexBuffer = vertexBuffers[attributes[index]];
  1368. if (!vertexBuffer) {
  1369. continue;
  1370. }
  1371. this._gl.enableVertexAttribArray(order);
  1372. if (!this._vaoRecordInProgress) {
  1373. this._vertexAttribArraysEnabled[order] = true;
  1374. }
  1375. var buffer = vertexBuffer.getBuffer();
  1376. if (buffer) {
  1377. this._vertexAttribPointer(buffer, order, vertexBuffer.getSize(), vertexBuffer.type, vertexBuffer.normalized, vertexBuffer.byteStride, vertexBuffer.byteOffset);
  1378. if (vertexBuffer.getIsInstanced()) {
  1379. this._gl.vertexAttribDivisor(order, vertexBuffer.getInstanceDivisor());
  1380. if (!this._vaoRecordInProgress) {
  1381. this._currentInstanceLocations.push(order);
  1382. this._currentInstanceBuffers.push(buffer);
  1383. }
  1384. }
  1385. }
  1386. }
  1387. }
  1388. }
  1389. /**
  1390. * Records a vertex array object
  1391. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  1392. * @param vertexBuffers defines the list of vertex buffers to store
  1393. * @param indexBuffer defines the index buffer to store
  1394. * @param effect defines the effect to store
  1395. * @returns the new vertex array object
  1396. */
  1397. public recordVertexArrayObject(vertexBuffers: { [key: string]: VertexBuffer; }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject {
  1398. var vao = this._gl.createVertexArray();
  1399. this._vaoRecordInProgress = true;
  1400. this._gl.bindVertexArray(vao);
  1401. this._mustWipeVertexAttributes = true;
  1402. this._bindVertexBuffersAttributes(vertexBuffers, effect);
  1403. this.bindIndexBuffer(indexBuffer);
  1404. this._vaoRecordInProgress = false;
  1405. this._gl.bindVertexArray(null);
  1406. return vao;
  1407. }
  1408. /**
  1409. * Bind a specific vertex array object
  1410. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  1411. * @param vertexArrayObject defines the vertex array object to bind
  1412. * @param indexBuffer defines the index buffer to bind
  1413. */
  1414. public bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void {
  1415. if (this._cachedVertexArrayObject !== vertexArrayObject) {
  1416. this._cachedVertexArrayObject = vertexArrayObject;
  1417. this._gl.bindVertexArray(vertexArrayObject);
  1418. this._cachedVertexBuffers = null;
  1419. this._cachedIndexBuffer = null;
  1420. this._uintIndicesCurrentlySet = indexBuffer != null && indexBuffer.is32Bits;
  1421. this._mustWipeVertexAttributes = true;
  1422. }
  1423. }
  1424. /**
  1425. * Bind webGl buffers directly to the webGL context
  1426. * @param vertexBuffer defines the vertex buffer to bind
  1427. * @param indexBuffer defines the index buffer to bind
  1428. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  1429. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  1430. * @param effect defines the effect associated with the vertex buffer
  1431. */
  1432. public bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void {
  1433. if (this._cachedVertexBuffers !== vertexBuffer || this._cachedEffectForVertexBuffers !== effect) {
  1434. this._cachedVertexBuffers = vertexBuffer;
  1435. this._cachedEffectForVertexBuffers = effect;
  1436. let attributesCount = effect.getAttributesCount();
  1437. this._unbindVertexArrayObject();
  1438. this.unbindAllAttributes();
  1439. var offset = 0;
  1440. for (var index = 0; index < attributesCount; index++) {
  1441. if (index < vertexDeclaration.length) {
  1442. var order = effect.getAttributeLocation(index);
  1443. if (order >= 0) {
  1444. this._gl.enableVertexAttribArray(order);
  1445. this._vertexAttribArraysEnabled[order] = true;
  1446. this._vertexAttribPointer(vertexBuffer, order, vertexDeclaration[index], this._gl.FLOAT, false, vertexStrideSize, offset);
  1447. }
  1448. offset += vertexDeclaration[index] * 4;
  1449. }
  1450. }
  1451. }
  1452. this._bindIndexBufferWithCache(indexBuffer);
  1453. }
  1454. private _unbindVertexArrayObject(): void {
  1455. if (!this._cachedVertexArrayObject) {
  1456. return;
  1457. }
  1458. this._cachedVertexArrayObject = null;
  1459. this._gl.bindVertexArray(null);
  1460. }
  1461. /**
  1462. * Bind a list of vertex buffers to the webGL context
  1463. * @param vertexBuffers defines the list of vertex buffers to bind
  1464. * @param indexBuffer defines the index buffer to bind
  1465. * @param effect defines the effect associated with the vertex buffers
  1466. */
  1467. public bindBuffers(vertexBuffers: { [key: string]: Nullable<VertexBuffer> }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void {
  1468. if (this._cachedVertexBuffers !== vertexBuffers || this._cachedEffectForVertexBuffers !== effect) {
  1469. this._cachedVertexBuffers = vertexBuffers;
  1470. this._cachedEffectForVertexBuffers = effect;
  1471. this._bindVertexBuffersAttributes(vertexBuffers, effect);
  1472. }
  1473. this._bindIndexBufferWithCache(indexBuffer);
  1474. }
  1475. /**
  1476. * Unbind all instance attributes
  1477. */
  1478. public unbindInstanceAttributes() {
  1479. var boundBuffer;
  1480. for (var i = 0, ul = this._currentInstanceLocations.length; i < ul; i++) {
  1481. var instancesBuffer = this._currentInstanceBuffers[i];
  1482. if (boundBuffer != instancesBuffer && instancesBuffer.references) {
  1483. boundBuffer = instancesBuffer;
  1484. this.bindArrayBuffer(instancesBuffer);
  1485. }
  1486. var offsetLocation = this._currentInstanceLocations[i];
  1487. this._gl.vertexAttribDivisor(offsetLocation, 0);
  1488. }
  1489. this._currentInstanceBuffers.length = 0;
  1490. this._currentInstanceLocations.length = 0;
  1491. }
  1492. /**
  1493. * Release and free the memory of a vertex array object
  1494. * @param vao defines the vertex array object to delete
  1495. */
  1496. public releaseVertexArrayObject(vao: WebGLVertexArrayObject) {
  1497. this._gl.deleteVertexArray(vao);
  1498. }
  1499. /** @hidden */
  1500. public _releaseBuffer(buffer: DataBuffer): boolean {
  1501. buffer.references--;
  1502. if (buffer.references === 0) {
  1503. this._deleteBuffer(buffer);
  1504. return true;
  1505. }
  1506. return false;
  1507. }
  1508. protected _deleteBuffer(buffer: DataBuffer): void {
  1509. this._gl.deleteBuffer(buffer.underlyingResource);
  1510. }
  1511. /**
  1512. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  1513. * @param instancesBuffer defines the webGL buffer to update and bind
  1514. * @param data defines the data to store in the buffer
  1515. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  1516. */
  1517. public updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void {
  1518. this.bindArrayBuffer(instancesBuffer);
  1519. if (data) {
  1520. this._gl.bufferSubData(this._gl.ARRAY_BUFFER, 0, data);
  1521. }
  1522. if ((<any>offsetLocations[0]).index !== undefined) {
  1523. this.bindInstancesBuffer(instancesBuffer, offsetLocations as any, true);
  1524. } else {
  1525. for (let index = 0; index < 4; index++) {
  1526. let offsetLocation = <number>offsetLocations[index];
  1527. if (!this._vertexAttribArraysEnabled[offsetLocation]) {
  1528. this._gl.enableVertexAttribArray(offsetLocation);
  1529. this._vertexAttribArraysEnabled[offsetLocation] = true;
  1530. }
  1531. this._vertexAttribPointer(instancesBuffer, offsetLocation, 4, this._gl.FLOAT, false, 64, index * 16);
  1532. this._gl.vertexAttribDivisor(offsetLocation, 1);
  1533. this._currentInstanceLocations.push(offsetLocation);
  1534. this._currentInstanceBuffers.push(instancesBuffer);
  1535. }
  1536. }
  1537. }
  1538. /**
  1539. * Bind the content of a webGL buffer used with instanciation
  1540. * @param instancesBuffer defines the webGL buffer to bind
  1541. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  1542. * @param computeStride defines Wether to compute the strides from the info or use the default 0
  1543. */
  1544. public bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride = true): void {
  1545. this.bindArrayBuffer(instancesBuffer);
  1546. let stride = 0;
  1547. if (computeStride) {
  1548. for (let i = 0; i < attributesInfo.length; i++) {
  1549. let ai = attributesInfo[i];
  1550. stride += ai.attributeSize * 4;
  1551. }
  1552. }
  1553. for (let i = 0; i < attributesInfo.length; i++) {
  1554. let ai = attributesInfo[i];
  1555. if (ai.index === undefined) {
  1556. ai.index = this._currentEffect!.getAttributeLocationByName(ai.attributeName);
  1557. }
  1558. if (!this._vertexAttribArraysEnabled[ai.index]) {
  1559. this._gl.enableVertexAttribArray(ai.index);
  1560. this._vertexAttribArraysEnabled[ai.index] = true;
  1561. }
  1562. this._vertexAttribPointer(instancesBuffer, ai.index, ai.attributeSize, ai.attributeType || this._gl.FLOAT, ai.normalized || false, stride, ai.offset);
  1563. this._gl.vertexAttribDivisor(ai.index, ai.divisor === undefined ? 1 : ai.divisor);
  1564. this._currentInstanceLocations.push(ai.index);
  1565. this._currentInstanceBuffers.push(instancesBuffer);
  1566. }
  1567. }
  1568. /**
  1569. * Disable the instance attribute corresponding to the name in parameter
  1570. * @param name defines the name of the attribute to disable
  1571. */
  1572. public disableInstanceAttributeByName(name: string) {
  1573. if (!this._currentEffect) {
  1574. return;
  1575. }
  1576. const attributeLocation = this._currentEffect.getAttributeLocationByName(name);
  1577. this.disableInstanceAttribute(attributeLocation);
  1578. }
  1579. /**
  1580. * Disable the instance attribute corresponding to the location in parameter
  1581. * @param attributeLocation defines the attribute location of the attribute to disable
  1582. */
  1583. public disableInstanceAttribute(attributeLocation: number) {
  1584. let shouldClean = false;
  1585. let index: number;
  1586. while ((index = this._currentInstanceLocations.indexOf(attributeLocation)) !== -1) {
  1587. this._currentInstanceLocations.splice(index, 1);
  1588. this._currentInstanceBuffers.splice(index, 1);
  1589. shouldClean = true;
  1590. index = this._currentInstanceLocations.indexOf(attributeLocation);
  1591. }
  1592. if (shouldClean) {
  1593. this._gl.vertexAttribDivisor(attributeLocation, 0);
  1594. this.disableAttributeByIndex(attributeLocation);
  1595. }
  1596. }
  1597. /**
  1598. * Disable the attribute corresponding to the location in parameter
  1599. * @param attributeLocation defines the attribute location of the attribute to disable
  1600. */
  1601. public disableAttributeByIndex(attributeLocation: number) {
  1602. this._gl.disableVertexAttribArray(attributeLocation);
  1603. this._vertexAttribArraysEnabled[attributeLocation] = false;
  1604. this._currentBufferPointers[attributeLocation].active = false;
  1605. }
  1606. /**
  1607. * Send a draw order
  1608. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  1609. * @param indexStart defines the starting index
  1610. * @param indexCount defines the number of index to draw
  1611. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  1612. */
  1613. public draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void {
  1614. this.drawElementsType(useTriangles ? Constants.MATERIAL_TriangleFillMode : Constants.MATERIAL_WireFrameFillMode, indexStart, indexCount, instancesCount);
  1615. }
  1616. /**
  1617. * Draw a list of points
  1618. * @param verticesStart defines the index of first vertex to draw
  1619. * @param verticesCount defines the count of vertices to draw
  1620. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  1621. */
  1622. public drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void {
  1623. this.drawArraysType(Constants.MATERIAL_PointFillMode, verticesStart, verticesCount, instancesCount);
  1624. }
  1625. /**
  1626. * Draw a list of unindexed primitives
  1627. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  1628. * @param verticesStart defines the index of first vertex to draw
  1629. * @param verticesCount defines the count of vertices to draw
  1630. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  1631. */
  1632. public drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void {
  1633. this.drawArraysType(useTriangles ? Constants.MATERIAL_TriangleFillMode : Constants.MATERIAL_WireFrameFillMode, verticesStart, verticesCount, instancesCount);
  1634. }
  1635. /**
  1636. * Draw a list of indexed primitives
  1637. * @param fillMode defines the primitive to use
  1638. * @param indexStart defines the starting index
  1639. * @param indexCount defines the number of index to draw
  1640. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  1641. */
  1642. public drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void {
  1643. // Apply states
  1644. this.applyStates();
  1645. this._reportDrawCall();
  1646. // Render
  1647. const drawMode = this._drawMode(fillMode);
  1648. var indexFormat = this._uintIndicesCurrentlySet ? this._gl.UNSIGNED_INT : this._gl.UNSIGNED_SHORT;
  1649. var mult = this._uintIndicesCurrentlySet ? 4 : 2;
  1650. if (instancesCount) {
  1651. this._gl.drawElementsInstanced(drawMode, indexCount, indexFormat, indexStart * mult, instancesCount);
  1652. } else {
  1653. this._gl.drawElements(drawMode, indexCount, indexFormat, indexStart * mult);
  1654. }
  1655. }
  1656. /**
  1657. * Draw a list of unindexed primitives
  1658. * @param fillMode defines the primitive to use
  1659. * @param verticesStart defines the index of first vertex to draw
  1660. * @param verticesCount defines the count of vertices to draw
  1661. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  1662. */
  1663. public drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void {
  1664. // Apply states
  1665. this.applyStates();
  1666. this._reportDrawCall();
  1667. const drawMode = this._drawMode(fillMode);
  1668. if (instancesCount) {
  1669. this._gl.drawArraysInstanced(drawMode, verticesStart, verticesCount, instancesCount);
  1670. } else {
  1671. this._gl.drawArrays(drawMode, verticesStart, verticesCount);
  1672. }
  1673. }
  1674. private _drawMode(fillMode: number): number {
  1675. switch (fillMode) {
  1676. // Triangle views
  1677. case Constants.MATERIAL_TriangleFillMode:
  1678. return this._gl.TRIANGLES;
  1679. case Constants.MATERIAL_PointFillMode:
  1680. return this._gl.POINTS;
  1681. case Constants.MATERIAL_WireFrameFillMode:
  1682. return this._gl.LINES;
  1683. // Draw modes
  1684. case Constants.MATERIAL_PointListDrawMode:
  1685. return this._gl.POINTS;
  1686. case Constants.MATERIAL_LineListDrawMode:
  1687. return this._gl.LINES;
  1688. case Constants.MATERIAL_LineLoopDrawMode:
  1689. return this._gl.LINE_LOOP;
  1690. case Constants.MATERIAL_LineStripDrawMode:
  1691. return this._gl.LINE_STRIP;
  1692. case Constants.MATERIAL_TriangleStripDrawMode:
  1693. return this._gl.TRIANGLE_STRIP;
  1694. case Constants.MATERIAL_TriangleFanDrawMode:
  1695. return this._gl.TRIANGLE_FAN;
  1696. default:
  1697. return this._gl.TRIANGLES;
  1698. }
  1699. }
  1700. /** @hidden */
  1701. protected _reportDrawCall() {
  1702. // Will be implemented by children
  1703. }
  1704. // Shaders
  1705. /** @hidden */
  1706. public _releaseEffect(effect: Effect): void {
  1707. if (this._compiledEffects[effect._key]) {
  1708. delete this._compiledEffects[effect._key];
  1709. this._deletePipelineContext(effect.getPipelineContext() as WebGLPipelineContext);
  1710. }
  1711. }
  1712. /** @hidden */
  1713. public _deletePipelineContext(pipelineContext: IPipelineContext): void {
  1714. let webGLPipelineContext = pipelineContext as WebGLPipelineContext;
  1715. if (webGLPipelineContext && webGLPipelineContext.program) {
  1716. webGLPipelineContext.program.__SPECTOR_rebuildProgram = null;
  1717. this._gl.deleteProgram(webGLPipelineContext.program);
  1718. }
  1719. }
  1720. /**
  1721. * Create a new effect (used to store vertex/fragment shaders)
  1722. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  1723. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  1724. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  1725. * @param samplers defines an array of string used to represent textures
  1726. * @param defines defines the string containing the defines to use to compile the shaders
  1727. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  1728. * @param onCompiled defines a function to call when the effect creation is successful
  1729. * @param onError defines a function to call when the effect creation has failed
  1730. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  1731. * @returns the new Effect
  1732. */
  1733. public createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string,
  1734. fallbacks?: IEffectFallbacks,
  1735. onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect {
  1736. var vertex = baseName.vertexElement || baseName.vertex || baseName;
  1737. var fragment = baseName.fragmentElement || baseName.fragment || baseName;
  1738. var name = vertex + "+" + fragment + "@" + (defines ? defines : (<IEffectCreationOptions>attributesNamesOrOptions).defines);
  1739. if (this._compiledEffects[name]) {
  1740. var compiledEffect = <Effect>this._compiledEffects[name];
  1741. if (onCompiled && compiledEffect.isReady()) {
  1742. onCompiled(compiledEffect);
  1743. }
  1744. return compiledEffect;
  1745. }
  1746. var effect = new Effect(baseName, attributesNamesOrOptions, uniformsNamesOrEngine, samplers, this, defines, fallbacks, onCompiled, onError, indexParameters);
  1747. effect._key = name;
  1748. this._compiledEffects[name] = effect;
  1749. return effect;
  1750. }
  1751. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion: string = ""): string {
  1752. return shaderVersion + (defines ? defines + "\n" : "") + source;
  1753. }
  1754. private _compileShader(source: string, type: string, defines: Nullable<string>, shaderVersion: string): WebGLShader {
  1755. return this._compileRawShader(ThinEngine._ConcatenateShader(source, defines, shaderVersion), type);
  1756. }
  1757. private _compileRawShader(source: string, type: string): WebGLShader {
  1758. var gl = this._gl;
  1759. var shader = gl.createShader(type === "vertex" ? gl.VERTEX_SHADER : gl.FRAGMENT_SHADER);
  1760. if (!shader) {
  1761. throw new Error("Something went wrong while compile the shader.");
  1762. }
  1763. gl.shaderSource(shader, source);
  1764. gl.compileShader(shader);
  1765. return shader;
  1766. }
  1767. /**
  1768. * Directly creates a webGL program
  1769. * @param pipelineContext defines the pipeline context to attach to
  1770. * @param vertexCode defines the vertex shader code to use
  1771. * @param fragmentCode defines the fragment shader code to use
  1772. * @param context defines the webGL context to use (if not set, the current one will be used)
  1773. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  1774. * @returns the new webGL program
  1775. */
  1776. public createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings: Nullable<string[]> = null): WebGLProgram {
  1777. context = context || this._gl;
  1778. var vertexShader = this._compileRawShader(vertexCode, "vertex");
  1779. var fragmentShader = this._compileRawShader(fragmentCode, "fragment");
  1780. return this._createShaderProgram(pipelineContext as WebGLPipelineContext, vertexShader, fragmentShader, context, transformFeedbackVaryings);
  1781. }
  1782. /**
  1783. * Creates a webGL program
  1784. * @param pipelineContext defines the pipeline context to attach to
  1785. * @param vertexCode defines the vertex shader code to use
  1786. * @param fragmentCode defines the fragment shader code to use
  1787. * @param defines defines the string containing the defines to use to compile the shaders
  1788. * @param context defines the webGL context to use (if not set, the current one will be used)
  1789. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  1790. * @returns the new webGL program
  1791. */
  1792. public createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings: Nullable<string[]> = null): WebGLProgram {
  1793. context = context || this._gl;
  1794. var shaderVersion = (this._webGLVersion > 1) ? "#version 300 es\n#define WEBGL2 \n" : "";
  1795. var vertexShader = this._compileShader(vertexCode, "vertex", defines, shaderVersion);
  1796. var fragmentShader = this._compileShader(fragmentCode, "fragment", defines, shaderVersion);
  1797. return this._createShaderProgram(pipelineContext as WebGLPipelineContext, vertexShader, fragmentShader, context, transformFeedbackVaryings);
  1798. }
  1799. /**
  1800. * Creates a new pipeline context
  1801. * @returns the new pipeline
  1802. */
  1803. public createPipelineContext(): IPipelineContext {
  1804. var pipelineContext = new WebGLPipelineContext();
  1805. pipelineContext.engine = this;
  1806. if (this._caps.parallelShaderCompile) {
  1807. pipelineContext.isParallelCompiled = true;
  1808. }
  1809. return pipelineContext;
  1810. }
  1811. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings: Nullable<string[]> = null): WebGLProgram {
  1812. var shaderProgram = context.createProgram();
  1813. pipelineContext.program = shaderProgram;
  1814. if (!shaderProgram) {
  1815. throw new Error("Unable to create program");
  1816. }
  1817. context.attachShader(shaderProgram, vertexShader);
  1818. context.attachShader(shaderProgram, fragmentShader);
  1819. context.linkProgram(shaderProgram);
  1820. pipelineContext.context = context;
  1821. pipelineContext.vertexShader = vertexShader;
  1822. pipelineContext.fragmentShader = fragmentShader;
  1823. if (!pipelineContext.isParallelCompiled) {
  1824. this._finalizePipelineContext(pipelineContext);
  1825. }
  1826. return shaderProgram;
  1827. }
  1828. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext) {
  1829. const context = pipelineContext.context!;
  1830. const vertexShader = pipelineContext.vertexShader!;
  1831. const fragmentShader = pipelineContext.fragmentShader!;
  1832. const program = pipelineContext.program!;
  1833. var linked = context.getProgramParameter(program, context.LINK_STATUS);
  1834. if (!linked) { // Get more info
  1835. // Vertex
  1836. if (!this._gl.getShaderParameter(vertexShader, this._gl.COMPILE_STATUS)) {
  1837. const log = this._gl.getShaderInfoLog(vertexShader);
  1838. if (log) {
  1839. pipelineContext.vertexCompilationError = log;
  1840. throw new Error("VERTEX SHADER " + log);
  1841. }
  1842. }
  1843. // Fragment
  1844. if (!this._gl.getShaderParameter(fragmentShader, this._gl.COMPILE_STATUS)) {
  1845. const log = this._gl.getShaderInfoLog(fragmentShader);
  1846. if (log) {
  1847. pipelineContext.fragmentCompilationError = log;
  1848. throw new Error("FRAGMENT SHADER " + log);
  1849. }
  1850. }
  1851. var error = context.getProgramInfoLog(program);
  1852. if (error) {
  1853. pipelineContext.programLinkError = error;
  1854. throw new Error(error);
  1855. }
  1856. }
  1857. if (this.validateShaderPrograms) {
  1858. context.validateProgram(program);
  1859. var validated = context.getProgramParameter(program, context.VALIDATE_STATUS);
  1860. if (!validated) {
  1861. var error = context.getProgramInfoLog(program);
  1862. if (error) {
  1863. pipelineContext.programValidationError = error;
  1864. throw new Error(error);
  1865. }
  1866. }
  1867. }
  1868. context.deleteShader(vertexShader);
  1869. context.deleteShader(fragmentShader);
  1870. pipelineContext.vertexShader = undefined;
  1871. pipelineContext.fragmentShader = undefined;
  1872. if (pipelineContext.onCompiled) {
  1873. pipelineContext.onCompiled();
  1874. pipelineContext.onCompiled = undefined;
  1875. }
  1876. }
  1877. /** @hidden */
  1878. public _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean,
  1879. rebuildRebind: any,
  1880. defines: Nullable<string>,
  1881. transformFeedbackVaryings: Nullable<string[]>) {
  1882. let webGLRenderingState = pipelineContext as WebGLPipelineContext;
  1883. if (createAsRaw) {
  1884. webGLRenderingState.program = this.createRawShaderProgram(webGLRenderingState, vertexSourceCode, fragmentSourceCode, undefined, transformFeedbackVaryings);
  1885. }
  1886. else {
  1887. webGLRenderingState.program = this.createShaderProgram(webGLRenderingState, vertexSourceCode, fragmentSourceCode, defines, undefined, transformFeedbackVaryings);
  1888. }
  1889. webGLRenderingState.program.__SPECTOR_rebuildProgram = rebuildRebind;
  1890. }
  1891. /** @hidden */
  1892. public _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean {
  1893. let webGLPipelineContext = pipelineContext as WebGLPipelineContext;
  1894. if (this._gl.getProgramParameter(webGLPipelineContext.program!, this._caps.parallelShaderCompile!.COMPLETION_STATUS_KHR)) {
  1895. this._finalizePipelineContext(webGLPipelineContext);
  1896. return true;
  1897. }
  1898. return false;
  1899. }
  1900. /** @hidden */
  1901. public _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void) {
  1902. let webGLPipelineContext = pipelineContext as WebGLPipelineContext;
  1903. if (!webGLPipelineContext.isParallelCompiled) {
  1904. action();
  1905. return;
  1906. }
  1907. let oldHandler = webGLPipelineContext.onCompiled;
  1908. if (oldHandler) {
  1909. webGLPipelineContext.onCompiled = () => {
  1910. oldHandler!();
  1911. action();
  1912. };
  1913. } else {
  1914. webGLPipelineContext.onCompiled = action;
  1915. }
  1916. }
  1917. /**
  1918. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  1919. * @param pipelineContext defines the pipeline context to use
  1920. * @param uniformsNames defines the list of uniform names
  1921. * @returns an array of webGL uniform locations
  1922. */
  1923. public getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[] {
  1924. var results = new Array<Nullable<WebGLUniformLocation>>();
  1925. let webGLPipelineContext = pipelineContext as WebGLPipelineContext;
  1926. for (var index = 0; index < uniformsNames.length; index++) {
  1927. results.push(this._gl.getUniformLocation(webGLPipelineContext.program!, uniformsNames[index]));
  1928. }
  1929. return results;
  1930. }
  1931. /**
  1932. * Gets the lsit of active attributes for a given webGL program
  1933. * @param pipelineContext defines the pipeline context to use
  1934. * @param attributesNames defines the list of attribute names to get
  1935. * @returns an array of indices indicating the offset of each attribute
  1936. */
  1937. public getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[] {
  1938. var results = [];
  1939. let webGLPipelineContext = pipelineContext as WebGLPipelineContext;
  1940. for (var index = 0; index < attributesNames.length; index++) {
  1941. try {
  1942. results.push(this._gl.getAttribLocation(webGLPipelineContext.program!, attributesNames[index]));
  1943. } catch (e) {
  1944. results.push(-1);
  1945. }
  1946. }
  1947. return results;
  1948. }
  1949. /**
  1950. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  1951. * @param effect defines the effect to activate
  1952. */
  1953. public enableEffect(effect: Nullable<Effect>): void {
  1954. if (!effect || effect === this._currentEffect) {
  1955. return;
  1956. }
  1957. // Use program
  1958. this.bindSamplers(effect);
  1959. this._currentEffect = effect;
  1960. if (effect.onBind) {
  1961. effect.onBind(effect);
  1962. }
  1963. if (effect._onBindObservable) {
  1964. effect._onBindObservable.notifyObservers(effect);
  1965. }
  1966. }
  1967. /**
  1968. * Set the value of an uniform to a number (int)
  1969. * @param uniform defines the webGL uniform location where to store the value
  1970. * @param value defines the int number to store
  1971. */
  1972. public setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void {
  1973. if (!uniform) {
  1974. return;
  1975. }
  1976. this._gl.uniform1i(uniform, value);
  1977. }
  1978. /**
  1979. * Set the value of an uniform to an array of int32
  1980. * @param uniform defines the webGL uniform location where to store the value
  1981. * @param array defines the array of int32 to store
  1982. */
  1983. public setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void {
  1984. if (!uniform) {
  1985. return;
  1986. }
  1987. this._gl.uniform1iv(uniform, array);
  1988. }
  1989. /**
  1990. * Set the value of an uniform to an array of int32 (stored as vec2)
  1991. * @param uniform defines the webGL uniform location where to store the value
  1992. * @param array defines the array of int32 to store
  1993. */
  1994. public setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void {
  1995. if (!uniform || array.length % 2 !== 0) {
  1996. return;
  1997. }
  1998. this._gl.uniform2iv(uniform, array);
  1999. }
  2000. /**
  2001. * Set the value of an uniform to an array of int32 (stored as vec3)
  2002. * @param uniform defines the webGL uniform location where to store the value
  2003. * @param array defines the array of int32 to store
  2004. */
  2005. public setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void {
  2006. if (!uniform || array.length % 3 !== 0) {
  2007. return;
  2008. }
  2009. this._gl.uniform3iv(uniform, array);
  2010. }
  2011. /**
  2012. * Set the value of an uniform to an array of int32 (stored as vec4)
  2013. * @param uniform defines the webGL uniform location where to store the value
  2014. * @param array defines the array of int32 to store
  2015. */
  2016. public setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void {
  2017. if (!uniform || array.length % 4 !== 0) {
  2018. return;
  2019. }
  2020. this._gl.uniform4iv(uniform, array);
  2021. }
  2022. /**
  2023. * Set the value of an uniform to an array of number
  2024. * @param uniform defines the webGL uniform location where to store the value
  2025. * @param array defines the array of number to store
  2026. */
  2027. public setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void {
  2028. if (!uniform) {
  2029. return;
  2030. }
  2031. this._gl.uniform1fv(uniform, array);
  2032. }
  2033. /**
  2034. * Set the value of an uniform to an array of number (stored as vec2)
  2035. * @param uniform defines the webGL uniform location where to store the value
  2036. * @param array defines the array of number to store
  2037. */
  2038. public setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void {
  2039. if (!uniform || array.length % 2 !== 0) {
  2040. return;
  2041. }
  2042. this._gl.uniform2fv(uniform, <any>array);
  2043. }
  2044. /**
  2045. * Set the value of an uniform to an array of number (stored as vec3)
  2046. * @param uniform defines the webGL uniform location where to store the value
  2047. * @param array defines the array of number to store
  2048. */
  2049. public setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void {
  2050. if (!uniform || array.length % 3 !== 0) {
  2051. return;
  2052. }
  2053. this._gl.uniform3fv(uniform, <any>array);
  2054. }
  2055. /**
  2056. * Set the value of an uniform to an array of number (stored as vec4)
  2057. * @param uniform defines the webGL uniform location where to store the value
  2058. * @param array defines the array of number to store
  2059. */
  2060. public setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void {
  2061. if (!uniform || array.length % 4 !== 0) {
  2062. return;
  2063. }
  2064. this._gl.uniform4fv(uniform, <any>array);
  2065. }
  2066. /**
  2067. * Set the value of an uniform to an array of float32 (stored as matrices)
  2068. * @param uniform defines the webGL uniform location where to store the value
  2069. * @param matrices defines the array of float32 to store
  2070. */
  2071. public setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void {
  2072. if (!uniform) {
  2073. return;
  2074. }
  2075. this._gl.uniformMatrix4fv(uniform, false, matrices);
  2076. }
  2077. /**
  2078. * Set the value of an uniform to a matrix (3x3)
  2079. * @param uniform defines the webGL uniform location where to store the value
  2080. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  2081. */
  2082. public setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void {
  2083. if (!uniform) {
  2084. return;
  2085. }
  2086. this._gl.uniformMatrix3fv(uniform, false, matrix);
  2087. }
  2088. /**
  2089. * Set the value of an uniform to a matrix (2x2)
  2090. * @param uniform defines the webGL uniform location where to store the value
  2091. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  2092. */
  2093. public setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void {
  2094. if (!uniform) {
  2095. return;
  2096. }
  2097. this._gl.uniformMatrix2fv(uniform, false, matrix);
  2098. }
  2099. /**
  2100. * Set the value of an uniform to a number (float)
  2101. * @param uniform defines the webGL uniform location where to store the value
  2102. * @param value defines the float number to store
  2103. */
  2104. public setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void {
  2105. if (!uniform) {
  2106. return;
  2107. }
  2108. this._gl.uniform1f(uniform, value);
  2109. }
  2110. /**
  2111. * Set the value of an uniform to a vec2
  2112. * @param uniform defines the webGL uniform location where to store the value
  2113. * @param x defines the 1st component of the value
  2114. * @param y defines the 2nd component of the value
  2115. */
  2116. public setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void {
  2117. if (!uniform) {
  2118. return;
  2119. }
  2120. this._gl.uniform2f(uniform, x, y);
  2121. }
  2122. /**
  2123. * Set the value of an uniform to a vec3
  2124. * @param uniform defines the webGL uniform location where to store the value
  2125. * @param x defines the 1st component of the value
  2126. * @param y defines the 2nd component of the value
  2127. * @param z defines the 3rd component of the value
  2128. */
  2129. public setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void {
  2130. if (!uniform) {
  2131. return;
  2132. }
  2133. this._gl.uniform3f(uniform, x, y, z);
  2134. }
  2135. /**
  2136. * Set the value of an uniform to a vec4
  2137. * @param uniform defines the webGL uniform location where to store the value
  2138. * @param x defines the 1st component of the value
  2139. * @param y defines the 2nd component of the value
  2140. * @param z defines the 3rd component of the value
  2141. * @param w defines the 4th component of the value
  2142. */
  2143. public setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void {
  2144. if (!uniform) {
  2145. return;
  2146. }
  2147. this._gl.uniform4f(uniform, x, y, z, w);
  2148. }
  2149. // States
  2150. /**
  2151. * Apply all cached states (depth, culling, stencil and alpha)
  2152. */
  2153. public applyStates() {
  2154. this._depthCullingState.apply(this._gl);
  2155. this._stencilState.apply(this._gl);
  2156. this._alphaState.apply(this._gl);
  2157. if (this._colorWriteChanged) {
  2158. this._colorWriteChanged = false;
  2159. const enable = this._colorWrite;
  2160. this._gl.colorMask(enable, enable, enable, enable);
  2161. }
  2162. }
  2163. /**
  2164. * Enable or disable color writing
  2165. * @param enable defines the state to set
  2166. */
  2167. public setColorWrite(enable: boolean): void {
  2168. if (enable !== this._colorWrite) {
  2169. this._colorWriteChanged = true;
  2170. this._colorWrite = enable;
  2171. }
  2172. }
  2173. /**
  2174. * Gets a boolean indicating if color writing is enabled
  2175. * @returns the current color writing state
  2176. */
  2177. public getColorWrite(): boolean {
  2178. return this._colorWrite;
  2179. }
  2180. /**
  2181. * Gets the depth culling state manager
  2182. */
  2183. public get depthCullingState(): DepthCullingState {
  2184. return this._depthCullingState;
  2185. }
  2186. /**
  2187. * Gets the alpha state manager
  2188. */
  2189. public get alphaState(): AlphaState {
  2190. return this._alphaState;
  2191. }
  2192. /**
  2193. * Gets the stencil state manager
  2194. */
  2195. public get stencilState(): StencilState {
  2196. return this._stencilState;
  2197. }
  2198. // Textures
  2199. /**
  2200. * Clears the list of texture accessible through engine.
  2201. * This can help preventing texture load conflict due to name collision.
  2202. */
  2203. public clearInternalTexturesCache() {
  2204. this._internalTexturesCache = [];
  2205. }
  2206. /**
  2207. * Force the entire cache to be cleared
  2208. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  2209. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  2210. */
  2211. public wipeCaches(bruteForce?: boolean): void {
  2212. if (this.preventCacheWipeBetweenFrames && !bruteForce) {
  2213. return;
  2214. }
  2215. this._currentEffect = null;
  2216. this._viewportCached.x = 0;
  2217. this._viewportCached.y = 0;
  2218. this._viewportCached.z = 0;
  2219. this._viewportCached.w = 0;
  2220. if (bruteForce) {
  2221. this._currentProgram = null;
  2222. this.resetTextureCache();
  2223. this._stencilState.reset();
  2224. this._depthCullingState.reset();
  2225. this._depthCullingState.depthFunc = this._gl.LEQUAL;
  2226. this._alphaState.reset();
  2227. this._alphaMode = Constants.ALPHA_ADD;
  2228. this._alphaEquation = Constants.ALPHA_DISABLE;
  2229. this._colorWrite = true;
  2230. this._colorWriteChanged = true;
  2231. this._unpackFlipYCached = null;
  2232. this._gl.pixelStorei(this._gl.UNPACK_COLORSPACE_CONVERSION_WEBGL, this._gl.NONE);
  2233. this._gl.pixelStorei(this._gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, 0);
  2234. this._mustWipeVertexAttributes = true;
  2235. this.unbindAllAttributes();
  2236. }
  2237. this._resetVertexBufferBinding();
  2238. this._cachedIndexBuffer = null;
  2239. this._cachedEffectForVertexBuffers = null;
  2240. this._unbindVertexArrayObject();
  2241. this.bindIndexBuffer(null);
  2242. }
  2243. /** @hidden */
  2244. public _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): { min: number; mag: number } {
  2245. var gl = this._gl;
  2246. var magFilter = gl.NEAREST;
  2247. var minFilter = gl.NEAREST;
  2248. switch (samplingMode) {
  2249. case Constants.TEXTURE_BILINEAR_SAMPLINGMODE:
  2250. magFilter = gl.LINEAR;
  2251. if (generateMipMaps) {
  2252. minFilter = gl.LINEAR_MIPMAP_NEAREST;
  2253. } else {
  2254. minFilter = gl.LINEAR;
  2255. }
  2256. break;
  2257. case Constants.TEXTURE_TRILINEAR_SAMPLINGMODE:
  2258. magFilter = gl.LINEAR;
  2259. if (generateMipMaps) {
  2260. minFilter = gl.LINEAR_MIPMAP_LINEAR;
  2261. } else {
  2262. minFilter = gl.LINEAR;
  2263. }
  2264. break;
  2265. case Constants.TEXTURE_NEAREST_SAMPLINGMODE:
  2266. magFilter = gl.NEAREST;
  2267. if (generateMipMaps) {
  2268. minFilter = gl.NEAREST_MIPMAP_LINEAR;
  2269. } else {
  2270. minFilter = gl.NEAREST;
  2271. }
  2272. break;
  2273. case Constants.TEXTURE_NEAREST_NEAREST_MIPNEAREST:
  2274. magFilter = gl.NEAREST;
  2275. if (generateMipMaps) {
  2276. minFilter = gl.NEAREST_MIPMAP_NEAREST;
  2277. } else {
  2278. minFilter = gl.NEAREST;
  2279. }
  2280. break;
  2281. case Constants.TEXTURE_NEAREST_LINEAR_MIPNEAREST:
  2282. magFilter = gl.NEAREST;
  2283. if (generateMipMaps) {
  2284. minFilter = gl.LINEAR_MIPMAP_NEAREST;
  2285. } else {
  2286. minFilter = gl.LINEAR;
  2287. }
  2288. break;
  2289. case Constants.TEXTURE_NEAREST_LINEAR_MIPLINEAR:
  2290. magFilter = gl.NEAREST;
  2291. if (generateMipMaps) {
  2292. minFilter = gl.LINEAR_MIPMAP_LINEAR;
  2293. } else {
  2294. minFilter = gl.LINEAR;
  2295. }
  2296. break;
  2297. case Constants.TEXTURE_NEAREST_LINEAR:
  2298. magFilter = gl.NEAREST;
  2299. minFilter = gl.LINEAR;
  2300. break;
  2301. case Constants.TEXTURE_NEAREST_NEAREST:
  2302. magFilter = gl.NEAREST;
  2303. minFilter = gl.NEAREST;
  2304. break;
  2305. case Constants.TEXTURE_LINEAR_NEAREST_MIPNEAREST:
  2306. magFilter = gl.LINEAR;
  2307. if (generateMipMaps) {
  2308. minFilter = gl.NEAREST_MIPMAP_NEAREST;
  2309. } else {
  2310. minFilter = gl.NEAREST;
  2311. }
  2312. break;
  2313. case Constants.TEXTURE_LINEAR_NEAREST_MIPLINEAR:
  2314. magFilter = gl.LINEAR;
  2315. if (generateMipMaps) {
  2316. minFilter = gl.NEAREST_MIPMAP_LINEAR;
  2317. } else {
  2318. minFilter = gl.NEAREST;
  2319. }
  2320. break;
  2321. case Constants.TEXTURE_LINEAR_LINEAR:
  2322. magFilter = gl.LINEAR;
  2323. minFilter = gl.LINEAR;
  2324. break;
  2325. case Constants.TEXTURE_LINEAR_NEAREST:
  2326. magFilter = gl.LINEAR;
  2327. minFilter = gl.NEAREST;
  2328. break;
  2329. }
  2330. return {
  2331. min: minFilter,
  2332. mag: magFilter
  2333. };
  2334. }
  2335. /** @hidden */
  2336. public _createTexture(): WebGLTexture {
  2337. let texture = this._gl.createTexture();
  2338. if (!texture) {
  2339. throw new Error("Unable to create texture");
  2340. }
  2341. return texture;
  2342. }
  2343. /**
  2344. * Usually called from Texture.ts.
  2345. * Passed information to create a WebGLTexture
  2346. * @param urlArg defines a value which contains one of the following:
  2347. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  2348. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  2349. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  2350. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  2351. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  2352. * @param scene needed for loading to the correct scene
  2353. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  2354. * @param onLoad optional callback to be called upon successful completion
  2355. * @param onError optional callback to be called upon failure
  2356. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  2357. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  2358. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  2359. * @param forcedExtension defines the extension to use to pick the right loader
  2360. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  2361. * @param mimeType defines an optional mime type
  2362. * @returns a InternalTexture for assignment back into BABYLON.Texture
  2363. */
  2364. public createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode: number = Constants.TEXTURE_TRILINEAR_SAMPLINGMODE,
  2365. onLoad: Nullable<() => void> = null, onError: Nullable<(message: string, exception: any) => void> = null,
  2366. buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap> = null, fallback: Nullable<InternalTexture> = null, format: Nullable<number> = null,
  2367. forcedExtension: Nullable<string> = null, excludeLoaders: Array<IInternalTextureLoader> = [], mimeType?: string): InternalTexture {
  2368. var url = String(urlArg); // assign a new string, so that the original is still available in case of fallback
  2369. var fromData = url.substr(0, 5) === "data:";
  2370. var fromBlob = url.substr(0, 5) === "blob:";
  2371. var isBase64 = fromData && url.indexOf(";base64,") !== -1;
  2372. let texture = fallback ? fallback : new InternalTexture(this, InternalTextureSource.Url);
  2373. // establish the file extension, if possible
  2374. var lastDot = url.lastIndexOf('.');
  2375. var extension = forcedExtension ? forcedExtension : (lastDot > -1 ? url.substring(lastDot).toLowerCase() : "");
  2376. const filteredFormat: Nullable<string> = this.excludedCompressedTextureFormats(url, this._textureFormatInUse);
  2377. let loader: Nullable<IInternalTextureLoader> = null;
  2378. for (let availableLoader of ThinEngine._TextureLoaders) {
  2379. if (excludeLoaders.indexOf(availableLoader) === -1 && availableLoader.canLoad(extension, filteredFormat, fallback, isBase64, buffer ? true : false)) {
  2380. loader = availableLoader;
  2381. break;
  2382. }
  2383. }
  2384. if (loader) {
  2385. url = loader.transformUrl(url, filteredFormat);
  2386. }
  2387. if (scene) {
  2388. scene._addPendingData(texture);
  2389. }
  2390. texture.url = url;
  2391. texture.generateMipMaps = !noMipmap;
  2392. texture.samplingMode = samplingMode;
  2393. texture.invertY = invertY;
  2394. if (!this._doNotHandleContextLost) {
  2395. // Keep a link to the buffer only if we plan to handle context lost
  2396. texture._buffer = buffer;
  2397. }
  2398. let onLoadObserver: Nullable<Observer<InternalTexture>> = null;
  2399. if (onLoad && !fallback) {
  2400. onLoadObserver = texture.onLoadedObservable.add(onLoad);
  2401. }
  2402. if (!fallback) { this._internalTexturesCache.push(texture); }
  2403. let onInternalError = (message?: string, exception?: any) => {
  2404. if (scene) {
  2405. scene._removePendingData(texture);
  2406. }
  2407. let customFallback = false;
  2408. if (loader) {
  2409. const fallbackUrl = loader.getFallbackTextureUrl(url, this._textureFormatInUse);
  2410. if (fallbackUrl) {
  2411. // Add Back
  2412. customFallback = true;
  2413. excludeLoaders.push(loader);
  2414. this.createTexture(urlArg, noMipmap, texture.invertY, scene, samplingMode, null, onError, buffer, texture, undefined, undefined, excludeLoaders);
  2415. return;
  2416. }
  2417. }
  2418. if (!customFallback) {
  2419. if (onLoadObserver) {
  2420. texture.onLoadedObservable.remove(onLoadObserver);
  2421. }
  2422. if (EngineStore.UseFallbackTexture) {
  2423. this.createTexture(EngineStore.FallbackTexture, noMipmap, texture.invertY, scene, samplingMode, null, onError, buffer, texture);
  2424. return;
  2425. }
  2426. }
  2427. if (onError) {
  2428. onError(message || "Unknown error", exception);
  2429. }
  2430. };
  2431. // processing for non-image formats
  2432. if (loader) {
  2433. var callback = (data: string | ArrayBuffer) => {
  2434. loader!.loadData(data as ArrayBuffer, texture, (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed) => {
  2435. if (loadFailed) {
  2436. onInternalError("TextureLoader failed to load data");
  2437. } else {
  2438. this._prepareWebGLTexture(texture, scene, width, height, texture.invertY, !loadMipmap, isCompressed, () => {
  2439. done();
  2440. return false;
  2441. }, samplingMode);
  2442. }
  2443. });
  2444. };
  2445. if (!buffer) {
  2446. this._loadFile(url, callback, undefined, scene ? scene.offlineProvider : undefined, true, (request?: IWebRequest, exception?: any) => {
  2447. onInternalError("Unable to load " + (request ? request.responseURL : url, exception));
  2448. });
  2449. } else {
  2450. //callback(buffer as ArrayBuffer);
  2451. if (buffer instanceof ArrayBuffer) {
  2452. callback(buffer);
  2453. }
  2454. else {
  2455. if (onError) {
  2456. onError("Unable to load: only ArrayBuffer supported here", null);
  2457. }
  2458. }
  2459. }
  2460. } else {
  2461. var onload = (img: HTMLImageElement | ImageBitmap) => {
  2462. if (fromBlob && !this._doNotHandleContextLost) {
  2463. // We need to store the image if we need to rebuild the texture
  2464. // in case of a webgl context lost
  2465. texture._buffer = img;
  2466. }
  2467. this._prepareWebGLTexture(texture, scene, img.width, img.height, texture.invertY, noMipmap, false, (potWidth, potHeight, continuationCallback) => {
  2468. let gl = this._gl;
  2469. var isPot = (img.width === potWidth && img.height === potHeight);
  2470. let internalFormat = format ? this._getInternalFormat(format) : ((extension === ".jpg") ? gl.RGB : gl.RGBA);
  2471. if (isPot) {
  2472. gl.texImage2D(gl.TEXTURE_2D, 0, internalFormat, internalFormat, gl.UNSIGNED_BYTE, img);
  2473. return false;
  2474. }
  2475. let maxTextureSize = this._caps.maxTextureSize;
  2476. if (img.width > maxTextureSize || img.height > maxTextureSize || !this._supportsHardwareTextureRescaling) {
  2477. this._prepareWorkingCanvas();
  2478. if (!this._workingCanvas || !this._workingContext) {
  2479. return false;
  2480. }
  2481. this._workingCanvas.width = potWidth;
  2482. this._workingCanvas.height = potHeight;
  2483. this._workingContext.drawImage(img, 0, 0, img.width, img.height, 0, 0, potWidth, potHeight);
  2484. gl.texImage2D(gl.TEXTURE_2D, 0, internalFormat, internalFormat, gl.UNSIGNED_BYTE, this._workingCanvas);
  2485. texture.width = potWidth;
  2486. texture.height = potHeight;
  2487. return false;
  2488. } else {
  2489. // Using shaders when possible to rescale because canvas.drawImage is lossy
  2490. let source = new InternalTexture(this, InternalTextureSource.Temp);
  2491. this._bindTextureDirectly(gl.TEXTURE_2D, source, true);
  2492. gl.texImage2D(gl.TEXTURE_2D, 0, internalFormat, internalFormat, gl.UNSIGNED_BYTE, img);
  2493. this._rescaleTexture(source, texture, scene, internalFormat, () => {
  2494. this._releaseTexture(source);
  2495. this._bindTextureDirectly(gl.TEXTURE_2D, texture, true);
  2496. continuationCallback();
  2497. });
  2498. }
  2499. return true;
  2500. }, samplingMode);
  2501. };
  2502. if (!fromData || isBase64) {
  2503. if (buffer && ((<HTMLImageElement>buffer).decoding || (<ImageBitmap>buffer).close)) {
  2504. onload(<HTMLImageElement>buffer);
  2505. } else {
  2506. FileTools.LoadImage(url, onload, onInternalError, scene ? scene.offlineProvider : null, mimeType);
  2507. }
  2508. }
  2509. else if (typeof buffer === "string" || buffer instanceof ArrayBuffer || ArrayBuffer.isView(buffer) || buffer instanceof Blob) {
  2510. FileTools.LoadImage(buffer, onload, onInternalError, scene ? scene.offlineProvider : null, mimeType);
  2511. }
  2512. else if (buffer) {
  2513. onload(<HTMLImageElement>buffer);
  2514. }
  2515. }
  2516. return texture;
  2517. }
  2518. /**
  2519. * @hidden
  2520. */
  2521. public _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void {
  2522. }
  2523. /**
  2524. * Creates a raw texture
  2525. * @param data defines the data to store in the texture
  2526. * @param width defines the width of the texture
  2527. * @param height defines the height of the texture
  2528. * @param format defines the format of the data
  2529. * @param generateMipMaps defines if the engine should generate the mip levels
  2530. * @param invertY defines if data must be stored with Y axis inverted
  2531. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  2532. * @param compression defines the compression used (null by default)
  2533. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  2534. * @returns the raw texture inside an InternalTexture
  2535. */
  2536. public createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string> = null, type: number = Constants.TEXTURETYPE_UNSIGNED_INT): InternalTexture {
  2537. throw _DevTools.WarnImport("Engine.RawTexture");
  2538. }
  2539. /**
  2540. * Creates a new raw cube texture
  2541. * @param data defines the array of data to use to create each face
  2542. * @param size defines the size of the textures
  2543. * @param format defines the format of the data
  2544. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  2545. * @param generateMipMaps defines if the engine should generate the mip levels
  2546. * @param invertY defines if data must be stored with Y axis inverted
  2547. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  2548. * @param compression defines the compression used (null by default)
  2549. * @returns the cube texture as an InternalTexture
  2550. */
  2551. public createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number,
  2552. generateMipMaps: boolean, invertY: boolean, samplingMode: number,
  2553. compression: Nullable<string> = null): InternalTexture {
  2554. throw _DevTools.WarnImport("Engine.RawTexture");
  2555. }
  2556. /**
  2557. * Creates a new raw 3D texture
  2558. * @param data defines the data used to create the texture
  2559. * @param width defines the width of the texture
  2560. * @param height defines the height of the texture
  2561. * @param depth defines the depth of the texture
  2562. * @param format defines the format of the texture
  2563. * @param generateMipMaps defines if the engine must generate mip levels
  2564. * @param invertY defines if data must be stored with Y axis inverted
  2565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  2566. * @param compression defines the compressed used (can be null)
  2567. * @param textureType defines the compressed used (can be null)
  2568. * @returns a new raw 3D texture (stored in an InternalTexture)
  2569. */
  2570. public createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string> = null, textureType = Constants.TEXTURETYPE_UNSIGNED_INT): InternalTexture {
  2571. throw _DevTools.WarnImport("Engine.RawTexture");
  2572. }
  2573. /**
  2574. * Creates a new raw 2D array texture
  2575. * @param data defines the data used to create the texture
  2576. * @param width defines the width of the texture
  2577. * @param height defines the height of the texture
  2578. * @param depth defines the number of layers of the texture
  2579. * @param format defines the format of the texture
  2580. * @param generateMipMaps defines if the engine must generate mip levels
  2581. * @param invertY defines if data must be stored with Y axis inverted
  2582. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  2583. * @param compression defines the compressed used (can be null)
  2584. * @param textureType defines the compressed used (can be null)
  2585. * @returns a new raw 2D array texture (stored in an InternalTexture)
  2586. */
  2587. public createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string> = null, textureType = Constants.TEXTURETYPE_UNSIGNED_INT): InternalTexture {
  2588. throw _DevTools.WarnImport("Engine.RawTexture");
  2589. }
  2590. private _unpackFlipYCached: Nullable<boolean> = null;
  2591. /**
  2592. * In case you are sharing the context with other applications, it might
  2593. * be interested to not cache the unpack flip y state to ensure a consistent
  2594. * value would be set.
  2595. */
  2596. public enableUnpackFlipYCached = true;
  2597. /** @hidden */
  2598. public _unpackFlipY(value: boolean): void {
  2599. if (this._unpackFlipYCached !== value) {
  2600. this._gl.pixelStorei(this._gl.UNPACK_FLIP_Y_WEBGL, value ? 1 : 0);
  2601. if (this.enableUnpackFlipYCached) {
  2602. this._unpackFlipYCached = value;
  2603. }
  2604. }
  2605. }
  2606. /** @hidden */
  2607. public _getUnpackAlignement(): number {
  2608. return this._gl.getParameter(this._gl.UNPACK_ALIGNMENT);
  2609. }
  2610. private _getTextureTarget(texture: InternalTexture): number {
  2611. if (texture.isCube) {
  2612. return this._gl.TEXTURE_CUBE_MAP;
  2613. } else if (texture.is3D) {
  2614. return this._gl.TEXTURE_3D;
  2615. } else if (texture.is2DArray) {
  2616. return this._gl.TEXTURE_2D_ARRAY;
  2617. }
  2618. return this._gl.TEXTURE_2D;
  2619. }
  2620. /**
  2621. * Update the sampling mode of a given texture
  2622. * @param samplingMode defines the required sampling mode
  2623. * @param texture defines the texture to update
  2624. * @param generateMipMaps defines whether to generate mipmaps for the texture
  2625. */
  2626. public updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps: boolean = false): void {
  2627. const target = this._getTextureTarget(texture);
  2628. var filters = this._getSamplingParameters(samplingMode, texture.generateMipMaps || generateMipMaps);
  2629. this._setTextureParameterInteger(target, this._gl.TEXTURE_MAG_FILTER, filters.mag, texture);
  2630. this._setTextureParameterInteger(target, this._gl.TEXTURE_MIN_FILTER, filters.min);
  2631. if (generateMipMaps) {
  2632. texture.generateMipMaps = true;
  2633. this._gl.generateMipmap(target);
  2634. }
  2635. this._bindTextureDirectly(target, null);
  2636. texture.samplingMode = samplingMode;
  2637. }
  2638. /**
  2639. * Update the sampling mode of a given texture
  2640. * @param texture defines the texture to update
  2641. * @param wrapU defines the texture wrap mode of the u coordinates
  2642. * @param wrapV defines the texture wrap mode of the v coordinates
  2643. * @param wrapR defines the texture wrap mode of the r coordinates
  2644. */
  2645. public updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV: Nullable<number> = null, wrapR: Nullable<number> = null): void {
  2646. const target = this._getTextureTarget(texture);
  2647. if (wrapU) {
  2648. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_S, this._getTextureWrapMode(wrapU));
  2649. texture._cachedWrapU = wrapU;
  2650. }
  2651. if (wrapV) {
  2652. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_T, this._getTextureWrapMode(wrapV));
  2653. texture._cachedWrapV = wrapV;
  2654. }
  2655. if (wrapR) {
  2656. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_R, this._getTextureWrapMode(wrapR));
  2657. texture._cachedWrapR = wrapR;
  2658. }
  2659. this._bindTextureDirectly(target, null);
  2660. }
  2661. /** @hidden */
  2662. public _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | { width: number, height: number }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void {
  2663. var width = (<{ width: number, height: number }>size).width || <number>size;
  2664. var height = (<{ width: number, height: number }>size).height || <number>size;
  2665. internalTexture.baseWidth = width;
  2666. internalTexture.baseHeight = height;
  2667. internalTexture.width = width;
  2668. internalTexture.height = height;
  2669. internalTexture.isReady = true;
  2670. internalTexture.samples = 1;
  2671. internalTexture.generateMipMaps = false;
  2672. internalTexture._generateDepthBuffer = true;
  2673. internalTexture._generateStencilBuffer = generateStencil;
  2674. internalTexture.samplingMode = bilinearFiltering ? Constants.TEXTURE_BILINEAR_SAMPLINGMODE : Constants.TEXTURE_NEAREST_SAMPLINGMODE;
  2675. internalTexture.type = Constants.TEXTURETYPE_UNSIGNED_INT;
  2676. internalTexture._comparisonFunction = comparisonFunction;
  2677. var gl = this._gl;
  2678. var target = internalTexture.isCube ? gl.TEXTURE_CUBE_MAP : gl.TEXTURE_2D;
  2679. var samplingParameters = this._getSamplingParameters(internalTexture.samplingMode, false);
  2680. gl.texParameteri(target, gl.TEXTURE_MAG_FILTER, samplingParameters.mag);
  2681. gl.texParameteri(target, gl.TEXTURE_MIN_FILTER, samplingParameters.min);
  2682. gl.texParameteri(target, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE);
  2683. gl.texParameteri(target, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE);
  2684. if (comparisonFunction === 0) {
  2685. gl.texParameteri(target, gl.TEXTURE_COMPARE_FUNC, Constants.LEQUAL);
  2686. gl.texParameteri(target, gl.TEXTURE_COMPARE_MODE, gl.NONE);
  2687. }
  2688. else {
  2689. gl.texParameteri(target, gl.TEXTURE_COMPARE_FUNC, comparisonFunction);
  2690. gl.texParameteri(target, gl.TEXTURE_COMPARE_MODE, gl.COMPARE_REF_TO_TEXTURE);
  2691. }
  2692. }
  2693. /** @hidden */
  2694. public _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex: number = 0, lod: number = 0) {
  2695. var gl = this._gl;
  2696. var target = gl.TEXTURE_2D;
  2697. if (texture.isCube) {
  2698. target = gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex;
  2699. }
  2700. this._gl.compressedTexImage2D(target, lod, internalFormat, width, height, 0, <DataView>data);
  2701. }
  2702. /** @hidden */
  2703. public _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex: number = 0, lod: number = 0, babylonInternalFormat?: number, useTextureWidthAndHeight = false): void {
  2704. var gl = this._gl;
  2705. var textureType = this._getWebGLTextureType(texture.type);
  2706. var format = this._getInternalFormat(texture.format);
  2707. var internalFormat = babylonInternalFormat === undefined ? this._getRGBABufferInternalSizedFormat(texture.type, format) : this._getInternalFormat(babylonInternalFormat);
  2708. this._unpackFlipY(texture.invertY);
  2709. var target = gl.TEXTURE_2D;
  2710. if (texture.isCube) {
  2711. target = gl.TEXTURE_CUBE_MAP_POSITIVE_X + faceIndex;
  2712. }
  2713. const lodMaxWidth = Math.round(Math.log(texture.width) * Math.LOG2E);
  2714. const lodMaxHeight = Math.round(Math.log(texture.height) * Math.LOG2E);
  2715. const width = useTextureWidthAndHeight ? texture.width : Math.pow(2, Math.max(lodMaxWidth - lod, 0));
  2716. const height = useTextureWidthAndHeight ? texture.height : Math.pow(2, Math.max(lodMaxHeight - lod, 0));
  2717. gl.texImage2D(target, lod, internalFormat, width, height, 0, format, textureType, imageData);
  2718. }
  2719. /** @hidden */
  2720. public _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex: number = 0, lod: number = 0): void {
  2721. var gl = this._gl;
  2722. var bindTarget = texture.isCube ? gl.TEXTURE_CUBE_MAP : gl.TEXTURE_2D;
  2723. this._bindTextureDirectly(bindTarget, texture, true);
  2724. this._uploadDataToTextureDirectly(texture, imageData, faceIndex, lod);
  2725. this._bindTextureDirectly(bindTarget, null, true);
  2726. }
  2727. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void {
  2728. var gl = this._gl;
  2729. if (!gl) {
  2730. return;
  2731. }
  2732. var filters = this._getSamplingParameters(samplingMode, !noMipmap);
  2733. gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, filters.mag);
  2734. gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, filters.min);
  2735. if (!noMipmap && !isCompressed) {
  2736. gl.generateMipmap(gl.TEXTURE_2D);
  2737. }
  2738. this._bindTextureDirectly(gl.TEXTURE_2D, null);
  2739. // this.resetTextureCache();
  2740. if (scene) {
  2741. scene._removePendingData(texture);
  2742. }
  2743. texture.onLoadedObservable.notifyObservers(texture);
  2744. texture.onLoadedObservable.clear();
  2745. }
  2746. private _prepareWebGLTexture(texture: InternalTexture, scene: Nullable<ISceneLike>, width: number, height: number, invertY: boolean, noMipmap: boolean, isCompressed: boolean,
  2747. processFunction: (width: number, height: number, continuationCallback: () => void) => boolean, samplingMode: number = Constants.TEXTURE_TRILINEAR_SAMPLINGMODE): void {
  2748. var maxTextureSize = this.getCaps().maxTextureSize;
  2749. var potWidth = Math.min(maxTextureSize, this.needPOTTextures ? ThinEngine.GetExponentOfTwo(width, maxTextureSize) : width);
  2750. var potHeight = Math.min(maxTextureSize, this.needPOTTextures ? ThinEngine.GetExponentOfTwo(height, maxTextureSize) : height);
  2751. var gl = this._gl;
  2752. if (!gl) {
  2753. return;
  2754. }
  2755. if (!texture._webGLTexture) {
  2756. // this.resetTextureCache();
  2757. if (scene) {
  2758. scene._removePendingData(texture);
  2759. }
  2760. return;
  2761. }
  2762. this._bindTextureDirectly(gl.TEXTURE_2D, texture, true);
  2763. this._unpackFlipY(invertY === undefined ? true : (invertY ? true : false));
  2764. texture.baseWidth = width;
  2765. texture.baseHeight = height;
  2766. texture.width = potWidth;
  2767. texture.height = potHeight;
  2768. texture.isReady = true;
  2769. if (processFunction(potWidth, potHeight, () => {
  2770. this._prepareWebGLTextureContinuation(texture, scene, noMipmap, isCompressed, samplingMode);
  2771. })) {
  2772. // Returning as texture needs extra async steps
  2773. return;
  2774. }
  2775. this._prepareWebGLTextureContinuation(texture, scene, noMipmap, isCompressed, samplingMode);
  2776. }
  2777. /** @hidden */
  2778. public _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples = 1): Nullable<WebGLRenderbuffer> {
  2779. var gl = this._gl;
  2780. // Create the depth/stencil buffer
  2781. if (generateStencilBuffer && generateDepthBuffer) {
  2782. return this._getDepthStencilBuffer(width, height, samples, gl.DEPTH_STENCIL, gl.DEPTH24_STENCIL8, gl.DEPTH_STENCIL_ATTACHMENT);
  2783. }
  2784. if (generateDepthBuffer) {
  2785. return this._getDepthStencilBuffer(width, height, samples, gl.DEPTH_COMPONENT16, gl.DEPTH_COMPONENT16, gl.DEPTH_ATTACHMENT);
  2786. }
  2787. if (generateStencilBuffer) {
  2788. return this._getDepthStencilBuffer(width, height, samples, gl.STENCIL_INDEX8, gl.STENCIL_INDEX8, gl.STENCIL_ATTACHMENT);
  2789. }
  2790. return null;
  2791. }
  2792. private _getDepthStencilBuffer = (width: number, height: number, samples: number, internalFormat: number, msInternalFormat: number, attachment: number) => {
  2793. var gl = this._gl;
  2794. const depthStencilBuffer = gl.createRenderbuffer();
  2795. gl.bindRenderbuffer(gl.RENDERBUFFER, depthStencilBuffer);
  2796. if (samples > 1) {
  2797. gl.renderbufferStorageMultisample(gl.RENDERBUFFER, samples, msInternalFormat, width, height);
  2798. } else {
  2799. gl.renderbufferStorage(gl.RENDERBUFFER, internalFormat, width, height);
  2800. }
  2801. gl.framebufferRenderbuffer(gl.FRAMEBUFFER, attachment, gl.RENDERBUFFER, depthStencilBuffer);
  2802. return depthStencilBuffer;
  2803. }
  2804. /** @hidden */
  2805. public _releaseFramebufferObjects(texture: InternalTexture): void {
  2806. var gl = this._gl;
  2807. if (texture._framebuffer) {
  2808. gl.deleteFramebuffer(texture._framebuffer);
  2809. texture._framebuffer = null;
  2810. }
  2811. if (texture._depthStencilBuffer) {
  2812. gl.deleteRenderbuffer(texture._depthStencilBuffer);
  2813. texture._depthStencilBuffer = null;
  2814. }
  2815. if (texture._MSAAFramebuffer) {
  2816. gl.deleteFramebuffer(texture._MSAAFramebuffer);
  2817. texture._MSAAFramebuffer = null;
  2818. }
  2819. if (texture._MSAARenderBuffer) {
  2820. gl.deleteRenderbuffer(texture._MSAARenderBuffer);
  2821. texture._MSAARenderBuffer = null;
  2822. }
  2823. }
  2824. /** @hidden */
  2825. public _releaseTexture(texture: InternalTexture): void {
  2826. this._releaseFramebufferObjects(texture);
  2827. this._deleteTexture(texture._webGLTexture);
  2828. // Unbind channels
  2829. this.unbindAllTextures();
  2830. var index = this._internalTexturesCache.indexOf(texture);
  2831. if (index !== -1) {
  2832. this._internalTexturesCache.splice(index, 1);
  2833. }
  2834. // Integrated fixed lod samplers.
  2835. if (texture._lodTextureHigh) {
  2836. texture._lodTextureHigh.dispose();
  2837. }
  2838. if (texture._lodTextureMid) {
  2839. texture._lodTextureMid.dispose();
  2840. }
  2841. if (texture._lodTextureLow) {
  2842. texture._lodTextureLow.dispose();
  2843. }
  2844. // Integrated irradiance map.
  2845. if (texture._irradianceTexture) {
  2846. texture._irradianceTexture.dispose();
  2847. }
  2848. }
  2849. protected _deleteTexture(texture: Nullable<WebGLTexture>): void {
  2850. this._gl.deleteTexture(texture);
  2851. }
  2852. protected _setProgram(program: WebGLProgram): void {
  2853. if (this._currentProgram !== program) {
  2854. this._gl.useProgram(program);
  2855. this._currentProgram = program;
  2856. }
  2857. }
  2858. protected _boundUniforms: { [key: number]: WebGLUniformLocation } = {};
  2859. /**
  2860. * Binds an effect to the webGL context
  2861. * @param effect defines the effect to bind
  2862. */
  2863. public bindSamplers(effect: Effect): void {
  2864. let webGLPipelineContext = effect.getPipelineContext() as WebGLPipelineContext;
  2865. this._setProgram(webGLPipelineContext.program!);
  2866. var samplers = effect.getSamplers();
  2867. for (var index = 0; index < samplers.length; index++) {
  2868. var uniform = effect.getUniform(samplers[index]);
  2869. if (uniform) {
  2870. this._boundUniforms[index] = uniform;
  2871. }
  2872. }
  2873. this._currentEffect = null;
  2874. }
  2875. private _activateCurrentTexture() {
  2876. if (this._currentTextureChannel !== this._activeChannel) {
  2877. this._gl.activeTexture(this._gl.TEXTURE0 + this._activeChannel);
  2878. this._currentTextureChannel = this._activeChannel;
  2879. }
  2880. }
  2881. /** @hidden */
  2882. public _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate = false, force = false): boolean {
  2883. var wasPreviouslyBound = false;
  2884. let isTextureForRendering = texture && texture._associatedChannel > -1;
  2885. if (forTextureDataUpdate && isTextureForRendering) {
  2886. this._activeChannel = texture!._associatedChannel;
  2887. }
  2888. let currentTextureBound = this._boundTexturesCache[this._activeChannel];
  2889. if (currentTextureBound !== texture || force) {
  2890. this._activateCurrentTexture();
  2891. if (texture && texture.isMultiview) {
  2892. this._gl.bindTexture(target, texture ? texture._colorTextureArray : null);
  2893. } else {
  2894. this._gl.bindTexture(target, texture ? texture._webGLTexture : null);
  2895. }
  2896. this._boundTexturesCache[this._activeChannel] = texture;
  2897. if (texture) {
  2898. texture._associatedChannel = this._activeChannel;
  2899. }
  2900. } else if (forTextureDataUpdate) {
  2901. wasPreviouslyBound = true;
  2902. this._activateCurrentTexture();
  2903. }
  2904. if (isTextureForRendering && !forTextureDataUpdate) {
  2905. this._bindSamplerUniformToChannel(texture!._associatedChannel, this._activeChannel);
  2906. }
  2907. return wasPreviouslyBound;
  2908. }
  2909. /** @hidden */
  2910. public _bindTexture(channel: number, texture: Nullable<InternalTexture>): void {
  2911. if (channel === undefined) {
  2912. return;
  2913. }
  2914. if (texture) {
  2915. texture._associatedChannel = channel;
  2916. }
  2917. this._activeChannel = channel;
  2918. this._bindTextureDirectly(this._gl.TEXTURE_2D, texture);
  2919. }
  2920. /**
  2921. * Unbind all textures from the webGL context
  2922. */
  2923. public unbindAllTextures(): void {
  2924. for (var channel = 0; channel < this._maxSimultaneousTextures; channel++) {
  2925. this._activeChannel = channel;
  2926. this._bindTextureDirectly(this._gl.TEXTURE_2D, null);
  2927. this._bindTextureDirectly(this._gl.TEXTURE_CUBE_MAP, null);
  2928. if (this.webGLVersion > 1) {
  2929. this._bindTextureDirectly(this._gl.TEXTURE_3D, null);
  2930. this._bindTextureDirectly(this._gl.TEXTURE_2D_ARRAY, null);
  2931. }
  2932. }
  2933. }
  2934. /**
  2935. * Sets a texture to the according uniform.
  2936. * @param channel The texture channel
  2937. * @param uniform The uniform to set
  2938. * @param texture The texture to apply
  2939. */
  2940. public setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void {
  2941. if (channel === undefined) {
  2942. return;
  2943. }
  2944. if (uniform) {
  2945. this._boundUniforms[channel] = uniform;
  2946. }
  2947. this._setTexture(channel, texture);
  2948. }
  2949. private _bindSamplerUniformToChannel(sourceSlot: number, destination: number) {
  2950. let uniform = this._boundUniforms[sourceSlot];
  2951. if (!uniform || uniform._currentState === destination) {
  2952. return;
  2953. }
  2954. this._gl.uniform1i(uniform, destination);
  2955. uniform._currentState = destination;
  2956. }
  2957. private _getTextureWrapMode(mode: number): number {
  2958. switch (mode) {
  2959. case Constants.TEXTURE_WRAP_ADDRESSMODE:
  2960. return this._gl.REPEAT;
  2961. case Constants.TEXTURE_CLAMP_ADDRESSMODE:
  2962. return this._gl.CLAMP_TO_EDGE;
  2963. case Constants.TEXTURE_MIRROR_ADDRESSMODE:
  2964. return this._gl.MIRRORED_REPEAT;
  2965. }
  2966. return this._gl.REPEAT;
  2967. }
  2968. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray = false, depthStencilTexture = false): boolean {
  2969. // Not ready?
  2970. if (!texture) {
  2971. if (this._boundTexturesCache[channel] != null) {
  2972. this._activeChannel = channel;
  2973. this._bindTextureDirectly(this._gl.TEXTURE_2D, null);
  2974. this._bindTextureDirectly(this._gl.TEXTURE_CUBE_MAP, null);
  2975. if (this.webGLVersion > 1) {
  2976. this._bindTextureDirectly(this._gl.TEXTURE_3D, null);
  2977. this._bindTextureDirectly(this._gl.TEXTURE_2D_ARRAY, null);
  2978. }
  2979. }
  2980. return false;
  2981. }
  2982. // Video
  2983. if ((<VideoTexture>texture).video) {
  2984. this._activeChannel = channel;
  2985. (<VideoTexture>texture).update();
  2986. } else if (texture.delayLoadState === Constants.DELAYLOADSTATE_NOTLOADED) { // Delay loading
  2987. texture.delayLoad();
  2988. return false;
  2989. }
  2990. let internalTexture: InternalTexture;
  2991. if (depthStencilTexture) {
  2992. internalTexture = (<RenderTargetTexture>texture).depthStencilTexture!;
  2993. }
  2994. else if (texture.isReady()) {
  2995. internalTexture = <InternalTexture>texture.getInternalTexture();
  2996. }
  2997. else if (texture.isCube) {
  2998. internalTexture = this.emptyCubeTexture;
  2999. }
  3000. else if (texture.is3D) {
  3001. internalTexture = this.emptyTexture3D;
  3002. }
  3003. else if (texture.is2DArray) {
  3004. internalTexture = this.emptyTexture2DArray;
  3005. }
  3006. else {
  3007. internalTexture = this.emptyTexture;
  3008. }
  3009. if (!isPartOfTextureArray && internalTexture) {
  3010. internalTexture._associatedChannel = channel;
  3011. }
  3012. let needToBind = true;
  3013. if (this._boundTexturesCache[channel] === internalTexture) {
  3014. if (!isPartOfTextureArray) {
  3015. this._bindSamplerUniformToChannel(internalTexture._associatedChannel, channel);
  3016. }
  3017. needToBind = false;
  3018. }
  3019. this._activeChannel = channel;
  3020. if (internalTexture && internalTexture.isMultiview) {
  3021. if (needToBind) {
  3022. this._bindTextureDirectly(this._gl.TEXTURE_2D_ARRAY, internalTexture, isPartOfTextureArray);
  3023. }
  3024. } else if (internalTexture && (internalTexture.is3D || internalTexture.is2DArray)) {
  3025. let is3D = internalTexture.is3D;
  3026. let target = is3D ? this._gl.TEXTURE_3D : this._gl.TEXTURE_2D_ARRAY;
  3027. if (needToBind) {
  3028. this._bindTextureDirectly(target, internalTexture, isPartOfTextureArray);
  3029. }
  3030. if (internalTexture && internalTexture._cachedWrapU !== texture.wrapU) {
  3031. internalTexture._cachedWrapU = texture.wrapU;
  3032. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_S, this._getTextureWrapMode(texture.wrapU), internalTexture);
  3033. }
  3034. if (internalTexture && internalTexture._cachedWrapV !== texture.wrapV) {
  3035. internalTexture._cachedWrapV = texture.wrapV;
  3036. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_T, this._getTextureWrapMode(texture.wrapV), internalTexture);
  3037. }
  3038. if (is3D && internalTexture && internalTexture._cachedWrapR !== texture.wrapR) {
  3039. internalTexture._cachedWrapR = texture.wrapR;
  3040. this._setTextureParameterInteger(target, this._gl.TEXTURE_WRAP_R, this._getTextureWrapMode(texture.wrapR), internalTexture);
  3041. }
  3042. this._setAnisotropicLevel(target, texture);
  3043. } else if (internalTexture && internalTexture.isCube) {
  3044. if (needToBind) {
  3045. this._bindTextureDirectly(this._gl.TEXTURE_CUBE_MAP, internalTexture, isPartOfTextureArray);
  3046. }
  3047. if (internalTexture._cachedCoordinatesMode !== texture.coordinatesMode) {
  3048. internalTexture._cachedCoordinatesMode = texture.coordinatesMode;
  3049. // CUBIC_MODE and SKYBOX_MODE both require CLAMP_TO_EDGE. All other modes use REPEAT.
  3050. var textureWrapMode = (texture.coordinatesMode !== Constants.TEXTURE_CUBIC_MODE && texture.coordinatesMode !== Constants.TEXTURE_SKYBOX_MODE) ? this._gl.REPEAT : this._gl.CLAMP_TO_EDGE;
  3051. this._setTextureParameterInteger(this._gl.TEXTURE_CUBE_MAP, this._gl.TEXTURE_WRAP_S, textureWrapMode, internalTexture);
  3052. this._setTextureParameterInteger(this._gl.TEXTURE_CUBE_MAP, this._gl.TEXTURE_WRAP_T, textureWrapMode);
  3053. }
  3054. this._setAnisotropicLevel(this._gl.TEXTURE_CUBE_MAP, texture);
  3055. } else {
  3056. if (needToBind) {
  3057. this._bindTextureDirectly(this._gl.TEXTURE_2D, internalTexture, isPartOfTextureArray);
  3058. }
  3059. if (internalTexture && internalTexture._cachedWrapU !== texture.wrapU) {
  3060. internalTexture._cachedWrapU = texture.wrapU;
  3061. this._setTextureParameterInteger(this._gl.TEXTURE_2D, this._gl.TEXTURE_WRAP_S, this._getTextureWrapMode(texture.wrapU), internalTexture);
  3062. }
  3063. if (internalTexture && internalTexture._cachedWrapV !== texture.wrapV) {
  3064. internalTexture._cachedWrapV = texture.wrapV;
  3065. this._setTextureParameterInteger(this._gl.TEXTURE_2D, this._gl.TEXTURE_WRAP_T, this._getTextureWrapMode(texture.wrapV), internalTexture);
  3066. }
  3067. this._setAnisotropicLevel(this._gl.TEXTURE_2D, texture);
  3068. }
  3069. return true;
  3070. }
  3071. /**
  3072. * Sets an array of texture to the webGL context
  3073. * @param channel defines the channel where the texture array must be set
  3074. * @param uniform defines the associated uniform location
  3075. * @param textures defines the array of textures to bind
  3076. */
  3077. public setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void {
  3078. if (channel === undefined || !uniform) {
  3079. return;
  3080. }
  3081. if (!this._textureUnits || this._textureUnits.length !== textures.length) {
  3082. this._textureUnits = new Int32Array(textures.length);
  3083. }
  3084. for (let i = 0; i < textures.length; i++) {
  3085. let texture = textures[i].getInternalTexture();
  3086. if (texture) {
  3087. this._textureUnits[i] = channel + i;
  3088. texture._associatedChannel = channel + i;
  3089. } else {
  3090. this._textureUnits[i] = -1;
  3091. }
  3092. }
  3093. this._gl.uniform1iv(uniform, this._textureUnits);
  3094. for (var index = 0; index < textures.length; index++) {
  3095. this._setTexture(this._textureUnits[index], textures[index], true);
  3096. }
  3097. }
  3098. /** @hidden */
  3099. public _setAnisotropicLevel(target: number, texture: BaseTexture) {
  3100. var internalTexture = texture.getInternalTexture();
  3101. if (!internalTexture) {
  3102. return;
  3103. }
  3104. var anisotropicFilterExtension = this._caps.textureAnisotropicFilterExtension;
  3105. var value = texture.anisotropicFilteringLevel;
  3106. if (internalTexture.samplingMode !== Constants.TEXTURE_LINEAR_LINEAR_MIPNEAREST
  3107. && internalTexture.samplingMode !== Constants.TEXTURE_LINEAR_LINEAR_MIPLINEAR
  3108. && internalTexture.samplingMode !== Constants.TEXTURE_LINEAR_LINEAR) {
  3109. value = 1; // Forcing the anisotropic to 1 because else webgl will force filters to linear
  3110. }
  3111. if (anisotropicFilterExtension && internalTexture._cachedAnisotropicFilteringLevel !== value) {
  3112. this._setTextureParameterFloat(target, anisotropicFilterExtension.TEXTURE_MAX_ANISOTROPY_EXT, Math.min(value, this._caps.maxAnisotropy), internalTexture);
  3113. internalTexture._cachedAnisotropicFilteringLevel = value;
  3114. }
  3115. }
  3116. private _setTextureParameterFloat(target: number, parameter: number, value: number, texture: InternalTexture): void {
  3117. this._bindTextureDirectly(target, texture, true, true);
  3118. this._gl.texParameterf(target, parameter, value);
  3119. }
  3120. private _setTextureParameterInteger(target: number, parameter: number, value: number, texture?: InternalTexture) {
  3121. if (texture) {
  3122. this._bindTextureDirectly(target, texture, true, true);
  3123. }
  3124. this._gl.texParameteri(target, parameter, value);
  3125. }
  3126. /**
  3127. * Unbind all vertex attributes from the webGL context
  3128. */
  3129. public unbindAllAttributes() {
  3130. if (this._mustWipeVertexAttributes) {
  3131. this._mustWipeVertexAttributes = false;
  3132. for (var i = 0; i < this._caps.maxVertexAttribs; i++) {
  3133. this.disableAttributeByIndex(i);
  3134. }
  3135. return;
  3136. }
  3137. for (var i = 0, ul = this._vertexAttribArraysEnabled.length; i < ul; i++) {
  3138. if (i >= this._caps.maxVertexAttribs || !this._vertexAttribArraysEnabled[i]) {
  3139. continue;
  3140. }
  3141. this.disableAttributeByIndex(i);
  3142. }
  3143. }
  3144. /**
  3145. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  3146. */
  3147. public releaseEffects() {
  3148. for (var name in this._compiledEffects) {
  3149. let webGLPipelineContext = this._compiledEffects[name].getPipelineContext() as WebGLPipelineContext;
  3150. this._deletePipelineContext(webGLPipelineContext);
  3151. }
  3152. this._compiledEffects = {};
  3153. }
  3154. /**
  3155. * Dispose and release all associated resources
  3156. */
  3157. public dispose(): void {
  3158. this.stopRenderLoop();
  3159. // Clear observables
  3160. if (this.onBeforeTextureInitObservable) {
  3161. this.onBeforeTextureInitObservable.clear();
  3162. }
  3163. // Empty texture
  3164. if (this._emptyTexture) {
  3165. this._releaseTexture(this._emptyTexture);
  3166. this._emptyTexture = null;
  3167. }
  3168. if (this._emptyCubeTexture) {
  3169. this._releaseTexture(this._emptyCubeTexture);
  3170. this._emptyCubeTexture = null;
  3171. }
  3172. // Release effects
  3173. this.releaseEffects();
  3174. // Unbind
  3175. this.unbindAllAttributes();
  3176. this._boundUniforms = [];
  3177. // Events
  3178. if (DomManagement.IsWindowObjectExist()) {
  3179. if (this._renderingCanvas) {
  3180. if (!this._doNotHandleContextLost) {
  3181. this._renderingCanvas.removeEventListener("webglcontextlost", this._onContextLost);
  3182. this._renderingCanvas.removeEventListener("webglcontextrestored", this._onContextRestored);
  3183. }
  3184. }
  3185. }
  3186. this._workingCanvas = null;
  3187. this._workingContext = null;
  3188. this._currentBufferPointers = [];
  3189. this._renderingCanvas = null;
  3190. this._currentProgram = null;
  3191. this._boundRenderFunction = null;
  3192. Effect.ResetCache();
  3193. // Abort active requests
  3194. for (let request of this._activeRequests) {
  3195. request.abort();
  3196. }
  3197. }
  3198. /**
  3199. * Attach a new callback raised when context lost event is fired
  3200. * @param callback defines the callback to call
  3201. */
  3202. public attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void {
  3203. if (this._renderingCanvas) {
  3204. this._renderingCanvas.addEventListener("webglcontextlost", <any>callback, false);
  3205. }
  3206. }
  3207. /**
  3208. * Attach a new callback raised when context restored event is fired
  3209. * @param callback defines the callback to call
  3210. */
  3211. public attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void {
  3212. if (this._renderingCanvas) {
  3213. this._renderingCanvas.addEventListener("webglcontextrestored", <any>callback, false);
  3214. }
  3215. }
  3216. /**
  3217. * Get the current error code of the webGL context
  3218. * @returns the error code
  3219. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  3220. */
  3221. public getError(): number {
  3222. return this._gl.getError();
  3223. }
  3224. private _canRenderToFloatFramebuffer(): boolean {
  3225. if (this._webGLVersion > 1) {
  3226. return this._caps.colorBufferFloat;
  3227. }
  3228. return this._canRenderToFramebuffer(Constants.TEXTURETYPE_FLOAT);
  3229. }
  3230. private _canRenderToHalfFloatFramebuffer(): boolean {
  3231. if (this._webGLVersion > 1) {
  3232. return this._caps.colorBufferFloat;
  3233. }
  3234. return this._canRenderToFramebuffer(Constants.TEXTURETYPE_HALF_FLOAT);
  3235. }
  3236. // Thank you : http://stackoverflow.com/questions/28827511/webgl-ios-render-to-floating-point-texture
  3237. private _canRenderToFramebuffer(type: number): boolean {
  3238. let gl = this._gl;
  3239. //clear existing errors
  3240. while (gl.getError() !== gl.NO_ERROR) { }
  3241. let successful = true;
  3242. let texture = gl.createTexture();
  3243. gl.bindTexture(gl.TEXTURE_2D, texture);
  3244. gl.texImage2D(gl.TEXTURE_2D, 0, this._getRGBABufferInternalSizedFormat(type), 1, 1, 0, gl.RGBA, this._getWebGLTextureType(type), null);
  3245. gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.NEAREST);
  3246. gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.NEAREST);
  3247. let fb = gl.createFramebuffer();
  3248. gl.bindFramebuffer(gl.FRAMEBUFFER, fb);
  3249. gl.framebufferTexture2D(gl.FRAMEBUFFER, gl.COLOR_ATTACHMENT0, gl.TEXTURE_2D, texture, 0);
  3250. let status = gl.checkFramebufferStatus(gl.FRAMEBUFFER);
  3251. successful = successful && (status === gl.FRAMEBUFFER_COMPLETE);
  3252. successful = successful && (gl.getError() === gl.NO_ERROR);
  3253. //try render by clearing frame buffer's color buffer
  3254. if (successful) {
  3255. gl.clear(gl.COLOR_BUFFER_BIT);
  3256. successful = successful && (gl.getError() === gl.NO_ERROR);
  3257. }
  3258. //try reading from frame to ensure render occurs (just creating the FBO is not sufficient to determine if rendering is supported)
  3259. if (successful) {
  3260. //in practice it's sufficient to just read from the backbuffer rather than handle potentially issues reading from the texture
  3261. gl.bindFramebuffer(gl.FRAMEBUFFER, null);
  3262. let readFormat = gl.RGBA;
  3263. let readType = gl.UNSIGNED_BYTE;
  3264. let buffer = new Uint8Array(4);
  3265. gl.readPixels(0, 0, 1, 1, readFormat, readType, buffer);
  3266. successful = successful && (gl.getError() === gl.NO_ERROR);
  3267. }
  3268. //clean up
  3269. gl.deleteTexture(texture);
  3270. gl.deleteFramebuffer(fb);
  3271. gl.bindFramebuffer(gl.FRAMEBUFFER, null);
  3272. //clear accumulated errors
  3273. while (!successful && (gl.getError() !== gl.NO_ERROR)) { }
  3274. return successful;
  3275. }
  3276. /** @hidden */
  3277. public _getWebGLTextureType(type: number): number {
  3278. if (this._webGLVersion === 1) {
  3279. switch (type) {
  3280. case Constants.TEXTURETYPE_FLOAT:
  3281. return this._gl.FLOAT;
  3282. case Constants.TEXTURETYPE_HALF_FLOAT:
  3283. return this._gl.HALF_FLOAT_OES;
  3284. case Constants.TEXTURETYPE_UNSIGNED_BYTE:
  3285. return this._gl.UNSIGNED_BYTE;
  3286. case Constants.TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4:
  3287. return this._gl.UNSIGNED_SHORT_4_4_4_4;
  3288. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1:
  3289. return this._gl.UNSIGNED_SHORT_5_5_5_1;
  3290. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_6_5:
  3291. return this._gl.UNSIGNED_SHORT_5_6_5;
  3292. }
  3293. return this._gl.UNSIGNED_BYTE;
  3294. }
  3295. switch (type) {
  3296. case Constants.TEXTURETYPE_BYTE:
  3297. return this._gl.BYTE;
  3298. case Constants.TEXTURETYPE_UNSIGNED_BYTE:
  3299. return this._gl.UNSIGNED_BYTE;
  3300. case Constants.TEXTURETYPE_SHORT:
  3301. return this._gl.SHORT;
  3302. case Constants.TEXTURETYPE_UNSIGNED_SHORT:
  3303. return this._gl.UNSIGNED_SHORT;
  3304. case Constants.TEXTURETYPE_INT:
  3305. return this._gl.INT;
  3306. case Constants.TEXTURETYPE_UNSIGNED_INTEGER: // Refers to UNSIGNED_INT
  3307. return this._gl.UNSIGNED_INT;
  3308. case Constants.TEXTURETYPE_FLOAT:
  3309. return this._gl.FLOAT;
  3310. case Constants.TEXTURETYPE_HALF_FLOAT:
  3311. return this._gl.HALF_FLOAT;
  3312. case Constants.TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4:
  3313. return this._gl.UNSIGNED_SHORT_4_4_4_4;
  3314. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1:
  3315. return this._gl.UNSIGNED_SHORT_5_5_5_1;
  3316. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_6_5:
  3317. return this._gl.UNSIGNED_SHORT_5_6_5;
  3318. case Constants.TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV:
  3319. return this._gl.UNSIGNED_INT_2_10_10_10_REV;
  3320. case Constants.TEXTURETYPE_UNSIGNED_INT_24_8:
  3321. return this._gl.UNSIGNED_INT_24_8;
  3322. case Constants.TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV:
  3323. return this._gl.UNSIGNED_INT_10F_11F_11F_REV;
  3324. case Constants.TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV:
  3325. return this._gl.UNSIGNED_INT_5_9_9_9_REV;
  3326. case Constants.TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV:
  3327. return this._gl.FLOAT_32_UNSIGNED_INT_24_8_REV;
  3328. }
  3329. return this._gl.UNSIGNED_BYTE;
  3330. }
  3331. /** @hidden */
  3332. public _getInternalFormat(format: number): number {
  3333. var internalFormat = this._gl.RGBA;
  3334. switch (format) {
  3335. case Constants.TEXTUREFORMAT_ALPHA:
  3336. internalFormat = this._gl.ALPHA;
  3337. break;
  3338. case Constants.TEXTUREFORMAT_LUMINANCE:
  3339. internalFormat = this._gl.LUMINANCE;
  3340. break;
  3341. case Constants.TEXTUREFORMAT_LUMINANCE_ALPHA:
  3342. internalFormat = this._gl.LUMINANCE_ALPHA;
  3343. break;
  3344. case Constants.TEXTUREFORMAT_RED:
  3345. internalFormat = this._gl.RED;
  3346. break;
  3347. case Constants.TEXTUREFORMAT_RG:
  3348. internalFormat = this._gl.RG;
  3349. break;
  3350. case Constants.TEXTUREFORMAT_RGB:
  3351. internalFormat = this._gl.RGB;
  3352. break;
  3353. case Constants.TEXTUREFORMAT_RGBA:
  3354. internalFormat = this._gl.RGBA;
  3355. break;
  3356. }
  3357. if (this._webGLVersion > 1) {
  3358. switch (format) {
  3359. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3360. internalFormat = this._gl.RED_INTEGER;
  3361. break;
  3362. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3363. internalFormat = this._gl.RG_INTEGER;
  3364. break;
  3365. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3366. internalFormat = this._gl.RGB_INTEGER;
  3367. break;
  3368. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3369. internalFormat = this._gl.RGBA_INTEGER;
  3370. break;
  3371. }
  3372. }
  3373. return internalFormat;
  3374. }
  3375. /** @hidden */
  3376. public _getRGBABufferInternalSizedFormat(type: number, format?: number): number {
  3377. if (this._webGLVersion === 1) {
  3378. if (format !== undefined) {
  3379. switch (format) {
  3380. case Constants.TEXTUREFORMAT_ALPHA:
  3381. return this._gl.ALPHA;
  3382. case Constants.TEXTUREFORMAT_LUMINANCE:
  3383. return this._gl.LUMINANCE;
  3384. case Constants.TEXTUREFORMAT_LUMINANCE_ALPHA:
  3385. return this._gl.LUMINANCE_ALPHA;
  3386. }
  3387. }
  3388. return this._gl.RGBA;
  3389. }
  3390. switch (type) {
  3391. case Constants.TEXTURETYPE_BYTE:
  3392. switch (format) {
  3393. case Constants.TEXTUREFORMAT_RED:
  3394. return this._gl.R8_SNORM;
  3395. case Constants.TEXTUREFORMAT_RG:
  3396. return this._gl.RG8_SNORM;
  3397. case Constants.TEXTUREFORMAT_RGB:
  3398. return this._gl.RGB8_SNORM;
  3399. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3400. return this._gl.R8I;
  3401. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3402. return this._gl.RG8I;
  3403. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3404. return this._gl.RGB8I;
  3405. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3406. return this._gl.RGBA8I;
  3407. default:
  3408. return this._gl.RGBA8_SNORM;
  3409. }
  3410. case Constants.TEXTURETYPE_UNSIGNED_BYTE:
  3411. switch (format) {
  3412. case Constants.TEXTUREFORMAT_RED:
  3413. return this._gl.R8;
  3414. case Constants.TEXTUREFORMAT_RG:
  3415. return this._gl.RG8;
  3416. case Constants.TEXTUREFORMAT_RGB:
  3417. return this._gl.RGB8; // By default. Other possibilities are RGB565, SRGB8.
  3418. case Constants.TEXTUREFORMAT_RGBA:
  3419. return this._gl.RGBA8; // By default. Other possibilities are RGB5_A1, RGBA4, SRGB8_ALPHA8.
  3420. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3421. return this._gl.R8UI;
  3422. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3423. return this._gl.RG8UI;
  3424. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3425. return this._gl.RGB8UI;
  3426. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3427. return this._gl.RGBA8UI;
  3428. case Constants.TEXTUREFORMAT_ALPHA:
  3429. return this._gl.ALPHA;
  3430. case Constants.TEXTUREFORMAT_LUMINANCE:
  3431. return this._gl.LUMINANCE;
  3432. case Constants.TEXTUREFORMAT_LUMINANCE_ALPHA:
  3433. return this._gl.LUMINANCE_ALPHA;
  3434. default:
  3435. return this._gl.RGBA8;
  3436. }
  3437. case Constants.TEXTURETYPE_SHORT:
  3438. switch (format) {
  3439. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3440. return this._gl.R16I;
  3441. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3442. return this._gl.RG16I;
  3443. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3444. return this._gl.RGB16I;
  3445. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3446. return this._gl.RGBA16I;
  3447. default:
  3448. return this._gl.RGBA16I;
  3449. }
  3450. case Constants.TEXTURETYPE_UNSIGNED_SHORT:
  3451. switch (format) {
  3452. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3453. return this._gl.R16UI;
  3454. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3455. return this._gl.RG16UI;
  3456. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3457. return this._gl.RGB16UI;
  3458. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3459. return this._gl.RGBA16UI;
  3460. default:
  3461. return this._gl.RGBA16UI;
  3462. }
  3463. case Constants.TEXTURETYPE_INT:
  3464. switch (format) {
  3465. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3466. return this._gl.R32I;
  3467. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3468. return this._gl.RG32I;
  3469. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3470. return this._gl.RGB32I;
  3471. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3472. return this._gl.RGBA32I;
  3473. default:
  3474. return this._gl.RGBA32I;
  3475. }
  3476. case Constants.TEXTURETYPE_UNSIGNED_INTEGER: // Refers to UNSIGNED_INT
  3477. switch (format) {
  3478. case Constants.TEXTUREFORMAT_RED_INTEGER:
  3479. return this._gl.R32UI;
  3480. case Constants.TEXTUREFORMAT_RG_INTEGER:
  3481. return this._gl.RG32UI;
  3482. case Constants.TEXTUREFORMAT_RGB_INTEGER:
  3483. return this._gl.RGB32UI;
  3484. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3485. return this._gl.RGBA32UI;
  3486. default:
  3487. return this._gl.RGBA32UI;
  3488. }
  3489. case Constants.TEXTURETYPE_FLOAT:
  3490. switch (format) {
  3491. case Constants.TEXTUREFORMAT_RED:
  3492. return this._gl.R32F; // By default. Other possibility is R16F.
  3493. case Constants.TEXTUREFORMAT_RG:
  3494. return this._gl.RG32F; // By default. Other possibility is RG16F.
  3495. case Constants.TEXTUREFORMAT_RGB:
  3496. return this._gl.RGB32F; // By default. Other possibilities are RGB16F, R11F_G11F_B10F, RGB9_E5.
  3497. case Constants.TEXTUREFORMAT_RGBA:
  3498. return this._gl.RGBA32F; // By default. Other possibility is RGBA16F.
  3499. default:
  3500. return this._gl.RGBA32F;
  3501. }
  3502. case Constants.TEXTURETYPE_HALF_FLOAT:
  3503. switch (format) {
  3504. case Constants.TEXTUREFORMAT_RED:
  3505. return this._gl.R16F;
  3506. case Constants.TEXTUREFORMAT_RG:
  3507. return this._gl.RG16F;
  3508. case Constants.TEXTUREFORMAT_RGB:
  3509. return this._gl.RGB16F; // By default. Other possibilities are R11F_G11F_B10F, RGB9_E5.
  3510. case Constants.TEXTUREFORMAT_RGBA:
  3511. return this._gl.RGBA16F;
  3512. default:
  3513. return this._gl.RGBA16F;
  3514. }
  3515. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_6_5:
  3516. return this._gl.RGB565;
  3517. case Constants.TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV:
  3518. return this._gl.R11F_G11F_B10F;
  3519. case Constants.TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV:
  3520. return this._gl.RGB9_E5;
  3521. case Constants.TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4:
  3522. return this._gl.RGBA4;
  3523. case Constants.TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1:
  3524. return this._gl.RGB5_A1;
  3525. case Constants.TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV:
  3526. switch (format) {
  3527. case Constants.TEXTUREFORMAT_RGBA:
  3528. return this._gl.RGB10_A2; // By default. Other possibility is RGB5_A1.
  3529. case Constants.TEXTUREFORMAT_RGBA_INTEGER:
  3530. return this._gl.RGB10_A2UI;
  3531. default:
  3532. return this._gl.RGB10_A2;
  3533. }
  3534. }
  3535. return this._gl.RGBA8;
  3536. }
  3537. /** @hidden */
  3538. public _getRGBAMultiSampleBufferFormat(type: number): number {
  3539. if (type === Constants.TEXTURETYPE_FLOAT) {
  3540. return this._gl.RGBA32F;
  3541. }
  3542. else if (type === Constants.TEXTURETYPE_HALF_FLOAT) {
  3543. return this._gl.RGBA16F;
  3544. }
  3545. return this._gl.RGBA8;
  3546. }
  3547. /** @hidden */
  3548. public _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void,
  3549. offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest {
  3550. let request = FileTools.LoadFile(url, onSuccess, onProgress, offlineProvider, useArrayBuffer, onError);
  3551. this._activeRequests.push(request);
  3552. request.onCompleteObservable.add((request) => {
  3553. this._activeRequests.splice(this._activeRequests.indexOf(request), 1);
  3554. });
  3555. return request;
  3556. }
  3557. /**
  3558. * Reads pixels from the current frame buffer. Please note that this function can be slow
  3559. * @param x defines the x coordinate of the rectangle where pixels must be read
  3560. * @param y defines the y coordinate of the rectangle where pixels must be read
  3561. * @param width defines the width of the rectangle where pixels must be read
  3562. * @param height defines the height of the rectangle where pixels must be read
  3563. * @param hasAlpha defines wether the output should have alpha or not (defaults to true)
  3564. * @returns a Uint8Array containing RGBA colors
  3565. */
  3566. public readPixels(x: number, y: number, width: number, height: number, hasAlpha = true): Uint8Array {
  3567. const numChannels = hasAlpha ? 4 : 3;
  3568. const format = hasAlpha ? this._gl.RGBA : this._gl.RGB;
  3569. const data = new Uint8Array(height * width * numChannels);
  3570. this._gl.readPixels(x, y, width, height, format, this._gl.UNSIGNED_BYTE, data);
  3571. return data;
  3572. }
  3573. // Statics
  3574. /**
  3575. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  3576. * @returns true if the engine can be created
  3577. * @ignorenaming
  3578. */
  3579. public static isSupported(): boolean {
  3580. try {
  3581. var tempcanvas = CanvasGenerator.CreateCanvas(1, 1);
  3582. var gl = tempcanvas.getContext("webgl") || (tempcanvas as any).getContext("experimental-webgl");
  3583. return gl != null && !!window.WebGLRenderingContext;
  3584. } catch (e) {
  3585. return false;
  3586. }
  3587. }
  3588. /**
  3589. * Find the next highest power of two.
  3590. * @param x Number to start search from.
  3591. * @return Next highest power of two.
  3592. */
  3593. public static CeilingPOT(x: number): number {
  3594. x--;
  3595. x |= x >> 1;
  3596. x |= x >> 2;
  3597. x |= x >> 4;
  3598. x |= x >> 8;
  3599. x |= x >> 16;
  3600. x++;
  3601. return x;
  3602. }
  3603. /**
  3604. * Find the next lowest power of two.
  3605. * @param x Number to start search from.
  3606. * @return Next lowest power of two.
  3607. */
  3608. public static FloorPOT(x: number): number {
  3609. x = x | (x >> 1);
  3610. x = x | (x >> 2);
  3611. x = x | (x >> 4);
  3612. x = x | (x >> 8);
  3613. x = x | (x >> 16);
  3614. return x - (x >> 1);
  3615. }
  3616. /**
  3617. * Find the nearest power of two.
  3618. * @param x Number to start search from.
  3619. * @return Next nearest power of two.
  3620. */
  3621. public static NearestPOT(x: number): number {
  3622. var c = ThinEngine.CeilingPOT(x);
  3623. var f = ThinEngine.FloorPOT(x);
  3624. return (c - x) > (x - f) ? f : c;
  3625. }
  3626. /**
  3627. * Get the closest exponent of two
  3628. * @param value defines the value to approximate
  3629. * @param max defines the maximum value to return
  3630. * @param mode defines how to define the closest value
  3631. * @returns closest exponent of two of the given value
  3632. */
  3633. public static GetExponentOfTwo(value: number, max: number, mode = Constants.SCALEMODE_NEAREST): number {
  3634. let pot;
  3635. switch (mode) {
  3636. case Constants.SCALEMODE_FLOOR:
  3637. pot = ThinEngine.FloorPOT(value);
  3638. break;
  3639. case Constants.SCALEMODE_NEAREST:
  3640. pot = ThinEngine.NearestPOT(value);
  3641. break;
  3642. case Constants.SCALEMODE_CEILING:
  3643. default:
  3644. pot = ThinEngine.CeilingPOT(value);
  3645. break;
  3646. }
  3647. return Math.min(pot, max);
  3648. }
  3649. /**
  3650. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  3651. * @param func - the function to be called
  3652. * @param requester - the object that will request the next frame. Falls back to window.
  3653. * @returns frame number
  3654. */
  3655. public static QueueNewFrame(func: () => void, requester?: any): number {
  3656. if (!DomManagement.IsWindowObjectExist()) {
  3657. if (typeof requestAnimationFrame !== "undefined") {
  3658. return requestAnimationFrame(func);
  3659. }
  3660. return setTimeout(func, 16);
  3661. }
  3662. if (!requester) {
  3663. requester = window;
  3664. }
  3665. if (requester.requestAnimationFrame) {
  3666. return requester.requestAnimationFrame(func);
  3667. }
  3668. else if (requester.msRequestAnimationFrame) {
  3669. return requester.msRequestAnimationFrame(func);
  3670. }
  3671. else if (requester.webkitRequestAnimationFrame) {
  3672. return requester.webkitRequestAnimationFrame(func);
  3673. }
  3674. else if (requester.mozRequestAnimationFrame) {
  3675. return requester.mozRequestAnimationFrame(func);
  3676. }
  3677. else if (requester.oRequestAnimationFrame) {
  3678. return requester.oRequestAnimationFrame(func);
  3679. }
  3680. else {
  3681. return window.setTimeout(func, 16);
  3682. }
  3683. }
  3684. /**
  3685. * Gets host document
  3686. * @returns the host document object
  3687. */
  3688. public getHostDocument(): Nullable<Document> {
  3689. if (this._renderingCanvas && this._renderingCanvas.ownerDocument) {
  3690. return this._renderingCanvas.ownerDocument;
  3691. }
  3692. return document;
  3693. }
  3694. }