| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334 |
- <!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>Basic depth packing.</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="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: 32x32
- 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">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="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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>READ_ONLY</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Read-only access</p></td>
- </tr>
- <tr>
- <td class="name"><code>WRITE_ONLY</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Write-only access.</p></td>
- </tr>
- <tr>
- <td class="name"><code>READ_WRITE</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>VERTEX</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>The vertex shader stage.</p></td>
- </tr>
- <tr>
- <td class="name"><code>FRAGMENT</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>BOOLEAN</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Boolean type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>INTEGER</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Integer type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>FLOAT</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Float type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>VECTOR2</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Two-dimensional vector type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>VECTOR3</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Three-dimensional vector type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>VECTOR4</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Four-dimensional vector type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>MATRIX2</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>2x2 matrix type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>MATRIX3</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>3x3 matrix type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>MATRIX4</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>NONE</code></td>
- <td class="type">
- <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"><code>FRAME</code></td>
- <td class="type">
- <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"><code>RENDER</code></td>
- <td class="type">
- <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"><code>OBJECT</code></td>
- <td class="type">
- <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="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="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="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>A 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>A 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>A 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_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="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="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"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>depthTexture</code></td>
- <td class="description last"><p>A reference to the shadow map's texture data.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowCoord</code></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.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>depthTexture</code></td>
- <td class="description last"><p>A reference to the shadow map's texture data.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowCoord</code></td>
- <td class="description last"><p>The shadow coordinates.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadow</code></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"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>depthTexture</code></td>
- <td class="description last"><p>A reference to the shadow map's texture data.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowCoord</code></td>
- <td class="description last"><p>The shadow coordinates.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadow</code></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">Node</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"><code>node</code></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="VSMPassHorizontal" translate="no">.<a href="#VSMPassHorizontal">VSMPassHorizontal</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.<vec2></span> </h3>
- <div class="method">
- <div class="description">
- <p>Represents the shader code for the second VSM render pass.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>samples</code></td>
- <td class="description last"><p>The number of samples</p></td>
- </tr>
- <tr>
- <td class="name"><code>radius</code></td>
- <td class="description last"><p>The radius.</p></td>
- </tr>
- <tr>
- <td class="name"><code>size</code></td>
- <td class="description last"><p>The size.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowPass</code></td>
- <td class="description last"><p>The result of the first VSM render pass.</p></td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The VSM output.</dt>
- </dl>
- </div>
- <h3 class="name name-method" id="VSMPassVertical" translate="no">.<a href="#VSMPassVertical">VSMPassVertical</a><span class="signature">( inputs : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="Node.html">Node</a>.<vec2></span> </h3>
- <div class="method">
- <div class="description">
- <p>Represents the shader code for the first VSM render pass.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>samples</code></td>
- <td class="description last"><p>The number of samples</p></td>
- </tr>
- <tr>
- <td class="name"><code>radius</code></td>
- <td class="description last"><p>The radius.</p></td>
- </tr>
- <tr>
- <td class="name"><code>size</code></td>
- <td class="description last"><p>The size.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowPass</code></td>
- <td class="description last"><p>A reference to the render target's depth data.</p></td>
- </tr>
- </tbody>
- </table>
- </td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> The VSM output.</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"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>depthTexture</code></td>
- <td class="description last"><p>A reference to the shadow map's texture data.</p></td>
- </tr>
- <tr>
- <td class="name"><code>shadowCoord</code></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="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"><code>value</code></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"><code>value</code></td>
- <td class="description last"><p>The value to clamp.</p></td>
- </tr>
- <tr>
- <td class="name"><code>min</code></td>
- <td class="description last"><p>The min value.</p></td>
- </tr>
- <tr>
- <td class="name"><code>max</code></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">Texture</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"><code>texture</code></td>
- <td class="description last"><p>The texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>aspect</code></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"><code>array</code></td>
- <td class="description last"><p>The array to convert.</p></td>
- </tr>
- <tr>
- <td class="name"><code>type</code></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">Texture</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"><code>texture</code></td>
- <td class="description last"><p>The texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>aspect</code></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"><code>type</code></td>
- <td class="description last"><p>The event type.</p></td>
- </tr>
- <tr>
- <td class="name"><code>callback</code></td>
- <td class="description last"><p>The callback function.</p></td>
- </tr>
- </tbody>
- </table>
- <dl class="details">
- <dt class="tag-returns"><strong>Returns:</strong> </dt>
- </dl>
- </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/">Frame rate independent damping using lerp</a>.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>x</code></td>
- <td class="description last"><p>The current point.</p></td>
- </tr>
- <tr>
- <td class="name"><code>y</code></td>
- <td class="description last"><p>The target point.</p></td>
- </tr>
- <tr>
- <td class="name"><code>lambda</code></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"><code>dt</code></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"><code>degrees</code></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"><code>value</code></td>
- <td class="description last"><p>The value to denormalize.</p></td>
- </tr>
- <tr>
- <td class="name"><code>array</code></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"><code>n</code></td>
- <td class="description last"><p>The first parameter.</p></td>
- </tr>
- <tr>
- <td class="name"><code>m</code></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">Texture</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"><code>texture</code></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"><code>jsonKeys</code></td>
- <td class="description last"><p>A list of JSON keyframes.</p></td>
- </tr>
- <tr>
- <td class="name"><code>times</code></td>
- <td class="description last"><p>This array will be filled with keyframe times by this function.</p></td>
- </tr>
- <tr>
- <td class="name"><code>values</code></td>
- <td class="description last"><p>This array will be filled with keyframe values by this function.</p></td>
- </tr>
- <tr>
- <td class="name"><code>valuePropertyName</code></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"><code>value</code></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"><code>val</code></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"><code>size</code></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"><code>size</code></td>
- <td class="description last"><p>The noise size.<br/>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">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"><code>width</code></td>
- <td class="description last"><p>The width of the texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>height</code></td>
- <td class="description last"><p>The height of the texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>format</code></td>
- <td class="description last"><p>The texture's format.</p></td>
- </tr>
- <tr>
- <td class="name"><code>type</code></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">RenderContext</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"><code>renderContext</code></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"><code>inputs</code></td>
- <td class="description last"><p>The input parameter object.</p>
- <h6>Properties</h6>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>lightDistance</code></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"><code>cutoffDistance</code></td>
- <td class="description last"><p>The light's cutoff distance.</p></td>
- </tr>
- <tr>
- <td class="name"><code>decayExponent</code></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"><code>floatLength</code></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">Texture</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"><code>texture</code></td>
- <td class="description last"><p>The texture.</p></td>
- </tr>
- <tr>
- <td class="name"><code>device</code></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.<br/>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"><code>times</code></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"><code>members</code></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"><code>vectorLength</code></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.<Texture></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"><code>textures</code></td>
- <td class="description last"><p>The textures of a MRT-configured render target.</p></td>
- </tr>
- <tr>
- <td class="name"><code>name</code></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">DataTexture</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"><code>splineTexture</code></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"><code>count</code></td>
- <td class="description last"><p>The number of vectors.</p></td>
- </tr>
- <tr>
- <td class="name"><code>vectorLength</code></td>
- <td class="description last"><p>The vector length.<br/>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">NodeBuilder</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"><code>builder</code></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"><code>x</code></td>
- <td class="description last"><p>The start point</p></td>
- </tr>
- <tr>
- <td class="name"><code>y</code></td>
- <td class="description last"><p>The end point.</p></td>
- </tr>
- <tr>
- <td class="name"><code>value</code></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"><code>value</code></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">( object : <span class="param-type">any</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"><code>object</code></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"><code>x</code></td>
- <td class="description last"><p>The start point</p></td>
- </tr>
- <tr>
- <td class="name"><code>y</code></td>
- <td class="description last"><p>The end point.</p></td>
- </tr>
- <tr>
- <td class="name"><code>t</code></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">AnimationClip</span>, referenceFrame : <span class="param-type">number</span>, referenceClip : <span class="param-type">AnimationClip</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"><code>targetClip</code></td>
- <td class="description last"><p>The clip to make additive.</p></td>
- </tr>
- <tr>
- <td class="name"><code>referenceFrame</code></td>
- <td class="description last"><p>The reference frame.<br/>Default is <code>0</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>referenceClip</code></td>
- <td class="description last"><p>The reference clip.<br/>Default is <code>targetClip</code>.</p></td>
- </tr>
- <tr>
- <td class="name"><code>fps</code></td>
- <td class="description last"><p>The FPS.<br/>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"><code>x</code></td>
- <td class="description last"><p>The value to be mapped.</p></td>
- </tr>
- <tr>
- <td class="name"><code>a1</code></td>
- <td class="description last"><p>Minimum value for range A.</p></td>
- </tr>
- <tr>
- <td class="name"><code>a2</code></td>
- <td class="description last"><p>Maximum value for range A.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b1</code></td>
- <td class="description last"><p>Minimum value for range B.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b2</code></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"><code>value</code></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"><code>array</code></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"><code>x</code></td>
- <td class="description last"><p>The value to pingpong.</p></td>
- </tr>
- <tr>
- <td class="name"><code>length</code></td>
- <td class="description last"><p>The positive value the function will pingpong to.<br/>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"><code>radians</code></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"><code>low</code></td>
- <td class="description last"><p>The lower value boundary.</p></td>
- </tr>
- <tr>
- <td class="name"><code>high</code></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"><code>range</code></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"><code>low</code></td>
- <td class="description last"><p>The lower value boundary.</p></td>
- </tr>
- <tr>
- <td class="name"><code>high</code></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">Node.<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"><code>callback</code></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"><code>uv</code></td>
- <td class="description last"><p>The UV node to be used in the texture sampling.<br/>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"><code>s</code></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">ArrayCamera</span>, cameraL : <span class="param-type">PerspectiveCamera</span>, cameraR : <span class="param-type">PerspectiveCamera</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"><code>camera</code></td>
- <td class="description last"><p>The camera to update.</p></td>
- </tr>
- <tr>
- <td class="name"><code>cameraL</code></td>
- <td class="description last"><p>The left camera.</p></td>
- </tr>
- <tr>
- <td class="name"><code>cameraR</code></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">Quaternion</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">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"><code>q</code></td>
- <td class="description last"><p>The quaternion to set.</p></td>
- </tr>
- <tr>
- <td class="name"><code>a</code></td>
- <td class="description last"><p>The rotation applied to the first axis, in radians.</p></td>
- </tr>
- <tr>
- <td class="name"><code>b</code></td>
- <td class="description last"><p>The rotation applied to the second axis, in radians.</p></td>
- </tr>
- <tr>
- <td class="name"><code>c</code></td>
- <td class="description last"><p>The rotation applied to the third axis, in radians.</p></td>
- </tr>
- <tr>
- <td class="name"><code>order</code></td>
- <td class="description last"><p>A string specifying the axes order.</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">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"><code>x</code></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"><code>min</code></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"><code>max</code></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">Smoothstep</a> for more details.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name"><code>x</code></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"><code>min</code></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"><code>max</code></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"><code>values</code></td>
- <td class="description last"><p>The values to sort.</p></td>
- </tr>
- <tr>
- <td class="name"><code>stride</code></td>
- <td class="description last"><p>The stride.</p></td>
- </tr>
- <tr>
- <td class="name"><code>order</code></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">AnimationClip</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"><code>sourceClip</code></td>
- <td class="description last"><p>The values to sort.</p></td>
- </tr>
- <tr>
- <td class="name"><code>name</code></td>
- <td class="description last"><p>The name of the clip.</p></td>
- </tr>
- <tr>
- <td class="name"><code>startFrame</code></td>
- <td class="description last"><p>The start frame.</p></td>
- </tr>
- <tr>
- <td class="name"><code>endFrame</code></td>
- <td class="description last"><p>The end frame.</p></td>
- </tr>
- <tr>
- <td class="name"><code>fps</code></td>
- <td class="description last"><p>The FPS.<br/>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"><code>val</code></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">Camera</span>, parent : <span class="param-type">Object3D</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"><code>camera</code></td>
- <td class="description last"><p>The camera to update.</p></td>
- </tr>
- <tr>
- <td class="name"><code>parent</code></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">Camera</span>, cameraXR : <span class="param-type">ArrayCamera</span>, parent : <span class="param-type">Object3D</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"><code>camera</code></td>
- <td class="description last"><p>The camera to update.</p></td>
- </tr>
- <tr>
- <td class="name"><code>cameraXR</code></td>
- <td class="description last"><p>The XR camera.</p></td>
- </tr>
- <tr>
- <td class="name"><code>parent</code></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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>NORMAL</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Normal sampling mode.</p></td>
- </tr>
- <tr>
- <td class="name"><code>CENTROID</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Centroid sampling mode.</p></td>
- </tr>
- <tr>
- <td class="name"><code>SAMPLE</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Sample-specific sampling mode.</p></td>
- </tr>
- <tr>
- <td class="name"><code>FIRST</code></td>
- <td class="type">
- <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"><code>EITHER</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>PERSPECTIVE</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Perspective-correct interpolation.</p></td>
- </tr>
- <tr>
- <td class="name"><code>LINEAR</code></td>
- <td class="type">
- <span class="param-type">string</span>
- </td>
- <td class="description last"><p>Linear interpolation.</p></td>
- </tr>
- <tr>
- <td class="name"><code>FLAT</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>MIDDLE</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>The left mouse button.</p></td>
- </tr>
- <tr>
- <td class="name"><code>LEFT</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>The middle mouse button.</p></td>
- </tr>
- <tr>
- <td class="name"><code>RIGHT</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>The right mouse button.</p></td>
- </tr>
- <tr>
- <td class="name"><code>ROTATE</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>A rotate interaction.</p></td>
- </tr>
- <tr>
- <td class="name"><code>DOLLY</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>A dolly interaction.</p></td>
- </tr>
- <tr>
- <td class="name"><code>PAN</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>COMPUTE</code></td>
- <td class="type">
- <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"><code>RENDER</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>ROTATE</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>A rotate interaction.</p></td>
- </tr>
- <tr>
- <td class="name"><code>PAN</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>A pan interaction.</p></td>
- </tr>
- <tr>
- <td class="name"><code>DOLLY_PAN</code></td>
- <td class="type">
- <span class="param-type">number</span>
- </td>
- <td class="description last"><p>The dolly-pan interaction.</p></td>
- </tr>
- <tr>
- <td class="name"><code>DOLLY_ROTATE</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Attributes</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>checkShaderErrors</code></td>
- <td class="type">
- <span class="param-type">boolean</span>
- </td>
- <td class="attributes">
- </td>
- <td class="description last"><p>Whether shader errors should be checked or not.</p></td>
- </tr>
- <tr>
- <td class="name"><code>onShaderError</code></td>
- <td class="type">
- <span class="param-type">function</span>
- </td>
- <td class="attributes">
- <nullable><br>
- </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"><code>getShaderAsync</code></td>
- <td class="type">
- <span class="param-type">function</span>
- </td>
- <td class="attributes">
- </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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>enabled</code></td>
- <td class="type">
- <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"><code>type</code></td>
- <td class="type">
- <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>
- <h5 class="subsection-title">Properties:</h5>
- <table class="props">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="name"><code>enabled</code></td>
- <td class="type">
- <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"><code>time</code></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"><code>frame</code></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"><code>error</code></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"><code>event</code></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">Object3D</span>, scene : <span class="param-type">Scene</span>, camera : <span class="param-type">Camera</span>, geometry : <span class="param-type">BufferGeometry</span>, material : <span class="param-type">Material</span>, group : <span class="param-type">Object</span>, lightsNode : <span class="param-type">LightsNode</span>, clippingContext : <span class="param-type">ClippingContext</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"><code>object</code></td>
- <td class="description last"><p>The 3D object.</p></td>
- </tr>
- <tr>
- <td class="name"><code>scene</code></td>
- <td class="description last"><p>The scene the 3D object belongs to.</p></td>
- </tr>
- <tr>
- <td class="name"><code>camera</code></td>
- <td class="description last"><p>The camera the object should be rendered with.</p></td>
- </tr>
- <tr>
- <td class="name"><code>geometry</code></td>
- <td class="description last"><p>The object's geometry.</p></td>
- </tr>
- <tr>
- <td class="name"><code>material</code></td>
- <td class="description last"><p>The object's material.</p></td>
- </tr>
- <tr>
- <td class="name"><code>group</code></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"><code>lightsNode</code></td>
- <td class="description last"><p>The current lights node.</p></td>
- </tr>
- <tr>
- <td class="name"><code>clippingContext</code></td>
- <td class="description last"><p>The clipping context.</p></td>
- </tr>
- <tr>
- <td class="name"><code>passId</code></td>
- <td class="description last"><p>An optional ID for identifying the pass.<br/>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">Node</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"><code>node</code></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>
|