global.html 184 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Global - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <h1 translate="no">Global</h1>
  13. <section>
  14. <header>
  15. </header>
  16. <article>
  17. <div class="container-overview">
  18. </div>
  19. <h2 class="subsection-title">Properties</h2>
  20. <div class="member">
  21. <h3 class="name" id="ACESFilmicToneMapping" translate="no">.<a href="#ACESFilmicToneMapping">ACESFilmicToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  22. <div class="description">
  23. <p>ACES Filmic tone mapping.</p>
  24. </div>
  25. </div>
  26. <div class="member">
  27. <h3 class="name" id="AddEquation" translate="no">.<a href="#AddEquation">AddEquation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  28. <div class="description">
  29. <p>A <code>source + destination</code> blending equation.</p>
  30. </div>
  31. </div>
  32. <div class="member">
  33. <h3 class="name" id="AddOperation" translate="no">.<a href="#AddOperation">AddOperation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  34. <div class="description">
  35. <p>Adds the two colors.</p>
  36. </div>
  37. </div>
  38. <div class="member">
  39. <h3 class="name" id="AdditiveAnimationBlendMode" translate="no">.<a href="#AdditiveAnimationBlendMode">AdditiveAnimationBlendMode</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  40. <div class="description">
  41. <p>Additive animation blend mode. Can be used to layer motions on top of
  42. each other to build complex performances from smaller re-usable assets.</p>
  43. </div>
  44. </div>
  45. <div class="member">
  46. <h3 class="name" id="AdditiveBlending" translate="no">.<a href="#AdditiveBlending">AdditiveBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  47. <div class="description">
  48. <p>Represents additive blending.</p>
  49. </div>
  50. </div>
  51. <div class="member">
  52. <h3 class="name" id="AgXToneMapping" translate="no">.<a href="#AgXToneMapping">AgXToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  53. <div class="description">
  54. <p>AgX tone mapping.</p>
  55. </div>
  56. </div>
  57. <div class="member">
  58. <h3 class="name" id="AlphaFormat" translate="no">.<a href="#AlphaFormat">AlphaFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  59. <div class="description">
  60. <p>Discards the red, green and blue components and reads just the alpha component.</p>
  61. </div>
  62. </div>
  63. <div class="member">
  64. <h3 class="name" id="AlwaysCompare" translate="no">.<a href="#AlwaysCompare">AlwaysCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  65. <div class="description">
  66. <p>Always pass.</p>
  67. </div>
  68. </div>
  69. <div class="member">
  70. <h3 class="name" id="AlwaysDepth" translate="no">.<a href="#AlwaysDepth">AlwaysDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  71. <div class="description">
  72. <p>Always pass.</p>
  73. </div>
  74. </div>
  75. <div class="member">
  76. <h3 class="name" id="AlwaysStencilFunc" translate="no">.<a href="#AlwaysStencilFunc">AlwaysStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  77. <div class="description">
  78. <p>Will always return true.</p>
  79. </div>
  80. </div>
  81. <div class="member">
  82. <h3 class="name" id="AnaglyphAlgorithm" translate="no">.<a href="#AnaglyphAlgorithm">AnaglyphAlgorithm</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  83. <div class="description">
  84. <p>Anaglyph algorithm types.</p>
  85. </div>
  86. <table class="props">
  87. <tbody>
  88. <tr>
  89. <td class="name">
  90. <strong>TRUE</strong>
  91. <br>
  92. <span class="param-type">string</span>
  93. </td>
  94. <td class="description last">
  95. </td>
  96. </tr>
  97. <tr>
  98. <td class="name">
  99. <strong>GREY</strong>
  100. <br>
  101. <span class="param-type">string</span>
  102. </td>
  103. <td class="description last">
  104. </td>
  105. </tr>
  106. <tr>
  107. <td class="name">
  108. <strong>COLOUR</strong>
  109. <br>
  110. <span class="param-type">string</span>
  111. </td>
  112. <td class="description last">
  113. </td>
  114. </tr>
  115. <tr>
  116. <td class="name">
  117. <strong>HALF_COLOUR</strong>
  118. <br>
  119. <span class="param-type">string</span>
  120. </td>
  121. <td class="description last">
  122. </td>
  123. </tr>
  124. <tr>
  125. <td class="name">
  126. <strong>DUBOIS</strong>
  127. <br>
  128. <span class="param-type">string</span>
  129. </td>
  130. <td class="description last">
  131. </td>
  132. </tr>
  133. <tr>
  134. <td class="name">
  135. <strong>OPTIMISED</strong>
  136. <br>
  137. <span class="param-type">string</span>
  138. </td>
  139. <td class="description last">
  140. </td>
  141. </tr>
  142. <tr>
  143. <td class="name">
  144. <strong>COMPROMISE</strong>
  145. <br>
  146. <span class="param-type">string</span>
  147. </td>
  148. <td class="description last">
  149. </td>
  150. </tr>
  151. </tbody>
  152. </table>
  153. </div>
  154. <div class="member">
  155. <h3 class="name" id="AnaglyphColorMode" translate="no">.<a href="#AnaglyphColorMode">AnaglyphColorMode</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  156. <div class="description">
  157. <p>Anaglyph color modes.</p>
  158. </div>
  159. <table class="props">
  160. <tbody>
  161. <tr>
  162. <td class="name">
  163. <strong>RED_CYAN</strong>
  164. <br>
  165. <span class="param-type">string</span>
  166. </td>
  167. <td class="description last">
  168. </td>
  169. </tr>
  170. <tr>
  171. <td class="name">
  172. <strong>MAGENTA_CYAN</strong>
  173. <br>
  174. <span class="param-type">string</span>
  175. </td>
  176. <td class="description last">
  177. </td>
  178. </tr>
  179. <tr>
  180. <td class="name">
  181. <strong>MAGENTA_GREEN</strong>
  182. <br>
  183. <span class="param-type">string</span>
  184. </td>
  185. <td class="description last">
  186. </td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. </div>
  191. <div class="member">
  192. <h3 class="name" id="AttachedBindMode" translate="no">.<a href="#AttachedBindMode">AttachedBindMode</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  193. <div class="description">
  194. <p>The skinned mesh shares the same world space as the skeleton.</p>
  195. </div>
  196. </div>
  197. <div class="member">
  198. <h3 class="name" id="BackSide" translate="no">.<a href="#BackSide">BackSide</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  199. <div class="description">
  200. <p>Only back faces are rendered.</p>
  201. </div>
  202. </div>
  203. <div class="member">
  204. <h3 class="name" id="BasicDepthPacking" translate="no">.<a href="#BasicDepthPacking">BasicDepthPacking</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  205. <div class="description">
  206. <p>The depth value is inverted (1.0 - z) for visualization purposes.</p>
  207. </div>
  208. </div>
  209. <div class="member">
  210. <h3 class="name" id="BasicShadowMap" translate="no">.<a href="#BasicShadowMap">BasicShadowMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  211. <div class="description">
  212. <p>Gives unfiltered shadow maps - fastest, but lowest quality.</p>
  213. </div>
  214. </div>
  215. <div class="member">
  216. <h3 class="name" id="ByteType" translate="no">.<a href="#ByteType">ByteType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  217. <div class="description">
  218. <p>A byte data type for textures.</p>
  219. </div>
  220. </div>
  221. <div class="member">
  222. <h3 class="name" id="CineonToneMapping" translate="no">.<a href="#CineonToneMapping">CineonToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  223. <div class="description">
  224. <p>Cineon tone mapping.</p>
  225. </div>
  226. </div>
  227. <div class="member">
  228. <h3 class="name" id="ClampToEdgeWrapping" translate="no">.<a href="#ClampToEdgeWrapping">ClampToEdgeWrapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  229. <div class="description">
  230. <p>The last pixel of the texture stretches to the edge of the mesh.</p>
  231. </div>
  232. </div>
  233. <div class="member">
  234. <h3 class="name" id="Compatibility" translate="no">.<a href="#Compatibility">Compatibility</a><span class="type-signature"> : Object</span> <span class="type-signature">(constant) </span></h3>
  235. <div class="description">
  236. <p>Compatibility flags for features that may not be supported across all platforms.</p>
  237. </div>
  238. </div>
  239. <div class="member">
  240. <h3 class="name" id="ConstantAlphaFactor" translate="no">.<a href="#ConstantAlphaFactor">ConstantAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  241. <div class="description">
  242. <p>Multiplies all colors by a constant alpha value.</p>
  243. </div>
  244. </div>
  245. <div class="member">
  246. <h3 class="name" id="ConstantColorFactor" translate="no">.<a href="#ConstantColorFactor">ConstantColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  247. <div class="description">
  248. <p>Multiplies all colors by a constant color.</p>
  249. </div>
  250. </div>
  251. <div class="member">
  252. <h3 class="name" id="CubeReflectionMapping" translate="no">.<a href="#CubeReflectionMapping">CubeReflectionMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  253. <div class="description">
  254. <p>Reflection mapping for cube textures.</p>
  255. </div>
  256. </div>
  257. <div class="member">
  258. <h3 class="name" id="CubeRefractionMapping" translate="no">.<a href="#CubeRefractionMapping">CubeRefractionMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  259. <div class="description">
  260. <p>Refraction mapping for cube textures.</p>
  261. </div>
  262. </div>
  263. <div class="member">
  264. <h3 class="name" id="CubeUVReflectionMapping" translate="no">.<a href="#CubeUVReflectionMapping">CubeUVReflectionMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  265. <div class="description">
  266. <p>Reflection mapping for PMREM textures.</p>
  267. </div>
  268. </div>
  269. <div class="member">
  270. <h3 class="name" id="CullFaceBack" translate="no">.<a href="#CullFaceBack">CullFaceBack</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  271. <div class="description">
  272. <p>Culls back faces.</p>
  273. </div>
  274. </div>
  275. <div class="member">
  276. <h3 class="name" id="CullFaceFront" translate="no">.<a href="#CullFaceFront">CullFaceFront</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  277. <div class="description">
  278. <p>Culls front faces.</p>
  279. </div>
  280. </div>
  281. <div class="member">
  282. <h3 class="name" id="CullFaceFrontBack" translate="no">.<a href="#CullFaceFrontBack">CullFaceFrontBack</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  283. <div class="description">
  284. <p>Culls both front and back faces.</p>
  285. </div>
  286. </div>
  287. <div class="member">
  288. <h3 class="name" id="CullFaceNone" translate="no">.<a href="#CullFaceNone">CullFaceNone</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  289. <div class="description">
  290. <p>Disables face culling.</p>
  291. </div>
  292. </div>
  293. <div class="member">
  294. <h3 class="name" id="CustomBlending" translate="no">.<a href="#CustomBlending">CustomBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  295. <div class="description">
  296. <p>Represents custom blending.</p>
  297. </div>
  298. </div>
  299. <div class="member">
  300. <h3 class="name" id="CustomToneMapping" translate="no">.<a href="#CustomToneMapping">CustomToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  301. <div class="description">
  302. <p>Custom tone mapping.</p>
  303. <p>Expects a custom implementation by modifying shader code of the material's fragment shader.</p>
  304. </div>
  305. </div>
  306. <div class="member">
  307. <h3 class="name" id="DATA" translate="no">.<a href="#DATA">DATA</a> <span class="type-signature">(constant) </span></h3>
  308. <div class="description">
  309. <p>Precomputed DFG LUT for Image-Based Lighting
  310. Resolution: 16x16
  311. Samples: 4096 per texel
  312. Format: RG16F (2 half floats per texel: scale, bias)</p>
  313. </div>
  314. </div>
  315. <div class="member">
  316. <h3 class="name" id="DecrementStencilOp" translate="no">.<a href="#DecrementStencilOp">DecrementStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  317. <div class="description">
  318. <p>Decrements the current stencil buffer value. Clamps to <code>0</code>.</p>
  319. </div>
  320. </div>
  321. <div class="member">
  322. <h3 class="name" id="DecrementWrapStencilOp" translate="no">.<a href="#DecrementWrapStencilOp">DecrementWrapStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  323. <div class="description">
  324. <p>Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable
  325. unsigned value when decrementing a stencil buffer value of <code>0</code>.</p>
  326. </div>
  327. </div>
  328. <div class="member">
  329. <h3 class="name" id="DefaultLoadingManager" translate="no">.<a href="#DefaultLoadingManager">DefaultLoadingManager</a><span class="type-signature"> : <a href="LoadingManager.html">LoadingManager</a></span> <span class="type-signature">(constant) </span></h3>
  330. <div class="description">
  331. <p>The global default loading manager.</p>
  332. </div>
  333. </div>
  334. <div class="member">
  335. <h3 class="name" id="DepthFormat" translate="no">.<a href="#DepthFormat">DepthFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  336. <div class="description">
  337. <p>Reads each element as a single depth value, converts it to floating point, and clamps to the range <code>[0,1]</code>.</p>
  338. </div>
  339. </div>
  340. <div class="member">
  341. <h3 class="name" id="DepthStencilFormat" translate="no">.<a href="#DepthStencilFormat">DepthStencilFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  342. <div class="description">
  343. <p>Reads each element is a pair of depth and stencil values. The depth component of the pair is interpreted as
  344. in <code>DepthFormat</code>. The stencil component is interpreted based on the depth + stencil internal format.</p>
  345. </div>
  346. </div>
  347. <div class="member">
  348. <h3 class="name" id="DetachedBindMode" translate="no">.<a href="#DetachedBindMode">DetachedBindMode</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  349. <div class="description">
  350. <p>The skinned mesh does not share the same world space as the skeleton.
  351. This is useful when a skeleton is shared across multiple skinned meshes.</p>
  352. </div>
  353. </div>
  354. <div class="member">
  355. <h3 class="name" id="DoubleSide" translate="no">.<a href="#DoubleSide">DoubleSide</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  356. <div class="description">
  357. <p>Both front and back faces are rendered.</p>
  358. </div>
  359. </div>
  360. <div class="member">
  361. <h3 class="name" id="DstAlphaFactor" translate="no">.<a href="#DstAlphaFactor">DstAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  362. <div class="description">
  363. <p>Multiplies all colors by the destination alpha value.</p>
  364. </div>
  365. </div>
  366. <div class="member">
  367. <h3 class="name" id="DstColorFactor" translate="no">.<a href="#DstColorFactor">DstColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  368. <div class="description">
  369. <p>Multiplies all colors by the destination color.</p>
  370. </div>
  371. </div>
  372. <div class="member">
  373. <h3 class="name" id="DynamicCopyUsage" translate="no">.<a href="#DynamicCopyUsage">DynamicCopyUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  374. <div class="description">
  375. <p>The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times
  376. as the source for WebGL drawing and image specification commands.</p>
  377. </div>
  378. </div>
  379. <div class="member">
  380. <h3 class="name" id="DynamicDrawUsage" translate="no">.<a href="#DynamicDrawUsage">DynamicDrawUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  381. <div class="description">
  382. <p>The contents are intended to be respecified repeatedly by the application, and
  383. used many times as the source for drawing and image specification commands.</p>
  384. </div>
  385. </div>
  386. <div class="member">
  387. <h3 class="name" id="DynamicReadUsage" translate="no">.<a href="#DynamicReadUsage">DynamicReadUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  388. <div class="description">
  389. <p>The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried
  390. many times by the application.</p>
  391. </div>
  392. </div>
  393. <div class="member">
  394. <h3 class="name" id="EqualCompare" translate="no">.<a href="#EqualCompare">EqualCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  395. <div class="description">
  396. <p>Pass if the incoming value equals the texture value.</p>
  397. </div>
  398. </div>
  399. <div class="member">
  400. <h3 class="name" id="EqualDepth" translate="no">.<a href="#EqualDepth">EqualDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  401. <div class="description">
  402. <p>Pass if the incoming value equals the depth buffer value.</p>
  403. </div>
  404. </div>
  405. <div class="member">
  406. <h3 class="name" id="EqualStencilFunc" translate="no">.<a href="#EqualStencilFunc">EqualStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  407. <div class="description">
  408. <p>Will return true if the stencil reference value is equal to the current stencil value.</p>
  409. </div>
  410. </div>
  411. <div class="member">
  412. <h3 class="name" id="EquirectangularReflectionMapping" translate="no">.<a href="#EquirectangularReflectionMapping">EquirectangularReflectionMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  413. <div class="description">
  414. <p>Reflection mapping for equirectangular textures.</p>
  415. </div>
  416. </div>
  417. <div class="member">
  418. <h3 class="name" id="EquirectangularRefractionMapping" translate="no">.<a href="#EquirectangularRefractionMapping">EquirectangularRefractionMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  419. <div class="description">
  420. <p>Refraction mapping for equirectangular textures.</p>
  421. </div>
  422. </div>
  423. <div class="member">
  424. <h3 class="name" id="FloatType" translate="no">.<a href="#FloatType">FloatType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  425. <div class="description">
  426. <p>A float data type for textures.</p>
  427. </div>
  428. </div>
  429. <div class="member">
  430. <h3 class="name" id="FrontSide" translate="no">.<a href="#FrontSide">FrontSide</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  431. <div class="description">
  432. <p>Only front faces are rendered.</p>
  433. </div>
  434. </div>
  435. <div class="member">
  436. <h3 class="name" id="GLSL1" translate="no">.<a href="#GLSL1">GLSL1</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  437. <div class="description">
  438. <p>GLSL 1 shader code.</p>
  439. </div>
  440. </div>
  441. <div class="member">
  442. <h3 class="name" id="GLSL3" translate="no">.<a href="#GLSL3">GLSL3</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  443. <div class="description">
  444. <p>GLSL 3 shader code.</p>
  445. </div>
  446. </div>
  447. <div class="member">
  448. <h3 class="name" id="GreaterCompare" translate="no">.<a href="#GreaterCompare">GreaterCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  449. <div class="description">
  450. <p>Pass if the incoming value is greater than the texture value.</p>
  451. </div>
  452. </div>
  453. <div class="member">
  454. <h3 class="name" id="GreaterDepth" translate="no">.<a href="#GreaterDepth">GreaterDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  455. <div class="description">
  456. <p>Pass if the incoming value is greater than the depth buffer value.</p>
  457. </div>
  458. </div>
  459. <div class="member">
  460. <h3 class="name" id="GreaterEqualCompare" translate="no">.<a href="#GreaterEqualCompare">GreaterEqualCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  461. <div class="description">
  462. <p>Pass if the incoming value is greater than or equal to the texture value.</p>
  463. </div>
  464. </div>
  465. <div class="member">
  466. <h3 class="name" id="GreaterEqualDepth" translate="no">.<a href="#GreaterEqualDepth">GreaterEqualDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  467. <div class="description">
  468. <p>Pass if the incoming value is greater than or equal to the depth buffer value.</p>
  469. </div>
  470. </div>
  471. <div class="member">
  472. <h3 class="name" id="GreaterEqualStencilFunc" translate="no">.<a href="#GreaterEqualStencilFunc">GreaterEqualStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  473. <div class="description">
  474. <p>Will return true if the stencil reference value is greater than or equal to the current stencil value.</p>
  475. </div>
  476. </div>
  477. <div class="member">
  478. <h3 class="name" id="GreaterStencilFunc" translate="no">.<a href="#GreaterStencilFunc">GreaterStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  479. <div class="description">
  480. <p>Will return true if the stencil reference value is greater than the current stencil value.</p>
  481. </div>
  482. </div>
  483. <div class="member">
  484. <h3 class="name" id="HalfFloatType" translate="no">.<a href="#HalfFloatType">HalfFloatType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  485. <div class="description">
  486. <p>A half float data type for textures.</p>
  487. </div>
  488. </div>
  489. <div class="member">
  490. <h3 class="name" id="IncrementStencilOp" translate="no">.<a href="#IncrementStencilOp">IncrementStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  491. <div class="description">
  492. <p>Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.</p>
  493. </div>
  494. </div>
  495. <div class="member">
  496. <h3 class="name" id="IncrementWrapStencilOp" translate="no">.<a href="#IncrementWrapStencilOp">IncrementWrapStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  497. <div class="description">
  498. <p>Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing
  499. the maximum representable unsigned value.</p>
  500. </div>
  501. </div>
  502. <div class="member">
  503. <h3 class="name" id="IntType" translate="no">.<a href="#IntType">IntType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  504. <div class="description">
  505. <p>An int data type for textures.</p>
  506. </div>
  507. </div>
  508. <div class="member">
  509. <h3 class="name" id="InterpolateBezier" translate="no">.<a href="#InterpolateBezier">InterpolateBezier</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  510. <div class="description">
  511. <p>Bezier interpolation mode for keyframe tracks.</p>
  512. <p>Uses cubic Bezier curves with explicit 2D control points.
  513. Requires tangent data to be set on the track.</p>
  514. </div>
  515. </div>
  516. <div class="member">
  517. <h3 class="name" id="InterpolateDiscrete" translate="no">.<a href="#InterpolateDiscrete">InterpolateDiscrete</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  518. <div class="description">
  519. <p>Discrete interpolation mode for keyframe tracks.</p>
  520. </div>
  521. </div>
  522. <div class="member">
  523. <h3 class="name" id="InterpolateLinear" translate="no">.<a href="#InterpolateLinear">InterpolateLinear</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  524. <div class="description">
  525. <p>Linear interpolation mode for keyframe tracks.</p>
  526. </div>
  527. </div>
  528. <div class="member">
  529. <h3 class="name" id="InterpolateSmooth" translate="no">.<a href="#InterpolateSmooth">InterpolateSmooth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  530. <div class="description">
  531. <p>Smooth interpolation mode for keyframe tracks.</p>
  532. </div>
  533. </div>
  534. <div class="member">
  535. <h3 class="name" id="InterpolationSamplingMode" translate="no">.<a href="#InterpolationSamplingMode">InterpolationSamplingMode</a><span class="type-signature"> : <a href="global.html#ConstantsInterpolationSamplingMode">ConstantsInterpolationSamplingMode</a></span> <span class="type-signature">(constant) </span></h3>
  536. <div class="description">
  537. <p>Represents the different interpolation sampling modes.</p>
  538. </div>
  539. </div>
  540. <div class="member">
  541. <h3 class="name" id="InterpolationSamplingType" translate="no">.<a href="#InterpolationSamplingType">InterpolationSamplingType</a><span class="type-signature"> : <a href="global.html#ConstantsInterpolationSamplingType">ConstantsInterpolationSamplingType</a></span> <span class="type-signature">(constant) </span></h3>
  542. <div class="description">
  543. <p>Represents mouse buttons and interaction types in context of controls.</p>
  544. </div>
  545. </div>
  546. <div class="member">
  547. <h3 class="name" id="InvertStencilOp" translate="no">.<a href="#InvertStencilOp">InvertStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  548. <div class="description">
  549. <p>Inverts the current stencil buffer value bitwise.</p>
  550. </div>
  551. </div>
  552. <div class="member">
  553. <h3 class="name" id="KHR_mesh_quantization_ExtraAttrTypes" translate="no">.<a href="#KHR_mesh_quantization_ExtraAttrTypes">KHR_mesh_quantization_ExtraAttrTypes</a> <span class="type-signature">(constant) </span></h3>
  554. <div class="description">
  555. <p>The KHR_mesh_quantization extension allows these extra attribute component types</p>
  556. </div>
  557. <dl class="details">
  558. <dt class="tag-see">See:</dt>
  559. <dd class="tag-see">
  560. <ul>
  561. <li><a href="https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Khronos/KHR_mesh_quantization/README.md#extending-mesh-attributes" target="_blank" rel="noopener">https://github.com/KhronosGroup/glTF/blob/main/extensions/2.0/Khronos/KHR_mesh_quantization/README.md#extending-mesh-attributes</a></li>
  562. </ul>
  563. </dd>
  564. </dl>
  565. </div>
  566. <div class="member">
  567. <h3 class="name" id="KeepStencilOp" translate="no">.<a href="#KeepStencilOp">KeepStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  568. <div class="description">
  569. <p>Keeps the current value.</p>
  570. </div>
  571. </div>
  572. <div class="member">
  573. <h3 class="name" id="LessCompare" translate="no">.<a href="#LessCompare">LessCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  574. <div class="description">
  575. <p>Pass if the incoming value is less than the texture value.</p>
  576. </div>
  577. </div>
  578. <div class="member">
  579. <h3 class="name" id="LessDepth" translate="no">.<a href="#LessDepth">LessDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  580. <div class="description">
  581. <p>Pass if the incoming value is less than the depth buffer value.</p>
  582. </div>
  583. </div>
  584. <div class="member">
  585. <h3 class="name" id="LessEqualCompare" translate="no">.<a href="#LessEqualCompare">LessEqualCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  586. <div class="description">
  587. <p>Pass if the incoming value is less than or equal to the texture value.</p>
  588. </div>
  589. </div>
  590. <div class="member">
  591. <h3 class="name" id="LessEqualDepth" translate="no">.<a href="#LessEqualDepth">LessEqualDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  592. <div class="description">
  593. <p>Pass if the incoming value is less than or equal to the depth buffer value.</p>
  594. </div>
  595. </div>
  596. <div class="member">
  597. <h3 class="name" id="LessEqualStencilFunc" translate="no">.<a href="#LessEqualStencilFunc">LessEqualStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  598. <div class="description">
  599. <p>Will return true if the stencil reference value is less than or equal to the current stencil value.</p>
  600. </div>
  601. </div>
  602. <div class="member">
  603. <h3 class="name" id="LessStencilFunc" translate="no">.<a href="#LessStencilFunc">LessStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  604. <div class="description">
  605. <p>Will return true if the stencil reference value is less than the current stencil value.</p>
  606. </div>
  607. </div>
  608. <div class="member">
  609. <h3 class="name" id="LinearFilter" translate="no">.<a href="#LinearFilter">LinearFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  610. <div class="description">
  611. <p>Returns the weighted average of the four texture elements that are closest to the specified
  612. texture coordinates, and can include items wrapped or repeated from other parts of a texture,
  613. depending on the values of <code>wrapS</code> and <code>wrapT</code>, and on the exact mapping.</p>
  614. </div>
  615. </div>
  616. <div class="member">
  617. <h3 class="name" id="LinearMipmapLinearFilter" translate="no">.<a href="#LinearMipmapLinearFilter">LinearMipmapLinearFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  618. <div class="description">
  619. <p>Chooses the two mipmaps that most closely match the size of the pixel being textured and uses
  620. the <code>LinearFilter</code> criterion to produce a texture value from each mipmap. The final texture value
  621. is a weighted average of those two values.</p>
  622. </div>
  623. </div>
  624. <div class="member">
  625. <h3 class="name" id="LinearMipmapNearestFilter" translate="no">.<a href="#LinearMipmapNearestFilter">LinearMipmapNearestFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  626. <div class="description">
  627. <p>Chooses the mipmap that most closely matches the size of the pixel being textured and uses
  628. the <code>LinearFilter</code> criterion (a weighted average of the four texels that are closest to the
  629. center of the pixel) to produce a texture value.</p>
  630. </div>
  631. </div>
  632. <div class="member">
  633. <h3 class="name" id="LinearSRGBColorSpace" translate="no">.<a href="#LinearSRGBColorSpace">LinearSRGBColorSpace</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  634. <div class="description">
  635. <p>sRGB-linear color space.</p>
  636. </div>
  637. </div>
  638. <div class="member">
  639. <h3 class="name" id="LinearToneMapping" translate="no">.<a href="#LinearToneMapping">LinearToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  640. <div class="description">
  641. <p>Linear tone mapping.</p>
  642. </div>
  643. </div>
  644. <div class="member">
  645. <h3 class="name" id="LinearTransfer" translate="no">.<a href="#LinearTransfer">LinearTransfer</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  646. <div class="description">
  647. <p>Linear transfer function.</p>
  648. </div>
  649. </div>
  650. <div class="member">
  651. <h3 class="name" id="LoopOnce" translate="no">.<a href="#LoopOnce">LoopOnce</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  652. <div class="description">
  653. <p>Animations are played once.</p>
  654. </div>
  655. </div>
  656. <div class="member">
  657. <h3 class="name" id="LoopPingPong" translate="no">.<a href="#LoopPingPong">LoopPingPong</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  658. <div class="description">
  659. <p>Animations are played with a chosen number of repetitions, alternately playing forward
  660. and backward.</p>
  661. </div>
  662. </div>
  663. <div class="member">
  664. <h3 class="name" id="LoopRepeat" translate="no">.<a href="#LoopRepeat">LoopRepeat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  665. <div class="description">
  666. <p>Animations are played with a chosen number of repetitions, each time jumping from
  667. the end of the clip directly to its beginning.</p>
  668. </div>
  669. </div>
  670. <div class="member">
  671. <h3 class="name" id="MOUSE" translate="no">.<a href="#MOUSE">MOUSE</a><span class="type-signature"> : <a href="global.html#ConstantsMouse">ConstantsMouse</a></span> <span class="type-signature">(constant) </span></h3>
  672. <div class="description">
  673. <p>Represents mouse buttons and interaction types in context of controls.</p>
  674. </div>
  675. </div>
  676. <div class="member">
  677. <h3 class="name" id="MaterialBlending" translate="no">.<a href="#MaterialBlending">MaterialBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  678. <div class="description">
  679. <p>Represents material blending.</p>
  680. </div>
  681. </div>
  682. <div class="member">
  683. <h3 class="name" id="MaxEquation" translate="no">.<a href="#MaxEquation">MaxEquation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  684. <div class="description">
  685. <p>A blend equation that uses the maximum of source and destination.</p>
  686. </div>
  687. </div>
  688. <div class="member">
  689. <h3 class="name" id="MinEquation" translate="no">.<a href="#MinEquation">MinEquation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  690. <div class="description">
  691. <p>A blend equation that uses the minimum of source and destination.</p>
  692. </div>
  693. </div>
  694. <div class="member">
  695. <h3 class="name" id="MirroredRepeatWrapping" translate="no">.<a href="#MirroredRepeatWrapping">MirroredRepeatWrapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  696. <div class="description">
  697. <p>The texture will repeats to infinity, mirroring on each repeat.</p>
  698. </div>
  699. </div>
  700. <div class="member">
  701. <h3 class="name" id="MixOperation" translate="no">.<a href="#MixOperation">MixOperation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  702. <div class="description">
  703. <p>Uses reflectivity to blend between the two colors.</p>
  704. </div>
  705. </div>
  706. <div class="member">
  707. <h3 class="name" id="MultiplyBlending" translate="no">.<a href="#MultiplyBlending">MultiplyBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  708. <div class="description">
  709. <p>Represents multiply blending.</p>
  710. </div>
  711. </div>
  712. <div class="member">
  713. <h3 class="name" id="MultiplyOperation" translate="no">.<a href="#MultiplyOperation">MultiplyOperation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  714. <div class="description">
  715. <p>Multiplies the environment map color with the surface color.</p>
  716. </div>
  717. </div>
  718. <div class="member">
  719. <h3 class="name" id="NearestFilter" translate="no">.<a href="#NearestFilter">NearestFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  720. <div class="description">
  721. <p>Returns the value of the texture element that is nearest (in Manhattan distance)
  722. to the specified texture coordinates.</p>
  723. </div>
  724. </div>
  725. <div class="member">
  726. <h3 class="name" id="NearestMipmapLinearFilter" translate="no">.<a href="#NearestMipmapLinearFilter">NearestMipmapLinearFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  727. <div class="description">
  728. <p>Chooses the two mipmaps that most closely match the size of the pixel being textured and
  729. uses the <code>NearestFilter</code> criterion to produce a texture value from each mipmap.
  730. The final texture value is a weighted average of those two values.</p>
  731. </div>
  732. </div>
  733. <div class="member">
  734. <h3 class="name" id="NearestMipmapNearestFilter" translate="no">.<a href="#NearestMipmapNearestFilter">NearestMipmapNearestFilter</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  735. <div class="description">
  736. <p>Chooses the mipmap that most closely matches the size of the pixel being textured
  737. and uses the <code>NearestFilter</code> criterion (the texel nearest to the center of the pixel)
  738. to produce a texture value.</p>
  739. </div>
  740. </div>
  741. <div class="member">
  742. <h3 class="name" id="NeutralToneMapping" translate="no">.<a href="#NeutralToneMapping">NeutralToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  743. <div class="description">
  744. <p>Neutral tone mapping.</p>
  745. <p>Implementation based on the Khronos 3D Commerce Group standard tone mapping.</p>
  746. </div>
  747. </div>
  748. <div class="member">
  749. <h3 class="name" id="NeverCompare" translate="no">.<a href="#NeverCompare">NeverCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  750. <div class="description">
  751. <p>Never pass.</p>
  752. </div>
  753. </div>
  754. <div class="member">
  755. <h3 class="name" id="NeverDepth" translate="no">.<a href="#NeverDepth">NeverDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  756. <div class="description">
  757. <p>Never pass.</p>
  758. </div>
  759. </div>
  760. <div class="member">
  761. <h3 class="name" id="NeverStencilFunc" translate="no">.<a href="#NeverStencilFunc">NeverStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  762. <div class="description">
  763. <p>Will never return true.</p>
  764. </div>
  765. </div>
  766. <div class="member">
  767. <h3 class="name" id="NoBlending" translate="no">.<a href="#NoBlending">NoBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  768. <div class="description">
  769. <p>No blending is performed which effectively disables
  770. alpha transparency.</p>
  771. </div>
  772. </div>
  773. <div class="member">
  774. <h3 class="name" id="NoColorSpace" translate="no">.<a href="#NoColorSpace">NoColorSpace</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  775. <div class="description">
  776. <p>No color space.</p>
  777. </div>
  778. </div>
  779. <div class="member">
  780. <h3 class="name" id="NoNormalPacking" translate="no">.<a href="#NoNormalPacking">NoNormalPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  781. <div class="description">
  782. <p>No normal map packing.</p>
  783. </div>
  784. </div>
  785. <div class="member">
  786. <h3 class="name" id="NoToneMapping" translate="no">.<a href="#NoToneMapping">NoToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  787. <div class="description">
  788. <p>No tone mapping is applied.</p>
  789. </div>
  790. </div>
  791. <div class="member">
  792. <h3 class="name" id="NodeAccess" translate="no">.<a href="#NodeAccess">NodeAccess</a> <span class="type-signature">(constant) </span></h3>
  793. <div class="description">
  794. <p>Access types of a node. These are relevant for compute and storage usage.</p>
  795. </div>
  796. <table class="props">
  797. <tbody>
  798. <tr>
  799. <td class="name">
  800. <strong>READ_ONLY</strong>
  801. <br>
  802. <span class="param-type">string</span>
  803. </td>
  804. <td class="description last">
  805. <p>Read-only access</p>
  806. </td>
  807. </tr>
  808. <tr>
  809. <td class="name">
  810. <strong>WRITE_ONLY</strong>
  811. <br>
  812. <span class="param-type">string</span>
  813. </td>
  814. <td class="description last">
  815. <p>Write-only access.</p>
  816. </td>
  817. </tr>
  818. <tr>
  819. <td class="name">
  820. <strong>READ_WRITE</strong>
  821. <br>
  822. <span class="param-type">string</span>
  823. </td>
  824. <td class="description last">
  825. <p>Read and write access.</p>
  826. </td>
  827. </tr>
  828. </tbody>
  829. </table>
  830. </div>
  831. <div class="member">
  832. <h3 class="name" id="NodeShaderStage" translate="no">.<a href="#NodeShaderStage">NodeShaderStage</a> <span class="type-signature">(constant) </span></h3>
  833. <div class="description">
  834. <p>Possible shader stages.</p>
  835. </div>
  836. <table class="props">
  837. <tbody>
  838. <tr>
  839. <td class="name">
  840. <strong>VERTEX</strong>
  841. <br>
  842. <span class="param-type">string</span>
  843. </td>
  844. <td class="description last">
  845. <p>The vertex shader stage.</p>
  846. </td>
  847. </tr>
  848. <tr>
  849. <td class="name">
  850. <strong>FRAGMENT</strong>
  851. <br>
  852. <span class="param-type">string</span>
  853. </td>
  854. <td class="description last">
  855. <p>The fragment shader stage.</p>
  856. </td>
  857. </tr>
  858. </tbody>
  859. </table>
  860. </div>
  861. <div class="member">
  862. <h3 class="name" id="NodeType" translate="no">.<a href="#NodeType">NodeType</a> <span class="type-signature">(constant) </span></h3>
  863. <div class="description">
  864. <p>Data types of a node.</p>
  865. </div>
  866. <table class="props">
  867. <tbody>
  868. <tr>
  869. <td class="name">
  870. <strong>BOOLEAN</strong>
  871. <br>
  872. <span class="param-type">string</span>
  873. </td>
  874. <td class="description last">
  875. <p>Boolean type.</p>
  876. </td>
  877. </tr>
  878. <tr>
  879. <td class="name">
  880. <strong>INTEGER</strong>
  881. <br>
  882. <span class="param-type">string</span>
  883. </td>
  884. <td class="description last">
  885. <p>Integer type.</p>
  886. </td>
  887. </tr>
  888. <tr>
  889. <td class="name">
  890. <strong>FLOAT</strong>
  891. <br>
  892. <span class="param-type">string</span>
  893. </td>
  894. <td class="description last">
  895. <p>Float type.</p>
  896. </td>
  897. </tr>
  898. <tr>
  899. <td class="name">
  900. <strong>VECTOR2</strong>
  901. <br>
  902. <span class="param-type">string</span>
  903. </td>
  904. <td class="description last">
  905. <p>Two-dimensional vector type.</p>
  906. </td>
  907. </tr>
  908. <tr>
  909. <td class="name">
  910. <strong>VECTOR3</strong>
  911. <br>
  912. <span class="param-type">string</span>
  913. </td>
  914. <td class="description last">
  915. <p>Three-dimensional vector type.</p>
  916. </td>
  917. </tr>
  918. <tr>
  919. <td class="name">
  920. <strong>VECTOR4</strong>
  921. <br>
  922. <span class="param-type">string</span>
  923. </td>
  924. <td class="description last">
  925. <p>Four-dimensional vector type.</p>
  926. </td>
  927. </tr>
  928. <tr>
  929. <td class="name">
  930. <strong>MATRIX2</strong>
  931. <br>
  932. <span class="param-type">string</span>
  933. </td>
  934. <td class="description last">
  935. <p>2x2 matrix type.</p>
  936. </td>
  937. </tr>
  938. <tr>
  939. <td class="name">
  940. <strong>MATRIX3</strong>
  941. <br>
  942. <span class="param-type">string</span>
  943. </td>
  944. <td class="description last">
  945. <p>3x3 matrix type.</p>
  946. </td>
  947. </tr>
  948. <tr>
  949. <td class="name">
  950. <strong>MATRIX4</strong>
  951. <br>
  952. <span class="param-type">string</span>
  953. </td>
  954. <td class="description last">
  955. <p>4x4 matrix type.</p>
  956. </td>
  957. </tr>
  958. </tbody>
  959. </table>
  960. </div>
  961. <div class="member">
  962. <h3 class="name" id="NodeUpdateType" translate="no">.<a href="#NodeUpdateType">NodeUpdateType</a> <span class="type-signature">(constant) </span></h3>
  963. <div class="description">
  964. <p>Update types of a node.</p>
  965. </div>
  966. <table class="props">
  967. <tbody>
  968. <tr>
  969. <td class="name">
  970. <strong>NONE</strong>
  971. <br>
  972. <span class="param-type">string</span>
  973. </td>
  974. <td class="description last">
  975. <p>The update method is not executed.</p>
  976. </td>
  977. </tr>
  978. <tr>
  979. <td class="name">
  980. <strong>FRAME</strong>
  981. <br>
  982. <span class="param-type">string</span>
  983. </td>
  984. <td class="description last">
  985. <p>The update method is executed per frame.</p>
  986. </td>
  987. </tr>
  988. <tr>
  989. <td class="name">
  990. <strong>RENDER</strong>
  991. <br>
  992. <span class="param-type">string</span>
  993. </td>
  994. <td class="description last">
  995. <p>The update method is executed per render. A frame might be produced by multiple render calls so this value allows more detailed updates than FRAME.</p>
  996. </td>
  997. </tr>
  998. <tr>
  999. <td class="name">
  1000. <strong>OBJECT</strong>
  1001. <br>
  1002. <span class="param-type">string</span>
  1003. </td>
  1004. <td class="description last">
  1005. <p>The update method is executed per <a href="Object3D.html">Object3D</a> that uses the node for rendering.</p>
  1006. </td>
  1007. </tr>
  1008. </tbody>
  1009. </table>
  1010. </div>
  1011. <div class="member">
  1012. <h3 class="name" id="NormalAnimationBlendMode" translate="no">.<a href="#NormalAnimationBlendMode">NormalAnimationBlendMode</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1013. <div class="description">
  1014. <p>Default animation blend mode.</p>
  1015. </div>
  1016. </div>
  1017. <div class="member">
  1018. <h3 class="name" id="NormalBlending" translate="no">.<a href="#NormalBlending">NormalBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1019. <div class="description">
  1020. <p>The default blending.</p>
  1021. </div>
  1022. </div>
  1023. <div class="member">
  1024. <h3 class="name" id="NormalGAPacking" translate="no">.<a href="#NormalGAPacking">NormalGAPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  1025. <div class="description">
  1026. <p>Normal GA packing.</p>
  1027. </div>
  1028. </div>
  1029. <div class="member">
  1030. <h3 class="name" id="NormalRGPacking" translate="no">.<a href="#NormalRGPacking">NormalRGPacking</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  1031. <div class="description">
  1032. <p>Normal RG packing.</p>
  1033. </div>
  1034. </div>
  1035. <div class="member">
  1036. <h3 class="name" id="NotEqualCompare" translate="no">.<a href="#NotEqualCompare">NotEqualCompare</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1037. <div class="description">
  1038. <p>Pass if the incoming value is not equal to the texture value.</p>
  1039. </div>
  1040. </div>
  1041. <div class="member">
  1042. <h3 class="name" id="NotEqualDepth" translate="no">.<a href="#NotEqualDepth">NotEqualDepth</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1043. <div class="description">
  1044. <p>Pass if the incoming value is not equal to the depth buffer value.</p>
  1045. </div>
  1046. </div>
  1047. <div class="member">
  1048. <h3 class="name" id="NotEqualStencilFunc" translate="no">.<a href="#NotEqualStencilFunc">NotEqualStencilFunc</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1049. <div class="description">
  1050. <p>Will return true if the stencil reference value is not equal to the current stencil value.</p>
  1051. </div>
  1052. </div>
  1053. <div class="member">
  1054. <h3 class="name" id="ObjectSpaceNormalMap" translate="no">.<a href="#ObjectSpaceNormalMap">ObjectSpaceNormalMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1055. <div class="description">
  1056. <p>Normal information is relative to the object orientation.</p>
  1057. </div>
  1058. </div>
  1059. <div class="member">
  1060. <h3 class="name" id="OnBeforeMaterialUpdate" translate="no">.<a href="#OnBeforeMaterialUpdate">OnBeforeMaterialUpdate</a> <span class="type-signature">(constant) </span></h3>
  1061. <div class="description">
  1062. <p>Creates an event that triggers a function before the material is updated.</p>
  1063. <p>The event will be bound to the declared TSL function <code>Fn()</code>; it must be declared within a <code>Fn()</code> or the JS function call must be inherited from one.</p>
  1064. </div>
  1065. </div>
  1066. <div class="member">
  1067. <h3 class="name" id="OnBeforeObjectUpdate" translate="no">.<a href="#OnBeforeObjectUpdate">OnBeforeObjectUpdate</a> <span class="type-signature">(constant) </span></h3>
  1068. <div class="description">
  1069. <p>Creates an event that triggers a function before an object (Mesh|Sprite) is updated.</p>
  1070. <p>The event will be bound to the declared TSL function <code>Fn()</code>; it must be declared within a <code>Fn()</code> or the JS function call must be inherited from one.</p>
  1071. </div>
  1072. </div>
  1073. <div class="member">
  1074. <h3 class="name" id="OnMaterialUpdate" translate="no">.<a href="#OnMaterialUpdate">OnMaterialUpdate</a> <span class="type-signature">(constant) </span></h3>
  1075. <div class="description">
  1076. <p>Creates an event that triggers a function when the first object that uses the material is rendered.</p>
  1077. <p>The event will be bound to the declared TSL function <code>Fn()</code>; it must be declared within a <code>Fn()</code> or the JS function call must be inherited from one.</p>
  1078. </div>
  1079. </div>
  1080. <div class="member">
  1081. <h3 class="name" id="OnObjectUpdate" translate="no">.<a href="#OnObjectUpdate">OnObjectUpdate</a> <span class="type-signature">(constant) </span></h3>
  1082. <div class="description">
  1083. <p>Creates an event that triggers a function every time an object (Mesh|Sprite) is rendered.</p>
  1084. <p>The event will be bound to the declared TSL function <code>Fn()</code>; it must be declared within a <code>Fn()</code> or the JS function call must be inherited from one.</p>
  1085. </div>
  1086. </div>
  1087. <div class="member">
  1088. <h3 class="name" id="OneFactor" translate="no">.<a href="#OneFactor">OneFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1089. <div class="description">
  1090. <p>Multiplies all colors by <code>1</code>.</p>
  1091. </div>
  1092. </div>
  1093. <div class="member">
  1094. <h3 class="name" id="OneMinusConstantAlphaFactor" translate="no">.<a href="#OneMinusConstantAlphaFactor">OneMinusConstantAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1095. <div class="description">
  1096. <p>Multiplies all colors by 1 minus a constant alpha value.</p>
  1097. </div>
  1098. </div>
  1099. <div class="member">
  1100. <h3 class="name" id="OneMinusConstantColorFactor" translate="no">.<a href="#OneMinusConstantColorFactor">OneMinusConstantColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1101. <div class="description">
  1102. <p>Multiplies all colors by <code>1</code> minus a constant color.</p>
  1103. </div>
  1104. </div>
  1105. <div class="member">
  1106. <h3 class="name" id="OneMinusDstAlphaFactor" translate="no">.<a href="#OneMinusDstAlphaFactor">OneMinusDstAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1107. <div class="description">
  1108. <p>Multiplies all colors by <code>1</code> minus the destination alpha value.</p>
  1109. </div>
  1110. </div>
  1111. <div class="member">
  1112. <h3 class="name" id="OneMinusDstColorFactor" translate="no">.<a href="#OneMinusDstColorFactor">OneMinusDstColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1113. <div class="description">
  1114. <p>Multiplies all colors by <code>1</code> minus each destination color.</p>
  1115. </div>
  1116. </div>
  1117. <div class="member">
  1118. <h3 class="name" id="OneMinusSrcAlphaFactor" translate="no">.<a href="#OneMinusSrcAlphaFactor">OneMinusSrcAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1119. <div class="description">
  1120. <p>Multiplies all colors by 1 minus the source alpha value.</p>
  1121. </div>
  1122. </div>
  1123. <div class="member">
  1124. <h3 class="name" id="OneMinusSrcColorFactor" translate="no">.<a href="#OneMinusSrcColorFactor">OneMinusSrcColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1125. <div class="description">
  1126. <p>Multiplies all colors by <code>1</code> minus each source color.</p>
  1127. </div>
  1128. </div>
  1129. <div class="member">
  1130. <h3 class="name" id="PCFShadowMap" translate="no">.<a href="#PCFShadowMap">PCFShadowMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1131. <div class="description">
  1132. <p>Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm.</p>
  1133. </div>
  1134. </div>
  1135. <div class="member">
  1136. <h3 class="name" id="PCFSoftShadowMap" translate="no">.<a href="#PCFSoftShadowMap">PCFSoftShadowMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1137. <div class="description">
  1138. <p>Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm with
  1139. better soft shadows especially when using low-resolution shadow maps.</p>
  1140. </div>
  1141. </div>
  1142. <div class="member">
  1143. <h3 class="name" id="R11_EAC_Format" translate="no">.<a href="#R11_EAC_Format">R11_EAC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1144. <div class="description">
  1145. <p>EAC R11 UNORM format.</p>
  1146. </div>
  1147. </div>
  1148. <div class="member">
  1149. <h3 class="name" id="RED_GREEN_RGTC2_Format" translate="no">.<a href="#RED_GREEN_RGTC2_Format">RED_GREEN_RGTC2_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1150. <div class="description">
  1151. <p>RGTC2 Red Green format.</p>
  1152. </div>
  1153. </div>
  1154. <div class="member">
  1155. <h3 class="name" id="RED_RGTC1_Format" translate="no">.<a href="#RED_RGTC1_Format">RED_RGTC1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1156. <div class="description">
  1157. <p>RGTC1 Red format.</p>
  1158. </div>
  1159. </div>
  1160. <div class="member">
  1161. <h3 class="name" id="RG11_EAC_Format" translate="no">.<a href="#RG11_EAC_Format">RG11_EAC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1162. <div class="description">
  1163. <p>EAC RG11 UNORM format.</p>
  1164. </div>
  1165. </div>
  1166. <div class="member">
  1167. <h3 class="name" id="RGBADepthPacking" translate="no">.<a href="#RGBADepthPacking">RGBADepthPacking</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1168. <div class="description">
  1169. <p>The depth value is packed into 32 bit RGBA.</p>
  1170. </div>
  1171. </div>
  1172. <div class="member">
  1173. <h3 class="name" id="RGBAFormat" translate="no">.<a href="#RGBAFormat">RGBAFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1174. <div class="description">
  1175. <p>Reads the red, green, blue and alpha components.</p>
  1176. </div>
  1177. </div>
  1178. <div class="member">
  1179. <h3 class="name" id="RGBAIntegerFormat" translate="no">.<a href="#RGBAIntegerFormat">RGBAIntegerFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1180. <div class="description">
  1181. <p>Reads the red, green, blue and alpha components. The texels are read as integers instead of floating point.</p>
  1182. </div>
  1183. </div>
  1184. <div class="member">
  1185. <h3 class="name" id="RGBA_ASTC_10x10_Format" translate="no">.<a href="#RGBA_ASTC_10x10_Format">RGBA_ASTC_10x10_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1186. <div class="description">
  1187. <p>ASTC RGBA 10x10 format.</p>
  1188. </div>
  1189. </div>
  1190. <div class="member">
  1191. <h3 class="name" id="RGBA_ASTC_10x5_Format" translate="no">.<a href="#RGBA_ASTC_10x5_Format">RGBA_ASTC_10x5_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1192. <div class="description">
  1193. <p>ASTC RGBA 10x5 format.</p>
  1194. </div>
  1195. </div>
  1196. <div class="member">
  1197. <h3 class="name" id="RGBA_ASTC_10x6_Format" translate="no">.<a href="#RGBA_ASTC_10x6_Format">RGBA_ASTC_10x6_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1198. <div class="description">
  1199. <p>ASTC RGBA 10x6 format.</p>
  1200. </div>
  1201. </div>
  1202. <div class="member">
  1203. <h3 class="name" id="RGBA_ASTC_10x8_Format" translate="no">.<a href="#RGBA_ASTC_10x8_Format">RGBA_ASTC_10x8_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1204. <div class="description">
  1205. <p>ASTC RGBA 10x8 format.</p>
  1206. </div>
  1207. </div>
  1208. <div class="member">
  1209. <h3 class="name" id="RGBA_ASTC_12x10_Format" translate="no">.<a href="#RGBA_ASTC_12x10_Format">RGBA_ASTC_12x10_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1210. <div class="description">
  1211. <p>ASTC RGBA 12x10 format.</p>
  1212. </div>
  1213. </div>
  1214. <div class="member">
  1215. <h3 class="name" id="RGBA_ASTC_12x12_Format" translate="no">.<a href="#RGBA_ASTC_12x12_Format">RGBA_ASTC_12x12_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1216. <div class="description">
  1217. <p>ASTC RGBA 12x12 format.</p>
  1218. </div>
  1219. </div>
  1220. <div class="member">
  1221. <h3 class="name" id="RGBA_ASTC_4x4_Format" translate="no">.<a href="#RGBA_ASTC_4x4_Format">RGBA_ASTC_4x4_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1222. <div class="description">
  1223. <p>ASTC RGBA 4x4 format.</p>
  1224. </div>
  1225. </div>
  1226. <div class="member">
  1227. <h3 class="name" id="RGBA_ASTC_5x4_Format" translate="no">.<a href="#RGBA_ASTC_5x4_Format">RGBA_ASTC_5x4_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1228. <div class="description">
  1229. <p>ASTC RGBA 5x4 format.</p>
  1230. </div>
  1231. </div>
  1232. <div class="member">
  1233. <h3 class="name" id="RGBA_ASTC_5x5_Format" translate="no">.<a href="#RGBA_ASTC_5x5_Format">RGBA_ASTC_5x5_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1234. <div class="description">
  1235. <p>ASTC RGBA 5x5 format.</p>
  1236. </div>
  1237. </div>
  1238. <div class="member">
  1239. <h3 class="name" id="RGBA_ASTC_6x5_Format" translate="no">.<a href="#RGBA_ASTC_6x5_Format">RGBA_ASTC_6x5_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1240. <div class="description">
  1241. <p>ASTC RGBA 6x5 format.</p>
  1242. </div>
  1243. </div>
  1244. <div class="member">
  1245. <h3 class="name" id="RGBA_ASTC_6x6_Format" translate="no">.<a href="#RGBA_ASTC_6x6_Format">RGBA_ASTC_6x6_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1246. <div class="description">
  1247. <p>ASTC RGBA 6x6 format.</p>
  1248. </div>
  1249. </div>
  1250. <div class="member">
  1251. <h3 class="name" id="RGBA_ASTC_8x5_Format" translate="no">.<a href="#RGBA_ASTC_8x5_Format">RGBA_ASTC_8x5_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1252. <div class="description">
  1253. <p>ASTC RGBA 8x5 format.</p>
  1254. </div>
  1255. </div>
  1256. <div class="member">
  1257. <h3 class="name" id="RGBA_ASTC_8x6_Format" translate="no">.<a href="#RGBA_ASTC_8x6_Format">RGBA_ASTC_8x6_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1258. <div class="description">
  1259. <p>ASTC RGBA 8x6 format.</p>
  1260. </div>
  1261. </div>
  1262. <div class="member">
  1263. <h3 class="name" id="RGBA_ASTC_8x8_Format" translate="no">.<a href="#RGBA_ASTC_8x8_Format">RGBA_ASTC_8x8_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1264. <div class="description">
  1265. <p>ASTC RGBA 8x8 format.</p>
  1266. </div>
  1267. </div>
  1268. <div class="member">
  1269. <h3 class="name" id="RGBA_BPTC_Format" translate="no">.<a href="#RGBA_BPTC_Format">RGBA_BPTC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1270. <div class="description">
  1271. <p>BPTC RGBA format.</p>
  1272. </div>
  1273. </div>
  1274. <div class="member">
  1275. <h3 class="name" id="RGBA_ETC2_EAC_Format" translate="no">.<a href="#RGBA_ETC2_EAC_Format">RGBA_ETC2_EAC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1276. <div class="description">
  1277. <p>ETC2 RGBA format.</p>
  1278. </div>
  1279. </div>
  1280. <div class="member">
  1281. <h3 class="name" id="RGBA_PVRTC_2BPPV1_Format" translate="no">.<a href="#RGBA_PVRTC_2BPPV1_Format">RGBA_PVRTC_2BPPV1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1282. <div class="description">
  1283. <p>PVRTC RGBA compression in 2-bit mode. One block for each 8×4 pixels.</p>
  1284. </div>
  1285. </div>
  1286. <div class="member">
  1287. <h3 class="name" id="RGBA_PVRTC_4BPPV1_Format" translate="no">.<a href="#RGBA_PVRTC_4BPPV1_Format">RGBA_PVRTC_4BPPV1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1288. <div class="description">
  1289. <p>PVRTC RGBA compression in 4-bit mode. One block for each 4×4 pixels.</p>
  1290. </div>
  1291. </div>
  1292. <div class="member">
  1293. <h3 class="name" id="RGBA_S3TC_DXT1_Format" translate="no">.<a href="#RGBA_S3TC_DXT1_Format">RGBA_S3TC_DXT1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1294. <div class="description">
  1295. <p>A DXT1-compressed image in an RGB image format with a simple on/off alpha value.</p>
  1296. </div>
  1297. </div>
  1298. <div class="member">
  1299. <h3 class="name" id="RGBA_S3TC_DXT3_Format" translate="no">.<a href="#RGBA_S3TC_DXT3_Format">RGBA_S3TC_DXT3_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1300. <div class="description">
  1301. <p>A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.</p>
  1302. </div>
  1303. </div>
  1304. <div class="member">
  1305. <h3 class="name" id="RGBA_S3TC_DXT5_Format" translate="no">.<a href="#RGBA_S3TC_DXT5_Format">RGBA_S3TC_DXT5_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1306. <div class="description">
  1307. <p>A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3
  1308. compression in how the alpha compression is done.</p>
  1309. </div>
  1310. </div>
  1311. <div class="member">
  1312. <h3 class="name" id="RGBDepthPacking" translate="no">.<a href="#RGBDepthPacking">RGBDepthPacking</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1313. <div class="description">
  1314. <p>The depth value is packed into 24 bit RGB.</p>
  1315. </div>
  1316. </div>
  1317. <div class="member">
  1318. <h3 class="name" id="RGBFormat" translate="no">.<a href="#RGBFormat">RGBFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1319. <div class="description">
  1320. <p>Discards the alpha component and reads the red, green and blue component.</p>
  1321. </div>
  1322. </div>
  1323. <div class="member">
  1324. <h3 class="name" id="RGBIntegerFormat" translate="no">.<a href="#RGBIntegerFormat">RGBIntegerFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1325. <div class="description">
  1326. <p>Discards the alpha component and reads the red, green and blue component. The texels are read as integers instead of floating point.</p>
  1327. </div>
  1328. </div>
  1329. <div class="member">
  1330. <h3 class="name" id="RGB_BPTC_SIGNED_Format" translate="no">.<a href="#RGB_BPTC_SIGNED_Format">RGB_BPTC_SIGNED_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1331. <div class="description">
  1332. <p>BPTC Signed RGB format.</p>
  1333. </div>
  1334. </div>
  1335. <div class="member">
  1336. <h3 class="name" id="RGB_BPTC_UNSIGNED_Format" translate="no">.<a href="#RGB_BPTC_UNSIGNED_Format">RGB_BPTC_UNSIGNED_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1337. <div class="description">
  1338. <p>BPTC Unsigned RGB format.</p>
  1339. </div>
  1340. </div>
  1341. <div class="member">
  1342. <h3 class="name" id="RGB_ETC1_Format" translate="no">.<a href="#RGB_ETC1_Format">RGB_ETC1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1343. <div class="description">
  1344. <p>ETC1 RGB format.</p>
  1345. </div>
  1346. </div>
  1347. <div class="member">
  1348. <h3 class="name" id="RGB_ETC2_Format" translate="no">.<a href="#RGB_ETC2_Format">RGB_ETC2_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1349. <div class="description">
  1350. <p>ETC2 RGB format.</p>
  1351. </div>
  1352. </div>
  1353. <div class="member">
  1354. <h3 class="name" id="RGB_PVRTC_2BPPV1_Format" translate="no">.<a href="#RGB_PVRTC_2BPPV1_Format">RGB_PVRTC_2BPPV1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1355. <div class="description">
  1356. <p>PVRTC RGB compression in 2-bit mode. One block for each 8×4 pixels.</p>
  1357. </div>
  1358. </div>
  1359. <div class="member">
  1360. <h3 class="name" id="RGB_PVRTC_4BPPV1_Format" translate="no">.<a href="#RGB_PVRTC_4BPPV1_Format">RGB_PVRTC_4BPPV1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1361. <div class="description">
  1362. <p>PVRTC RGB compression in 4-bit mode. One block for each 4×4 pixels.</p>
  1363. </div>
  1364. </div>
  1365. <div class="member">
  1366. <h3 class="name" id="RGB_S3TC_DXT1_Format" translate="no">.<a href="#RGB_S3TC_DXT1_Format">RGB_S3TC_DXT1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1367. <div class="description">
  1368. <p>A DXT1-compressed image in an RGB image format.</p>
  1369. </div>
  1370. </div>
  1371. <div class="member">
  1372. <h3 class="name" id="RGDepthPacking" translate="no">.<a href="#RGDepthPacking">RGDepthPacking</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1373. <div class="description">
  1374. <p>The depth value is packed into 16 bit RG.</p>
  1375. </div>
  1376. </div>
  1377. <div class="member">
  1378. <h3 class="name" id="RGFormat" translate="no">.<a href="#RGFormat">RGFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1379. <div class="description">
  1380. <p>Discards the alpha, and blue components and reads the red, and green components.</p>
  1381. </div>
  1382. </div>
  1383. <div class="member">
  1384. <h3 class="name" id="RGIntegerFormat" translate="no">.<a href="#RGIntegerFormat">RGIntegerFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1385. <div class="description">
  1386. <p>Discards the alpha, and blue components and reads the red, and green components. The texels are read as integers instead of floating point.</p>
  1387. </div>
  1388. </div>
  1389. <div class="member">
  1390. <h3 class="name" id="RedFormat" translate="no">.<a href="#RedFormat">RedFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1391. <div class="description">
  1392. <p>Discards the green, blue and alpha components and reads just the red component.</p>
  1393. </div>
  1394. </div>
  1395. <div class="member">
  1396. <h3 class="name" id="RedIntegerFormat" translate="no">.<a href="#RedIntegerFormat">RedIntegerFormat</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1397. <div class="description">
  1398. <p>Discards the green, blue and alpha components and reads just the red component. The texels are read as integers instead of floating point.</p>
  1399. </div>
  1400. </div>
  1401. <div class="member">
  1402. <h3 class="name" id="ReinhardToneMapping" translate="no">.<a href="#ReinhardToneMapping">ReinhardToneMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1403. <div class="description">
  1404. <p>Reinhard tone mapping.</p>
  1405. </div>
  1406. </div>
  1407. <div class="member">
  1408. <h3 class="name" id="RepeatWrapping" translate="no">.<a href="#RepeatWrapping">RepeatWrapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1409. <div class="description">
  1410. <p>The texture will simply repeat to infinity.</p>
  1411. </div>
  1412. </div>
  1413. <div class="member">
  1414. <h3 class="name" id="ReplaceStencilOp" translate="no">.<a href="#ReplaceStencilOp">ReplaceStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1415. <div class="description">
  1416. <p>Sets the stencil buffer value to the specified reference value.</p>
  1417. </div>
  1418. </div>
  1419. <div class="member">
  1420. <h3 class="name" id="ReverseSubtractEquation" translate="no">.<a href="#ReverseSubtractEquation">ReverseSubtractEquation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1421. <div class="description">
  1422. <p>A <code>destination - source</code> blending equation.</p>
  1423. </div>
  1424. </div>
  1425. <div class="member">
  1426. <h3 class="name" id="SIGNED_R11_EAC_Format" translate="no">.<a href="#SIGNED_R11_EAC_Format">SIGNED_R11_EAC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1427. <div class="description">
  1428. <p>EAC R11 SNORM format.</p>
  1429. </div>
  1430. </div>
  1431. <div class="member">
  1432. <h3 class="name" id="SIGNED_RED_GREEN_RGTC2_Format" translate="no">.<a href="#SIGNED_RED_GREEN_RGTC2_Format">SIGNED_RED_GREEN_RGTC2_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1433. <div class="description">
  1434. <p>RGTC2 Signed Red Green format.</p>
  1435. </div>
  1436. </div>
  1437. <div class="member">
  1438. <h3 class="name" id="SIGNED_RED_RGTC1_Format" translate="no">.<a href="#SIGNED_RED_RGTC1_Format">SIGNED_RED_RGTC1_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1439. <div class="description">
  1440. <p>RGTC1 Signed Red format.</p>
  1441. </div>
  1442. </div>
  1443. <div class="member">
  1444. <h3 class="name" id="SIGNED_RG11_EAC_Format" translate="no">.<a href="#SIGNED_RG11_EAC_Format">SIGNED_RG11_EAC_Format</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1445. <div class="description">
  1446. <p>EAC RG11 SNORM format.</p>
  1447. </div>
  1448. </div>
  1449. <div class="member">
  1450. <h3 class="name" id="SRGBColorSpace" translate="no">.<a href="#SRGBColorSpace">SRGBColorSpace</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  1451. <div class="description">
  1452. <p>sRGB color space.</p>
  1453. </div>
  1454. </div>
  1455. <div class="member">
  1456. <h3 class="name" id="SRGBTransfer" translate="no">.<a href="#SRGBTransfer">SRGBTransfer</a><span class="type-signature"> : string</span> <span class="type-signature">(constant) </span></h3>
  1457. <div class="description">
  1458. <p>sRGB transfer function.</p>
  1459. </div>
  1460. </div>
  1461. <div class="member">
  1462. <h3 class="name" id="SRGB_TO_LINEAR" translate="no">.<a href="#SRGB_TO_LINEAR">SRGB_TO_LINEAR</a> <span class="type-signature">(constant) </span></h3>
  1463. <div class="description">
  1464. <p>UltraHDR Image Format - https://developer.android.com/media/platform/hdr-image-format</p>
  1465. <p>Short format brief:</p>
  1466. <p>[JPEG headers]
  1467. [Metadata describing the MPF container and both SDR and gainmap images]</p>
  1468. <ul>
  1469. <li>XMP metadata (legacy format)</li>
  1470. <li>ISO 21496-1 metadata (current standard)
  1471. [Optional metadata] [EXIF] [ICC Profile]
  1472. [SDR image]
  1473. [Gainmap image with metadata]</li>
  1474. </ul>
  1475. <p>Each section is separated by a 0xFFXX byte followed by a descriptor byte (0xFFE0, 0xFFE1, 0xFFE2.)
  1476. Binary image storages are prefixed with a unique 0xFFD8 16-bit descriptor.</p>
  1477. </div>
  1478. </div>
  1479. <div class="member">
  1480. <h3 class="name" id="ShortType" translate="no">.<a href="#ShortType">ShortType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1481. <div class="description">
  1482. <p>A short data type for textures.</p>
  1483. </div>
  1484. </div>
  1485. <div class="member">
  1486. <h3 class="name" id="SrcAlphaFactor" translate="no">.<a href="#SrcAlphaFactor">SrcAlphaFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1487. <div class="description">
  1488. <p>Multiplies all colors by the source alpha value.</p>
  1489. </div>
  1490. </div>
  1491. <div class="member">
  1492. <h3 class="name" id="SrcAlphaSaturateFactor" translate="no">.<a href="#SrcAlphaSaturateFactor">SrcAlphaSaturateFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1493. <div class="description">
  1494. <p>Multiplies the RGB colors by the smaller of either the source alpha
  1495. value or the value of <code>1</code> minus the destination alpha value. The alpha
  1496. value is multiplied by <code>1</code>.</p>
  1497. </div>
  1498. </div>
  1499. <div class="member">
  1500. <h3 class="name" id="SrcColorFactor" translate="no">.<a href="#SrcColorFactor">SrcColorFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1501. <div class="description">
  1502. <p>Multiplies all colors by the source colors.</p>
  1503. </div>
  1504. </div>
  1505. <div class="member">
  1506. <h3 class="name" id="StaticCopyUsage" translate="no">.<a href="#StaticCopyUsage">StaticCopyUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1507. <div class="description">
  1508. <p>The contents are intended to be specified once by reading data from the 3D API, and used many times as
  1509. the source for WebGL drawing and image specification commands.</p>
  1510. </div>
  1511. </div>
  1512. <div class="member">
  1513. <h3 class="name" id="StaticDrawUsage" translate="no">.<a href="#StaticDrawUsage">StaticDrawUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1514. <div class="description">
  1515. <p>The contents are intended to be specified once by the application, and used many
  1516. times as the source for drawing and image specification commands.</p>
  1517. </div>
  1518. </div>
  1519. <div class="member">
  1520. <h3 class="name" id="StaticReadUsage" translate="no">.<a href="#StaticReadUsage">StaticReadUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1521. <div class="description">
  1522. <p>The contents are intended to be specified once by reading data from the 3D API, and queried
  1523. many times by the application.</p>
  1524. </div>
  1525. </div>
  1526. <div class="member">
  1527. <h3 class="name" id="StreamCopyUsage" translate="no">.<a href="#StreamCopyUsage">StreamCopyUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1528. <div class="description">
  1529. <p>The contents are intended to be specified once by reading data from the 3D API, and used at most a few times
  1530. as the source for WebGL drawing and image specification commands.</p>
  1531. </div>
  1532. </div>
  1533. <div class="member">
  1534. <h3 class="name" id="StreamDrawUsage" translate="no">.<a href="#StreamDrawUsage">StreamDrawUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1535. <div class="description">
  1536. <p>The contents are intended to be specified once by the application, and used at most
  1537. a few times as the source for drawing and image specification commands.</p>
  1538. </div>
  1539. </div>
  1540. <div class="member">
  1541. <h3 class="name" id="StreamReadUsage" translate="no">.<a href="#StreamReadUsage">StreamReadUsage</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1542. <div class="description">
  1543. <p>The contents are intended to be specified once by reading data from the 3D API, and queried at most
  1544. a few times by the application</p>
  1545. </div>
  1546. </div>
  1547. <div class="member">
  1548. <h3 class="name" id="SubtractEquation" translate="no">.<a href="#SubtractEquation">SubtractEquation</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1549. <div class="description">
  1550. <p>A <code>source - destination</code> blending equation.</p>
  1551. </div>
  1552. </div>
  1553. <div class="member">
  1554. <h3 class="name" id="SubtractiveBlending" translate="no">.<a href="#SubtractiveBlending">SubtractiveBlending</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1555. <div class="description">
  1556. <p>Represents subtractive blending.</p>
  1557. </div>
  1558. </div>
  1559. <div class="member">
  1560. <h3 class="name" id="TOUCH" translate="no">.<a href="#TOUCH">TOUCH</a><span class="type-signature"> : <a href="global.html#ConstantsTouch">ConstantsTouch</a></span> <span class="type-signature">(constant) </span></h3>
  1561. <div class="description">
  1562. <p>Represents touch interaction types in context of controls.</p>
  1563. </div>
  1564. </div>
  1565. <div class="member">
  1566. <h3 class="name" id="TangentSpaceNormalMap" translate="no">.<a href="#TangentSpaceNormalMap">TangentSpaceNormalMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1567. <div class="description">
  1568. <p>Normal information is relative to the underlying surface.</p>
  1569. </div>
  1570. </div>
  1571. <div class="member">
  1572. <h3 class="name" id="TimestampQuery" translate="no">.<a href="#TimestampQuery">TimestampQuery</a><span class="type-signature"> : <a href="global.html#ConstantsTimestampQuery">ConstantsTimestampQuery</a></span> <span class="type-signature">(constant) </span></h3>
  1573. <div class="description">
  1574. <p>Represents the different timestamp query types.</p>
  1575. </div>
  1576. </div>
  1577. <div class="member">
  1578. <h3 class="name" id="TriangleFanDrawMode" translate="no">.<a href="#TriangleFanDrawMode">TriangleFanDrawMode</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1579. <div class="description">
  1580. <p>For each vertex draw a triangle from the first vertex and the last two vertices.</p>
  1581. </div>
  1582. </div>
  1583. <div class="member">
  1584. <h3 class="name" id="TriangleStripDrawMode" translate="no">.<a href="#TriangleStripDrawMode">TriangleStripDrawMode</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1585. <div class="description">
  1586. <p>For each vertex draw a triangle from the last three vertices.</p>
  1587. </div>
  1588. </div>
  1589. <div class="member">
  1590. <h3 class="name" id="TrianglesDrawMode" translate="no">.<a href="#TrianglesDrawMode">TrianglesDrawMode</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1591. <div class="description">
  1592. <p>For every three vertices draw a single triangle.</p>
  1593. </div>
  1594. </div>
  1595. <div class="member">
  1596. <h3 class="name" id="UVMapping" translate="no">.<a href="#UVMapping">UVMapping</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1597. <div class="description">
  1598. <p>Maps textures using the geometry's UV coordinates.</p>
  1599. </div>
  1600. </div>
  1601. <div class="member">
  1602. <h3 class="name" id="UnsignedByteType" translate="no">.<a href="#UnsignedByteType">UnsignedByteType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1603. <div class="description">
  1604. <p>An unsigned byte data type for textures.</p>
  1605. </div>
  1606. </div>
  1607. <div class="member">
  1608. <h3 class="name" id="UnsignedInt101111Type" translate="no">.<a href="#UnsignedInt101111Type">UnsignedInt101111Type</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1609. <div class="description">
  1610. <p>An unsigned int 10_11_11 (packed) data type for textures.</p>
  1611. </div>
  1612. </div>
  1613. <div class="member">
  1614. <h3 class="name" id="UnsignedInt248Type" translate="no">.<a href="#UnsignedInt248Type">UnsignedInt248Type</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1615. <div class="description">
  1616. <p>An unsigned int 24_8 data type for textures.</p>
  1617. </div>
  1618. </div>
  1619. <div class="member">
  1620. <h3 class="name" id="UnsignedInt5999Type" translate="no">.<a href="#UnsignedInt5999Type">UnsignedInt5999Type</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1621. <div class="description">
  1622. <p>An unsigned int 5_9_9_9 (packed) data type for textures.</p>
  1623. </div>
  1624. </div>
  1625. <div class="member">
  1626. <h3 class="name" id="UnsignedIntType" translate="no">.<a href="#UnsignedIntType">UnsignedIntType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1627. <div class="description">
  1628. <p>An unsigned int data type for textures.</p>
  1629. </div>
  1630. </div>
  1631. <div class="member">
  1632. <h3 class="name" id="UnsignedShort4444Type" translate="no">.<a href="#UnsignedShort4444Type">UnsignedShort4444Type</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1633. <div class="description">
  1634. <p>An unsigned short 4_4_4_4 (packed) data type for textures.</p>
  1635. </div>
  1636. </div>
  1637. <div class="member">
  1638. <h3 class="name" id="UnsignedShort5551Type" translate="no">.<a href="#UnsignedShort5551Type">UnsignedShort5551Type</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1639. <div class="description">
  1640. <p>An unsigned short 5_5_5_1 (packed) data type for textures.</p>
  1641. </div>
  1642. </div>
  1643. <div class="member">
  1644. <h3 class="name" id="UnsignedShortType" translate="no">.<a href="#UnsignedShortType">UnsignedShortType</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1645. <div class="description">
  1646. <p>An unsigned short data type for textures.</p>
  1647. </div>
  1648. </div>
  1649. <div class="member">
  1650. <h3 class="name" id="VK_FORMAT_MAP" translate="no">.<a href="#VK_FORMAT_MAP">VK_FORMAT_MAP</a> <span class="type-signature">(constant) </span></h3>
  1651. <div class="description">
  1652. <p>References:</p>
  1653. <ul>
  1654. <li>https://github.khronos.org/KTX-Specification/ktxspec.v2.html</li>
  1655. <li>https://registry.khronos.org/DataFormat/specs/1.3/dataformat.1.3.html</li>
  1656. <li>https://github.com/donmccurdy/KTX-Parse</li>
  1657. </ul>
  1658. </div>
  1659. </div>
  1660. <div class="member">
  1661. <h3 class="name" id="VSMShadowMap" translate="no">.<a href="#VSMShadowMap">VSMShadowMap</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1662. <div class="description">
  1663. <p>Filters shadow maps using the Variance Shadow Map (VSM) algorithm.
  1664. When using VSMShadowMap all shadow receivers will also cast shadows.</p>
  1665. </div>
  1666. </div>
  1667. <div class="member">
  1668. <h3 class="name" id="WebGLCoordinateSystem" translate="no">.<a href="#WebGLCoordinateSystem">WebGLCoordinateSystem</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1669. <div class="description">
  1670. <p>WebGL coordinate system.</p>
  1671. </div>
  1672. </div>
  1673. <div class="member">
  1674. <h3 class="name" id="WebGPUCoordinateSystem" translate="no">.<a href="#WebGPUCoordinateSystem">WebGPUCoordinateSystem</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1675. <div class="description">
  1676. <p>WebGPU coordinate system.</p>
  1677. </div>
  1678. </div>
  1679. <div class="member">
  1680. <h3 class="name" id="WrapAroundEnding" translate="no">.<a href="#WrapAroundEnding">WrapAroundEnding</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1681. <div class="description">
  1682. <p>Wrap around ending for animations.</p>
  1683. </div>
  1684. </div>
  1685. <div class="member">
  1686. <h3 class="name" id="ZeroCurvatureEnding" translate="no">.<a href="#ZeroCurvatureEnding">ZeroCurvatureEnding</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1687. <div class="description">
  1688. <p>Zero curvature ending for animations.</p>
  1689. </div>
  1690. </div>
  1691. <div class="member">
  1692. <h3 class="name" id="ZeroFactor" translate="no">.<a href="#ZeroFactor">ZeroFactor</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1693. <div class="description">
  1694. <p>Multiplies all colors by <code>0</code>.</p>
  1695. </div>
  1696. </div>
  1697. <div class="member">
  1698. <h3 class="name" id="ZeroSlopeEnding" translate="no">.<a href="#ZeroSlopeEnding">ZeroSlopeEnding</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1699. <div class="description">
  1700. <p>Zero slope ending for animations.</p>
  1701. </div>
  1702. </div>
  1703. <div class="member">
  1704. <h3 class="name" id="ZeroStencilOp" translate="no">.<a href="#ZeroStencilOp">ZeroStencilOp</a><span class="type-signature"> : number</span> <span class="type-signature">(constant) </span></h3>
  1705. <div class="description">
  1706. <p>Sets the stencil buffer value to <code>0</code>.</p>
  1707. </div>
  1708. </div>
  1709. <div class="member">
  1710. <h3 class="name" id="depthAwareBlend" translate="no">.<a href="#depthAwareBlend">depthAwareBlend</a> <span class="type-signature">(constant) </span></h3>
  1711. <div class="description">
  1712. <p>Performs a depth-aware blend between a base scene and a secondary effect (like godrays).
  1713. This function uses a Poisson disk sampling pattern to detect depth discontinuities
  1714. in the neighborhood of the current pixel. If an edge is detected, it shifts the
  1715. sampling coordinate for the blend node away from the edge to prevent light leaking/haloing.</p>
  1716. </div>
  1717. </div>
  1718. <div class="member">
  1719. <h3 class="name" id="disposeShadowMaterial" translate="no">.<a href="#disposeShadowMaterial">disposeShadowMaterial</a> <span class="type-signature">(constant) </span></h3>
  1720. <div class="description">
  1721. <p>Disposes the shadow material for the given light source.</p>
  1722. </div>
  1723. </div>
  1724. <div class="member">
  1725. <h3 class="name" id="viewportResolution" translate="no">.<a href="#viewportResolution">viewportResolution</a> <span class="type-signature">(constant) </span></h3>
  1726. <dl class="details">
  1727. <dt class="important tag-deprecated"><strong>Deprecated:</strong> since r169. Use <a href="TSL.html#screenSize">screenSize</a> instead.</dt>
  1728. </dl>
  1729. </div>
  1730. <h2 class="subsection-title">Methods</h2>
  1731. <h3 class="name name-method" id="BasicShadowFilter" translate="no">.<a href="#BasicShadowFilter">BasicShadowFilter</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  1732. <div class="method">
  1733. <div class="description">
  1734. <p>A shadow filtering function performing basic filtering. This is in fact an unfiltered version of the shadow map
  1735. with a binary <code>[0,1]</code> result.</p>
  1736. </div>
  1737. <table class="params">
  1738. <tbody>
  1739. <tr>
  1740. <td class="name">
  1741. <strong translate="no">inputs</strong>
  1742. </td>
  1743. <td class="description last">
  1744. <p>The input parameter object.</p>
  1745. <table class="params">
  1746. <tbody>
  1747. <tr>
  1748. <td class="name">
  1749. <strong translate="no">depthTexture</strong>
  1750. </td>
  1751. <td class="description last">
  1752. <p>A reference to the shadow map's texture data.</p>
  1753. </td>
  1754. </tr>
  1755. <tr>
  1756. <td class="name">
  1757. <strong translate="no">shadowCoord</strong>
  1758. </td>
  1759. <td class="description last">
  1760. <p>The shadow coordinates.</p>
  1761. </td>
  1762. </tr>
  1763. </tbody>
  1764. </table>
  1765. </td>
  1766. </tr>
  1767. </tbody>
  1768. </table>
  1769. <dl class="details">
  1770. <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
  1771. </dl>
  1772. </div>
  1773. <h3 class="name name-method" id="PCFShadowFilter" translate="no">.<a href="#PCFShadowFilter">PCFShadowFilter</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  1774. <div class="method">
  1775. <div class="description">
  1776. <p>A shadow filtering function performing PCF filtering with Vogel disk sampling and IGN.</p>
  1777. <p>Uses 5 samples distributed via Vogel disk pattern, rotated per-pixel using Interleaved
  1778. Gradient Noise (IGN) to break up banding artifacts. Combined with hardware PCF (4-tap
  1779. filtering per sample), this effectively provides 20 filtered taps with better distribution.</p>
  1780. </div>
  1781. <table class="params">
  1782. <tbody>
  1783. <tr>
  1784. <td class="name">
  1785. <strong translate="no">inputs</strong>
  1786. </td>
  1787. <td class="description last">
  1788. <p>The input parameter object.</p>
  1789. <table class="params">
  1790. <tbody>
  1791. <tr>
  1792. <td class="name">
  1793. <strong translate="no">depthTexture</strong>
  1794. </td>
  1795. <td class="description last">
  1796. <p>A reference to the shadow map's texture data.</p>
  1797. </td>
  1798. </tr>
  1799. <tr>
  1800. <td class="name">
  1801. <strong translate="no">shadowCoord</strong>
  1802. </td>
  1803. <td class="description last">
  1804. <p>The shadow coordinates.</p>
  1805. </td>
  1806. </tr>
  1807. <tr>
  1808. <td class="name">
  1809. <strong translate="no">shadow</strong>
  1810. </td>
  1811. <td class="description last">
  1812. <p>The light shadow.</p>
  1813. </td>
  1814. </tr>
  1815. </tbody>
  1816. </table>
  1817. </td>
  1818. </tr>
  1819. </tbody>
  1820. </table>
  1821. <dl class="details">
  1822. <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
  1823. </dl>
  1824. </div>
  1825. <h3 class="name name-method" id="PCFSoftShadowFilter" translate="no">.<a href="#PCFSoftShadowFilter">PCFSoftShadowFilter</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  1826. <div class="method">
  1827. <div class="description">
  1828. <p>A shadow filtering function performing PCF soft filtering.</p>
  1829. </div>
  1830. <table class="params">
  1831. <tbody>
  1832. <tr>
  1833. <td class="name">
  1834. <strong translate="no">inputs</strong>
  1835. </td>
  1836. <td class="description last">
  1837. <p>The input parameter object.</p>
  1838. <table class="params">
  1839. <tbody>
  1840. <tr>
  1841. <td class="name">
  1842. <strong translate="no">depthTexture</strong>
  1843. </td>
  1844. <td class="description last">
  1845. <p>A reference to the shadow map's texture data.</p>
  1846. </td>
  1847. </tr>
  1848. <tr>
  1849. <td class="name">
  1850. <strong translate="no">shadowCoord</strong>
  1851. </td>
  1852. <td class="description last">
  1853. <p>The shadow coordinates.</p>
  1854. </td>
  1855. </tr>
  1856. <tr>
  1857. <td class="name">
  1858. <strong translate="no">shadow</strong>
  1859. </td>
  1860. <td class="description last">
  1861. <p>The light shadow.</p>
  1862. </td>
  1863. </tr>
  1864. </tbody>
  1865. </table>
  1866. </td>
  1867. </tr>
  1868. </tbody>
  1869. </table>
  1870. <dl class="details">
  1871. <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
  1872. </dl>
  1873. </div>
  1874. <h3 class="name name-method" id="PointShadowFilter" translate="no">.<a href="#PointShadowFilter">PointShadowFilter</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  1875. <div class="method">
  1876. <div class="description">
  1877. <p>A shadow filtering function for point lights using Vogel disk sampling and IGN.</p>
  1878. <p>Uses 5 samples distributed via Vogel disk pattern in tangent space around the
  1879. sample direction, rotated per-pixel using Interleaved Gradient Noise (IGN).</p>
  1880. </div>
  1881. <table class="params">
  1882. <tbody>
  1883. <tr>
  1884. <td class="name">
  1885. <strong translate="no">inputs</strong>
  1886. </td>
  1887. <td class="description last">
  1888. <p>The input parameter object.</p>
  1889. <table class="params">
  1890. <tbody>
  1891. <tr>
  1892. <td class="name">
  1893. <strong translate="no">depthTexture</strong>
  1894. </td>
  1895. <td class="description last">
  1896. <p>A reference to the shadow cube map.</p>
  1897. </td>
  1898. </tr>
  1899. <tr>
  1900. <td class="name">
  1901. <strong translate="no">bd3D</strong>
  1902. </td>
  1903. <td class="description last">
  1904. <p>The normalized direction from light to fragment.</p>
  1905. </td>
  1906. </tr>
  1907. <tr>
  1908. <td class="name">
  1909. <strong translate="no">dp</strong>
  1910. </td>
  1911. <td class="description last">
  1912. <p>The depth value to compare against.</p>
  1913. </td>
  1914. </tr>
  1915. <tr>
  1916. <td class="name">
  1917. <strong translate="no">shadow</strong>
  1918. </td>
  1919. <td class="description last">
  1920. <p>The light shadow.</p>
  1921. </td>
  1922. </tr>
  1923. </tbody>
  1924. </table>
  1925. </td>
  1926. </tr>
  1927. </tbody>
  1928. </table>
  1929. <dl class="details">
  1930. <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
  1931. </dl>
  1932. </div>
  1933. <h3 class="name name-method" id="Stack" translate="no">.<a href="#Stack">Stack</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span> )</span><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  1934. <div class="method">
  1935. <div class="description">
  1936. <p>Add the given node to the current stack.</p>
  1937. </div>
  1938. <table class="params">
  1939. <tbody>
  1940. <tr>
  1941. <td class="name">
  1942. <strong translate="no">node</strong>
  1943. </td>
  1944. <td class="description last">
  1945. <p>The node to add.</p>
  1946. </td>
  1947. </tr>
  1948. </tbody>
  1949. </table>
  1950. <dl class="details">
  1951. <dt class="tag-returns"><strong>Returns:</strong> The node that was added to the stack.</dt>
  1952. </dl>
  1953. </div>
  1954. <h3 class="name name-method" id="VSMShadowFilter" translate="no">.<a href="#VSMShadowFilter">VSMShadowFilter</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  1955. <div class="method">
  1956. <div class="description">
  1957. <p>A shadow filtering function performing VSM filtering.</p>
  1958. </div>
  1959. <table class="params">
  1960. <tbody>
  1961. <tr>
  1962. <td class="name">
  1963. <strong translate="no">inputs</strong>
  1964. </td>
  1965. <td class="description last">
  1966. <p>The input parameter object.</p>
  1967. <table class="params">
  1968. <tbody>
  1969. <tr>
  1970. <td class="name">
  1971. <strong translate="no">depthTexture</strong>
  1972. </td>
  1973. <td class="description last">
  1974. <p>A reference to the shadow map's texture data.</p>
  1975. </td>
  1976. </tr>
  1977. <tr>
  1978. <td class="name">
  1979. <strong translate="no">shadowCoord</strong>
  1980. </td>
  1981. <td class="description last">
  1982. <p>The shadow coordinates.</p>
  1983. </td>
  1984. </tr>
  1985. </tbody>
  1986. </table>
  1987. </td>
  1988. </tr>
  1989. </tbody>
  1990. </table>
  1991. <dl class="details">
  1992. <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
  1993. </dl>
  1994. </div>
  1995. <h3 class="name name-method" id="buildData3DTexture" translate="no">.<a href="#buildData3DTexture">buildData3DTexture</a><span class="signature">( chunk : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Data3DTexture.html">Data3DTexture</a></span> </h3>
  1996. <div class="method">
  1997. <div class="description">
  1998. <p>Builds a 3D texture from a VOX chunk.</p>
  1999. </div>
  2000. <table class="params">
  2001. <tbody>
  2002. <tr>
  2003. <td class="name">
  2004. <strong translate="no">chunk</strong>
  2005. </td>
  2006. <td class="description last">
  2007. <p>A VOX chunk loaded via <a href="VOXLoader.html">VOXLoader</a>.</p>
  2008. </td>
  2009. </tr>
  2010. </tbody>
  2011. </table>
  2012. <dl class="details">
  2013. <dt class="tag-returns"><strong>Returns:</strong> The generated 3D texture.</dt>
  2014. </dl>
  2015. </div>
  2016. <h3 class="name name-method" id="buildMesh" translate="no">.<a href="#buildMesh">buildMesh</a><span class="signature">( chunk : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Mesh.html">Mesh</a></span> </h3>
  2017. <div class="method">
  2018. <div class="description">
  2019. <p>Builds a mesh from a VOX chunk.</p>
  2020. </div>
  2021. <table class="params">
  2022. <tbody>
  2023. <tr>
  2024. <td class="name">
  2025. <strong translate="no">chunk</strong>
  2026. </td>
  2027. <td class="description last">
  2028. <p>A VOX chunk loaded via <a href="VOXLoader.html">VOXLoader</a>.</p>
  2029. </td>
  2030. </tr>
  2031. </tbody>
  2032. </table>
  2033. <dl class="details">
  2034. <dt class="tag-returns"><strong>Returns:</strong> The generated mesh.</dt>
  2035. </dl>
  2036. </div>
  2037. <h3 class="name name-method" id="ceilPowerOfTwo" translate="no">.<a href="#ceilPowerOfTwo">ceilPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2038. <div class="method">
  2039. <div class="description">
  2040. <p>Returns the smallest power of two that is greater than or equal to the given number.</p>
  2041. </div>
  2042. <table class="params">
  2043. <tbody>
  2044. <tr>
  2045. <td class="name">
  2046. <strong translate="no">value</strong>
  2047. </td>
  2048. <td class="description last">
  2049. <p>The value to find a POT for. Must be greater than <code>0</code>.</p>
  2050. </td>
  2051. </tr>
  2052. </tbody>
  2053. </table>
  2054. <dl class="details">
  2055. <dt class="tag-returns"><strong>Returns:</strong> The smallest power of two that is greater than or equal to the given number.</dt>
  2056. </dl>
  2057. </div>
  2058. <h3 class="name name-method" id="clamp" translate="no">.<a href="#clamp">clamp</a><span class="signature">( value : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2059. <div class="method">
  2060. <div class="description">
  2061. <p>Clamps the given value between min and max.</p>
  2062. </div>
  2063. <table class="params">
  2064. <tbody>
  2065. <tr>
  2066. <td class="name">
  2067. <strong translate="no">value</strong>
  2068. </td>
  2069. <td class="description last">
  2070. <p>The value to clamp.</p>
  2071. </td>
  2072. </tr>
  2073. <tr>
  2074. <td class="name">
  2075. <strong translate="no">min</strong>
  2076. </td>
  2077. <td class="description last">
  2078. <p>The min value.</p>
  2079. </td>
  2080. </tr>
  2081. <tr>
  2082. <td class="name">
  2083. <strong translate="no">max</strong>
  2084. </td>
  2085. <td class="description last">
  2086. <p>The max value.</p>
  2087. </td>
  2088. </tr>
  2089. </tbody>
  2090. </table>
  2091. <dl class="details">
  2092. <dt class="tag-returns"><strong>Returns:</strong> The clamped value.</dt>
  2093. </dl>
  2094. </div>
  2095. <h3 class="name name-method" id="contain" translate="no">.<a href="#contain">contain</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span>, aspect : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Texture.html">Texture</a></span> </h3>
  2096. <div class="method">
  2097. <div class="description">
  2098. <p>Scales the texture as large as possible within its surface without cropping
  2099. or stretching the texture. The method preserves the original aspect ratio of
  2100. the texture. Akin to CSS <code>object-fit: contain</code></p>
  2101. </div>
  2102. <table class="params">
  2103. <tbody>
  2104. <tr>
  2105. <td class="name">
  2106. <strong translate="no">texture</strong>
  2107. </td>
  2108. <td class="description last">
  2109. <p>The texture.</p>
  2110. </td>
  2111. </tr>
  2112. <tr>
  2113. <td class="name">
  2114. <strong translate="no">aspect</strong>
  2115. </td>
  2116. <td class="description last">
  2117. <p>The texture's aspect ratio.</p>
  2118. </td>
  2119. </tr>
  2120. </tbody>
  2121. </table>
  2122. <dl class="details">
  2123. <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
  2124. </dl>
  2125. </div>
  2126. <h3 class="name name-method" id="convertArray" translate="no">.<a href="#convertArray">convertArray</a><span class="signature">( array : <span class="param-type">TypedArray | Array</span>, type : <span class="param-type">TypedArray.constructor</span> )</span><span class="type-signature"> : TypedArray</span> </h3>
  2127. <div class="method">
  2128. <div class="description">
  2129. <p>Converts an array to a specific type.</p>
  2130. </div>
  2131. <table class="params">
  2132. <tbody>
  2133. <tr>
  2134. <td class="name">
  2135. <strong translate="no">array</strong>
  2136. </td>
  2137. <td class="description last">
  2138. <p>The array to convert.</p>
  2139. </td>
  2140. </tr>
  2141. <tr>
  2142. <td class="name">
  2143. <strong translate="no">type</strong>
  2144. </td>
  2145. <td class="description last">
  2146. <p>The constructor of a typed array that defines the new type.</p>
  2147. </td>
  2148. </tr>
  2149. </tbody>
  2150. </table>
  2151. <dl class="details">
  2152. <dt class="tag-returns"><strong>Returns:</strong> The converted array.</dt>
  2153. </dl>
  2154. </div>
  2155. <h3 class="name name-method" id="cover" translate="no">.<a href="#cover">cover</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span>, aspect : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Texture.html">Texture</a></span> </h3>
  2156. <div class="method">
  2157. <div class="description">
  2158. <p>Scales the texture to the smallest possible size to fill the surface, leaving
  2159. no empty space. The method preserves the original aspect ratio of the texture.
  2160. Akin to CSS <code>object-fit: cover</code>.</p>
  2161. </div>
  2162. <table class="params">
  2163. <tbody>
  2164. <tr>
  2165. <td class="name">
  2166. <strong translate="no">texture</strong>
  2167. </td>
  2168. <td class="description last">
  2169. <p>The texture.</p>
  2170. </td>
  2171. </tr>
  2172. <tr>
  2173. <td class="name">
  2174. <strong translate="no">aspect</strong>
  2175. </td>
  2176. <td class="description last">
  2177. <p>The texture's aspect ratio.</p>
  2178. </td>
  2179. </tr>
  2180. </tbody>
  2181. </table>
  2182. <dl class="details">
  2183. <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
  2184. </dl>
  2185. </div>
  2186. <h3 class="name name-method" id="createCanvasElement" translate="no">.<a href="#createCanvasElement">createCanvasElement</a><span class="signature">()</span><span class="type-signature"> : HTMLCanvasElement</span> </h3>
  2187. <div class="method">
  2188. <div class="description">
  2189. <p>Creates a canvas element configured for block display.</p>
  2190. <p>This is a convenience function that creates a canvas element with
  2191. display style set to 'block', which is commonly used in three.js
  2192. rendering contexts to avoid inline element spacing issues.</p>
  2193. </div>
  2194. <dl class="details">
  2195. <dt class="tag-returns"><strong>Returns:</strong> A canvas element with display set to 'block'.</dt>
  2196. </dl>
  2197. </div>
  2198. <h3 class="name name-method" id="createEvent" translate="no">.<a href="#createEvent">createEvent</a><span class="signature">( type : <span class="param-type">string</span>, callback : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="EventNode.html">EventNode</a></span> </h3>
  2199. <div class="method">
  2200. <div class="description">
  2201. <p>Helper to create an EventNode and add it to the stack.</p>
  2202. </div>
  2203. <table class="params">
  2204. <tbody>
  2205. <tr>
  2206. <td class="name">
  2207. <strong translate="no">type</strong>
  2208. </td>
  2209. <td class="description last">
  2210. <p>The event type.</p>
  2211. </td>
  2212. </tr>
  2213. <tr>
  2214. <td class="name">
  2215. <strong translate="no">callback</strong>
  2216. </td>
  2217. <td class="description last">
  2218. <p>The callback function.</p>
  2219. </td>
  2220. </tr>
  2221. </tbody>
  2222. </table>
  2223. </div>
  2224. <h3 class="name name-method" id="damp" translate="no">.<a href="#damp">damp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, lambda : <span class="param-type">number</span>, dt : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2225. <div class="method">
  2226. <div class="description">
  2227. <p>Smoothly interpolate a number from <code>x</code> to <code>y</code> in a spring-like manner using a delta
  2228. time to maintain frame rate independent movement. For details, see
  2229. <a href="http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/" target="_blank" rel="noopener">Frame rate independent damping using lerp</a>.</p>
  2230. </div>
  2231. <table class="params">
  2232. <tbody>
  2233. <tr>
  2234. <td class="name">
  2235. <strong translate="no">x</strong>
  2236. </td>
  2237. <td class="description last">
  2238. <p>The current point.</p>
  2239. </td>
  2240. </tr>
  2241. <tr>
  2242. <td class="name">
  2243. <strong translate="no">y</strong>
  2244. </td>
  2245. <td class="description last">
  2246. <p>The target point.</p>
  2247. </td>
  2248. </tr>
  2249. <tr>
  2250. <td class="name">
  2251. <strong translate="no">lambda</strong>
  2252. </td>
  2253. <td class="description last">
  2254. <p>A higher lambda value will make the movement more sudden,
  2255. and a lower value will make the movement more gradual.</p>
  2256. </td>
  2257. </tr>
  2258. <tr>
  2259. <td class="name">
  2260. <strong translate="no">dt</strong>
  2261. </td>
  2262. <td class="description last">
  2263. <p>Delta time in seconds.</p>
  2264. </td>
  2265. </tr>
  2266. </tbody>
  2267. </table>
  2268. <dl class="details">
  2269. <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
  2270. </dl>
  2271. </div>
  2272. <h3 class="name name-method" id="degToRad" translate="no">.<a href="#degToRad">degToRad</a><span class="signature">( degrees : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2273. <div class="method">
  2274. <div class="description">
  2275. <p>Converts degrees to radians.</p>
  2276. </div>
  2277. <table class="params">
  2278. <tbody>
  2279. <tr>
  2280. <td class="name">
  2281. <strong translate="no">degrees</strong>
  2282. </td>
  2283. <td class="description last">
  2284. <p>A value in degrees.</p>
  2285. </td>
  2286. </tr>
  2287. </tbody>
  2288. </table>
  2289. <dl class="details">
  2290. <dt class="tag-returns"><strong>Returns:</strong> The converted value in radians.</dt>
  2291. </dl>
  2292. </div>
  2293. <h3 class="name name-method" id="denormalize" translate="no">.<a href="#denormalize">denormalize</a><span class="signature">( value : <span class="param-type">number</span>, array : <span class="param-type">TypedArray</span> )</span><span class="type-signature"> : number</span> </h3>
  2294. <div class="method">
  2295. <div class="description">
  2296. <p>Denormalizes the given value according to the given typed array.</p>
  2297. </div>
  2298. <table class="params">
  2299. <tbody>
  2300. <tr>
  2301. <td class="name">
  2302. <strong translate="no">value</strong>
  2303. </td>
  2304. <td class="description last">
  2305. <p>The value to denormalize.</p>
  2306. </td>
  2307. </tr>
  2308. <tr>
  2309. <td class="name">
  2310. <strong translate="no">array</strong>
  2311. </td>
  2312. <td class="description last">
  2313. <p>The typed array that defines the data type of the value.</p>
  2314. </td>
  2315. </tr>
  2316. </tbody>
  2317. </table>
  2318. <dl class="details">
  2319. <dt class="tag-returns"><strong>Returns:</strong> The denormalize (float) value in the range <code>[0,1]</code>.</dt>
  2320. </dl>
  2321. </div>
  2322. <h3 class="name name-method" id="enhanceLogMessage" translate="no">.<a href="#enhanceLogMessage">enhanceLogMessage</a><span class="signature">( params : <span class="param-type">Array.&lt;<a href="global.html#any">any</a>></span> )</span><span class="type-signature"> : Array.&lt;<a href="global.html#any">any</a>></span> </h3>
  2323. <div class="method">
  2324. <div class="description">
  2325. <p>Enhances log/warn/error messages related to TSL.</p>
  2326. </div>
  2327. <table class="params">
  2328. <tbody>
  2329. <tr>
  2330. <td class="name">
  2331. <strong translate="no">params</strong>
  2332. </td>
  2333. <td class="description last">
  2334. <p>The original message parameters.</p>
  2335. </td>
  2336. </tr>
  2337. </tbody>
  2338. </table>
  2339. <dl class="details">
  2340. <dt class="tag-returns"><strong>Returns:</strong> The filtered and enhanced message parameters.</dt>
  2341. </dl>
  2342. </div>
  2343. <h3 class="name name-method" id="error" translate="no">.<a href="#error">error</a><span class="signature">( &hellip;params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
  2344. <div class="method">
  2345. <div class="description">
  2346. <p>Logs an error message with the 'THREE.' prefix.</p>
  2347. <p>If a custom console function is set via setConsoleFunction(), it will be used
  2348. instead of the native console.error. The first parameter is treated as the
  2349. method name and is automatically prefixed with 'THREE.'.</p>
  2350. </div>
  2351. <table class="params">
  2352. <tbody>
  2353. <tr>
  2354. <td class="name">
  2355. <strong translate="no">params</strong>
  2356. </td>
  2357. <td class="description last">
  2358. <p>The message components. The first param is used as
  2359. the method name and prefixed with 'THREE.'.</p>
  2360. </td>
  2361. </tr>
  2362. </tbody>
  2363. </table>
  2364. </div>
  2365. <h3 class="name name-method" id="euclideanModulo" translate="no">.<a href="#euclideanModulo">euclideanModulo</a><span class="signature">( n : <span class="param-type">number</span>, m : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2366. <div class="method">
  2367. <div class="description">
  2368. <p>Computes the Euclidean modulo of the given parameters that
  2369. is <code>( ( n % m ) + m ) % m</code>.</p>
  2370. </div>
  2371. <table class="params">
  2372. <tbody>
  2373. <tr>
  2374. <td class="name">
  2375. <strong translate="no">n</strong>
  2376. </td>
  2377. <td class="description last">
  2378. <p>The first parameter.</p>
  2379. </td>
  2380. </tr>
  2381. <tr>
  2382. <td class="name">
  2383. <strong translate="no">m</strong>
  2384. </td>
  2385. <td class="description last">
  2386. <p>The second parameter.</p>
  2387. </td>
  2388. </tr>
  2389. </tbody>
  2390. </table>
  2391. <dl class="details">
  2392. <dt class="tag-returns"><strong>Returns:</strong> The Euclidean modulo.</dt>
  2393. </dl>
  2394. </div>
  2395. <h3 class="name name-method" id="fill" translate="no">.<a href="#fill">fill</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span> )</span><span class="type-signature"> : <a href="Texture.html">Texture</a></span> </h3>
  2396. <div class="method">
  2397. <div class="description">
  2398. <p>Configures the texture to the default transformation. Akin to CSS <code>object-fit: fill</code>.</p>
  2399. </div>
  2400. <table class="params">
  2401. <tbody>
  2402. <tr>
  2403. <td class="name">
  2404. <strong translate="no">texture</strong>
  2405. </td>
  2406. <td class="description last">
  2407. <p>The texture.</p>
  2408. </td>
  2409. </tr>
  2410. </tbody>
  2411. </table>
  2412. <dl class="details">
  2413. <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
  2414. </dl>
  2415. </div>
  2416. <h3 class="name name-method" id="flattenJSON" translate="no">.<a href="#flattenJSON">flattenJSON</a><span class="signature">( jsonKeys : <span class="param-type">Array.&lt;number></span>, times : <span class="param-type">Array.&lt;number></span>, values : <span class="param-type">Array.&lt;number></span>, valuePropertyName : <span class="param-type">string</span> )</span> </h3>
  2417. <div class="method">
  2418. <div class="description">
  2419. <p>Used for parsing AOS keyframe formats.</p>
  2420. </div>
  2421. <table class="params">
  2422. <tbody>
  2423. <tr>
  2424. <td class="name">
  2425. <strong translate="no">jsonKeys</strong>
  2426. </td>
  2427. <td class="description last">
  2428. <p>A list of JSON keyframes.</p>
  2429. </td>
  2430. </tr>
  2431. <tr>
  2432. <td class="name">
  2433. <strong translate="no">times</strong>
  2434. </td>
  2435. <td class="description last">
  2436. <p>This array will be filled with keyframe times by this function.</p>
  2437. </td>
  2438. </tr>
  2439. <tr>
  2440. <td class="name">
  2441. <strong translate="no">values</strong>
  2442. </td>
  2443. <td class="description last">
  2444. <p>This array will be filled with keyframe values by this function.</p>
  2445. </td>
  2446. </tr>
  2447. <tr>
  2448. <td class="name">
  2449. <strong translate="no">valuePropertyName</strong>
  2450. </td>
  2451. <td class="description last">
  2452. <p>The name of the property to use.</p>
  2453. </td>
  2454. </tr>
  2455. </tbody>
  2456. </table>
  2457. </div>
  2458. <h3 class="name name-method" id="floorPowerOfTwo" translate="no">.<a href="#floorPowerOfTwo">floorPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2459. <div class="method">
  2460. <div class="description">
  2461. <p>Returns the largest power of two that is less than or equal to the given number.</p>
  2462. </div>
  2463. <table class="params">
  2464. <tbody>
  2465. <tr>
  2466. <td class="name">
  2467. <strong translate="no">value</strong>
  2468. </td>
  2469. <td class="description last">
  2470. <p>The value to find a POT for. Must be greater than <code>0</code>.</p>
  2471. </td>
  2472. </tr>
  2473. </tbody>
  2474. </table>
  2475. <dl class="details">
  2476. <dt class="tag-returns"><strong>Returns:</strong> The largest power of two that is less than or equal to the given number.</dt>
  2477. </dl>
  2478. </div>
  2479. <h3 class="name name-method" id="fromHalfFloat" translate="no">.<a href="#fromHalfFloat">fromHalfFloat</a><span class="signature">( val : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2480. <div class="method">
  2481. <div class="description">
  2482. <p>Returns a single precision floating point value (FP32) from the given half
  2483. precision floating point value (FP16).</p>
  2484. </div>
  2485. <table class="params">
  2486. <tbody>
  2487. <tr>
  2488. <td class="name">
  2489. <strong translate="no">val</strong>
  2490. </td>
  2491. <td class="description last">
  2492. <p>A half precision floating point value.</p>
  2493. </td>
  2494. </tr>
  2495. </tbody>
  2496. </table>
  2497. <dl class="details">
  2498. <dt class="tag-returns"><strong>Returns:</strong> The FP32 value.</dt>
  2499. </dl>
  2500. </div>
  2501. <h3 class="name name-method" id="generateMagicSquare" translate="no">.<a href="#generateMagicSquare">generateMagicSquare</a><span class="signature">( size : <span class="param-type">number</span> )</span><span class="type-signature"> : Array.&lt;number></span> </h3>
  2502. <div class="method">
  2503. <div class="description">
  2504. <p>Computes an array of magic square values required to generate the noise texture.</p>
  2505. </div>
  2506. <table class="params">
  2507. <tbody>
  2508. <tr>
  2509. <td class="name">
  2510. <strong translate="no">size</strong>
  2511. </td>
  2512. <td class="description last">
  2513. <p>The noise size.</p>
  2514. </td>
  2515. </tr>
  2516. </tbody>
  2517. </table>
  2518. <dl class="details">
  2519. <dt class="tag-returns"><strong>Returns:</strong> The magic square values.</dt>
  2520. </dl>
  2521. </div>
  2522. <h3 class="name name-method" id="generateMagicSquareNoise" translate="no">.<a href="#generateMagicSquareNoise">generateMagicSquareNoise</a><span class="signature">( size : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="DataTexture.html">DataTexture</a></span> </h3>
  2523. <div class="method">
  2524. <div class="description">
  2525. <p>Generates the AO's noise texture for the given size.</p>
  2526. </div>
  2527. <table class="params">
  2528. <tbody>
  2529. <tr>
  2530. <td class="name">
  2531. <strong translate="no">size</strong>
  2532. </td>
  2533. <td class="description last">
  2534. <p>The noise size.</p>
  2535. <p>Default is <code>5</code>.</p>
  2536. </td>
  2537. </tr>
  2538. </tbody>
  2539. </table>
  2540. <dl class="details">
  2541. <dt class="tag-returns"><strong>Returns:</strong> The generated noise texture.</dt>
  2542. </dl>
  2543. </div>
  2544. <h3 class="name name-method" id="generateUUID" translate="no">.<a href="#generateUUID">generateUUID</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  2545. <div class="method">
  2546. <div class="description">
  2547. <p>Generate a <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" target="_blank" rel="noopener">UUID</a>
  2548. (universally unique identifier).</p>
  2549. </div>
  2550. <dl class="details">
  2551. <dt class="tag-returns"><strong>Returns:</strong> The UUID.</dt>
  2552. </dl>
  2553. </div>
  2554. <h3 class="name name-method" id="getByteLength" translate="no">.<a href="#getByteLength">getByteLength</a><span class="signature">( width : <span class="param-type">number</span>, height : <span class="param-type">number</span>, format : <span class="param-type">number</span>, type : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2555. <div class="method">
  2556. <div class="description">
  2557. <p>Determines how many bytes must be used to represent the texture.</p>
  2558. </div>
  2559. <table class="params">
  2560. <tbody>
  2561. <tr>
  2562. <td class="name">
  2563. <strong translate="no">width</strong>
  2564. </td>
  2565. <td class="description last">
  2566. <p>The width of the texture.</p>
  2567. </td>
  2568. </tr>
  2569. <tr>
  2570. <td class="name">
  2571. <strong translate="no">height</strong>
  2572. </td>
  2573. <td class="description last">
  2574. <p>The height of the texture.</p>
  2575. </td>
  2576. </tr>
  2577. <tr>
  2578. <td class="name">
  2579. <strong translate="no">format</strong>
  2580. </td>
  2581. <td class="description last">
  2582. <p>The texture's format.</p>
  2583. </td>
  2584. </tr>
  2585. <tr>
  2586. <td class="name">
  2587. <strong translate="no">type</strong>
  2588. </td>
  2589. <td class="description last">
  2590. <p>The texture's type.</p>
  2591. </td>
  2592. </tr>
  2593. </tbody>
  2594. </table>
  2595. <dl class="details">
  2596. <dt class="tag-returns"><strong>Returns:</strong> The byte length.</dt>
  2597. </dl>
  2598. </div>
  2599. <h3 class="name name-method" id="getCacheKey" translate="no">.<a href="#getCacheKey">getCacheKey</a><span class="signature">( renderContext : <span class="param-type"><a href="RenderContext.html">RenderContext</a></span> )</span><span class="type-signature"> : number</span> </h3>
  2600. <div class="method">
  2601. <div class="description">
  2602. <p>Computes a cache key for the given render context. This key
  2603. should identify the render target state so it is possible to
  2604. configure the correct attachments in the respective backend.</p>
  2605. </div>
  2606. <table class="params">
  2607. <tbody>
  2608. <tr>
  2609. <td class="name">
  2610. <strong translate="no">renderContext</strong>
  2611. </td>
  2612. <td class="description last">
  2613. <p>The render context.</p>
  2614. </td>
  2615. </tr>
  2616. </tbody>
  2617. </table>
  2618. <dl class="details">
  2619. <dt class="tag-returns"><strong>Returns:</strong> The cache key.</dt>
  2620. </dl>
  2621. </div>
  2622. <h3 class="name name-method" id="getConsoleFunction" translate="no">.<a href="#getConsoleFunction">getConsoleFunction</a><span class="signature">()</span><span class="type-signature"> : function | null</span> </h3>
  2623. <div class="method">
  2624. <div class="description">
  2625. <p>Gets the currently set custom console function.</p>
  2626. </div>
  2627. <dl class="details">
  2628. <dt class="tag-returns"><strong>Returns:</strong> The custom console function, or null if not set.</dt>
  2629. </dl>
  2630. </div>
  2631. <h3 class="name name-method" id="getDistanceAttenuation" translate="no">.<a href="#getDistanceAttenuation">getDistanceAttenuation</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  2632. <div class="method">
  2633. <div class="description">
  2634. <p>Represents a <code>discard</code> shader operation in TSL.</p>
  2635. </div>
  2636. <table class="params">
  2637. <tbody>
  2638. <tr>
  2639. <td class="name">
  2640. <strong translate="no">inputs</strong>
  2641. </td>
  2642. <td class="description last">
  2643. <p>The input parameter object.</p>
  2644. <table class="params">
  2645. <tbody>
  2646. <tr>
  2647. <td class="name">
  2648. <strong translate="no">lightDistance</strong>
  2649. </td>
  2650. <td class="description last">
  2651. <p>The distance of the light's position to the current fragment position.</p>
  2652. </td>
  2653. </tr>
  2654. <tr>
  2655. <td class="name">
  2656. <strong translate="no">cutoffDistance</strong>
  2657. </td>
  2658. <td class="description last">
  2659. <p>The light's cutoff distance.</p>
  2660. </td>
  2661. </tr>
  2662. <tr>
  2663. <td class="name">
  2664. <strong translate="no">decayExponent</strong>
  2665. </td>
  2666. <td class="description last">
  2667. <p>The light's decay exponent.</p>
  2668. </td>
  2669. </tr>
  2670. </tbody>
  2671. </table>
  2672. </td>
  2673. </tr>
  2674. </tbody>
  2675. </table>
  2676. <dl class="details">
  2677. <dt class="tag-returns"><strong>Returns:</strong> The distance falloff.</dt>
  2678. </dl>
  2679. </div>
  2680. <h3 class="name name-method" id="getElementsByTagName" translate="no">.<a href="#getElementsByTagName">getElementsByTagName</a><span class="signature">()</span> </h3>
  2681. <div class="method">
  2682. <div class="description">
  2683. <p>Utility functions for parsing</p>
  2684. </div>
  2685. </div>
  2686. <h3 class="name name-method" id="getFilteredStack" translate="no">.<a href="#getFilteredStack">getFilteredStack</a><span class="signature">()</span> </h3>
  2687. <div class="method">
  2688. <div class="description">
  2689. <p>Parses the stack trace and filters out ignored files.
  2690. Returns an array with function name, file, line, and column.</p>
  2691. </div>
  2692. </div>
  2693. <h3 class="name name-method" id="getFloatLength" translate="no">.<a href="#getFloatLength">getFloatLength</a><span class="signature">( floatLength : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2694. <div class="method">
  2695. <div class="description">
  2696. <p>This function is usually called with the length in bytes of an array buffer.
  2697. It returns an padded value which ensure chunk size alignment according to STD140 layout.</p>
  2698. </div>
  2699. <table class="params">
  2700. <tbody>
  2701. <tr>
  2702. <td class="name">
  2703. <strong translate="no">floatLength</strong>
  2704. </td>
  2705. <td class="description last">
  2706. <p>The buffer length.</p>
  2707. </td>
  2708. </tr>
  2709. </tbody>
  2710. </table>
  2711. <dl class="details">
  2712. <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
  2713. </dl>
  2714. </div>
  2715. <h3 class="name name-method" id="getFormat" translate="no">.<a href="#getFormat">getFormat</a><span class="signature">( texture : <span class="param-type"><a href="Texture.html">Texture</a></span>, device : <span class="param-type">GPUDevice</span> )</span><span class="type-signature"> : string</span> </h3>
  2716. <div class="method">
  2717. <div class="description">
  2718. <p>Returns the GPU format for the given texture.</p>
  2719. </div>
  2720. <table class="params">
  2721. <tbody>
  2722. <tr>
  2723. <td class="name">
  2724. <strong translate="no">texture</strong>
  2725. </td>
  2726. <td class="description last">
  2727. <p>The texture.</p>
  2728. </td>
  2729. </tr>
  2730. <tr>
  2731. <td class="name">
  2732. <strong translate="no">device</strong>
  2733. </td>
  2734. <td class="description last">
  2735. <p>The GPU device which is used for feature detection.
  2736. It is not necessary to apply the device for most formats.</p>
  2737. <p>Default is <code>null</code>.</p>
  2738. </td>
  2739. </tr>
  2740. </tbody>
  2741. </table>
  2742. <dl class="details">
  2743. <dt class="tag-returns"><strong>Returns:</strong> The GPU format.</dt>
  2744. </dl>
  2745. </div>
  2746. <h3 class="name name-method" id="getKeyframeOrder" translate="no">.<a href="#getKeyframeOrder">getKeyframeOrder</a><span class="signature">( times : <span class="param-type">Array.&lt;number></span> )</span><span class="type-signature"> : Array.&lt;number></span> </h3>
  2747. <div class="method">
  2748. <div class="description">
  2749. <p>Returns an array by which times and values can be sorted.</p>
  2750. </div>
  2751. <table class="params">
  2752. <tbody>
  2753. <tr>
  2754. <td class="name">
  2755. <strong translate="no">times</strong>
  2756. </td>
  2757. <td class="description last">
  2758. <p>The keyframe time values.</p>
  2759. </td>
  2760. </tr>
  2761. </tbody>
  2762. </table>
  2763. <dl class="details">
  2764. <dt class="tag-returns"><strong>Returns:</strong> The array.</dt>
  2765. </dl>
  2766. </div>
  2767. <h3 class="name name-method" id="getMembersLayout" translate="no">.<a href="#getMembersLayout">getMembersLayout</a><span class="signature">( members : <span class="param-type">Object.&lt;string, (string|Object)></span> )</span><span class="type-signature"> : Array.&lt;{name: string, type: string, atomic: boolean}></span> </h3>
  2768. <div class="method">
  2769. <div class="description">
  2770. <p>Generates a layout for struct members.
  2771. This function takes an object representing struct members and returns an array of member layouts.
  2772. Each member layout includes the member's name, type, and whether it is atomic.</p>
  2773. </div>
  2774. <table class="params">
  2775. <tbody>
  2776. <tr>
  2777. <td class="name">
  2778. <strong translate="no">members</strong>
  2779. </td>
  2780. <td class="description last">
  2781. <p>An object where keys are member names and values are either types (as strings) or objects with type and atomic properties.</p>
  2782. </td>
  2783. </tr>
  2784. </tbody>
  2785. </table>
  2786. <dl class="details">
  2787. <dt class="tag-returns"><strong>Returns:</strong> An array of member layouts.</dt>
  2788. </dl>
  2789. </div>
  2790. <h3 class="name name-method" id="getStrideLength" translate="no">.<a href="#getStrideLength">getStrideLength</a><span class="signature">( vectorLength : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2791. <div class="method">
  2792. <div class="description">
  2793. <p>This function is called with a vector length and ensure the computed length
  2794. matches a predefined stride (in this case <code>4</code>).</p>
  2795. </div>
  2796. <table class="params">
  2797. <tbody>
  2798. <tr>
  2799. <td class="name">
  2800. <strong translate="no">vectorLength</strong>
  2801. </td>
  2802. <td class="description last">
  2803. <p>The vector length.</p>
  2804. </td>
  2805. </tr>
  2806. </tbody>
  2807. </table>
  2808. <dl class="details">
  2809. <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
  2810. </dl>
  2811. </div>
  2812. <h3 class="name name-method" id="getTextureIndex" translate="no">.<a href="#getTextureIndex">getTextureIndex</a><span class="signature">( textures : <span class="param-type">Array.&lt;<a href="Texture.html">Texture</a>></span>, name : <span class="param-type">string</span> )</span><span class="type-signature"> : number</span> </h3>
  2813. <div class="method">
  2814. <div class="description">
  2815. <p>Returns the MRT texture index for the given name.</p>
  2816. </div>
  2817. <table class="params">
  2818. <tbody>
  2819. <tr>
  2820. <td class="name">
  2821. <strong translate="no">textures</strong>
  2822. </td>
  2823. <td class="description last">
  2824. <p>The textures of a MRT-configured render target.</p>
  2825. </td>
  2826. </tr>
  2827. <tr>
  2828. <td class="name">
  2829. <strong translate="no">name</strong>
  2830. </td>
  2831. <td class="description last">
  2832. <p>The name of the MRT texture which index is requested.</p>
  2833. </td>
  2834. </tr>
  2835. </tbody>
  2836. </table>
  2837. <dl class="details">
  2838. <dt class="tag-returns"><strong>Returns:</strong> The texture index.</dt>
  2839. </dl>
  2840. </div>
  2841. <h3 class="name name-method" id="getUniforms" translate="no">.<a href="#getUniforms">getUniforms</a><span class="signature">( splineTexture : <span class="param-type"><a href="DataTexture.html">DataTexture</a></span> )</span><span class="type-signature"> : Object</span> </h3>
  2842. <div class="method">
  2843. <div class="description">
  2844. <p>Create a new set of uniforms for describing the curve modifier.</p>
  2845. </div>
  2846. <table class="params">
  2847. <tbody>
  2848. <tr>
  2849. <td class="name">
  2850. <strong translate="no">splineTexture</strong>
  2851. </td>
  2852. <td class="description last">
  2853. <p>Which holds the curve description.</p>
  2854. </td>
  2855. </tr>
  2856. </tbody>
  2857. </table>
  2858. <dl class="details">
  2859. <dt class="tag-returns"><strong>Returns:</strong> The uniforms object to be used in the shader.</dt>
  2860. </dl>
  2861. </div>
  2862. <h3 class="name name-method" id="getVectorLength" translate="no">.<a href="#getVectorLength">getVectorLength</a><span class="signature">( count : <span class="param-type">number</span>, vectorLength : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2863. <div class="method">
  2864. <div class="description">
  2865. <p>Given the count of vectors and their vector length, this function computes
  2866. a total length in bytes with buffer alignment according to STD140 layout.</p>
  2867. </div>
  2868. <table class="params">
  2869. <tbody>
  2870. <tr>
  2871. <td class="name">
  2872. <strong translate="no">count</strong>
  2873. </td>
  2874. <td class="description last">
  2875. <p>The number of vectors.</p>
  2876. </td>
  2877. </tr>
  2878. <tr>
  2879. <td class="name">
  2880. <strong translate="no">vectorLength</strong>
  2881. </td>
  2882. <td class="description last">
  2883. <p>The vector length.</p>
  2884. <p>Default is <code>4</code>.</p>
  2885. </td>
  2886. </tr>
  2887. </tbody>
  2888. </table>
  2889. <dl class="details">
  2890. <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
  2891. </dl>
  2892. </div>
  2893. <h3 class="name name-method" id="getViewZNode" translate="no">.<a href="#getViewZNode">getViewZNode</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  2894. <div class="method">
  2895. <div class="description">
  2896. <p>Returns a node that represents the <code>z</code> coordinate in view space
  2897. for the current fragment. It's a different representation of the
  2898. default depth value.</p>
  2899. <p>This value can be part of a computation that defines how the fog
  2900. density increases when moving away from the camera.</p>
  2901. </div>
  2902. <table class="params">
  2903. <tbody>
  2904. <tr>
  2905. <td class="name">
  2906. <strong translate="no">builder</strong>
  2907. </td>
  2908. <td class="description last">
  2909. <p>The current node builder.</p>
  2910. </td>
  2911. </tr>
  2912. </tbody>
  2913. </table>
  2914. <dl class="details">
  2915. <dt class="tag-returns"><strong>Returns:</strong> The viewZ node.</dt>
  2916. </dl>
  2917. </div>
  2918. <h3 class="name name-method" id="inverseLerp" translate="no">.<a href="#inverseLerp">inverseLerp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2919. <div class="method">
  2920. <div class="description">
  2921. <p>Returns the percentage in the closed interval <code>[0, 1]</code> of the given value
  2922. between the start and end point.</p>
  2923. </div>
  2924. <table class="params">
  2925. <tbody>
  2926. <tr>
  2927. <td class="name">
  2928. <strong translate="no">x</strong>
  2929. </td>
  2930. <td class="description last">
  2931. <p>The start point</p>
  2932. </td>
  2933. </tr>
  2934. <tr>
  2935. <td class="name">
  2936. <strong translate="no">y</strong>
  2937. </td>
  2938. <td class="description last">
  2939. <p>The end point.</p>
  2940. </td>
  2941. </tr>
  2942. <tr>
  2943. <td class="name">
  2944. <strong translate="no">value</strong>
  2945. </td>
  2946. <td class="description last">
  2947. <p>A value between start and end.</p>
  2948. </td>
  2949. </tr>
  2950. </tbody>
  2951. </table>
  2952. <dl class="details">
  2953. <dt class="tag-returns"><strong>Returns:</strong> The interpolation factor.</dt>
  2954. </dl>
  2955. </div>
  2956. <h3 class="name name-method" id="isPowerOfTwo" translate="no">.<a href="#isPowerOfTwo">isPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : boolean</span> </h3>
  2957. <div class="method">
  2958. <div class="description">
  2959. <p>Returns <code>true</code> if the given number is a power of two.</p>
  2960. </div>
  2961. <table class="params">
  2962. <tbody>
  2963. <tr>
  2964. <td class="name">
  2965. <strong translate="no">value</strong>
  2966. </td>
  2967. <td class="description last">
  2968. <p>The value to check.</p>
  2969. </td>
  2970. </tr>
  2971. </tbody>
  2972. </table>
  2973. <dl class="details">
  2974. <dt class="tag-returns"><strong>Returns:</strong> Whether the given number is a power of two or not.</dt>
  2975. </dl>
  2976. </div>
  2977. <h3 class="name name-method" id="isTypedArray" translate="no">.<a href="#isTypedArray">isTypedArray</a><span class="signature">( array : <span class="param-type"><a href="global.html#any">any</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
  2978. <div class="method">
  2979. <div class="description">
  2980. <p>Returns <code>true</code> if the given object is a typed array.</p>
  2981. </div>
  2982. <table class="params">
  2983. <tbody>
  2984. <tr>
  2985. <td class="name">
  2986. <strong translate="no">array</strong>
  2987. </td>
  2988. <td class="description last">
  2989. <p>The object to check.</p>
  2990. </td>
  2991. </tr>
  2992. </tbody>
  2993. </table>
  2994. <dl class="details">
  2995. <dt class="tag-returns"><strong>Returns:</strong> Whether the given object is a typed array.</dt>
  2996. </dl>
  2997. </div>
  2998. <h3 class="name name-method" id="lerp" translate="no">.<a href="#lerp">lerp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, t : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  2999. <div class="method">
  3000. <div class="description">
  3001. <p>Returns a value linearly interpolated from two known points based on the given interval -
  3002. <code>t = 0</code> will return <code>x</code> and <code>t = 1</code> will return <code>y</code>.</p>
  3003. </div>
  3004. <table class="params">
  3005. <tbody>
  3006. <tr>
  3007. <td class="name">
  3008. <strong translate="no">x</strong>
  3009. </td>
  3010. <td class="description last">
  3011. <p>The start point</p>
  3012. </td>
  3013. </tr>
  3014. <tr>
  3015. <td class="name">
  3016. <strong translate="no">y</strong>
  3017. </td>
  3018. <td class="description last">
  3019. <p>The end point.</p>
  3020. </td>
  3021. </tr>
  3022. <tr>
  3023. <td class="name">
  3024. <strong translate="no">t</strong>
  3025. </td>
  3026. <td class="description last">
  3027. <p>The interpolation factor in the closed interval <code>[0, 1]</code>.</p>
  3028. </td>
  3029. </tr>
  3030. </tbody>
  3031. </table>
  3032. <dl class="details">
  3033. <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
  3034. </dl>
  3035. </div>
  3036. <h3 class="name name-method" id="log" translate="no">.<a href="#log">log</a><span class="signature">( &hellip;params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
  3037. <div class="method">
  3038. <div class="description">
  3039. <p>Logs an informational message with the 'THREE.' prefix.</p>
  3040. <p>If a custom console function is set via setConsoleFunction(), it will be used
  3041. instead of the native console.log. The first parameter is treated as the
  3042. method name and is automatically prefixed with 'THREE.'.</p>
  3043. </div>
  3044. <table class="params">
  3045. <tbody>
  3046. <tr>
  3047. <td class="name">
  3048. <strong translate="no">params</strong>
  3049. </td>
  3050. <td class="description last">
  3051. <p>The message components. The first param is used as
  3052. the method name and prefixed with 'THREE.'.</p>
  3053. </td>
  3054. </tr>
  3055. </tbody>
  3056. </table>
  3057. </div>
  3058. <h3 class="name name-method" id="makeClipAdditive" translate="no">.<a href="#makeClipAdditive">makeClipAdditive</a><span class="signature">( targetClip : <span class="param-type"><a href="AnimationClip.html">AnimationClip</a></span>, referenceFrame : <span class="param-type">number</span>, referenceClip : <span class="param-type"><a href="AnimationClip.html">AnimationClip</a></span>, fps : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationClip.html">AnimationClip</a></span> </h3>
  3059. <div class="method">
  3060. <div class="description">
  3061. <p>Converts the keyframes of the given animation clip to an additive format.</p>
  3062. </div>
  3063. <table class="params">
  3064. <tbody>
  3065. <tr>
  3066. <td class="name">
  3067. <strong translate="no">targetClip</strong>
  3068. </td>
  3069. <td class="description last">
  3070. <p>The clip to make additive.</p>
  3071. </td>
  3072. </tr>
  3073. <tr>
  3074. <td class="name">
  3075. <strong translate="no">referenceFrame</strong>
  3076. </td>
  3077. <td class="description last">
  3078. <p>The reference frame.</p>
  3079. <p>Default is <code>0</code>.</p>
  3080. </td>
  3081. </tr>
  3082. <tr>
  3083. <td class="name">
  3084. <strong translate="no">referenceClip</strong>
  3085. </td>
  3086. <td class="description last">
  3087. <p>The reference clip.</p>
  3088. <p>Default is <code>targetClip</code>.</p>
  3089. </td>
  3090. </tr>
  3091. <tr>
  3092. <td class="name">
  3093. <strong translate="no">fps</strong>
  3094. </td>
  3095. <td class="description last">
  3096. <p>The FPS.</p>
  3097. <p>Default is <code>30</code>.</p>
  3098. </td>
  3099. </tr>
  3100. </tbody>
  3101. </table>
  3102. <dl class="details">
  3103. <dt class="tag-returns"><strong>Returns:</strong> The updated clip which is now additive.</dt>
  3104. </dl>
  3105. </div>
  3106. <h3 class="name name-method" id="mapLinear" translate="no">.<a href="#mapLinear">mapLinear</a><span class="signature">( x : <span class="param-type">number</span>, a1 : <span class="param-type">number</span>, a2 : <span class="param-type">number</span>, b1 : <span class="param-type">number</span>, b2 : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3107. <div class="method">
  3108. <div class="description">
  3109. <p>Performs a linear mapping from range <code>&lt;a1, a2&gt;</code> to range <code>&lt;b1, b2&gt;</code>
  3110. for the given value. <code>a2</code> must be greater than <code>a1</code>.</p>
  3111. </div>
  3112. <table class="params">
  3113. <tbody>
  3114. <tr>
  3115. <td class="name">
  3116. <strong translate="no">x</strong>
  3117. </td>
  3118. <td class="description last">
  3119. <p>The value to be mapped.</p>
  3120. </td>
  3121. </tr>
  3122. <tr>
  3123. <td class="name">
  3124. <strong translate="no">a1</strong>
  3125. </td>
  3126. <td class="description last">
  3127. <p>Minimum value for range A.</p>
  3128. </td>
  3129. </tr>
  3130. <tr>
  3131. <td class="name">
  3132. <strong translate="no">a2</strong>
  3133. </td>
  3134. <td class="description last">
  3135. <p>Maximum value for range A.</p>
  3136. </td>
  3137. </tr>
  3138. <tr>
  3139. <td class="name">
  3140. <strong translate="no">b1</strong>
  3141. </td>
  3142. <td class="description last">
  3143. <p>Minimum value for range B.</p>
  3144. </td>
  3145. </tr>
  3146. <tr>
  3147. <td class="name">
  3148. <strong translate="no">b2</strong>
  3149. </td>
  3150. <td class="description last">
  3151. <p>Maximum value for range B.</p>
  3152. </td>
  3153. </tr>
  3154. </tbody>
  3155. </table>
  3156. <dl class="details">
  3157. <dt class="tag-returns"><strong>Returns:</strong> The mapped value.</dt>
  3158. </dl>
  3159. </div>
  3160. <h3 class="name name-method" id="normalize" translate="no">.<a href="#normalize">normalize</a><span class="signature">( value : <span class="param-type">number</span>, array : <span class="param-type">TypedArray</span> )</span><span class="type-signature"> : number</span> </h3>
  3161. <div class="method">
  3162. <div class="description">
  3163. <p>Normalizes the given value according to the given typed array.</p>
  3164. </div>
  3165. <table class="params">
  3166. <tbody>
  3167. <tr>
  3168. <td class="name">
  3169. <strong translate="no">value</strong>
  3170. </td>
  3171. <td class="description last">
  3172. <p>The float value in the range <code>[0,1]</code> to normalize.</p>
  3173. </td>
  3174. </tr>
  3175. <tr>
  3176. <td class="name">
  3177. <strong translate="no">array</strong>
  3178. </td>
  3179. <td class="description last">
  3180. <p>The typed array that defines the data type of the value.</p>
  3181. </td>
  3182. </tr>
  3183. </tbody>
  3184. </table>
  3185. <dl class="details">
  3186. <dt class="tag-returns"><strong>Returns:</strong> The normalize value.</dt>
  3187. </dl>
  3188. </div>
  3189. <h3 class="name name-method" id="pingpong" translate="no">.<a href="#pingpong">pingpong</a><span class="signature">( x : <span class="param-type">number</span>, length : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3190. <div class="method">
  3191. <div class="description">
  3192. <p>Returns a value that alternates between <code>0</code> and the given <code>length</code> parameter.</p>
  3193. </div>
  3194. <table class="params">
  3195. <tbody>
  3196. <tr>
  3197. <td class="name">
  3198. <strong translate="no">x</strong>
  3199. </td>
  3200. <td class="description last">
  3201. <p>The value to pingpong.</p>
  3202. </td>
  3203. </tr>
  3204. <tr>
  3205. <td class="name">
  3206. <strong translate="no">length</strong>
  3207. </td>
  3208. <td class="description last">
  3209. <p>The positive value the function will pingpong to.</p>
  3210. <p>Default is <code>1</code>.</p>
  3211. </td>
  3212. </tr>
  3213. </tbody>
  3214. </table>
  3215. <dl class="details">
  3216. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  3217. </dl>
  3218. </div>
  3219. <h3 class="name name-method" id="radToDeg" translate="no">.<a href="#radToDeg">radToDeg</a><span class="signature">( radians : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3220. <div class="method">
  3221. <div class="description">
  3222. <p>Converts radians to degrees.</p>
  3223. </div>
  3224. <table class="params">
  3225. <tbody>
  3226. <tr>
  3227. <td class="name">
  3228. <strong translate="no">radians</strong>
  3229. </td>
  3230. <td class="description last">
  3231. <p>A value in radians.</p>
  3232. </td>
  3233. </tr>
  3234. </tbody>
  3235. </table>
  3236. <dl class="details">
  3237. <dt class="tag-returns"><strong>Returns:</strong> The converted value in degrees.</dt>
  3238. </dl>
  3239. </div>
  3240. <h3 class="name name-method" id="randFloat" translate="no">.<a href="#randFloat">randFloat</a><span class="signature">( low : <span class="param-type">number</span>, high : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3241. <div class="method">
  3242. <div class="description">
  3243. <p>Returns a random float from <code>&lt;low, high&gt;</code> interval.</p>
  3244. </div>
  3245. <table class="params">
  3246. <tbody>
  3247. <tr>
  3248. <td class="name">
  3249. <strong translate="no">low</strong>
  3250. </td>
  3251. <td class="description last">
  3252. <p>The lower value boundary.</p>
  3253. </td>
  3254. </tr>
  3255. <tr>
  3256. <td class="name">
  3257. <strong translate="no">high</strong>
  3258. </td>
  3259. <td class="description last">
  3260. <p>The upper value boundary</p>
  3261. </td>
  3262. </tr>
  3263. </tbody>
  3264. </table>
  3265. <dl class="details">
  3266. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  3267. </dl>
  3268. </div>
  3269. <h3 class="name name-method" id="randFloatSpread" translate="no">.<a href="#randFloatSpread">randFloatSpread</a><span class="signature">( range : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3270. <div class="method">
  3271. <div class="description">
  3272. <p>Returns a random integer from <code>&lt;-range/2, range/2&gt;</code> interval.</p>
  3273. </div>
  3274. <table class="params">
  3275. <tbody>
  3276. <tr>
  3277. <td class="name">
  3278. <strong translate="no">range</strong>
  3279. </td>
  3280. <td class="description last">
  3281. <p>Defines the value range.</p>
  3282. </td>
  3283. </tr>
  3284. </tbody>
  3285. </table>
  3286. <dl class="details">
  3287. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  3288. </dl>
  3289. </div>
  3290. <h3 class="name name-method" id="randInt" translate="no">.<a href="#randInt">randInt</a><span class="signature">( low : <span class="param-type">number</span>, high : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3291. <div class="method">
  3292. <div class="description">
  3293. <p>Returns a random integer from <code>&lt;low, high&gt;</code> interval.</p>
  3294. </div>
  3295. <table class="params">
  3296. <tbody>
  3297. <tr>
  3298. <td class="name">
  3299. <strong translate="no">low</strong>
  3300. </td>
  3301. <td class="description last">
  3302. <p>The lower value boundary.</p>
  3303. </td>
  3304. </tr>
  3305. <tr>
  3306. <td class="name">
  3307. <strong translate="no">high</strong>
  3308. </td>
  3309. <td class="description last">
  3310. <p>The upper value boundary</p>
  3311. </td>
  3312. </tr>
  3313. </tbody>
  3314. </table>
  3315. <dl class="details">
  3316. <dt class="tag-returns"><strong>Returns:</strong> A random integer.</dt>
  3317. </dl>
  3318. </div>
  3319. <h3 class="name name-method" id="sample" translate="no">.<a href="#sample">sample</a><span class="signature">( callback : <span class="param-type">function</span>, uv : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec2></span> )</span><span class="type-signature"> : <a href="SampleNode.html">SampleNode</a></span> </h3>
  3320. <div class="method">
  3321. <div class="description">
  3322. <p>Helper function to create a SampleNode wrapped as a node object.</p>
  3323. </div>
  3324. <table class="params">
  3325. <tbody>
  3326. <tr>
  3327. <td class="name">
  3328. <strong translate="no">callback</strong>
  3329. </td>
  3330. <td class="description last">
  3331. <p>The function to be called when sampling. Should accept a UV node and return a value.</p>
  3332. </td>
  3333. </tr>
  3334. <tr>
  3335. <td class="name">
  3336. <strong translate="no">uv</strong>
  3337. </td>
  3338. <td class="description last">
  3339. <p>The UV node to be used in the texture sampling.</p>
  3340. <p>Default is <code>null</code>.</p>
  3341. </td>
  3342. </tr>
  3343. </tbody>
  3344. </table>
  3345. <dl class="details">
  3346. <dt class="tag-returns"><strong>Returns:</strong> The created SampleNode instance wrapped as a node object.</dt>
  3347. </dl>
  3348. </div>
  3349. <h3 class="name name-method" id="seededRandom" translate="no">.<a href="#seededRandom">seededRandom</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3350. <div class="method">
  3351. <div class="description">
  3352. <p>Returns a deterministic pseudo-random float in the interval <code>[0, 1]</code>.</p>
  3353. </div>
  3354. <table class="params">
  3355. <tbody>
  3356. <tr>
  3357. <td class="name">
  3358. <strong translate="no">s</strong>
  3359. </td>
  3360. <td class="description last">
  3361. <p>The integer seed.</p>
  3362. </td>
  3363. </tr>
  3364. </tbody>
  3365. </table>
  3366. <dl class="details">
  3367. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  3368. </dl>
  3369. </div>
  3370. <h3 class="name name-method" id="setConsoleFunction" translate="no">.<a href="#setConsoleFunction">setConsoleFunction</a><span class="signature">( fn : <span class="param-type">function</span> )</span> </h3>
  3371. <div class="method">
  3372. <div class="description">
  3373. <p>Sets a custom function to handle console output.</p>
  3374. <p>This allows external code to intercept and handle console.log, console.warn,
  3375. and console.error calls made by three.js, which is useful for custom logging,
  3376. testing, or debugging workflows.</p>
  3377. </div>
  3378. <table class="params">
  3379. <tbody>
  3380. <tr>
  3381. <td class="name">
  3382. <strong translate="no">fn</strong>
  3383. </td>
  3384. <td class="description last">
  3385. <p>The function to handle console output. Should accept
  3386. (type, message, ...params) where type is 'log', 'warn', or 'error'.</p>
  3387. </td>
  3388. </tr>
  3389. </tbody>
  3390. </table>
  3391. </div>
  3392. <h3 class="name name-method" id="setProjectionFromUnion" translate="no">.<a href="#setProjectionFromUnion">setProjectionFromUnion</a><span class="signature">( camera : <span class="param-type"><a href="ArrayCamera.html">ArrayCamera</a></span>, cameraL : <span class="param-type"><a href="PerspectiveCamera.html">PerspectiveCamera</a></span>, cameraR : <span class="param-type"><a href="PerspectiveCamera.html">PerspectiveCamera</a></span> )</span> </h3>
  3393. <div class="method">
  3394. <div class="description">
  3395. <p>Assumes 2 cameras that are parallel and share an X-axis, and that
  3396. the cameras' projection and world matrices have already been set.
  3397. And that near and far planes are identical for both cameras.
  3398. Visualization of this technique: https://computergraphics.stackexchange.com/a/4765</p>
  3399. </div>
  3400. <table class="params">
  3401. <tbody>
  3402. <tr>
  3403. <td class="name">
  3404. <strong translate="no">camera</strong>
  3405. </td>
  3406. <td class="description last">
  3407. <p>The camera to update.</p>
  3408. </td>
  3409. </tr>
  3410. <tr>
  3411. <td class="name">
  3412. <strong translate="no">cameraL</strong>
  3413. </td>
  3414. <td class="description last">
  3415. <p>The left camera.</p>
  3416. </td>
  3417. </tr>
  3418. <tr>
  3419. <td class="name">
  3420. <strong translate="no">cameraR</strong>
  3421. </td>
  3422. <td class="description last">
  3423. <p>The right camera.</p>
  3424. </td>
  3425. </tr>
  3426. </tbody>
  3427. </table>
  3428. </div>
  3429. <h3 class="name name-method" id="setQuaternionFromProperEuler" translate="no">.<a href="#setQuaternionFromProperEuler">setQuaternionFromProperEuler</a><span class="signature">( q : <span class="param-type"><a href="Quaternion.html">Quaternion</a></span>, a : <span class="param-type">number</span>, b : <span class="param-type">number</span>, c : <span class="param-type">number</span>, order : <span class="param-type">'XYX' | 'XZX' | 'YXY' | 'YZY' | 'ZXZ' | 'ZYZ'</span> )</span> </h3>
  3430. <div class="method">
  3431. <div class="description">
  3432. <p>Sets the given quaternion from the <a href="https://en.wikipedia.org/wiki/Euler_angles" target="_blank" rel="noopener">Intrinsic Proper Euler Angles</a>
  3433. defined by the given angles and order.</p>
  3434. <p>Rotations are applied to the axes in the order specified by order:
  3435. rotation by angle <code>a</code> is applied first, then by angle <code>b</code>, then by angle <code>c</code>.</p>
  3436. </div>
  3437. <table class="params">
  3438. <tbody>
  3439. <tr>
  3440. <td class="name">
  3441. <strong translate="no">q</strong>
  3442. </td>
  3443. <td class="description last">
  3444. <p>The quaternion to set.</p>
  3445. </td>
  3446. </tr>
  3447. <tr>
  3448. <td class="name">
  3449. <strong translate="no">a</strong>
  3450. </td>
  3451. <td class="description last">
  3452. <p>The rotation applied to the first axis, in radians.</p>
  3453. </td>
  3454. </tr>
  3455. <tr>
  3456. <td class="name">
  3457. <strong translate="no">b</strong>
  3458. </td>
  3459. <td class="description last">
  3460. <p>The rotation applied to the second axis, in radians.</p>
  3461. </td>
  3462. </tr>
  3463. <tr>
  3464. <td class="name">
  3465. <strong translate="no">c</strong>
  3466. </td>
  3467. <td class="description last">
  3468. <p>The rotation applied to the third axis, in radians.</p>
  3469. </td>
  3470. </tr>
  3471. <tr>
  3472. <td class="name">
  3473. <strong translate="no">order</strong>
  3474. </td>
  3475. <td class="description last">
  3476. <p>A string specifying the axes order.</p>
  3477. </td>
  3478. </tr>
  3479. </tbody>
  3480. </table>
  3481. </div>
  3482. <h3 class="name name-method" id="shadowRenderObjectFunction" translate="no">.<a href="#shadowRenderObjectFunction">shadowRenderObjectFunction</a><span class="signature">( object : <span class="param-type"><a href="Object3D.html">Object3D</a></span>, scene : <span class="param-type"><a href="Scene.html">Scene</a></span>, _camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, geometry : <span class="param-type"><a href="BufferGeometry.html">BufferGeometry</a></span>, material : <span class="param-type"><a href="Material.html">Material</a></span>, group : <span class="param-type"><a href="Group.html">Group</a></span>, &hellip;params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
  3483. <div class="method">
  3484. <div class="description">
  3485. <p>Shadow Render Object Function.</p>
  3486. </div>
  3487. <table class="params">
  3488. <tbody>
  3489. <tr>
  3490. <td class="name">
  3491. <strong translate="no">object</strong>
  3492. </td>
  3493. <td class="description last">
  3494. <p>The 3D object to render.</p>
  3495. </td>
  3496. </tr>
  3497. <tr>
  3498. <td class="name">
  3499. <strong translate="no">scene</strong>
  3500. </td>
  3501. <td class="description last">
  3502. <p>The scene containing the object.</p>
  3503. </td>
  3504. </tr>
  3505. <tr>
  3506. <td class="name">
  3507. <strong translate="no">_camera</strong>
  3508. </td>
  3509. <td class="description last">
  3510. <p>The camera used for rendering.</p>
  3511. </td>
  3512. </tr>
  3513. <tr>
  3514. <td class="name">
  3515. <strong translate="no">geometry</strong>
  3516. </td>
  3517. <td class="description last">
  3518. <p>The geometry of the object.</p>
  3519. </td>
  3520. </tr>
  3521. <tr>
  3522. <td class="name">
  3523. <strong translate="no">material</strong>
  3524. </td>
  3525. <td class="description last">
  3526. <p>The material of the object.</p>
  3527. </td>
  3528. </tr>
  3529. <tr>
  3530. <td class="name">
  3531. <strong translate="no">group</strong>
  3532. </td>
  3533. <td class="description last">
  3534. <p>The group the object belongs to.</p>
  3535. </td>
  3536. </tr>
  3537. <tr>
  3538. <td class="name">
  3539. <strong translate="no">params</strong>
  3540. </td>
  3541. <td class="description last">
  3542. <p>Additional parameters for rendering.</p>
  3543. </td>
  3544. </tr>
  3545. </tbody>
  3546. </table>
  3547. </div>
  3548. <h3 class="name name-method" id="smootherstep" translate="no">.<a href="#smootherstep">smootherstep</a><span class="signature">( x : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3549. <div class="method">
  3550. <div class="description">
  3551. <p>A <a href="https://en.wikipedia.org/wiki/Smoothstep#Variations" target="_blank" rel="noopener">variation on smoothstep</a>
  3552. that has zero 1st and 2nd order derivatives at <code>x=0</code> and <code>x=1</code>.</p>
  3553. </div>
  3554. <table class="params">
  3555. <tbody>
  3556. <tr>
  3557. <td class="name">
  3558. <strong translate="no">x</strong>
  3559. </td>
  3560. <td class="description last">
  3561. <p>The value to evaluate based on its position between <code>min</code> and <code>max</code>.</p>
  3562. </td>
  3563. </tr>
  3564. <tr>
  3565. <td class="name">
  3566. <strong translate="no">min</strong>
  3567. </td>
  3568. <td class="description last">
  3569. <p>The min value. Any <code>x</code> value below <code>min</code> will be <code>0</code>. <code>min</code> must be lower than <code>max</code>.</p>
  3570. </td>
  3571. </tr>
  3572. <tr>
  3573. <td class="name">
  3574. <strong translate="no">max</strong>
  3575. </td>
  3576. <td class="description last">
  3577. <p>The max value. Any <code>x</code> value above <code>max</code> will be <code>1</code>. <code>max</code> must be greater than <code>min</code>.</p>
  3578. </td>
  3579. </tr>
  3580. </tbody>
  3581. </table>
  3582. <dl class="details">
  3583. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  3584. </dl>
  3585. </div>
  3586. <h3 class="name name-method" id="smoothstep" translate="no">.<a href="#smoothstep">smoothstep</a><span class="signature">( x : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3587. <div class="method">
  3588. <div class="description">
  3589. <p>Returns a value in the range <code>[0,1]</code> that represents the percentage that <code>x</code> has
  3590. moved between <code>min</code> and <code>max</code>, but smoothed or slowed down the closer <code>x</code> is to
  3591. the <code>min</code> and <code>max</code>.</p>
  3592. <p>See <a href="http://en.wikipedia.org/wiki/Smoothstep" target="_blank" rel="noopener">Smoothstep</a> for more details.</p>
  3593. </div>
  3594. <table class="params">
  3595. <tbody>
  3596. <tr>
  3597. <td class="name">
  3598. <strong translate="no">x</strong>
  3599. </td>
  3600. <td class="description last">
  3601. <p>The value to evaluate based on its position between <code>min</code> and <code>max</code>.</p>
  3602. </td>
  3603. </tr>
  3604. <tr>
  3605. <td class="name">
  3606. <strong translate="no">min</strong>
  3607. </td>
  3608. <td class="description last">
  3609. <p>The min value. Any <code>x</code> value below <code>min</code> will be <code>0</code>. <code>min</code> must be lower than <code>max</code>.</p>
  3610. </td>
  3611. </tr>
  3612. <tr>
  3613. <td class="name">
  3614. <strong translate="no">max</strong>
  3615. </td>
  3616. <td class="description last">
  3617. <p>The max value. Any <code>x</code> value above <code>max</code> will be <code>1</code>. <code>max</code> must be greater than <code>min</code>.</p>
  3618. </td>
  3619. </tr>
  3620. </tbody>
  3621. </table>
  3622. <dl class="details">
  3623. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  3624. </dl>
  3625. </div>
  3626. <h3 class="name name-method" id="sortedArray" translate="no">.<a href="#sortedArray">sortedArray</a><span class="signature">( values : <span class="param-type">Array.&lt;number></span>, stride : <span class="param-type">number</span>, order : <span class="param-type">Array.&lt;number></span> )</span><span class="type-signature"> : Array.&lt;number></span> </h3>
  3627. <div class="method">
  3628. <div class="description">
  3629. <p>Sorts the given array by the previously computed order via <code>getKeyframeOrder()</code>.</p>
  3630. </div>
  3631. <table class="params">
  3632. <tbody>
  3633. <tr>
  3634. <td class="name">
  3635. <strong translate="no">values</strong>
  3636. </td>
  3637. <td class="description last">
  3638. <p>The values to sort.</p>
  3639. </td>
  3640. </tr>
  3641. <tr>
  3642. <td class="name">
  3643. <strong translate="no">stride</strong>
  3644. </td>
  3645. <td class="description last">
  3646. <p>The stride.</p>
  3647. </td>
  3648. </tr>
  3649. <tr>
  3650. <td class="name">
  3651. <strong translate="no">order</strong>
  3652. </td>
  3653. <td class="description last">
  3654. <p>The sort order.</p>
  3655. </td>
  3656. </tr>
  3657. </tbody>
  3658. </table>
  3659. <dl class="details">
  3660. <dt class="tag-returns"><strong>Returns:</strong> The sorted values.</dt>
  3661. </dl>
  3662. </div>
  3663. <h3 class="name name-method" id="subclip" translate="no">.<a href="#subclip">subclip</a><span class="signature">( sourceClip : <span class="param-type"><a href="AnimationClip.html">AnimationClip</a></span>, name : <span class="param-type">string</span>, startFrame : <span class="param-type">number</span>, endFrame : <span class="param-type">number</span>, fps : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="AnimationClip.html">AnimationClip</a></span> </h3>
  3664. <div class="method">
  3665. <div class="description">
  3666. <p>Creates a new clip, containing only the segment of the original clip between the given frames.</p>
  3667. </div>
  3668. <table class="params">
  3669. <tbody>
  3670. <tr>
  3671. <td class="name">
  3672. <strong translate="no">sourceClip</strong>
  3673. </td>
  3674. <td class="description last">
  3675. <p>The values to sort.</p>
  3676. </td>
  3677. </tr>
  3678. <tr>
  3679. <td class="name">
  3680. <strong translate="no">name</strong>
  3681. </td>
  3682. <td class="description last">
  3683. <p>The name of the clip.</p>
  3684. </td>
  3685. </tr>
  3686. <tr>
  3687. <td class="name">
  3688. <strong translate="no">startFrame</strong>
  3689. </td>
  3690. <td class="description last">
  3691. <p>The start frame.</p>
  3692. </td>
  3693. </tr>
  3694. <tr>
  3695. <td class="name">
  3696. <strong translate="no">endFrame</strong>
  3697. </td>
  3698. <td class="description last">
  3699. <p>The end frame.</p>
  3700. </td>
  3701. </tr>
  3702. <tr>
  3703. <td class="name">
  3704. <strong translate="no">fps</strong>
  3705. </td>
  3706. <td class="description last">
  3707. <p>The FPS.</p>
  3708. <p>Default is <code>30</code>.</p>
  3709. </td>
  3710. </tr>
  3711. </tbody>
  3712. </table>
  3713. <dl class="details">
  3714. <dt class="tag-returns"><strong>Returns:</strong> The new sub clip.</dt>
  3715. </dl>
  3716. </div>
  3717. <h3 class="name name-method" id="toHalfFloat" translate="no">.<a href="#toHalfFloat">toHalfFloat</a><span class="signature">( val : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  3718. <div class="method">
  3719. <div class="description">
  3720. <p>Returns a half precision floating point value (FP16) from the given single
  3721. precision floating point value (FP32).</p>
  3722. </div>
  3723. <table class="params">
  3724. <tbody>
  3725. <tr>
  3726. <td class="name">
  3727. <strong translate="no">val</strong>
  3728. </td>
  3729. <td class="description last">
  3730. <p>A single precision floating point value.</p>
  3731. </td>
  3732. </tr>
  3733. </tbody>
  3734. </table>
  3735. <dl class="details">
  3736. <dt class="tag-returns"><strong>Returns:</strong> The FP16 value.</dt>
  3737. </dl>
  3738. </div>
  3739. <h3 class="name name-method" id="updateCamera" translate="no">.<a href="#updateCamera">updateCamera</a><span class="signature">( camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, parent : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  3740. <div class="method">
  3741. <div class="description">
  3742. <p>Updates the world matrices for the given camera based on the parent 3D object.</p>
  3743. </div>
  3744. <table class="params">
  3745. <tbody>
  3746. <tr>
  3747. <td class="name">
  3748. <strong translate="no">camera</strong>
  3749. </td>
  3750. <td class="description last">
  3751. <p>The camera to update.</p>
  3752. </td>
  3753. </tr>
  3754. <tr>
  3755. <td class="name">
  3756. <strong translate="no">parent</strong>
  3757. </td>
  3758. <td class="description last">
  3759. <p>The parent 3D object.</p>
  3760. </td>
  3761. </tr>
  3762. </tbody>
  3763. </table>
  3764. </div>
  3765. <h3 class="name name-method" id="updateUserCamera" translate="no">.<a href="#updateUserCamera">updateUserCamera</a><span class="signature">( camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, cameraXR : <span class="param-type"><a href="ArrayCamera.html">ArrayCamera</a></span>, parent : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  3766. <div class="method">
  3767. <div class="description">
  3768. <p>Updates the given camera with the transformation of the XR camera and parent object.</p>
  3769. </div>
  3770. <table class="params">
  3771. <tbody>
  3772. <tr>
  3773. <td class="name">
  3774. <strong translate="no">camera</strong>
  3775. </td>
  3776. <td class="description last">
  3777. <p>The camera to update.</p>
  3778. </td>
  3779. </tr>
  3780. <tr>
  3781. <td class="name">
  3782. <strong translate="no">cameraXR</strong>
  3783. </td>
  3784. <td class="description last">
  3785. <p>The XR camera.</p>
  3786. </td>
  3787. </tr>
  3788. <tr>
  3789. <td class="name">
  3790. <strong translate="no">parent</strong>
  3791. </td>
  3792. <td class="description last">
  3793. <p>The parent 3D object.</p>
  3794. </td>
  3795. </tr>
  3796. </tbody>
  3797. </table>
  3798. </div>
  3799. <h3 class="name name-method" id="warn" translate="no">.<a href="#warn">warn</a><span class="signature">( &hellip;params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
  3800. <div class="method">
  3801. <div class="description">
  3802. <p>Logs a warning message with the 'THREE.' prefix.</p>
  3803. <p>If a custom console function is set via setConsoleFunction(), it will be used
  3804. instead of the native console.warn. The first parameter is treated as the
  3805. method name and is automatically prefixed with 'THREE.'.</p>
  3806. </div>
  3807. <table class="params">
  3808. <tbody>
  3809. <tr>
  3810. <td class="name">
  3811. <strong translate="no">params</strong>
  3812. </td>
  3813. <td class="description last">
  3814. <p>The message components. The first param is used as
  3815. the method name and prefixed with 'THREE.'.</p>
  3816. </td>
  3817. </tr>
  3818. </tbody>
  3819. </table>
  3820. </div>
  3821. <h3 class="name name-method" id="warnOnce" translate="no">.<a href="#warnOnce">warnOnce</a><span class="signature">( &hellip;params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
  3822. <div class="method">
  3823. <div class="description">
  3824. <p>Logs a warning message only once, preventing duplicate warnings.</p>
  3825. <p>This function maintains an internal cache of warning messages and will only
  3826. output each unique warning message once. Useful for warnings that may be
  3827. triggered repeatedly but should only be shown to the user once.</p>
  3828. </div>
  3829. <table class="params">
  3830. <tbody>
  3831. <tr>
  3832. <td class="name">
  3833. <strong translate="no">params</strong>
  3834. </td>
  3835. <td class="description last">
  3836. <p>The warning message components.</p>
  3837. </td>
  3838. </tr>
  3839. </tbody>
  3840. </table>
  3841. </div>
  3842. <h2 class="subsection-title">Type Definitions</h2>
  3843. <div class="member">
  3844. <h3 class="name" id="ConstantsInterpolationSamplingMode" translate="no">.<a href="#ConstantsInterpolationSamplingMode">ConstantsInterpolationSamplingMode</a> </h3>
  3845. <div class="description">
  3846. <p>Represents the different interpolation sampling modes.</p>
  3847. </div>
  3848. <table class="props">
  3849. <tbody>
  3850. <tr>
  3851. <td class="name">
  3852. <strong>NORMAL</strong>
  3853. <br>
  3854. <span class="param-type">string</span>
  3855. </td>
  3856. <td class="description last">
  3857. <p>Normal sampling mode.</p>
  3858. </td>
  3859. </tr>
  3860. <tr>
  3861. <td class="name">
  3862. <strong>CENTROID</strong>
  3863. <br>
  3864. <span class="param-type">string</span>
  3865. </td>
  3866. <td class="description last">
  3867. <p>Centroid sampling mode.</p>
  3868. </td>
  3869. </tr>
  3870. <tr>
  3871. <td class="name">
  3872. <strong>SAMPLE</strong>
  3873. <br>
  3874. <span class="param-type">string</span>
  3875. </td>
  3876. <td class="description last">
  3877. <p>Sample-specific sampling mode.</p>
  3878. </td>
  3879. </tr>
  3880. <tr>
  3881. <td class="name">
  3882. <strong>FIRST</strong>
  3883. <br>
  3884. <span class="param-type">string</span>
  3885. </td>
  3886. <td class="description last">
  3887. <p>Flat interpolation using the first vertex.</p>
  3888. </td>
  3889. </tr>
  3890. <tr>
  3891. <td class="name">
  3892. <strong>EITHER</strong>
  3893. <br>
  3894. <span class="param-type">string</span>
  3895. </td>
  3896. <td class="description last">
  3897. <p>Flat interpolation using either vertex.</p>
  3898. </td>
  3899. </tr>
  3900. </tbody>
  3901. </table>
  3902. </div>
  3903. <div class="member">
  3904. <h3 class="name" id="ConstantsInterpolationSamplingType" translate="no">.<a href="#ConstantsInterpolationSamplingType">ConstantsInterpolationSamplingType</a> </h3>
  3905. <div class="description">
  3906. <p>Represents the different interpolation sampling types.</p>
  3907. </div>
  3908. <table class="props">
  3909. <tbody>
  3910. <tr>
  3911. <td class="name">
  3912. <strong>PERSPECTIVE</strong>
  3913. <br>
  3914. <span class="param-type">string</span>
  3915. </td>
  3916. <td class="description last">
  3917. <p>Perspective-correct interpolation.</p>
  3918. </td>
  3919. </tr>
  3920. <tr>
  3921. <td class="name">
  3922. <strong>LINEAR</strong>
  3923. <br>
  3924. <span class="param-type">string</span>
  3925. </td>
  3926. <td class="description last">
  3927. <p>Linear interpolation.</p>
  3928. </td>
  3929. </tr>
  3930. <tr>
  3931. <td class="name">
  3932. <strong>FLAT</strong>
  3933. <br>
  3934. <span class="param-type">string</span>
  3935. </td>
  3936. <td class="description last">
  3937. <p>Flat interpolation.</p>
  3938. </td>
  3939. </tr>
  3940. </tbody>
  3941. </table>
  3942. </div>
  3943. <div class="member">
  3944. <h3 class="name" id="ConstantsMouse" translate="no">.<a href="#ConstantsMouse">ConstantsMouse</a> </h3>
  3945. <div class="description">
  3946. <p>This type represents mouse buttons and interaction types in context of controls.</p>
  3947. </div>
  3948. <table class="props">
  3949. <tbody>
  3950. <tr>
  3951. <td class="name">
  3952. <strong>MIDDLE</strong>
  3953. <br>
  3954. <span class="param-type">number</span>
  3955. </td>
  3956. <td class="description last">
  3957. <p>The left mouse button.</p>
  3958. </td>
  3959. </tr>
  3960. <tr>
  3961. <td class="name">
  3962. <strong>LEFT</strong>
  3963. <br>
  3964. <span class="param-type">number</span>
  3965. </td>
  3966. <td class="description last">
  3967. <p>The middle mouse button.</p>
  3968. </td>
  3969. </tr>
  3970. <tr>
  3971. <td class="name">
  3972. <strong>RIGHT</strong>
  3973. <br>
  3974. <span class="param-type">number</span>
  3975. </td>
  3976. <td class="description last">
  3977. <p>The right mouse button.</p>
  3978. </td>
  3979. </tr>
  3980. <tr>
  3981. <td class="name">
  3982. <strong>ROTATE</strong>
  3983. <br>
  3984. <span class="param-type">number</span>
  3985. </td>
  3986. <td class="description last">
  3987. <p>A rotate interaction.</p>
  3988. </td>
  3989. </tr>
  3990. <tr>
  3991. <td class="name">
  3992. <strong>DOLLY</strong>
  3993. <br>
  3994. <span class="param-type">number</span>
  3995. </td>
  3996. <td class="description last">
  3997. <p>A dolly interaction.</p>
  3998. </td>
  3999. </tr>
  4000. <tr>
  4001. <td class="name">
  4002. <strong>PAN</strong>
  4003. <br>
  4004. <span class="param-type">number</span>
  4005. </td>
  4006. <td class="description last">
  4007. <p>A pan interaction.</p>
  4008. </td>
  4009. </tr>
  4010. </tbody>
  4011. </table>
  4012. </div>
  4013. <div class="member">
  4014. <h3 class="name" id="ConstantsTimestampQuery" translate="no">.<a href="#ConstantsTimestampQuery">ConstantsTimestampQuery</a> </h3>
  4015. <div class="description">
  4016. <p>This type represents the different timestamp query types.</p>
  4017. </div>
  4018. <table class="props">
  4019. <tbody>
  4020. <tr>
  4021. <td class="name">
  4022. <strong>COMPUTE</strong>
  4023. <br>
  4024. <span class="param-type">string</span>
  4025. </td>
  4026. <td class="description last">
  4027. <p>A <code>compute</code> timestamp query.</p>
  4028. </td>
  4029. </tr>
  4030. <tr>
  4031. <td class="name">
  4032. <strong>RENDER</strong>
  4033. <br>
  4034. <span class="param-type">string</span>
  4035. </td>
  4036. <td class="description last">
  4037. <p>A <code>render</code> timestamp query.</p>
  4038. </td>
  4039. </tr>
  4040. </tbody>
  4041. </table>
  4042. </div>
  4043. <div class="member">
  4044. <h3 class="name" id="ConstantsTouch" translate="no">.<a href="#ConstantsTouch">ConstantsTouch</a> </h3>
  4045. <div class="description">
  4046. <p>This type represents touch interaction types in context of controls.</p>
  4047. </div>
  4048. <table class="props">
  4049. <tbody>
  4050. <tr>
  4051. <td class="name">
  4052. <strong>ROTATE</strong>
  4053. <br>
  4054. <span class="param-type">number</span>
  4055. </td>
  4056. <td class="description last">
  4057. <p>A rotate interaction.</p>
  4058. </td>
  4059. </tr>
  4060. <tr>
  4061. <td class="name">
  4062. <strong>PAN</strong>
  4063. <br>
  4064. <span class="param-type">number</span>
  4065. </td>
  4066. <td class="description last">
  4067. <p>A pan interaction.</p>
  4068. </td>
  4069. </tr>
  4070. <tr>
  4071. <td class="name">
  4072. <strong>DOLLY_PAN</strong>
  4073. <br>
  4074. <span class="param-type">number</span>
  4075. </td>
  4076. <td class="description last">
  4077. <p>The dolly-pan interaction.</p>
  4078. </td>
  4079. </tr>
  4080. <tr>
  4081. <td class="name">
  4082. <strong>DOLLY_ROTATE</strong>
  4083. <br>
  4084. <span class="param-type">number</span>
  4085. </td>
  4086. <td class="description last">
  4087. <p>A dolly-rotate interaction.</p>
  4088. </td>
  4089. </tr>
  4090. </tbody>
  4091. </table>
  4092. </div>
  4093. <div class="member">
  4094. <h3 class="name" id="DebugConfig" translate="no">.<a href="#DebugConfig">DebugConfig</a> </h3>
  4095. <div class="description">
  4096. <p>Debug configuration.</p>
  4097. </div>
  4098. <table class="props">
  4099. <tbody>
  4100. <tr>
  4101. <td class="name">
  4102. <strong>checkShaderErrors</strong>
  4103. <br>
  4104. <span class="param-type">boolean</span>
  4105. </td>
  4106. <td class="description last">
  4107. <p>Whether shader errors should be checked or not.</p>
  4108. </td>
  4109. </tr>
  4110. <tr>
  4111. <td class="name">
  4112. <strong>onShaderError</strong>
  4113. <br>
  4114. <span class="param-type">function</span>
  4115. </td>
  4116. <td class="description last">
  4117. <p>A callback function that is executed when a shader error happens. Only supported with WebGL 2 right now.</p>
  4118. </td>
  4119. </tr>
  4120. <tr>
  4121. <td class="name">
  4122. <strong>getShaderAsync</strong>
  4123. <br>
  4124. <span class="param-type">function</span>
  4125. </td>
  4126. <td class="description last">
  4127. <p>Allows the get the raw shader code for the given scene, camera and 3D object.</p>
  4128. </td>
  4129. </tr>
  4130. </tbody>
  4131. </table>
  4132. </div>
  4133. <div class="member">
  4134. <h3 class="name" id="ShadowMapConfig" translate="no">.<a href="#ShadowMapConfig">ShadowMapConfig</a> </h3>
  4135. <div class="description">
  4136. <p>Shadow map configuration</p>
  4137. </div>
  4138. <table class="props">
  4139. <tbody>
  4140. <tr>
  4141. <td class="name">
  4142. <strong>enabled</strong>
  4143. <br>
  4144. <span class="param-type">boolean</span>
  4145. </td>
  4146. <td class="description last">
  4147. <p>Whether to globally enable shadows or not.</p>
  4148. </td>
  4149. </tr>
  4150. <tr>
  4151. <td class="name">
  4152. <strong>transmitted</strong>
  4153. <br>
  4154. <span class="param-type">boolean</span>
  4155. </td>
  4156. <td class="description last">
  4157. <p>Whether to enable light transmission through non-opaque materials.</p>
  4158. </td>
  4159. </tr>
  4160. <tr>
  4161. <td class="name">
  4162. <strong>type</strong>
  4163. <br>
  4164. <span class="param-type">number</span>
  4165. </td>
  4166. <td class="description last">
  4167. <p>The shadow map type.</p>
  4168. </td>
  4169. </tr>
  4170. </tbody>
  4171. </table>
  4172. </div>
  4173. <div class="member">
  4174. <h3 class="name" id="XRConfig" translate="no">.<a href="#XRConfig">XRConfig</a> </h3>
  4175. <div class="description">
  4176. <p>XR configuration.</p>
  4177. </div>
  4178. <table class="props">
  4179. <tbody>
  4180. <tr>
  4181. <td class="name">
  4182. <strong>enabled</strong>
  4183. <br>
  4184. <span class="param-type">boolean</span>
  4185. </td>
  4186. <td class="description last">
  4187. <p>Whether to globally enable XR or not.</p>
  4188. </td>
  4189. </tr>
  4190. </tbody>
  4191. </table>
  4192. </div>
  4193. <h3 class="name name-method" id="onAnimationCallback" translate="no">.<a href="#onAnimationCallback">onAnimationCallback</a><span class="signature">( time : <span class="param-type">DOMHighResTimeStamp</span>, frame : <span class="param-type">XRFrame</span> )</span> </h3>
  4194. <div class="method">
  4195. <div class="description">
  4196. <p>Animation loop parameter of <code>renderer.setAnimationLoop()</code>.</p>
  4197. </div>
  4198. <table class="params">
  4199. <tbody>
  4200. <tr>
  4201. <td class="name">
  4202. <strong translate="no">time</strong>
  4203. </td>
  4204. <td class="description last">
  4205. <p>A timestamp indicating the end time of the previous frame's rendering.</p>
  4206. </td>
  4207. </tr>
  4208. <tr>
  4209. <td class="name">
  4210. <strong translate="no">frame</strong>
  4211. </td>
  4212. <td class="description last">
  4213. <p>A reference to the current XR frame. Only relevant when using XR rendering.</p>
  4214. </td>
  4215. </tr>
  4216. </tbody>
  4217. </table>
  4218. </div>
  4219. <h3 class="name name-method" id="onErrorCallback" translate="no">.<a href="#onErrorCallback">onErrorCallback</a><span class="signature">( error : <span class="param-type">Error</span> )</span> </h3>
  4220. <div class="method">
  4221. <div class="description">
  4222. <p>Callback for onError in loaders.</p>
  4223. </div>
  4224. <table class="params">
  4225. <tbody>
  4226. <tr>
  4227. <td class="name">
  4228. <strong translate="no">error</strong>
  4229. </td>
  4230. <td class="description last">
  4231. <p>The error which occurred during the loading process.</p>
  4232. </td>
  4233. </tr>
  4234. </tbody>
  4235. </table>
  4236. </div>
  4237. <h3 class="name name-method" id="onProgressCallback" translate="no">.<a href="#onProgressCallback">onProgressCallback</a><span class="signature">( event : <span class="param-type">ProgressEvent</span> )</span> </h3>
  4238. <div class="method">
  4239. <div class="description">
  4240. <p>Callback for onProgress in loaders.</p>
  4241. </div>
  4242. <table class="params">
  4243. <tbody>
  4244. <tr>
  4245. <td class="name">
  4246. <strong translate="no">event</strong>
  4247. </td>
  4248. <td class="description last">
  4249. <p>An instance of <code>ProgressEvent</code> that represents the current loading status.</p>
  4250. </td>
  4251. </tr>
  4252. </tbody>
  4253. </table>
  4254. </div>
  4255. <h3 class="name name-method" id="renderObjectFunction" translate="no">.<a href="#renderObjectFunction">renderObjectFunction</a><span class="signature">( object : <span class="param-type"><a href="Object3D.html">Object3D</a></span>, scene : <span class="param-type"><a href="Scene.html">Scene</a></span>, camera : <span class="param-type"><a href="Camera.html">Camera</a></span>, geometry : <span class="param-type"><a href="BufferGeometry.html">BufferGeometry</a></span>, material : <span class="param-type"><a href="Material.html">Material</a></span>, group : <span class="param-type">Object</span>, lightsNode : <span class="param-type"><a href="LightsNode.html">LightsNode</a></span>, clippingContext : <span class="param-type"><a href="ClippingContext.html">ClippingContext</a></span>, passId : <span class="param-type">string</span> )</span> </h3>
  4256. <div class="method">
  4257. <div class="description">
  4258. <p>Callback for <a href="Renderer.html#setRenderObjectFunction">Renderer#setRenderObjectFunction</a>.</p>
  4259. </div>
  4260. <table class="params">
  4261. <tbody>
  4262. <tr>
  4263. <td class="name">
  4264. <strong translate="no">object</strong>
  4265. </td>
  4266. <td class="description last">
  4267. <p>The 3D object.</p>
  4268. </td>
  4269. </tr>
  4270. <tr>
  4271. <td class="name">
  4272. <strong translate="no">scene</strong>
  4273. </td>
  4274. <td class="description last">
  4275. <p>The scene the 3D object belongs to.</p>
  4276. </td>
  4277. </tr>
  4278. <tr>
  4279. <td class="name">
  4280. <strong translate="no">camera</strong>
  4281. </td>
  4282. <td class="description last">
  4283. <p>The camera the object should be rendered with.</p>
  4284. </td>
  4285. </tr>
  4286. <tr>
  4287. <td class="name">
  4288. <strong translate="no">geometry</strong>
  4289. </td>
  4290. <td class="description last">
  4291. <p>The object's geometry.</p>
  4292. </td>
  4293. </tr>
  4294. <tr>
  4295. <td class="name">
  4296. <strong translate="no">material</strong>
  4297. </td>
  4298. <td class="description last">
  4299. <p>The object's material.</p>
  4300. </td>
  4301. </tr>
  4302. <tr>
  4303. <td class="name">
  4304. <strong translate="no">group</strong>
  4305. </td>
  4306. <td class="description last">
  4307. <p>Only relevant for objects using multiple materials. This represents a group entry from the respective <code>BufferGeometry</code>.</p>
  4308. </td>
  4309. </tr>
  4310. <tr>
  4311. <td class="name">
  4312. <strong translate="no">lightsNode</strong>
  4313. </td>
  4314. <td class="description last">
  4315. <p>The current lights node.</p>
  4316. </td>
  4317. </tr>
  4318. <tr>
  4319. <td class="name">
  4320. <strong translate="no">clippingContext</strong>
  4321. </td>
  4322. <td class="description last">
  4323. <p>The clipping context.</p>
  4324. </td>
  4325. </tr>
  4326. <tr>
  4327. <td class="name">
  4328. <strong translate="no">passId</strong>
  4329. </td>
  4330. <td class="description last">
  4331. <p>An optional ID for identifying the pass.</p>
  4332. <p>Default is <code>null</code>.</p>
  4333. </td>
  4334. </tr>
  4335. </tbody>
  4336. </table>
  4337. </div>
  4338. <h3 class="name name-method" id="traverseCallback" translate="no">.<a href="#traverseCallback">traverseCallback</a><span class="signature">( node : <span class="param-type"><a href="Node.html">Node</a></span> )</span> </h3>
  4339. <div class="method">
  4340. <div class="description">
  4341. <p>Callback for <a href="Node.html#traverse">Node#traverse</a>.</p>
  4342. </div>
  4343. <table class="params">
  4344. <tbody>
  4345. <tr>
  4346. <td class="name">
  4347. <strong translate="no">node</strong>
  4348. </td>
  4349. <td class="description last">
  4350. <p>The current node.</p>
  4351. </td>
  4352. </tr>
  4353. </tbody>
  4354. </table>
  4355. </div>
  4356. </article>
  4357. </section>
  4358. <script src="../scripts/linenumber.js"></script>
  4359. <script src="../scripts/page.js"></script>
  4360. </body>
  4361. </html>
粤ICP备19079148号