| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Global - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <h1 translate="no">Global</h1>
- <section>
- <header>
- </header>
- <article>
- <div class="container-overview">
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <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>
- <div class="description">
- <p>ACES Filmic tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A <code>source + destination</code> blending equation.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Adds the two colors.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Additive animation blend mode. Can be used to layer motions on top of
- each other to build complex performances from smaller re-usable assets.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents additive blending.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>AgX tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discards the red, green and blue components and reads just the alpha component.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Always pass.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Always pass.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will always return true.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The skinned mesh shares the same world space as the skeleton.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Only back faces are rendered.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The depth value is inverted (1.0 - z) for visualization purposes.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Gives unfiltered shadow maps - fastest, but lowest quality.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A byte data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Cineon tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The last pixel of the texture stretches to the edge of the mesh.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Compatibility flags for features that may not be supported across all platforms.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by a constant alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by a constant color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reflection mapping for cube textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Refraction mapping for cube textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reflection mapping for PMREM textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Culls back faces.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Culls front faces.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Culls both front and back faces.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Disables face culling.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents custom blending.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Custom tone mapping.</p>
- <p>Expects a custom implementation by modifying shader code of the material's fragment shader.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="DATA" translate="no">.<a href="#DATA">DATA</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Precomputed DFG LUT for Image-Based Lighting
- Resolution: 16x16
- Samples: 4096 per texel
- Format: RG16F (2 half floats per texel: scale, bias)</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Decrements the current stencil buffer value. Clamps to <code>0</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable
- unsigned value when decrementing a stencil buffer value of <code>0</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The global default loading manager.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reads each element as a single depth value, converts it to floating point, and clamps to the range <code>[0,1]</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reads each element is a pair of depth and stencil values. The depth component of the pair is interpreted as
- in <code>DepthFormat</code>. The stencil component is interpreted based on the depth + stencil internal format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The skinned mesh does not share the same world space as the skeleton.
- This is useful when a skeleton is shared across multiple skinned meshes.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Both front and back faces are rendered.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by the destination alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by the destination color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be respecified repeatedly by reading data from the 3D API, and used many times
- as the source for WebGL drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be respecified repeatedly by the application, and
- used many times as the source for drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be respecified repeatedly by reading data from the 3D API, and queried
- many times by the application.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value equals the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value equals the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is equal to the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reflection mapping for equirectangular textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Refraction mapping for equirectangular textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A float data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Only front faces are rendered.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>GLSL 1 shader code.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>GLSL 3 shader code.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is greater than the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is greater than the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is greater than or equal to the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is greater than or equal to the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is greater than or equal to the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is greater than the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A half float data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing
- the maximum representable unsigned value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An int data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discrete interpolation mode for keyframe tracks.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Linear interpolation mode for keyframe tracks.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Smooth interpolation mode for keyframe tracks.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents the different interpolation sampling modes.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents mouse buttons and interaction types in context of controls.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Inverts the current stencil buffer value bitwise.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The KHR_mesh_quantization extension allows these extra attribute component types</p>
- </div>
- <dl class="details">
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <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>
- </ul>
- </dd>
- </dl>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Keeps the current value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is less than the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is less than the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is less than or equal to the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is less than or equal to the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is less than or equal to the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is less than the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Returns the weighted average of the four texture elements that are closest to the specified
- texture coordinates, and can include items wrapped or repeated from other parts of a texture,
- depending on the values of <code>wrapS</code> and <code>wrapT</code>, and on the exact mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Chooses the two mipmaps that most closely match the size of the pixel being textured and uses
- the <code>LinearFilter</code> criterion to produce a texture value from each mipmap. The final texture value
- is a weighted average of those two values.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Chooses the mipmap that most closely matches the size of the pixel being textured and uses
- the <code>LinearFilter</code> criterion (a weighted average of the four texels that are closest to the
- center of the pixel) to produce a texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>sRGB-linear color space.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Linear tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Linear transfer function.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Animations are played once.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Animations are played with a chosen number of repetitions, alternately playing forward
- and backward.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Animations are played with a chosen number of repetitions, each time jumping from
- the end of the clip directly to its beginning.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents mouse buttons and interaction types in context of controls.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A blend equation that uses the maximum of source and destination.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A blend equation that uses the minimum of source and destination.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The texture will repeats to infinity, mirroring on each repeat.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Uses reflectivity to blend between the two colors.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents multiply blending.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies the environment map color with the surface color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Returns the value of the texture element that is nearest (in Manhattan distance)
- to the specified texture coordinates.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Chooses the two mipmaps that most closely match the size of the pixel being textured and
- uses the <code>NearestFilter</code> criterion to produce a texture value from each mipmap.
- The final texture value is a weighted average of those two values.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Chooses the mipmap that most closely matches the size of the pixel being textured
- and uses the <code>NearestFilter</code> criterion (the texel nearest to the center of the pixel)
- to produce a texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Neutral tone mapping.</p>
- <p>Implementation based on the Khronos 3D Commerce Group standard tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Never pass.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Never pass.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will never return true.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>No blending is performed which effectively disables
- alpha transparency.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>No color space.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>No normal map packing.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>No tone mapping is applied.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="NodeAccess" translate="no">.<a href="#NodeAccess">NodeAccess</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Access types of a node. These are relevant for compute and storage usage.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>READ_ONLY</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Read-only access</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>WRITE_ONLY</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Write-only access.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>READ_WRITE</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Read and write access.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="NodeShaderStage" translate="no">.<a href="#NodeShaderStage">NodeShaderStage</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Possible shader stages.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>VERTEX</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>The vertex shader stage.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>FRAGMENT</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>The fragment shader stage.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="NodeType" translate="no">.<a href="#NodeType">NodeType</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Data types of a node.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>BOOLEAN</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Boolean type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>INTEGER</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Integer type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>FLOAT</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Float type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>VECTOR2</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Two-dimensional vector type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>VECTOR3</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Three-dimensional vector type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>VECTOR4</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Four-dimensional vector type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>MATRIX2</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>2x2 matrix type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>MATRIX3</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>3x3 matrix type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>MATRIX4</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>4x4 matrix type.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="NodeUpdateType" translate="no">.<a href="#NodeUpdateType">NodeUpdateType</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Update types of a node.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>NONE</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>The update method is not executed.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>FRAME</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>The update method is executed per frame.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>RENDER</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <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>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>OBJECT</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>The update method is executed per <a href="Object3D.html">Object3D</a> that uses the node for rendering.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Default animation blend mode.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The default blending.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Normal GA packing.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Normal RG packing.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is not equal to the texture value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Pass if the incoming value is not equal to the depth buffer value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Will return true if the stencil reference value is not equal to the current stencil value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Normal information is relative to the object orientation.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="OnBeforeMaterialUpdate" translate="no">.<a href="#OnBeforeMaterialUpdate">OnBeforeMaterialUpdate</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Creates an event that triggers a function before the material is updated.</p>
- <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>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="OnBeforeObjectUpdate" translate="no">.<a href="#OnBeforeObjectUpdate">OnBeforeObjectUpdate</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Creates an event that triggers a function before an object (Mesh|Sprite) is updated.</p>
- <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>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="OnMaterialUpdate" translate="no">.<a href="#OnMaterialUpdate">OnMaterialUpdate</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Creates an event that triggers a function when the first object that uses the material is rendered.</p>
- <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>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="OnObjectUpdate" translate="no">.<a href="#OnObjectUpdate">OnObjectUpdate</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Creates an event that triggers a function every time an object (Mesh|Sprite) is rendered.</p>
- <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>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by 1 minus a constant alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>1</code> minus a constant color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>1</code> minus the destination alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>1</code> minus each destination color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by 1 minus the source alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>1</code> minus each source color.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Filters shadow maps using the Percentage-Closer Filtering (PCF) algorithm with
- better soft shadows especially when using low-resolution shadow maps.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>EAC R11 UNORM format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>RGTC2 Red Green format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>RGTC1 Red format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>EAC RG11 UNORM format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The depth value is packed into 32 bit RGBA.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reads the red, green, blue and alpha components.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reads the red, green, blue and alpha components. The texels are read as integers instead of floating point.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 10x10 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 10x5 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 10x6 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 10x8 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 12x10 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 12x12 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 4x4 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 5x4 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 5x5 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 6x5 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 6x6 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 8x5 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 8x6 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ASTC RGBA 8x8 format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>BPTC RGBA format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ETC2 RGBA format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>PVRTC RGBA compression in 2-bit mode. One block for each 8×4 pixels.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>PVRTC RGBA compression in 4-bit mode. One block for each 4×4 pixels.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A DXT1-compressed image in an RGB image format with a simple on/off alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A DXT3-compressed image in an RGBA image format. Compared to a 32-bit RGBA texture, it offers 4:1 compression.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A DXT5-compressed image in an RGBA image format. It also provides a 4:1 compression, but differs to the DXT3
- compression in how the alpha compression is done.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The depth value is packed into 24 bit RGB.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discards the alpha component and reads the red, green and blue component.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discards the alpha component and reads the red, green and blue component. The texels are read as integers instead of floating point.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>BPTC Signed RGB format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>BPTC Unsigned RGB format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ETC1 RGB format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>ETC2 RGB format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>PVRTC RGB compression in 2-bit mode. One block for each 8×4 pixels.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>PVRTC RGB compression in 4-bit mode. One block for each 4×4 pixels.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A DXT1-compressed image in an RGB image format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The depth value is packed into 16 bit RG.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discards the alpha, and blue components and reads the red, and green components.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <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>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Discards the green, blue and alpha components and reads just the red component.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <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>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Reinhard tone mapping.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The texture will simply repeat to infinity.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Sets the stencil buffer value to the specified reference value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A <code>destination - source</code> blending equation.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>EAC R11 SNORM format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>RGTC2 Signed Red Green format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>RGTC1 Signed Red format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>EAC RG11 SNORM format.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>sRGB color space.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>sRGB transfer function.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>UltraHDR Image Format - https://developer.android.com/media/platform/hdr-image-format</p>
- <p>Short format brief:</p>
- <p>[JPEG headers]
- [XMP metadata describing the MPF container and <em>both</em> SDR and gainmap images]
- [Optional metadata] [EXIF] [ICC Profile]
- [SDR image]
- [XMP metadata describing only the gainmap image]
- [Gainmap image]</p>
- <p>Each section is separated by a 0xFFXX byte followed by a descriptor byte (0xFFE0, 0xFFE1, 0xFFE2.)
- Binary image storages are prefixed with a unique 0xFFD8 16-bit descriptor.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="ScriptableNodeResources" translate="no">.<a href="#ScriptableNodeResources">ScriptableNodeResources</a><span class="type-signature"> : <a href="Resources.html">Resources</a></span> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Defines the resources (e.g. namespaces) of scriptable nodes.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A short data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by the source alpha value.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies the RGB colors by the smaller of either the source alpha
- value or the value of <code>1</code> minus the destination alpha value. The alpha
- value is multiplied by <code>1</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by the source colors.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by reading data from the 3D API, and used many times as
- the source for WebGL drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by the application, and used many
- times as the source for drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by reading data from the 3D API, and queried
- many times by the application.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by reading data from the 3D API, and used at most a few times
- as the source for WebGL drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by the application, and used at most
- a few times as the source for drawing and image specification commands.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The contents are intended to be specified once by reading data from the 3D API, and queried at most
- a few times by the application</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>A <code>source - destination</code> blending equation.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents subtractive blending.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents touch interaction types in context of controls.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Normal information is relative to the underlying surface.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Represents the different timestamp query types.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>For each vertex draw a triangle from the first vertex and the last two vertices.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>For each vertex draw a triangle from the last three vertices.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>For every three vertices draw a single triangle.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Maps textures using the geometry's UV coordinates.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned byte data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned int 10_11_11 (packed) data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned int 24_8 data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned int 5_9_9_9 (packed) data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned int data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned short 4_4_4_4 (packed) data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned short 5_5_5_1 (packed) data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>An unsigned short data type for textures.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>References:</p>
- <ul>
- <li>https://github.khronos.org/KTX-Specification/ktxspec.v2.html</li>
- <li>https://registry.khronos.org/DataFormat/specs/1.3/dataformat.1.3.html</li>
- <li>https://github.com/donmccurdy/KTX-Parse</li>
- </ul>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Filters shadow maps using the Variance Shadow Map (VSM) algorithm.
- When using VSMShadowMap all shadow receivers will also cast shadows.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>WebGL coordinate system.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>WebGPU coordinate system.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Wrap around ending for animations.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Zero curvature ending for animations.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Multiplies all colors by <code>0</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Zero slope ending for animations.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>Sets the stencil buffer value to <code>0</code>.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="disposeShadowMaterial" translate="no">.<a href="#disposeShadowMaterial">disposeShadowMaterial</a> <span class="type-signature">(constant) </span></h3>
- <div class="description">
- <p>Disposes the shadow material for the given light source.</p>
- </div>
- </div>
- <div class="member">
- <h3 class="name" id="viewportResolution" translate="no">.<a href="#viewportResolution">viewportResolution</a> <span class="type-signature">(constant) </span></h3>
- <dl class="details">
- <dt class="important tag-deprecated"><strong>Deprecated:</strong> since r169. Use <a href="TSL.html#screenSize">screenSize</a> instead.</dt>
- </dl>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>A shadow filtering function performing basic filtering. This is in fact an unfiltered version of the shadow map
- with a binary <code>[0,1]</code> result.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>depthTexture</strong>
- </td>
- <td class="description last">
- <p>A reference to the shadow map's texture data.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadowCoord</strong>
- </td>
- <td class="description last">
- <p>The shadow coordinates.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
- </dl>
- </div>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>A shadow filtering function performing PCF filtering with Vogel disk sampling and IGN.</p>
- <p>Uses 5 samples distributed via Vogel disk pattern, rotated per-pixel using Interleaved
- Gradient Noise (IGN) to break up banding artifacts. Combined with hardware PCF (4-tap
- filtering per sample), this effectively provides 20 filtered taps with better distribution.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>depthTexture</strong>
- </td>
- <td class="description last">
- <p>A reference to the shadow map's texture data.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadowCoord</strong>
- </td>
- <td class="description last">
- <p>The shadow coordinates.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadow</strong>
- </td>
- <td class="description last">
- <p>The light shadow.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
- </dl>
- </div>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>A shadow filtering function performing PCF soft filtering.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>depthTexture</strong>
- </td>
- <td class="description last">
- <p>A reference to the shadow map's texture data.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadowCoord</strong>
- </td>
- <td class="description last">
- <p>The shadow coordinates.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadow</strong>
- </td>
- <td class="description last">
- <p>The light shadow.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
- </dl>
- </div>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>A shadow filtering function for point lights using Vogel disk sampling and IGN.</p>
- <p>Uses 5 samples distributed via Vogel disk pattern in tangent space around the
- sample direction, rotated per-pixel using Interleaved Gradient Noise (IGN).</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>depthTexture</strong>
- </td>
- <td class="description last">
- <p>A reference to the shadow cube map.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>bd3D</strong>
- </td>
- <td class="description last">
- <p>The normalized direction from light to fragment.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>dp</strong>
- </td>
- <td class="description last">
- <p>The depth value to compare against.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadow</strong>
- </td>
- <td class="description last">
- <p>The light shadow.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Add the given node to the current stack.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>node</strong>
- </td>
- <td class="description last">
- <p>The node to add.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The node that was added to the stack.</dt>
- </dl>
- </div>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>A shadow filtering function performing VSM filtering.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>depthTexture</strong>
- </td>
- <td class="description last">
- <p>A reference to the shadow map's texture data.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>shadowCoord</strong>
- </td>
- <td class="description last">
- <p>The shadow coordinates.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The filtering result.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Builds a 3D texture from a VOX chunk.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>chunk</strong>
- </td>
- <td class="description last">
- <p>A VOX chunk loaded via <a href="VOXLoader.html">VOXLoader</a>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The generated 3D texture.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Builds a mesh from a VOX chunk.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>chunk</strong>
- </td>
- <td class="description last">
- <p>A VOX chunk loaded via <a href="VOXLoader.html">VOXLoader</a>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The generated mesh.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns the smallest power of two that is greater than or equal to the given number.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The value to find a POT for.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The smallest power of two that is greater than or equal to the given number.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Clamps the given value between min and max.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The value to clamp.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>min</strong>
- </td>
- <td class="description last">
- <p>The min value.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>max</strong>
- </td>
- <td class="description last">
- <p>The max value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The clamped value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Scales the texture as large as possible within its surface without cropping
- or stretching the texture. The method preserves the original aspect ratio of
- the texture. Akin to CSS <code>object-fit: contain</code></p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>texture</strong>
- </td>
- <td class="description last">
- <p>The texture.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>aspect</strong>
- </td>
- <td class="description last">
- <p>The texture's aspect ratio.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Converts an array to a specific type.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>array</strong>
- </td>
- <td class="description last">
- <p>The array to convert.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>type</strong>
- </td>
- <td class="description last">
- <p>The constructor of a typed array that defines the new type.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The converted array.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Scales the texture to the smallest possible size to fill the surface, leaving
- no empty space. The method preserves the original aspect ratio of the texture.
- Akin to CSS <code>object-fit: cover</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>texture</strong>
- </td>
- <td class="description last">
- <p>The texture.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>aspect</strong>
- </td>
- <td class="description last">
- <p>The texture's aspect ratio.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Helper to create an EventNode and add it to the stack.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>type</strong>
- </td>
- <td class="description last">
- <p>The event type.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>callback</strong>
- </td>
- <td class="description last">
- <p>The callback function.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Smoothly interpolate a number from <code>x</code> to <code>y</code> in a spring-like manner using a delta
- time to maintain frame rate independent movement. For details, see
- <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>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The current point.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>y</strong>
- </td>
- <td class="description last">
- <p>The target point.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>lambda</strong>
- </td>
- <td class="description last">
- <p>A higher lambda value will make the movement more sudden,
- and a lower value will make the movement more gradual.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>dt</strong>
- </td>
- <td class="description last">
- <p>Delta time in seconds.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Converts degrees to radians.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>degrees</strong>
- </td>
- <td class="description last">
- <p>A value in degrees.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The converted value in radians.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Denormalizes the given value according to the given typed array.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The value to denormalize.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>array</strong>
- </td>
- <td class="description last">
- <p>The typed array that defines the data type of the value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The denormalize (float) value in the range <code>[0,1]</code>.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Computes the Euclidean modulo of the given parameters that
- is <code>( ( n % m ) + m ) % m</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>n</strong>
- </td>
- <td class="description last">
- <p>The first parameter.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>m</strong>
- </td>
- <td class="description last">
- <p>The second parameter.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The Euclidean modulo.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Configures the texture to the default transformation. Akin to CSS <code>object-fit: fill</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>texture</strong>
- </td>
- <td class="description last">
- <p>The texture.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The updated texture.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="flattenJSON" translate="no">.<a href="#flattenJSON">flattenJSON</a><span class="signature">( jsonKeys : <span class="param-type">Array.<number></span>, times : <span class="param-type">Array.<number></span>, values : <span class="param-type">Array.<number></span>, valuePropertyName : <span class="param-type">string</span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Used for parsing AOS keyframe formats.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>jsonKeys</strong>
- </td>
- <td class="description last">
- <p>A list of JSON keyframes.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>times</strong>
- </td>
- <td class="description last">
- <p>This array will be filled with keyframe times by this function.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>values</strong>
- </td>
- <td class="description last">
- <p>This array will be filled with keyframe values by this function.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>valuePropertyName</strong>
- </td>
- <td class="description last">
- <p>The name of the property to use.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns the largest power of two that is less than or equal to the given number.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The value to find a POT for.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The largest power of two that is less than or equal to the given number.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a single precision floating point value (FP32) from the given half
- precision floating point value (FP16).</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>val</strong>
- </td>
- <td class="description last">
- <p>A half precision floating point value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The FP32 value.</dt>
- </dl>
- </div>
- <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.<number></span> </h3>
- <div class="method">
- <div class="description">
- <p>Computes an array of magic square values required to generate the noise texture.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>size</strong>
- </td>
- <td class="description last">
- <p>The noise size.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The magic square values.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Generates the AO's noise texture for the given size.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>size</strong>
- </td>
- <td class="description last">
- <p>The noise size.</p>
- <p>Default is <code>5</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The generated noise texture.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Generate a <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" target="_blank" rel="noopener">UUID</a>
- (universally unique identifier).</p>
- </div>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The UUID.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Determines how many bytes must be used to represent the texture.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>width</strong>
- </td>
- <td class="description last">
- <p>The width of the texture.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>height</strong>
- </td>
- <td class="description last">
- <p>The height of the texture.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>format</strong>
- </td>
- <td class="description last">
- <p>The texture's format.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>type</strong>
- </td>
- <td class="description last">
- <p>The texture's type.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The byte length.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Computes a cache key for the given render context. This key
- should identify the render target state so it is possible to
- configure the correct attachments in the respective backend.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>renderContext</strong>
- </td>
- <td class="description last">
- <p>The render context.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The cache key.</dt>
- </dl>
- </div>
- <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>.<float></span> </h3>
- <div class="method">
- <div class="description">
- <p>Represents a <code>discard</code> shader operation in TSL.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>inputs</strong>
- </td>
- <td class="description last">
- <p>The input parameter object.</p>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>lightDistance</strong>
- </td>
- <td class="description last">
- <p>The distance of the light's position to the current fragment position.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>cutoffDistance</strong>
- </td>
- <td class="description last">
- <p>The light's cutoff distance.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>decayExponent</strong>
- </td>
- <td class="description last">
- <p>The light's decay exponent.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The distance falloff.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>This function is usually called with the length in bytes of an array buffer.
- It returns an padded value which ensure chunk size alignment according to STD140 layout.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>floatLength</strong>
- </td>
- <td class="description last">
- <p>The buffer length.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns the GPU format for the given texture.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>texture</strong>
- </td>
- <td class="description last">
- <p>The texture.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>device</strong>
- </td>
- <td class="description last">
- <p>The GPU device which is used for feature detection.
- It is not necessary to apply the device for most formats.</p>
- <p>Default is <code>null</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The GPU format.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getKeyframeOrder" translate="no">.<a href="#getKeyframeOrder">getKeyframeOrder</a><span class="signature">( times : <span class="param-type">Array.<number></span> )</span><span class="type-signature"> : Array.<number></span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns an array by which times and values can be sorted.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>times</strong>
- </td>
- <td class="description last">
- <p>The keyframe time values.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The array.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getMembersLayout" translate="no">.<a href="#getMembersLayout">getMembersLayout</a><span class="signature">( members : <span class="param-type">Object.<string, (string|Object)></span> )</span><span class="type-signature"> : Array.<{name: string, type: string, atomic: boolean}></span> </h3>
- <div class="method">
- <div class="description">
- <p>Generates a layout for struct members.
- This function takes an object representing struct members and returns an array of member layouts.
- Each member layout includes the member's name, type, and whether it is atomic.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>members</strong>
- </td>
- <td class="description last">
- <p>An object where keys are member names and values are either types (as strings) or objects with type and atomic properties.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> An array of member layouts.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>This function is called with a vector length and ensure the computed length
- matches a predefined stride (in this case <code>4</code>).</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>vectorLength</strong>
- </td>
- <td class="description last">
- <p>The vector length.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="getTextureIndex" translate="no">.<a href="#getTextureIndex">getTextureIndex</a><span class="signature">( textures : <span class="param-type">Array.<<a href="Texture.html">Texture</a>></span>, name : <span class="param-type">string</span> )</span><span class="type-signature"> : number</span> </h3>
- <div class="method">
- <div class="description">
- <p>Returns the MRT texture index for the given name.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>textures</strong>
- </td>
- <td class="description last">
- <p>The textures of a MRT-configured render target.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>name</strong>
- </td>
- <td class="description last">
- <p>The name of the MRT texture which index is requested.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The texture index.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Create a new set of uniforms for describing the curve modifier.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>splineTexture</strong>
- </td>
- <td class="description last">
- <p>Which holds the curve description.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The uniforms object to be used in the shader.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Given the count of vectors and their vector length, this function computes
- a total length in bytes with buffer alignment according to STD140 layout.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>count</strong>
- </td>
- <td class="description last">
- <p>The number of vectors.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>vectorLength</strong>
- </td>
- <td class="description last">
- <p>The vector length.</p>
- <p>Default is <code>4</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The padded length.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a node that represents the <code>z</code> coordinate in view space
- for the current fragment. It's a different representation of the
- default depth value.</p>
- <p>This value can be part of a computation that defines how the fog
- density increases when moving away from the camera.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>builder</strong>
- </td>
- <td class="description last">
- <p>The current node builder.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The viewZ node.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns the percentage in the closed interval <code>[0, 1]</code> of the given value
- between the start and end point.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The start point</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>y</strong>
- </td>
- <td class="description last">
- <p>The end point.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>A value between start and end.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The interpolation factor.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns <code>true</code> if the given number is a power of two.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The value to check.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> Whether the given number is a power of two or not.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns <code>true</code> if the given object is a typed array.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>array</strong>
- </td>
- <td class="description last">
- <p>The object to check.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> Whether the given object is a typed array.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a value linearly interpolated from two known points based on the given interval -
- <code>t = 0</code> will return <code>x</code> and <code>t = 1</code> will return <code>y</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The start point</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>y</strong>
- </td>
- <td class="description last">
- <p>The end point.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>t</strong>
- </td>
- <td class="description last">
- <p>The interpolation factor in the closed interval <code>[0, 1]</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Converts the keyframes of the given animation clip to an additive format.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>targetClip</strong>
- </td>
- <td class="description last">
- <p>The clip to make additive.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>referenceFrame</strong>
- </td>
- <td class="description last">
- <p>The reference frame.</p>
- <p>Default is <code>0</code>.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>referenceClip</strong>
- </td>
- <td class="description last">
- <p>The reference clip.</p>
- <p>Default is <code>targetClip</code>.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>fps</strong>
- </td>
- <td class="description last">
- <p>The FPS.</p>
- <p>Default is <code>30</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The updated clip which is now additive.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Performs a linear mapping from range <code><a1, a2></code> to range <code><b1, b2></code>
- for the given value.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The value to be mapped.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>a1</strong>
- </td>
- <td class="description last">
- <p>Minimum value for range A.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>a2</strong>
- </td>
- <td class="description last">
- <p>Maximum value for range A.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>b1</strong>
- </td>
- <td class="description last">
- <p>Minimum value for range B.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>b2</strong>
- </td>
- <td class="description last">
- <p>Maximum value for range B.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The mapped value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Normalizes the given value according to the given typed array.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>value</strong>
- </td>
- <td class="description last">
- <p>The float value in the range <code>[0,1]</code> to normalize.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>array</strong>
- </td>
- <td class="description last">
- <p>The typed array that defines the data type of the value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The normalize value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a value that alternates between <code>0</code> and the given <code>length</code> parameter.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The value to pingpong.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>length</strong>
- </td>
- <td class="description last">
- <p>The positive value the function will pingpong to.</p>
- <p>Default is <code>1</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Converts radians to degrees.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>radians</strong>
- </td>
- <td class="description last">
- <p>A value in radians.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The converted value in degrees.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a random float from <code><low, high></code> interval.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>low</strong>
- </td>
- <td class="description last">
- <p>The lower value boundary.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>high</strong>
- </td>
- <td class="description last">
- <p>The upper value boundary</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a random integer from <code><-range/2, range/2></code> interval.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>range</strong>
- </td>
- <td class="description last">
- <p>Defines the value range.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a random integer from <code><low, high></code> interval.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>low</strong>
- </td>
- <td class="description last">
- <p>The lower value boundary.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>high</strong>
- </td>
- <td class="description last">
- <p>The upper value boundary</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A random integer.</dt>
- </dl>
- </div>
- <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>.<vec2></span> )</span><span class="type-signature"> : <a href="SampleNode.html">SampleNode</a></span> </h3>
- <div class="method">
- <div class="description">
- <p>Helper function to create a SampleNode wrapped as a node object.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>callback</strong>
- </td>
- <td class="description last">
- <p>The function to be called when sampling. Should accept a UV node and return a value.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>uv</strong>
- </td>
- <td class="description last">
- <p>The UV node to be used in the texture sampling.</p>
- <p>Default is <code>null</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The created SampleNode instance wrapped as a node object.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a deterministic pseudo-random float in the interval <code>[0, 1]</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>s</strong>
- </td>
- <td class="description last">
- <p>The integer seed.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Assumes 2 cameras that are parallel and share an X-axis, and that
- the cameras' projection and world matrices have already been set.
- And that near and far planes are identical for both cameras.
- Visualization of this technique: https://computergraphics.stackexchange.com/a/4765</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>camera</strong>
- </td>
- <td class="description last">
- <p>The camera to update.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>cameraL</strong>
- </td>
- <td class="description last">
- <p>The left camera.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>cameraR</strong>
- </td>
- <td class="description last">
- <p>The right camera.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <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>
- defined by the given angles and order.</p>
- <p>Rotations are applied to the axes in the order specified by order:
- rotation by angle <code>a</code> is applied first, then by angle <code>b</code>, then by angle <code>c</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>q</strong>
- </td>
- <td class="description last">
- <p>The quaternion to set.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>a</strong>
- </td>
- <td class="description last">
- <p>The rotation applied to the first axis, in radians.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>b</strong>
- </td>
- <td class="description last">
- <p>The rotation applied to the second axis, in radians.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>c</strong>
- </td>
- <td class="description last">
- <p>The rotation applied to the third axis, in radians.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>order</strong>
- </td>
- <td class="description last">
- <p>A string specifying the axes order.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>, …params : <span class="param-type"><a href="global.html#any">any</a></span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Shadow Render Object Function.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>object</strong>
- </td>
- <td class="description last">
- <p>The 3D object to render.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>scene</strong>
- </td>
- <td class="description last">
- <p>The scene containing the object.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>_camera</strong>
- </td>
- <td class="description last">
- <p>The camera used for rendering.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>geometry</strong>
- </td>
- <td class="description last">
- <p>The geometry of the object.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>material</strong>
- </td>
- <td class="description last">
- <p>The material of the object.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>group</strong>
- </td>
- <td class="description last">
- <p>The group the object belongs to.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>params</strong>
- </td>
- <td class="description last">
- <p>Additional parameters for rendering.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>A <a href="https://en.wikipedia.org/wiki/Smoothstep#Variations" target="_blank" rel="noopener">variation on smoothstep</a>
- that has zero 1st and 2nd order derivatives at x=0 and x=1.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The value to evaluate based on its position between min and max.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>min</strong>
- </td>
- <td class="description last">
- <p>The min value. Any x value below min will be <code>0</code>.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>max</strong>
- </td>
- <td class="description last">
- <p>The max value. Any x value above max will be <code>1</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a value in the range <code>[0,1]</code> that represents the percentage that <code>x</code> has
- moved between <code>min</code> and <code>max</code>, but smoothed or slowed down the closer <code>x</code> is to
- the <code>min</code> and <code>max</code>.</p>
- <p>See <a href="http://en.wikipedia.org/wiki/Smoothstep" target="_blank" rel="noopener">Smoothstep</a> for more details.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>x</strong>
- </td>
- <td class="description last">
- <p>The value to evaluate based on its position between min and max.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>min</strong>
- </td>
- <td class="description last">
- <p>The min value. Any x value below min will be <code>0</code>.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>max</strong>
- </td>
- <td class="description last">
- <p>The max value. Any x value above max will be <code>1</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="sortedArray" translate="no">.<a href="#sortedArray">sortedArray</a><span class="signature">( values : <span class="param-type">Array.<number></span>, stride : <span class="param-type">number</span>, order : <span class="param-type">Array.<number></span> )</span><span class="type-signature"> : Array.<number></span> </h3>
- <div class="method">
- <div class="description">
- <p>Sorts the given array by the previously computed order via <code>getKeyframeOrder()</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>values</strong>
- </td>
- <td class="description last">
- <p>The values to sort.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>stride</strong>
- </td>
- <td class="description last">
- <p>The stride.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>order</strong>
- </td>
- <td class="description last">
- <p>The sort order.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The sorted values.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Creates a new clip, containing only the segment of the original clip between the given frames.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>sourceClip</strong>
- </td>
- <td class="description last">
- <p>The values to sort.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>name</strong>
- </td>
- <td class="description last">
- <p>The name of the clip.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>startFrame</strong>
- </td>
- <td class="description last">
- <p>The start frame.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>endFrame</strong>
- </td>
- <td class="description last">
- <p>The end frame.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>fps</strong>
- </td>
- <td class="description last">
- <p>The FPS.</p>
- <p>Default is <code>30</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The new sub clip.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Returns a half precision floating point value (FP16) from the given single
- precision floating point value (FP32).</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>val</strong>
- </td>
- <td class="description last">
- <p>A single precision floating point value.</p>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The FP16 value.</dt>
- </dl>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Updates the world matrices for the given camera based on the parent 3D object.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>camera</strong>
- </td>
- <td class="description last">
- <p>The camera to update.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>parent</strong>
- </td>
- <td class="description last">
- <p>The parent 3D object.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Updates the given camera with the transformation of the XR camera and parent object.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>camera</strong>
- </td>
- <td class="description last">
- <p>The camera to update.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>cameraXR</strong>
- </td>
- <td class="description last">
- <p>The XR camera.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>parent</strong>
- </td>
- <td class="description last">
- <p>The parent 3D object.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <h2 class="subsection-title">Type Definitions</h2>
- <div class="member">
- <h3 class="name" id="ConstantsInterpolationSamplingMode" translate="no">.<a href="#ConstantsInterpolationSamplingMode">ConstantsInterpolationSamplingMode</a> </h3>
- <div class="description">
- <p>Represents the different interpolation sampling modes.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>NORMAL</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Normal sampling mode.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>CENTROID</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Centroid sampling mode.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>SAMPLE</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Sample-specific sampling mode.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>FIRST</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Flat interpolation using the first vertex.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>EITHER</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Flat interpolation using either vertex.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="ConstantsInterpolationSamplingType" translate="no">.<a href="#ConstantsInterpolationSamplingType">ConstantsInterpolationSamplingType</a> </h3>
- <div class="description">
- <p>Represents the different interpolation sampling types.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>PERSPECTIVE</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Perspective-correct interpolation.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>LINEAR</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Linear interpolation.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>FLAT</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>Flat interpolation.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="ConstantsMouse" translate="no">.<a href="#ConstantsMouse">ConstantsMouse</a> </h3>
- <div class="description">
- <p>This type represents mouse buttons and interaction types in context of controls.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>MIDDLE</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>The left mouse button.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>LEFT</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>The middle mouse button.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>RIGHT</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>The right mouse button.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>ROTATE</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A rotate interaction.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>DOLLY</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A dolly interaction.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>PAN</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A pan interaction.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="ConstantsTimestampQuery" translate="no">.<a href="#ConstantsTimestampQuery">ConstantsTimestampQuery</a> </h3>
- <div class="description">
- <p>This type represents the different timestamp query types.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>COMPUTE</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>A <code>compute</code> timestamp query.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>RENDER</strong>
- <br>
- <span class="param-type">string</span>
- </td>
- <td class="description last">
- <p>A <code>render</code> timestamp query.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="ConstantsTouch" translate="no">.<a href="#ConstantsTouch">ConstantsTouch</a> </h3>
- <div class="description">
- <p>This type represents touch interaction types in context of controls.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>ROTATE</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A rotate interaction.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>PAN</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A pan interaction.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>DOLLY_PAN</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>The dolly-pan interaction.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>DOLLY_ROTATE</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>A dolly-rotate interaction.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="DebugConfig" translate="no">.<a href="#DebugConfig">DebugConfig</a> </h3>
- <div class="description">
- <p>Debug configuration.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>checkShaderErrors</strong>
- <br>
- <span class="param-type">boolean</span>
- </td>
- <td class="description last">
- <p>Whether shader errors should be checked or not.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>onShaderError</strong>
- <br>
- <span class="param-type">function</span>
- </td>
- <td class="description last">
- <p>A callback function that is executed when a shader error happens. Only supported with WebGL 2 right now.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>getShaderAsync</strong>
- <br>
- <span class="param-type">function</span>
- </td>
- <td class="description last">
- <p>Allows the get the raw shader code for the given scene, camera and 3D object.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="ShadowMapConfig" translate="no">.<a href="#ShadowMapConfig">ShadowMapConfig</a> </h3>
- <div class="description">
- <p>Shadow map configuration</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>enabled</strong>
- <br>
- <span class="param-type">boolean</span>
- </td>
- <td class="description last">
- <p>Whether to globally enable shadows or not.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>transmitted</strong>
- <br>
- <span class="param-type">boolean</span>
- </td>
- <td class="description last">
- <p>Whether to enable light transmission through non-opaque materials.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>type</strong>
- <br>
- <span class="param-type">number</span>
- </td>
- <td class="description last">
- <p>The shadow map type.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="member">
- <h3 class="name" id="XRConfig" translate="no">.<a href="#XRConfig">XRConfig</a> </h3>
- <div class="description">
- <p>XR configuration.</p>
- </div>
- <table class="props">
- <tbody>
- <tr>
- <td class="name">
- <strong>enabled</strong>
- <br>
- <span class="param-type">boolean</span>
- </td>
- <td class="description last">
- <p>Whether to globally enable XR or not.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Animation loop parameter of <code>renderer.setAnimationLoop()</code>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>time</strong>
- </td>
- <td class="description last">
- <p>A timestamp indicating the end time of the previous frame's rendering.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>frame</strong>
- </td>
- <td class="description last">
- <p>A reference to the current XR frame. Only relevant when using XR rendering.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Callback for onError in loaders.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>error</strong>
- </td>
- <td class="description last">
- <p>The error which occurred during the loading process.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Callback for onProgress in loaders.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>event</strong>
- </td>
- <td class="description last">
- <p>An instance of <code>ProgressEvent</code> that represents the current loading status.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Callback for <a href="Renderer.html#setRenderObjectFunction">Renderer#setRenderObjectFunction</a>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>object</strong>
- </td>
- <td class="description last">
- <p>The 3D object.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>scene</strong>
- </td>
- <td class="description last">
- <p>The scene the 3D object belongs to.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>camera</strong>
- </td>
- <td class="description last">
- <p>The camera the object should be rendered with.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>geometry</strong>
- </td>
- <td class="description last">
- <p>The object's geometry.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>material</strong>
- </td>
- <td class="description last">
- <p>The object's material.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>group</strong>
- </td>
- <td class="description last">
- <p>Only relevant for objects using multiple materials. This represents a group entry from the respective <code>BufferGeometry</code>.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>lightsNode</strong>
- </td>
- <td class="description last">
- <p>The current lights node.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>clippingContext</strong>
- </td>
- <td class="description last">
- <p>The clipping context.</p>
- </td>
- </tr>
- <tr>
- <td class="name">
- <strong>passId</strong>
- </td>
- <td class="description last">
- <p>An optional ID for identifying the pass.</p>
- <p>Default is <code>null</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <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>
- <div class="method">
- <div class="description">
- <p>Callback for <a href="Node.html#traverse">Node#traverse</a>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>node</strong>
- </td>
- <td class="description last">
- <p>The current node.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|