class_renderingserver.rst 1.2 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingServer.xml.
  6. .. _class_RenderingServer:
  7. RenderingServer
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Server for anything visible.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. The rendering server is the API backend for everything visible. The whole scene system mounts on it to display. The rendering server is completely opaque: the internals are entirely implementation-specific and cannot be accessed.
  15. The rendering server can be used to bypass the scene/:ref:`Node<class_Node>` system entirely. This can improve performance in cases where the scene system is the bottleneck, but won't improve performance otherwise (for instance, if the GPU is already fully utilized).
  16. Resources are created using the ``*_create`` functions. These functions return :ref:`RID<class_RID>`\ s which are not references to the objects themselves, but opaque *pointers* towards these objects.
  17. All objects are drawn to a viewport. You can use the :ref:`Viewport<class_Viewport>` attached to the :ref:`SceneTree<class_SceneTree>` or you can create one yourself with :ref:`viewport_create<class_RenderingServer_method_viewport_create>`. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` or :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`.
  18. \ **Scenarios:** In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any :ref:`Node3D<class_Node3D>` node with :ref:`Node3D.get_world_3d<class_Node3D_method_get_world_3d>`. Otherwise, a scenario can be created with :ref:`scenario_create<class_RenderingServer_method_scenario_create>`.
  19. Similarly, in 2D, a canvas is needed to draw all canvas items.
  20. \ **3D:** In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`. The instance must also be attached to the scenario using :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` in order to be visible. RenderingServer methods that don't have a prefix are usually 3D-specific (but not always).
  21. \ **2D:** In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas. 2D-specific RenderingServer methods generally start with ``canvas_*``.
  22. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **RenderingServer** will return dummy values in this case.
  23. .. rst-class:: classref-introduction-group
  24. Tutorials
  25. ---------
  26. - :doc:`Optimization using Servers <../tutorials/performance/using_servers>`
  27. .. rst-class:: classref-reftable-group
  28. Properties
  29. ----------
  30. .. table::
  31. :widths: auto
  32. +-------------------------+--------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_RenderingServer_property_render_loop_enabled>` |
  34. +-------------------------+--------------------------------------------------------------------------------+
  35. .. rst-class:: classref-reftable-group
  36. Methods
  37. -------
  38. .. table::
  39. :widths: auto
  40. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`\ (\ base\: :ref:`RID<class_RID>`, material_overrides\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], image_size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  42. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`call_on_render_thread<class_RenderingServer_method_call_on_render_thread>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  44. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>`\ (\ ) |
  46. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | |void| | :ref:`camera_attributes_set_auto_exposure<class_RenderingServer_method_camera_attributes_set_auto_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, min_sensitivity\: :ref:`float<class_float>`, max_sensitivity\: :ref:`float<class_float>`, speed\: :ref:`float<class_float>`, scale\: :ref:`float<class_float>`\ ) |
  48. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | |void| | :ref:`camera_attributes_set_dof_blur<class_RenderingServer_method_camera_attributes_set_dof_blur>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, far_enable\: :ref:`bool<class_bool>`, far_distance\: :ref:`float<class_float>`, far_transition\: :ref:`float<class_float>`, near_enable\: :ref:`bool<class_bool>`, near_distance\: :ref:`float<class_float>`, near_transition\: :ref:`float<class_float>`, amount\: :ref:`float<class_float>`\ ) |
  50. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`camera_attributes_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>`\ (\ shape\: :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`\ ) |
  52. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`camera_attributes_set_dof_blur_quality<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>`\ (\ quality\: :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`, use_jitter\: :ref:`bool<class_bool>`\ ) |
  54. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, normalization\: :ref:`float<class_float>`\ ) |
  56. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>`\ (\ ) |
  58. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`camera_set_camera_attributes<class_RenderingServer_method_camera_set_camera_attributes>`\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  60. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`camera_set_compositor<class_RenderingServer_method_camera_set_compositor>`\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  62. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>`\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  64. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>`\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) |
  66. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, offset\: :ref:`Vector2<class_Vector2>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  68. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  70. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>`\ (\ camera\: :ref:`RID<class_RID>`, fovy_degrees\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  72. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>`\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  74. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>`\ (\ camera\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  76. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>`\ (\ ) |
  78. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`canvas_item_add_animation_slice<class_RenderingServer_method_canvas_item_add_animation_slice>`\ (\ item\: :ref:`RID<class_RID>`, animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) |
  80. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>`\ (\ item\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  82. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>`\ (\ item\: :ref:`RID<class_RID>`, ignore\: :ref:`bool<class_bool>`\ ) |
  84. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`canvas_item_add_lcd_texture_rect_region<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>`\ ) |
  86. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>`\ (\ item\: :ref:`RID<class_RID>`, from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  88. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  90. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline_size\: :ref:`int<class_int>` = 0, px_range\: :ref:`float<class_float>` = 1.0, scale\: :ref:`float<class_float>` = 1.0\ ) |
  92. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`canvas_item_add_multiline<class_RenderingServer_method_canvas_item_add_multiline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  94. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>` = RID()\ ) |
  96. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, source\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, topleft\: :ref:`Vector2<class_Vector2>`, bottomright\: :ref:`Vector2<class_Vector2>`, x_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, y_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, draw_center\: :ref:`bool<class_bool>` = true, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |
  98. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>`\ (\ item\: :ref:`RID<class_RID>`, particles\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  100. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | |void| | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  102. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | |void| | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  104. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | |void| | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`RID<class_RID>`\ ) |
  106. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | |void| | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  108. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | |void| | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  110. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | |void| | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, tile\: :ref:`bool<class_bool>` = false, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) |
  112. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | |void| | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) |
  114. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | |void| | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`\ (\ item\: :ref:`RID<class_RID>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), bones\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array<class_PackedFloat32Array>` = PackedFloat32Array(), texture\: :ref:`RID<class_RID>` = RID(), count\: :ref:`int<class_int>` = -1\ ) |
  116. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | |void| | :ref:`canvas_item_attach_skeleton<class_RenderingServer_method_canvas_item_attach_skeleton>`\ (\ item\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) |
  118. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | |void| | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  120. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>`\ (\ ) |
  122. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Variant<class_Variant>` | :ref:`canvas_item_get_instance_shader_parameter<class_RenderingServer_method_canvas_item_get_instance_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  124. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`Variant<class_Variant>` | :ref:`canvas_item_get_instance_shader_parameter_default_value<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  126. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`canvas_item_get_instance_shader_parameter_list<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| |
  128. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | |void| | :ref:`canvas_item_reset_physics_interpolation<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  130. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | |void| | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>`\ (\ item\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>`, clear_margin\: :ref:`float<class_float>` = 5.0, fit_empty\: :ref:`bool<class_bool>` = false, fit_margin\: :ref:`float<class_float>` = 0.0, blur_mipmaps\: :ref:`bool<class_bool>` = false\ ) |
  132. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | |void| | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>`\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) |
  134. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | |void| | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>`\ ) |
  136. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | |void| | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>`\ (\ item\: :ref:`RID<class_RID>`, use_custom_rect\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) |
  138. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | |void| | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>`\ (\ item\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  140. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | |void| | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  142. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | |void| | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  144. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | |void| | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  146. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | |void| | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>`\ (\ item\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  148. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | |void| | :ref:`canvas_item_set_instance_shader_parameter<class_RenderingServer_method_canvas_item_set_instance_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  150. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | |void| | :ref:`canvas_item_set_interpolated<class_RenderingServer_method_canvas_item_set_interpolated>`\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  152. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | |void| | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>`\ (\ item\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  154. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | |void| | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>`\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  156. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | |void| | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  158. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | |void| | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>`\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  160. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | |void| | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  162. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | |void| | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  164. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  166. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  168. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`canvas_item_set_visibility_layer<class_RenderingServer_method_canvas_item_set_visibility_layer>`\ (\ item\: :ref:`RID<class_RID>`, visibility_layer\: :ref:`int<class_int>`\ ) |
  170. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>`\ (\ item\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, area\: :ref:`Rect2<class_Rect2>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) |
  172. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |void| | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>`\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  174. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  176. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>`\ (\ item\: :ref:`RID<class_RID>`, z_index\: :ref:`int<class_int>`\ ) |
  178. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`canvas_item_transform_physics_interpolation<class_RenderingServer_method_canvas_item_transform_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  180. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>`\ (\ light\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  182. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>`\ (\ ) |
  184. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>`\ (\ occluder\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  186. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>`\ (\ ) |
  188. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`canvas_light_occluder_reset_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`\ ) |
  190. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>`\ (\ occluder\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  192. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>`\ (\ occluder\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  194. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`canvas_light_occluder_set_interpolated<class_RenderingServer_method_canvas_light_occluder_set_interpolated>`\ (\ occluder\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  196. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>`\ (\ occluder\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  198. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>`\ (\ occluder\: :ref:`RID<class_RID>`, polygon\: :ref:`RID<class_RID>`\ ) |
  200. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  202. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |void| | :ref:`canvas_light_occluder_transform_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  204. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |void| | :ref:`canvas_light_reset_physics_interpolation<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`\ ) |
  206. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`canvas_light_set_blend_mode<class_RenderingServer_method_canvas_light_set_blend_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>`\ ) |
  208. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  210. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  212. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>`\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  214. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>`\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) |
  216. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`canvas_light_set_interpolated<class_RenderingServer_method_canvas_light_set_interpolated>`\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  218. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |void| | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  220. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  222. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>`\ (\ light\: :ref:`RID<class_RID>`, min_layer\: :ref:`int<class_int>`, max_layer\: :ref:`int<class_int>`\ ) |
  224. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) |
  226. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  228. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  230. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>`\ (\ light\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>`\ ) |
  232. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>`\ (\ light\: :ref:`RID<class_RID>`, smooth\: :ref:`float<class_float>`\ ) |
  234. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  236. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>`\ (\ light\: :ref:`RID<class_RID>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
  238. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |void| | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>`\ (\ light\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  240. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  242. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>`\ (\ light\: :ref:`RID<class_RID>`, min_z\: :ref:`int<class_int>`, max_z\: :ref:`int<class_int>`\ ) |
  244. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`canvas_light_transform_physics_interpolation<class_RenderingServer_method_canvas_light_transform_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  246. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>`\ (\ ) |
  248. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>`\ ) |
  250. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, shape\: :ref:`PackedVector2Array<class_PackedVector2Array>`, closed\: :ref:`bool<class_bool>`\ ) |
  252. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>`\ (\ disable\: :ref:`bool<class_bool>`\ ) |
  254. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |void| | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>`\ (\ canvas\: :ref:`RID<class_RID>`, item\: :ref:`RID<class_RID>`, mirroring\: :ref:`Vector2<class_Vector2>`\ ) |
  256. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`canvas_set_item_repeat<class_RenderingServer_method_canvas_set_item_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat_size\: :ref:`Vector2<class_Vector2>`, repeat_times\: :ref:`int<class_int>`\ ) |
  258. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>`\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  260. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>`\ (\ size\: :ref:`int<class_int>`\ ) |
  262. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>`\ (\ ) |
  264. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |void| | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, channel\: :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>`, texture\: :ref:`RID<class_RID>`\ ) |
  266. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |void| | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, base_color\: :ref:`Color<class_Color>`, shininess\: :ref:`float<class_float>`\ ) |
  268. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  270. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | |void| | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  272. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`RID<class_RID>` | :ref:`compositor_create<class_RenderingServer_method_compositor_create>`\ (\ ) |
  274. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`RID<class_RID>` | :ref:`compositor_effect_create<class_RenderingServer_method_compositor_effect_create>`\ (\ ) |
  276. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`compositor_effect_set_callback<class_RenderingServer_method_compositor_effect_set_callback>`\ (\ effect\: :ref:`RID<class_RID>`, callback_type\: :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  278. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | |void| | :ref:`compositor_effect_set_enabled<class_RenderingServer_method_compositor_effect_set_enabled>`\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  280. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | |void| | :ref:`compositor_effect_set_flag<class_RenderingServer_method_compositor_effect_set_flag>`\ (\ effect\: :ref:`RID<class_RID>`, flag\: :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>`, set\: :ref:`bool<class_bool>`\ ) |
  282. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |void| | :ref:`compositor_set_compositor_effects<class_RenderingServer_method_compositor_set_compositor_effects>`\ (\ compositor\: :ref:`RID<class_RID>`, effects\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ ) |
  284. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>`\ (\ ) |const| |
  286. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`Rect2<class_Rect2>` | :ref:`debug_canvas_item_get_rect<class_RenderingServer_method_debug_canvas_item_get_rect>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  288. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>`\ (\ ) |
  290. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | |void| | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>`\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) |
  292. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | |void| | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>`\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  294. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | |void| | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  296. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | |void| | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>`\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  298. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | |void| | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>`\ (\ decal\: :ref:`RID<class_RID>`, above\: :ref:`float<class_float>`, below\: :ref:`float<class_float>`\ ) |
  300. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | |void| | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>`\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  302. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | |void| | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>`\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) |
  304. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | |void| | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>`\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  306. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | |void| | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>`\ (\ decal\: :ref:`RID<class_RID>`, type\: :ref:`DecalTexture<enum_RenderingServer_DecalTexture>`, texture\: :ref:`RID<class_RID>`\ ) |
  308. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | |void| | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>`\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) |
  310. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>`\ (\ ) |
  312. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | |void| | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>`\ (\ size\: :ref:`int<class_int>`, is_16bits\: :ref:`bool<class_bool>`\ ) |
  314. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | |void| | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  316. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>`\ (\ environment\: :ref:`RID<class_RID>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  318. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>`\ (\ ) |
  320. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |void| | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  322. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |void| | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`, use_1d_color_correction\: :ref:`bool<class_bool>`, color_correction\: :ref:`RID<class_RID>`\ ) |
  324. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contribution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) |
  326. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>`\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) |
  328. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |void| | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  330. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |void| | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>`\ (\ env\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, exposure_value\: :ref:`float<class_float>`\ ) |
  332. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`environment_set_camera_id<class_RenderingServer_method_environment_set_camera_id>`\ (\ env\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  334. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |void| | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>`\ (\ env\: :ref:`RID<class_RID>`, max_layer\: :ref:`int<class_int>`\ ) |
  336. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |void| | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, light_color\: :ref:`Color<class_Color>`, light_energy\: :ref:`float<class_float>`, sun_scatter\: :ref:`float<class_float>`, density\: :ref:`float<class_float>`, height\: :ref:`float<class_float>`, height_density\: :ref:`float<class_float>`, aerial_perspective\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`, fog_mode\: :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` = 0\ ) |
  338. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |void| | :ref:`environment_set_glow<class_RenderingServer_method_environment_set_glow>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, levels\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, intensity\: :ref:`float<class_float>`, strength\: :ref:`float<class_float>`, mix\: :ref:`float<class_float>`, bloom_threshold\: :ref:`float<class_float>`, blend_mode\: :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>`, hdr_bleed_threshold\: :ref:`float<class_float>`, hdr_bleed_scale\: :ref:`float<class_float>`, hdr_luminance_cap\: :ref:`float<class_float>`, glow_map_strength\: :ref:`float<class_float>`, glow_map\: :ref:`RID<class_RID>`\ ) |
  340. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |void| | :ref:`environment_set_sdfgi<class_RenderingServer_method_environment_set_sdfgi>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, cascades\: :ref:`int<class_int>`, min_cell_size\: :ref:`float<class_float>`, y_scale\: :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>`, use_occlusion\: :ref:`bool<class_bool>`, bounce_feedback\: :ref:`float<class_float>`, read_sky\: :ref:`bool<class_bool>`, energy\: :ref:`float<class_float>`, normal_bias\: :ref:`float<class_float>`, probe_bias\: :ref:`float<class_float>`\ ) |
  342. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |void| | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) |
  344. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |void| | :ref:`environment_set_sdfgi_frames_to_update_light<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`\ ) |
  346. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |void| | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>`\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) |
  348. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | |void| | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>`\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) |
  350. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | |void| | :ref:`environment_set_sky_custom_fov<class_RenderingServer_method_environment_set_sky_custom_fov>`\ (\ env\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  352. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | |void| | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>`\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) |
  354. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | |void| | :ref:`environment_set_ssao<class_RenderingServer_method_environment_set_ssao>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, radius\: :ref:`float<class_float>`, intensity\: :ref:`float<class_float>`, power\: :ref:`float<class_float>`, detail\: :ref:`float<class_float>`, horizon\: :ref:`float<class_float>`, sharpness\: :ref:`float<class_float>`, light_affect\: :ref:`float<class_float>`, ao_channel_affect\: :ref:`float<class_float>`\ ) |
  356. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |void| | :ref:`environment_set_ssao_quality<class_RenderingServer_method_environment_set_ssao_quality>`\ (\ quality\: :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) |
  358. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |void| | :ref:`environment_set_ssil_quality<class_RenderingServer_method_environment_set_ssil_quality>`\ (\ quality\: :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) |
  360. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | |void| | :ref:`environment_set_ssr<class_RenderingServer_method_environment_set_ssr>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, max_steps\: :ref:`int<class_int>`, fade_in\: :ref:`float<class_float>`, fade_out\: :ref:`float<class_float>`, depth_tolerance\: :ref:`float<class_float>`\ ) |
  362. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | |void| | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>`\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) |
  364. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | |void| | :ref:`environment_set_tonemap<class_RenderingServer_method_environment_set_tonemap>`\ (\ env\: :ref:`RID<class_RID>`, tone_mapper\: :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>`, exposure\: :ref:`float<class_float>`, white\: :ref:`float<class_float>`\ ) |
  366. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | |void| | :ref:`environment_set_volumetric_fog<class_RenderingServer_method_environment_set_volumetric_fog>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, density\: :ref:`float<class_float>`, albedo\: :ref:`Color<class_Color>`, emission\: :ref:`Color<class_Color>`, emission_energy\: :ref:`float<class_float>`, anisotropy\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`, p_detail_spread\: :ref:`float<class_float>`, gi_inject\: :ref:`float<class_float>`, temporal_reprojection\: :ref:`bool<class_bool>`, temporal_reprojection_amount\: :ref:`float<class_float>`, ambient_inject\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`\ ) |
  368. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | |void| | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  370. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | |void| | :ref:`environment_set_volumetric_fog_volume_size<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>`\ (\ size\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`\ ) |
  372. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>`\ (\ ) |
  374. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | |void| | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>`\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  376. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | |void| | :ref:`fog_volume_set_shape<class_RenderingServer_method_fog_volume_set_shape>`\ (\ fog_volume\: :ref:`RID<class_RID>`, shape\: :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>`\ ) |
  378. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | |void| | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>`\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  380. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | |void| | :ref:`force_draw<class_RenderingServer_method_force_draw>`\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) |
  382. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | |void| | :ref:`force_sync<class_RenderingServer_method_force_sync>`\ (\ ) |
  384. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | |void| | :ref:`free_rid<class_RenderingServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  386. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`String<class_String>` | :ref:`get_current_rendering_driver_name<class_RenderingServer_method_get_current_rendering_driver_name>`\ (\ ) |const| |
  388. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`String<class_String>` | :ref:`get_current_rendering_method<class_RenderingServer_method_get_current_rendering_method>`\ (\ ) |const| |
  390. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>`\ (\ ) |
  392. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>`\ (\ ) |const| |
  394. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>`\ (\ ) |const| |
  396. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) |
  398. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_shader_parameter_list<class_RenderingServer_method_get_shader_parameter_list>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| |
  400. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>`\ (\ ) |
  402. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>`\ (\ ) |
  404. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>`\ (\ ) |const| |
  406. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>`\ (\ ) |const| |
  408. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>`\ (\ ) |const| |
  410. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>`\ (\ ) |const| |
  412. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>`\ (\ ) |
  414. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | |void| | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>`\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) |
  416. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | |void| | :ref:`global_shader_parameter_add<class_RenderingServer_method_global_shader_parameter_add>`\ (\ name\: :ref:`StringName<class_StringName>`, type\: :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>`, default_value\: :ref:`Variant<class_Variant>`\ ) |
  418. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  420. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>`\ (\ ) |const| |
  422. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` | :ref:`global_shader_parameter_get_type<class_RenderingServer_method_global_shader_parameter_get_type>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  424. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | |void| | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
  426. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |void| | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  428. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |void| | :ref:`global_shader_parameter_set_override<class_RenderingServer_method_global_shader_parameter_set_override>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  430. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>`\ (\ ) |const| |
  432. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>`\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| |
  434. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>`\ (\ feature\: :ref:`String<class_String>`\ ) |const| |
  436. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | |void| | :ref:`instance_attach_object_instance_id<class_RenderingServer_method_instance_attach_object_instance_id>`\ (\ instance\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  438. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | |void| | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>`\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) |
  440. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>`\ (\ ) |
  442. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>`\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  444. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter<class_RenderingServer_method_instance_geometry_get_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  446. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter_default_value<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  448. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`instance_geometry_get_shader_parameter_list<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| |
  450. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | |void| | :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`\ (\ instance\: :ref:`RID<class_RID>`, shadow_casting_setting\: :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`\ ) |
  452. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | |void| | :ref:`instance_geometry_set_flag<class_RenderingServer_method_instance_geometry_set_flag>`\ (\ instance\: :ref:`RID<class_RID>`, flag\: :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`, enabled\: :ref:`bool<class_bool>`\ ) |
  454. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | |void| | :ref:`instance_geometry_set_lightmap<class_RenderingServer_method_instance_geometry_set_lightmap>`\ (\ instance\: :ref:`RID<class_RID>`, lightmap\: :ref:`RID<class_RID>`, lightmap_uv_scale\: :ref:`Rect2<class_Rect2>`, lightmap_slice\: :ref:`int<class_int>`\ ) |
  456. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | |void| | :ref:`instance_geometry_set_lod_bias<class_RenderingServer_method_instance_geometry_set_lod_bias>`\ (\ instance\: :ref:`RID<class_RID>`, lod_bias\: :ref:`float<class_float>`\ ) |
  458. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | |void| | :ref:`instance_geometry_set_material_overlay<class_RenderingServer_method_instance_geometry_set_material_overlay>`\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  460. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | |void| | :ref:`instance_geometry_set_material_override<class_RenderingServer_method_instance_geometry_set_material_override>`\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  462. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | |void| | :ref:`instance_geometry_set_shader_parameter<class_RenderingServer_method_instance_geometry_set_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  464. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | |void| | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>`\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) |
  466. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | |void| | :ref:`instance_geometry_set_visibility_range<class_RenderingServer_method_instance_geometry_set_visibility_range>`\ (\ instance\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`, min_margin\: :ref:`float<class_float>`, max_margin\: :ref:`float<class_float>`, fade_mode\: :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>`\ ) |
  468. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | |void| | :ref:`instance_reset_physics_interpolation<class_RenderingServer_method_instance_reset_physics_interpolation>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |
  470. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | |void| | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) |
  472. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | |void| | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>`\ (\ instance\: :ref:`RID<class_RID>`, shape\: :ref:`int<class_int>`, weight\: :ref:`float<class_float>`\ ) |
  474. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | |void| | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>`\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  476. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | |void| | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>`\ (\ instance\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  478. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | |void| | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>`\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  480. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | |void| | :ref:`instance_set_interpolated<class_RenderingServer_method_instance_set_interpolated>`\ (\ instance\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  482. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | |void| | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>`\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  484. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | |void| | :ref:`instance_set_pivot_data<class_RenderingServer_method_instance_set_pivot_data>`\ (\ instance\: :ref:`RID<class_RID>`, sorting_offset\: :ref:`float<class_float>`, use_aabb_center\: :ref:`bool<class_bool>`\ ) |
  486. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | |void| | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>`\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  488. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | |void| | :ref:`instance_set_surface_override_material<class_RenderingServer_method_instance_set_surface_override_material>`\ (\ instance\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) |
  490. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | |void| | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>`\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  492. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | |void| | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>`\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  494. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | |void| | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>`\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  496. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`\ (\ aabb\: :ref:`AABB<class_AABB>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  498. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`\ (\ convex\: :ref:`Array<class_Array>`\[:ref:`Plane<class_Plane>`\], scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  500. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  501. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  502. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  503. | :ref:`bool<class_bool>` | :ref:`is_on_render_thread<class_RenderingServer_method_is_on_render_thread>`\ (\ ) |
  504. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  505. | |void| | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  506. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  507. | |void| | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>`\ ) |
  508. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  509. | |void| | :ref:`light_directional_set_sky_mode<class_RenderingServer_method_light_directional_set_sky_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>`\ ) |
  510. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  511. | |void| | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>`\ ) |
  512. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  513. | |void| | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>`\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) |
  514. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  515. | |void| | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>`\ (\ light\: :ref:`RID<class_RID>`, bake_mode\: :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>`\ ) |
  516. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  517. | |void| | :ref:`light_set_color<class_RenderingServer_method_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  518. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  519. | |void| | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  520. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  521. | |void| | :ref:`light_set_distance_fade<class_RenderingServer_method_light_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, shadow\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  522. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  523. | |void| | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>`\ (\ light\: :ref:`RID<class_RID>`, cascade\: :ref:`int<class_int>`\ ) |
  524. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  525. | |void| | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  526. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  527. | |void| | :ref:`light_set_param<class_RenderingServer_method_light_set_param>`\ (\ light\: :ref:`RID<class_RID>`, param\: :ref:`LightParam<enum_RenderingServer_LightParam>`, value\: :ref:`float<class_float>`\ ) |
  528. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  529. | |void| | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  530. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  531. | |void| | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  532. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  533. | |void| | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  534. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  535. | |void| | :ref:`light_set_shadow_caster_mask<class_RenderingServer_method_light_set_shadow_caster_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  536. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  537. | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>`\ (\ ) |
  538. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  539. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  540. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  541. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  542. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  543. | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  544. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  545. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  546. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  547. | |void| | :ref:`lightmap_set_baked_exposure_normalization<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>`\ (\ lightmap\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) |
  548. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  549. | |void| | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>`\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) |
  550. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  551. | |void| | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>`\ (\ lightmap\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector3Array<class_PackedVector3Array>`, point_sh\: :ref:`PackedColorArray<class_PackedColorArray>`, tetrahedra\: :ref:`PackedInt32Array<class_PackedInt32Array>`, bsp_tree\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  552. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  553. | |void| | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`\ (\ speed\: :ref:`float<class_float>`\ ) |
  554. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  555. | |void| | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>`\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) |
  556. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  557. | |void| | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>`\ (\ lightmap\: :ref:`RID<class_RID>`, light\: :ref:`RID<class_RID>`, uses_sh\: :ref:`bool<class_bool>`\ ) |
  558. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  559. | |void| | :ref:`lightmaps_set_bicubic_filter<class_RenderingServer_method_lightmaps_set_bicubic_filter>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  560. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  561. | :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>`\ (\ latitudes\: :ref:`int<class_int>`, longitudes\: :ref:`int<class_int>`, radius\: :ref:`float<class_float>`\ ) |
  562. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  563. | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>`\ (\ ) |
  564. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  565. | :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  566. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  567. | |void| | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>`\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) |
  568. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  569. | |void| | :ref:`material_set_param<class_RenderingServer_method_material_set_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  570. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  571. | |void| | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>`\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  572. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  573. | |void| | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>`\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) |
  574. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  575. | |void| | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) |
  576. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  577. | |void| | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, primitive\: :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>` = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\] = 0\ ) |
  578. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  579. | |void| | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |
  580. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  581. | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>`\ (\ ) |
  582. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  583. | :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>`\ (\ surfaces\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], blend_shape_count\: :ref:`int<class_int>` = 0\ ) |
  584. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  585. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  586. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  587. | :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  588. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  589. | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  590. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  591. | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |
  592. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  593. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  594. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  595. | |void| | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`, mode\: :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>`\ ) |
  596. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  597. | |void| | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  598. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  599. | |void| | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>`\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) |
  600. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  601. | :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  602. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  603. | :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  604. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  605. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  606. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  607. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_normal_tangent_stride<class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  608. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  609. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_RenderingServer_method_mesh_surface_get_format_offset>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`, array_index\: :ref:`int<class_int>`\ ) |const| |
  610. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  611. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_skin_stride<class_RenderingServer_method_mesh_surface_get_format_skin_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  612. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  613. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_vertex_stride<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  614. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  615. | :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_RenderingServer_method_mesh_surface_get_material>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  616. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  617. | |void| | :ref:`mesh_surface_remove<class_RenderingServer_method_mesh_surface_remove>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |
  618. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  619. | |void| | :ref:`mesh_surface_set_material<class_RenderingServer_method_mesh_surface_set_material>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) |
  620. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  621. | |void| | :ref:`mesh_surface_update_attribute_region<class_RenderingServer_method_mesh_surface_update_attribute_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  622. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  623. | |void| | :ref:`mesh_surface_update_skin_region<class_RenderingServer_method_mesh_surface_update_skin_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  624. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  625. | |void| | :ref:`mesh_surface_update_vertex_region<class_RenderingServer_method_mesh_surface_update_vertex_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  626. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  627. | |void| | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false, use_indirect\: :ref:`bool<class_bool>` = false\ ) |
  628. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  629. | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>`\ (\ ) |
  630. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  631. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  632. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  633. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  634. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  635. | :ref:`RID<class_RID>` | :ref:`multimesh_get_buffer_rd_rid<class_RenderingServer_method_multimesh_get_buffer_rd_rid>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  636. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  637. | :ref:`RID<class_RID>` | :ref:`multimesh_get_command_buffer_rd_rid<class_RenderingServer_method_multimesh_get_command_buffer_rd_rid>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  638. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  639. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_custom_aabb<class_RenderingServer_method_multimesh_get_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  640. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  641. | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  642. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  643. | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  644. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  645. | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  646. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  647. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_RenderingServer_method_multimesh_instance_get_color>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  648. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  649. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_RenderingServer_method_multimesh_instance_get_custom_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  650. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  651. | :ref:`Transform3D<class_Transform3D>` | :ref:`multimesh_instance_get_transform<class_RenderingServer_method_multimesh_instance_get_transform>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  652. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  653. | :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_RenderingServer_method_multimesh_instance_get_transform_2d>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  654. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  655. | |void| | :ref:`multimesh_instance_reset_physics_interpolation<class_RenderingServer_method_multimesh_instance_reset_physics_interpolation>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  656. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  657. | |void| | :ref:`multimesh_instance_set_color<class_RenderingServer_method_multimesh_instance_set_color>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |
  658. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  659. | |void| | :ref:`multimesh_instance_set_custom_data<class_RenderingServer_method_multimesh_instance_set_custom_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, custom_data\: :ref:`Color<class_Color>`\ ) |
  660. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  661. | |void| | :ref:`multimesh_instance_set_transform<class_RenderingServer_method_multimesh_instance_set_transform>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  662. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  663. | |void| | :ref:`multimesh_instance_set_transform_2d<class_RenderingServer_method_multimesh_instance_set_transform_2d>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  664. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  665. | |void| | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  666. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  667. | |void| | :ref:`multimesh_set_buffer_interpolated<class_RenderingServer_method_multimesh_set_buffer_interpolated>`\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, buffer_previous\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  668. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  669. | |void| | :ref:`multimesh_set_custom_aabb<class_RenderingServer_method_multimesh_set_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  670. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  671. | |void| | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  672. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  673. | |void| | :ref:`multimesh_set_physics_interpolated<class_RenderingServer_method_multimesh_set_physics_interpolated>`\ (\ multimesh\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  674. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  675. | |void| | :ref:`multimesh_set_physics_interpolation_quality<class_RenderingServer_method_multimesh_set_physics_interpolation_quality>`\ (\ multimesh\: :ref:`RID<class_RID>`, quality\: :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`\ ) |
  676. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  677. | |void| | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) |
  678. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  679. | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>`\ (\ ) |
  680. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  681. | |void| | :ref:`occluder_set_mesh<class_RenderingServer_method_occluder_set_mesh>`\ (\ occluder\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  682. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  683. | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>`\ (\ ) |
  684. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  685. | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>`\ (\ ) |
  686. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  687. | |void| | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>`\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) |
  688. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  689. | |void| | :ref:`particles_collision_set_attractor_attenuation<class_RenderingServer_method_particles_collision_set_attractor_attenuation>`\ (\ particles_collision\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`\ ) |
  690. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  691. | |void| | :ref:`particles_collision_set_attractor_directionality<class_RenderingServer_method_particles_collision_set_attractor_directionality>`\ (\ particles_collision\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) |
  692. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  693. | |void| | :ref:`particles_collision_set_attractor_strength<class_RenderingServer_method_particles_collision_set_attractor_strength>`\ (\ particles_collision\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  694. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  695. | |void| | :ref:`particles_collision_set_box_extents<class_RenderingServer_method_particles_collision_set_box_extents>`\ (\ particles_collision\: :ref:`RID<class_RID>`, extents\: :ref:`Vector3<class_Vector3>`\ ) |
  696. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  697. | |void| | :ref:`particles_collision_set_collision_type<class_RenderingServer_method_particles_collision_set_collision_type>`\ (\ particles_collision\: :ref:`RID<class_RID>`, type\: :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>`\ ) |
  698. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  699. | |void| | :ref:`particles_collision_set_cull_mask<class_RenderingServer_method_particles_collision_set_cull_mask>`\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  700. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  701. | |void| | :ref:`particles_collision_set_field_texture<class_RenderingServer_method_particles_collision_set_field_texture>`\ (\ particles_collision\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  702. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  703. | |void| | :ref:`particles_collision_set_height_field_resolution<class_RenderingServer_method_particles_collision_set_height_field_resolution>`\ (\ particles_collision\: :ref:`RID<class_RID>`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`\ ) |
  704. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  705. | |void| | :ref:`particles_collision_set_sphere_radius<class_RenderingServer_method_particles_collision_set_sphere_radius>`\ (\ particles_collision\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) |
  706. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  707. | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>`\ (\ ) |
  708. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  709. | |void| | :ref:`particles_emit<class_RenderingServer_method_particles_emit>`\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, emit_flags\: :ref:`int<class_int>`\ ) |
  710. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  711. | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  712. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  713. | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  714. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  715. | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  716. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  717. | |void| | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  718. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  719. | |void| | :ref:`particles_request_process_time<class_RenderingServer_method_particles_request_process_time>`\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) |
  720. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  721. | |void| | :ref:`particles_restart<class_RenderingServer_method_particles_restart>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  722. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  723. | |void| | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>`\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) |
  724. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  725. | |void| | :ref:`particles_set_amount_ratio<class_RenderingServer_method_particles_set_amount_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  726. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  727. | |void| | :ref:`particles_set_collision_base_size<class_RenderingServer_method_particles_set_collision_base_size>`\ (\ particles\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`\ ) |
  728. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  729. | |void| | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>`\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  730. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  731. | |void| | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>`\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) |
  732. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  733. | |void| | :ref:`particles_set_draw_pass_mesh<class_RenderingServer_method_particles_set_draw_pass_mesh>`\ (\ particles\: :ref:`RID<class_RID>`, pass\: :ref:`int<class_int>`, mesh\: :ref:`RID<class_RID>`\ ) |
  734. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  735. | |void| | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>`\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  736. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  737. | |void| | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>`\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  738. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  739. | |void| | :ref:`particles_set_emitter_velocity<class_RenderingServer_method_particles_set_emitter_velocity>`\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  740. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  741. | |void| | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>`\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) |
  742. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  743. | |void| | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  744. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  745. | |void| | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>`\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) |
  746. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  747. | |void| | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  748. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  749. | |void| | :ref:`particles_set_interp_to_end<class_RenderingServer_method_particles_set_interp_to_end>`\ (\ particles\: :ref:`RID<class_RID>`, factor\: :ref:`float<class_float>`\ ) |
  750. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  751. | |void| | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  752. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  753. | |void| | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>`\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) |
  754. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  755. | |void| | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>`\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) |
  756. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  757. | |void| | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>`\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) |
  758. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  759. | |void| | :ref:`particles_set_pre_process_time<class_RenderingServer_method_particles_set_pre_process_time>`\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) |
  760. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  761. | |void| | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>`\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  762. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  763. | |void| | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  764. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  765. | |void| | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>`\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  766. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  767. | |void| | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>`\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) |
  768. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  769. | |void| | :ref:`particles_set_trail_bind_poses<class_RenderingServer_method_particles_set_trail_bind_poses>`\ (\ particles\: :ref:`RID<class_RID>`, bind_poses\: :ref:`Array<class_Array>`\[:ref:`Transform3D<class_Transform3D>`\]\ ) |
  770. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  771. | |void| | :ref:`particles_set_trails<class_RenderingServer_method_particles_set_trails>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, length_sec\: :ref:`float<class_float>`\ ) |
  772. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  773. | |void| | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>`\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) |
  774. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  775. | |void| | :ref:`particles_set_use_local_coordinates<class_RenderingServer_method_particles_set_use_local_coordinates>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  776. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  777. | |void| | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  778. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  779. | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>`\ (\ ) |
  780. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  781. | |void| | :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>`\ (\ probe\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  782. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  783. | |void| | :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>`\ (\ probe\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  784. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  785. | |void| | :ref:`reflection_probe_set_ambient_mode<class_RenderingServer_method_reflection_probe_set_ambient_mode>`\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>`\ ) |
  786. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  787. | |void| | :ref:`reflection_probe_set_as_interior<class_RenderingServer_method_reflection_probe_set_as_interior>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  788. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  789. | |void| | :ref:`reflection_probe_set_blend_distance<class_RenderingServer_method_reflection_probe_set_blend_distance>`\ (\ probe\: :ref:`RID<class_RID>`, blend_distance\: :ref:`float<class_float>`\ ) |
  790. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  791. | |void| | :ref:`reflection_probe_set_cull_mask<class_RenderingServer_method_reflection_probe_set_cull_mask>`\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  792. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  793. | |void| | :ref:`reflection_probe_set_enable_box_projection<class_RenderingServer_method_reflection_probe_set_enable_box_projection>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  794. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  795. | |void| | :ref:`reflection_probe_set_enable_shadows<class_RenderingServer_method_reflection_probe_set_enable_shadows>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  796. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  797. | |void| | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>`\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) |
  798. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  799. | |void| | :ref:`reflection_probe_set_max_distance<class_RenderingServer_method_reflection_probe_set_max_distance>`\ (\ probe\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) |
  800. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  801. | |void| | :ref:`reflection_probe_set_mesh_lod_threshold<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>`\ (\ probe\: :ref:`RID<class_RID>`, pixels\: :ref:`float<class_float>`\ ) |
  802. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  803. | |void| | :ref:`reflection_probe_set_origin_offset<class_RenderingServer_method_reflection_probe_set_origin_offset>`\ (\ probe\: :ref:`RID<class_RID>`, offset\: :ref:`Vector3<class_Vector3>`\ ) |
  804. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  805. | |void| | :ref:`reflection_probe_set_reflection_mask<class_RenderingServer_method_reflection_probe_set_reflection_mask>`\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  806. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  807. | |void| | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>`\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) |
  808. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  809. | |void| | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>`\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  810. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  811. | |void| | :ref:`reflection_probe_set_update_mode<class_RenderingServer_method_reflection_probe_set_update_mode>`\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>`\ ) |
  812. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  813. | |void| | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  814. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  815. | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>`\ (\ ) |
  816. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  817. | |void| | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>`\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  818. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  819. | |void| | :ref:`scenario_set_compositor<class_RenderingServer_method_scenario_set_compositor>`\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  820. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  821. | |void| | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  822. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  823. | |void| | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  824. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  825. | |void| | :ref:`screen_space_roughness_limiter_set_active<class_RenderingServer_method_screen_space_roughness_limiter_set_active>`\ (\ enable\: :ref:`bool<class_bool>`, amount\: :ref:`float<class_float>`, limit\: :ref:`float<class_float>`\ ) |
  826. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  827. | |void| | :ref:`set_boot_image<class_RenderingServer_method_set_boot_image>`\ (\ image\: :ref:`Image<class_Image>`, color\: :ref:`Color<class_Color>`, scale\: :ref:`bool<class_bool>`, use_filter\: :ref:`bool<class_bool>` = true\ ) |
  828. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  829. | |void| | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>`\ (\ generate\: :ref:`bool<class_bool>`\ ) |
  830. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  831. | |void| | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
  832. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  833. | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>`\ (\ ) |
  834. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  835. | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| |
  836. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  837. | :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_parameter<class_RenderingServer_method_shader_get_default_texture_parameter>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, index\: :ref:`int<class_int>` = 0\ ) |const| |
  838. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  839. | :ref:`Variant<class_Variant>` | :ref:`shader_get_parameter_default<class_RenderingServer_method_shader_get_parameter_default>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`\ ) |const| |
  840. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  841. | |void| | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>`\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) |
  842. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  843. | |void| | :ref:`shader_set_default_texture_parameter<class_RenderingServer_method_shader_set_default_texture_parameter>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, texture\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>` = 0\ ) |
  844. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  845. | |void| | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>`\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  846. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  847. | |void| | :ref:`skeleton_allocate_data<class_RenderingServer_method_skeleton_allocate_data>`\ (\ skeleton\: :ref:`RID<class_RID>`, bones\: :ref:`int<class_int>`, is_2d_skeleton\: :ref:`bool<class_bool>` = false\ ) |
  848. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  849. | :ref:`Transform3D<class_Transform3D>` | :ref:`skeleton_bone_get_transform<class_RenderingServer_method_skeleton_bone_get_transform>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| |
  850. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  851. | :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_RenderingServer_method_skeleton_bone_get_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| |
  852. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  853. | |void| | :ref:`skeleton_bone_set_transform<class_RenderingServer_method_skeleton_bone_set_transform>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  854. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  855. | |void| | :ref:`skeleton_bone_set_transform_2d<class_RenderingServer_method_skeleton_bone_set_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  856. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  857. | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>`\ (\ ) |
  858. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  859. | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>`\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| |
  860. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  861. | |void| | :ref:`skeleton_set_base_transform_2d<class_RenderingServer_method_skeleton_set_base_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, base_transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  862. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  863. | :ref:`Image<class_Image>` | :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>`\ (\ sky\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  864. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  865. | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>`\ (\ ) |
  866. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  867. | |void| | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>`\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  868. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  869. | |void| | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>`\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) |
  870. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  871. | |void| | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>`\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) |
  872. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  873. | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>`\ (\ ) |
  874. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  875. | |void| | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>`\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) |
  876. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  877. | |void| | :ref:`sub_surface_scattering_set_scale<class_RenderingServer_method_sub_surface_scattering_set_scale>`\ (\ scale\: :ref:`float<class_float>`, depth_scale\: :ref:`float<class_float>`\ ) |
  878. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  879. | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
  880. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  881. | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  882. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  883. | :ref:`Image<class_Image>` | :ref:`texture_2d_layer_get<class_RenderingServer_method_texture_2d_layer_get>`\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |const| |
  884. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  885. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_create<class_RenderingServer_method_texture_2d_layered_create>`\ (\ layers\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\], layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) |
  886. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  887. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>`\ (\ layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) |
  888. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  889. | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>`\ (\ ) |
  890. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  891. | |void| | :ref:`texture_2d_update<class_RenderingServer_method_texture_2d_update>`\ (\ texture\: :ref:`RID<class_RID>`, image\: :ref:`Image<class_Image>`, layer\: :ref:`int<class_int>`\ ) |
  892. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  893. | :ref:`RID<class_RID>` | :ref:`texture_3d_create<class_RenderingServer_method_texture_3d_create>`\ (\ format\: :ref:`Format<enum_Image_Format>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, mipmaps\: :ref:`bool<class_bool>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) |
  894. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  895. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  896. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  897. | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>`\ (\ ) |
  898. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  899. | |void| | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>`\ (\ texture\: :ref:`RID<class_RID>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) |
  900. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  901. | :ref:`RID<class_RID>` | :ref:`texture_create_from_native_handle<class_RenderingServer_method_texture_create_from_native_handle>`\ (\ type\: :ref:`TextureType<enum_RenderingServer_TextureType>`, format\: :ref:`Format<enum_Image_Format>`, native_handle\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>` = 1, layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) |
  902. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  903. | :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_RenderingServer_method_texture_get_format>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  904. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  905. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingServer_method_texture_get_native_handle>`\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| |
  906. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  907. | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  908. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  909. | :ref:`RID<class_RID>` | :ref:`texture_get_rd_texture<class_RenderingServer_method_texture_get_rd_texture>`\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| |
  910. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  911. | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>`\ (\ base\: :ref:`RID<class_RID>`\ ) |
  912. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  913. | |void| | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>`\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) |
  914. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  915. | :ref:`RID<class_RID>` | :ref:`texture_rd_create<class_RenderingServer_method_texture_rd_create>`\ (\ rd_texture\: :ref:`RID<class_RID>`, layer_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) |
  916. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  917. | |void| | :ref:`texture_replace<class_RenderingServer_method_texture_replace>`\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) |
  918. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  919. | |void| | :ref:`texture_set_force_redraw_if_visible<class_RenderingServer_method_texture_set_force_redraw_if_visible>`\ (\ texture\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  920. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  921. | |void| | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>`\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  922. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  923. | |void| | :ref:`texture_set_size_override<class_RenderingServer_method_texture_set_size_override>`\ (\ texture\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
  924. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  925. | |void| | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>`\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) |
  926. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  927. | |void| | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  928. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  929. | |void| | :ref:`viewport_attach_to_screen<class_RenderingServer_method_viewport_attach_to_screen>`\ (\ viewport\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), screen\: :ref:`int<class_int>` = 0\ ) |
  930. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  931. | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>`\ (\ ) |
  932. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  933. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  934. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  935. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  936. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  937. | :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>`\ (\ viewport\: :ref:`RID<class_RID>`, type\: :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>`, info\: :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>`\ ) |
  938. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  939. | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  940. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  941. | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  942. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  943. | :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` | :ref:`viewport_get_update_mode<class_RenderingServer_method_viewport_get_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  944. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  945. | |void| | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  946. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  947. | |void| | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>`\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  948. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  949. | |void| | :ref:`viewport_set_anisotropic_filtering_level<class_RenderingServer_method_viewport_set_anisotropic_filtering_level>`\ (\ viewport\: :ref:`RID<class_RID>`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>`\ ) |
  950. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  951. | |void| | :ref:`viewport_set_canvas_cull_mask<class_RenderingServer_method_viewport_set_canvas_cull_mask>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas_cull_mask\: :ref:`int<class_int>`\ ) |
  952. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  953. | |void| | :ref:`viewport_set_canvas_stacking<class_RenderingServer_method_viewport_set_canvas_stacking>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, sublayer\: :ref:`int<class_int>`\ ) |
  954. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  955. | |void| | :ref:`viewport_set_canvas_transform<class_RenderingServer_method_viewport_set_canvas_transform>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, offset\: :ref:`Transform2D<class_Transform2D>`\ ) |
  956. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  957. | |void| | :ref:`viewport_set_clear_mode<class_RenderingServer_method_viewport_set_clear_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, clear_mode\: :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>`\ ) |
  958. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  959. | |void| | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>`\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) |
  960. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  961. | |void| | :ref:`viewport_set_default_canvas_item_texture_filter<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>`\ (\ viewport\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  962. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  963. | |void| | :ref:`viewport_set_default_canvas_item_texture_repeat<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>`\ (\ viewport\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  964. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  965. | |void| | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  966. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  967. | |void| | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  968. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  969. | |void| | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) |
  970. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  971. | |void| | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>`\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) |
  972. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  973. | |void| | :ref:`viewport_set_global_canvas_transform<class_RenderingServer_method_viewport_set_global_canvas_transform>`\ (\ viewport\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  974. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  975. | |void| | :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  976. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  977. | |void| | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  978. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  979. | |void| | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  980. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  981. | |void| | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) |
  982. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  983. | |void| | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) |
  984. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  985. | |void| | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>`\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) |
  986. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  987. | |void| | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>`\ (\ viewport\: :ref:`RID<class_RID>`, quadrant\: :ref:`int<class_int>`, subdivision\: :ref:`int<class_int>`\ ) |
  988. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  989. | |void| | :ref:`viewport_set_positional_shadow_atlas_size<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>`\ (\ viewport\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, use_16_bits\: :ref:`bool<class_bool>` = false\ ) |
  990. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  991. | |void| | :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  992. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  993. | |void| | :ref:`viewport_set_scaling_3d_mode<class_RenderingServer_method_viewport_set_scaling_3d_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, scaling_3d_mode\: :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>`\ ) |
  994. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  995. | |void| | :ref:`viewport_set_scaling_3d_scale<class_RenderingServer_method_viewport_set_scaling_3d_scale>`\ (\ viewport\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  996. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  997. | |void| | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>`\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  998. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  999. | |void| | :ref:`viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>`\ ) |
  1000. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1001. | |void| | :ref:`viewport_set_sdf_oversize_and_scale<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>`\ (\ viewport\: :ref:`RID<class_RID>`, oversize\: :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>`, scale\: :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>`\ ) |
  1002. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1003. | |void| | :ref:`viewport_set_size<class_RenderingServer_method_viewport_set_size>`\ (\ viewport\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
  1004. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1005. | |void| | :ref:`viewport_set_snap_2d_transforms_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  1006. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1007. | |void| | :ref:`viewport_set_snap_2d_vertices_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  1008. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1009. | |void| | :ref:`viewport_set_texture_mipmap_bias<class_RenderingServer_method_viewport_set_texture_mipmap_bias>`\ (\ viewport\: :ref:`RID<class_RID>`, mipmap_bias\: :ref:`float<class_float>`\ ) |
  1010. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1011. | |void| | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  1012. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1013. | |void| | :ref:`viewport_set_update_mode<class_RenderingServer_method_viewport_set_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, update_mode\: :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>`\ ) |
  1014. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1015. | |void| | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1016. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1017. | |void| | :ref:`viewport_set_use_hdr_2d<class_RenderingServer_method_viewport_set_use_hdr_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  1018. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1019. | |void| | :ref:`viewport_set_use_occlusion_culling<class_RenderingServer_method_viewport_set_use_occlusion_culling>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1020. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1021. | |void| | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1022. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1023. | |void| | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>`\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) |
  1024. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1025. | |void| | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) |
  1026. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1027. | |void| | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>`\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  1028. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1029. | |void| | :ref:`viewport_set_vrs_update_mode<class_RenderingServer_method_viewport_set_vrs_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>`\ ) |
  1030. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1031. | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>`\ (\ ) |
  1032. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1033. | |void| | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>`\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  1034. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1035. | |void| | :ref:`visibility_notifier_set_callbacks<class_RenderingServer_method_visibility_notifier_set_callbacks>`\ (\ notifier\: :ref:`RID<class_RID>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) |
  1036. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1037. | |void| | :ref:`voxel_gi_allocate_data<class_RenderingServer_method_voxel_gi_allocate_data>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, to_cell_xform\: :ref:`Transform3D<class_Transform3D>`, aabb\: :ref:`AABB<class_AABB>`, octree_size\: :ref:`Vector3i<class_Vector3i>`, octree_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, data_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, distance_field\: :ref:`PackedByteArray<class_PackedByteArray>`, level_counts\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  1038. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1039. | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>`\ (\ ) |
  1040. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1041. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_data_cells<class_RenderingServer_method_voxel_gi_get_data_cells>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1042. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1043. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_distance_field<class_RenderingServer_method_voxel_gi_get_distance_field>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1044. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1045. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`voxel_gi_get_level_counts<class_RenderingServer_method_voxel_gi_get_level_counts>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1046. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1047. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_octree_cells<class_RenderingServer_method_voxel_gi_get_octree_cells>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1048. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1049. | :ref:`Vector3i<class_Vector3i>` | :ref:`voxel_gi_get_octree_size<class_RenderingServer_method_voxel_gi_get_octree_size>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1050. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1051. | :ref:`Transform3D<class_Transform3D>` | :ref:`voxel_gi_get_to_cell_xform<class_RenderingServer_method_voxel_gi_get_to_cell_xform>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1052. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1053. | |void| | :ref:`voxel_gi_set_baked_exposure_normalization<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) |
  1054. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1055. | |void| | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) |
  1056. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1057. | |void| | :ref:`voxel_gi_set_dynamic_range<class_RenderingServer_method_voxel_gi_set_dynamic_range>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, range\: :ref:`float<class_float>`\ ) |
  1058. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1059. | |void| | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  1060. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1061. | |void| | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1062. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1063. | |void| | :ref:`voxel_gi_set_normal_bias<class_RenderingServer_method_voxel_gi_set_normal_bias>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) |
  1064. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1065. | |void| | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) |
  1066. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1067. | |void| | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>`\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) |
  1068. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1069. | |void| | :ref:`voxel_gi_set_use_two_bounces<class_RenderingServer_method_voxel_gi_set_use_two_bounces>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1070. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1071. .. rst-class:: classref-section-separator
  1072. ----
  1073. .. rst-class:: classref-descriptions-group
  1074. Signals
  1075. -------
  1076. .. _class_RenderingServer_signal_frame_post_draw:
  1077. .. rst-class:: classref-signal
  1078. **frame_post_draw**\ (\ ) :ref:`🔗<class_RenderingServer_signal_frame_post_draw>`
  1079. Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
  1080. .. rst-class:: classref-item-separator
  1081. ----
  1082. .. _class_RenderingServer_signal_frame_pre_draw:
  1083. .. rst-class:: classref-signal
  1084. **frame_pre_draw**\ (\ ) :ref:`🔗<class_RenderingServer_signal_frame_pre_draw>`
  1085. Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
  1086. .. rst-class:: classref-section-separator
  1087. ----
  1088. .. rst-class:: classref-descriptions-group
  1089. Enumerations
  1090. ------------
  1091. .. _enum_RenderingServer_TextureType:
  1092. .. rst-class:: classref-enumeration
  1093. enum **TextureType**: :ref:`🔗<enum_RenderingServer_TextureType>`
  1094. .. _class_RenderingServer_constant_TEXTURE_TYPE_2D:
  1095. .. rst-class:: classref-enumeration-constant
  1096. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_2D** = ``0``
  1097. 2D texture.
  1098. .. _class_RenderingServer_constant_TEXTURE_TYPE_LAYERED:
  1099. .. rst-class:: classref-enumeration-constant
  1100. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_LAYERED** = ``1``
  1101. Layered texture.
  1102. .. _class_RenderingServer_constant_TEXTURE_TYPE_3D:
  1103. .. rst-class:: classref-enumeration-constant
  1104. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_3D** = ``2``
  1105. 3D texture.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _enum_RenderingServer_TextureLayeredType:
  1109. .. rst-class:: classref-enumeration
  1110. enum **TextureLayeredType**: :ref:`🔗<enum_RenderingServer_TextureLayeredType>`
  1111. .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
  1112. .. rst-class:: classref-enumeration-constant
  1113. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
  1114. Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
  1115. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
  1116. .. rst-class:: classref-enumeration-constant
  1117. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
  1118. Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
  1119. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
  1120. .. rst-class:: classref-enumeration-constant
  1121. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
  1122. Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
  1123. .. rst-class:: classref-item-separator
  1124. ----
  1125. .. _enum_RenderingServer_CubeMapLayer:
  1126. .. rst-class:: classref-enumeration
  1127. enum **CubeMapLayer**: :ref:`🔗<enum_RenderingServer_CubeMapLayer>`
  1128. .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
  1129. .. rst-class:: classref-enumeration-constant
  1130. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
  1131. Left face of a :ref:`Cubemap<class_Cubemap>`.
  1132. .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
  1133. .. rst-class:: classref-enumeration-constant
  1134. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
  1135. Right face of a :ref:`Cubemap<class_Cubemap>`.
  1136. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
  1137. .. rst-class:: classref-enumeration-constant
  1138. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
  1139. Bottom face of a :ref:`Cubemap<class_Cubemap>`.
  1140. .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
  1141. .. rst-class:: classref-enumeration-constant
  1142. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
  1143. Top face of a :ref:`Cubemap<class_Cubemap>`.
  1144. .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
  1145. .. rst-class:: classref-enumeration-constant
  1146. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
  1147. Front face of a :ref:`Cubemap<class_Cubemap>`.
  1148. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
  1149. .. rst-class:: classref-enumeration-constant
  1150. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
  1151. Back face of a :ref:`Cubemap<class_Cubemap>`.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _enum_RenderingServer_ShaderMode:
  1155. .. rst-class:: classref-enumeration
  1156. enum **ShaderMode**: :ref:`🔗<enum_RenderingServer_ShaderMode>`
  1157. .. _class_RenderingServer_constant_SHADER_SPATIAL:
  1158. .. rst-class:: classref-enumeration-constant
  1159. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
  1160. Shader is a 3D shader.
  1161. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
  1162. .. rst-class:: classref-enumeration-constant
  1163. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
  1164. Shader is a 2D shader.
  1165. .. _class_RenderingServer_constant_SHADER_PARTICLES:
  1166. .. rst-class:: classref-enumeration-constant
  1167. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
  1168. Shader is a particle shader (can be used in both 2D and 3D).
  1169. .. _class_RenderingServer_constant_SHADER_SKY:
  1170. .. rst-class:: classref-enumeration-constant
  1171. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
  1172. Shader is a 3D sky shader.
  1173. .. _class_RenderingServer_constant_SHADER_FOG:
  1174. .. rst-class:: classref-enumeration-constant
  1175. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
  1176. Shader is a 3D fog shader.
  1177. .. _class_RenderingServer_constant_SHADER_MAX:
  1178. .. rst-class:: classref-enumeration-constant
  1179. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
  1180. Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
  1181. .. rst-class:: classref-item-separator
  1182. ----
  1183. .. _enum_RenderingServer_ArrayType:
  1184. .. rst-class:: classref-enumeration
  1185. enum **ArrayType**: :ref:`🔗<enum_RenderingServer_ArrayType>`
  1186. .. _class_RenderingServer_constant_ARRAY_VERTEX:
  1187. .. rst-class:: classref-enumeration-constant
  1188. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
  1189. Array is a vertex position array.
  1190. .. _class_RenderingServer_constant_ARRAY_NORMAL:
  1191. .. rst-class:: classref-enumeration-constant
  1192. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
  1193. Array is a normal array.
  1194. .. _class_RenderingServer_constant_ARRAY_TANGENT:
  1195. .. rst-class:: classref-enumeration-constant
  1196. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
  1197. Array is a tangent array.
  1198. .. _class_RenderingServer_constant_ARRAY_COLOR:
  1199. .. rst-class:: classref-enumeration-constant
  1200. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
  1201. Array is a vertex color array.
  1202. .. _class_RenderingServer_constant_ARRAY_TEX_UV:
  1203. .. rst-class:: classref-enumeration-constant
  1204. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
  1205. Array is a UV coordinates array.
  1206. .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
  1207. .. rst-class:: classref-enumeration-constant
  1208. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
  1209. Array is a UV coordinates array for the second set of UV coordinates.
  1210. .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
  1211. .. rst-class:: classref-enumeration-constant
  1212. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
  1213. Array is a custom data array for the first set of custom data.
  1214. .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
  1215. .. rst-class:: classref-enumeration-constant
  1216. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
  1217. Array is a custom data array for the second set of custom data.
  1218. .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
  1219. .. rst-class:: classref-enumeration-constant
  1220. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
  1221. Array is a custom data array for the third set of custom data.
  1222. .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
  1223. .. rst-class:: classref-enumeration-constant
  1224. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
  1225. Array is a custom data array for the fourth set of custom data.
  1226. .. _class_RenderingServer_constant_ARRAY_BONES:
  1227. .. rst-class:: classref-enumeration-constant
  1228. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
  1229. Array contains bone information.
  1230. .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
  1231. .. rst-class:: classref-enumeration-constant
  1232. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
  1233. Array is weight information.
  1234. .. _class_RenderingServer_constant_ARRAY_INDEX:
  1235. .. rst-class:: classref-enumeration-constant
  1236. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
  1237. Array is an index array.
  1238. .. _class_RenderingServer_constant_ARRAY_MAX:
  1239. .. rst-class:: classref-enumeration-constant
  1240. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
  1241. Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
  1242. .. rst-class:: classref-item-separator
  1243. ----
  1244. .. _enum_RenderingServer_ArrayCustomFormat:
  1245. .. rst-class:: classref-enumeration
  1246. enum **ArrayCustomFormat**: :ref:`🔗<enum_RenderingServer_ArrayCustomFormat>`
  1247. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
  1248. .. rst-class:: classref-enumeration-constant
  1249. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
  1250. Custom data array contains 8-bit-per-channel red/green/blue/alpha color data. Values are normalized, unsigned floating-point in the ``[0.0, 1.0]`` range.
  1251. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
  1252. .. rst-class:: classref-enumeration-constant
  1253. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
  1254. Custom data array contains 8-bit-per-channel red/green/blue/alpha color data. Values are normalized, signed floating-point in the ``[-1.0, 1.0]`` range.
  1255. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
  1256. .. rst-class:: classref-enumeration-constant
  1257. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
  1258. Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
  1259. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
  1260. .. rst-class:: classref-enumeration-constant
  1261. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
  1262. Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
  1263. .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
  1264. .. rst-class:: classref-enumeration-constant
  1265. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
  1266. Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
  1267. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
  1268. .. rst-class:: classref-enumeration-constant
  1269. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
  1270. Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
  1271. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
  1272. .. rst-class:: classref-enumeration-constant
  1273. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
  1274. Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
  1275. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
  1276. .. rst-class:: classref-enumeration-constant
  1277. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
  1278. Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
  1279. .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
  1280. .. rst-class:: classref-enumeration-constant
  1281. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
  1282. Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
  1283. .. rst-class:: classref-item-separator
  1284. ----
  1285. .. _enum_RenderingServer_ArrayFormat:
  1286. .. rst-class:: classref-enumeration
  1287. flags **ArrayFormat**: :ref:`🔗<enum_RenderingServer_ArrayFormat>`
  1288. .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
  1289. .. rst-class:: classref-enumeration-constant
  1290. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
  1291. Flag used to mark a vertex position array.
  1292. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
  1293. .. rst-class:: classref-enumeration-constant
  1294. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
  1295. Flag used to mark a normal array.
  1296. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
  1297. .. rst-class:: classref-enumeration-constant
  1298. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
  1299. Flag used to mark a tangent array.
  1300. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
  1301. .. rst-class:: classref-enumeration-constant
  1302. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
  1303. Flag used to mark a vertex color array.
  1304. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
  1305. .. rst-class:: classref-enumeration-constant
  1306. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
  1307. Flag used to mark a UV coordinates array.
  1308. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
  1309. .. rst-class:: classref-enumeration-constant
  1310. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
  1311. Flag used to mark a UV coordinates array for the second UV coordinates.
  1312. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
  1313. .. rst-class:: classref-enumeration-constant
  1314. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
  1315. Flag used to mark an array of custom per-vertex data for the first set of custom data.
  1316. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
  1317. .. rst-class:: classref-enumeration-constant
  1318. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
  1319. Flag used to mark an array of custom per-vertex data for the second set of custom data.
  1320. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
  1321. .. rst-class:: classref-enumeration-constant
  1322. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
  1323. Flag used to mark an array of custom per-vertex data for the third set of custom data.
  1324. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
  1325. .. rst-class:: classref-enumeration-constant
  1326. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
  1327. Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
  1328. .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
  1329. .. rst-class:: classref-enumeration-constant
  1330. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
  1331. Flag used to mark a bone information array.
  1332. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
  1335. Flag used to mark a weights array.
  1336. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
  1337. .. rst-class:: classref-enumeration-constant
  1338. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
  1339. Flag used to mark an index array.
  1340. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
  1341. .. rst-class:: classref-enumeration-constant
  1342. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
  1343. Mask of mesh channels permitted in blend shapes.
  1344. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
  1345. .. rst-class:: classref-enumeration-constant
  1346. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
  1347. Shift of first custom channel.
  1348. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
  1349. .. rst-class:: classref-enumeration-constant
  1350. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
  1351. Number of format bits per custom channel. See :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>`.
  1352. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
  1353. .. rst-class:: classref-enumeration-constant
  1354. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
  1355. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 0.
  1356. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
  1357. .. rst-class:: classref-enumeration-constant
  1358. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
  1359. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 1.
  1360. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
  1361. .. rst-class:: classref-enumeration-constant
  1362. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
  1363. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 2.
  1364. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
  1365. .. rst-class:: classref-enumeration-constant
  1366. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
  1367. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 3.
  1368. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
  1369. .. rst-class:: classref-enumeration-constant
  1370. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
  1371. Mask of custom format bits per custom channel. Must be shifted by one of the SHIFT constants. See :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>`.
  1372. .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
  1373. .. rst-class:: classref-enumeration-constant
  1374. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
  1375. Shift of first compress flag. Compress flags should be passed to :ref:`ArrayMesh.add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` and :ref:`SurfaceTool.commit<class_SurfaceTool_method_commit>`.
  1376. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
  1377. .. rst-class:: classref-enumeration-constant
  1378. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
  1379. Flag used to mark that the array contains 2D vertices.
  1380. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
  1381. .. rst-class:: classref-enumeration-constant
  1382. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
  1383. Flag indices that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan.
  1384. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
  1385. .. rst-class:: classref-enumeration-constant
  1386. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
  1387. Flag used to mark that the array uses 8 bone weights instead of 4.
  1388. .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
  1389. .. rst-class:: classref-enumeration-constant
  1390. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
  1391. Flag used to mark that the mesh does not have a vertex array and instead will infer vertex positions in the shader using indices and other information.
  1392. .. _class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES:
  1393. .. rst-class:: classref-enumeration-constant
  1394. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912``
  1395. Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can.
  1396. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE:
  1397. .. rst-class:: classref-enumeration-constant
  1398. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_BASE** = ``35``
  1399. Flag used to mark the start of the bits used to store the mesh version.
  1400. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT:
  1401. .. rst-class:: classref-enumeration-constant
  1402. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_SHIFT** = ``35``
  1403. Flag used to shift a mesh format int to bring the version into the lowest digits.
  1404. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1:
  1405. .. rst-class:: classref-enumeration-constant
  1406. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_1** = ``0``
  1407. Flag used to record the format used by prior mesh versions before the introduction of a version.
  1408. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2:
  1409. .. rst-class:: classref-enumeration-constant
  1410. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_2** = ``34359738368``
  1411. Flag used to record the second iteration of the mesh version flag. The primary difference between this and :ref:`ARRAY_FLAG_FORMAT_VERSION_1<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1>` is that this version supports :ref:`ARRAY_FLAG_COMPRESS_ATTRIBUTES<class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES>` and in this version vertex positions are de-interleaved from normals and tangents.
  1412. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_CURRENT_VERSION:
  1413. .. rst-class:: classref-enumeration-constant
  1414. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_CURRENT_VERSION** = ``34359738368``
  1415. Flag used to record the current version that the engine expects. Currently this is the same as :ref:`ARRAY_FLAG_FORMAT_VERSION_2<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2>`.
  1416. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_MASK:
  1417. .. rst-class:: classref-enumeration-constant
  1418. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_MASK** = ``255``
  1419. Flag used to isolate the bits used for mesh version after using :ref:`ARRAY_FLAG_FORMAT_VERSION_SHIFT<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT>` to shift them into place.
  1420. .. rst-class:: classref-item-separator
  1421. ----
  1422. .. _enum_RenderingServer_PrimitiveType:
  1423. .. rst-class:: classref-enumeration
  1424. enum **PrimitiveType**: :ref:`🔗<enum_RenderingServer_PrimitiveType>`
  1425. .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
  1426. .. rst-class:: classref-enumeration-constant
  1427. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
  1428. Primitive to draw consists of points.
  1429. .. _class_RenderingServer_constant_PRIMITIVE_LINES:
  1430. .. rst-class:: classref-enumeration-constant
  1431. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
  1432. Primitive to draw consists of lines.
  1433. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
  1434. .. rst-class:: classref-enumeration-constant
  1435. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
  1436. Primitive to draw consists of a line strip from start to end.
  1437. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
  1438. .. rst-class:: classref-enumeration-constant
  1439. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
  1440. Primitive to draw consists of triangles.
  1441. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
  1442. .. rst-class:: classref-enumeration-constant
  1443. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
  1444. Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  1445. .. _class_RenderingServer_constant_PRIMITIVE_MAX:
  1446. .. rst-class:: classref-enumeration-constant
  1447. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
  1448. Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
  1449. .. rst-class:: classref-item-separator
  1450. ----
  1451. .. _enum_RenderingServer_BlendShapeMode:
  1452. .. rst-class:: classref-enumeration
  1453. enum **BlendShapeMode**: :ref:`🔗<enum_RenderingServer_BlendShapeMode>`
  1454. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
  1455. .. rst-class:: classref-enumeration-constant
  1456. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
  1457. Blend shapes are normalized.
  1458. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
  1459. .. rst-class:: classref-enumeration-constant
  1460. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
  1461. Blend shapes are relative to base weight.
  1462. .. rst-class:: classref-item-separator
  1463. ----
  1464. .. _enum_RenderingServer_MultimeshTransformFormat:
  1465. .. rst-class:: classref-enumeration
  1466. enum **MultimeshTransformFormat**: :ref:`🔗<enum_RenderingServer_MultimeshTransformFormat>`
  1467. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
  1468. .. rst-class:: classref-enumeration-constant
  1469. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
  1470. Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
  1471. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
  1472. .. rst-class:: classref-enumeration-constant
  1473. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
  1474. Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
  1475. .. rst-class:: classref-item-separator
  1476. ----
  1477. .. _enum_RenderingServer_MultimeshPhysicsInterpolationQuality:
  1478. .. rst-class:: classref-enumeration
  1479. enum **MultimeshPhysicsInterpolationQuality**: :ref:`🔗<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`
  1480. .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_FAST:
  1481. .. rst-class:: classref-enumeration-constant
  1482. :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>` **MULTIMESH_INTERP_QUALITY_FAST** = ``0``
  1483. MultiMesh physics interpolation favors speed over quality.
  1484. .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_HIGH:
  1485. .. rst-class:: classref-enumeration-constant
  1486. :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>` **MULTIMESH_INTERP_QUALITY_HIGH** = ``1``
  1487. MultiMesh physics interpolation favors quality over speed.
  1488. .. rst-class:: classref-item-separator
  1489. ----
  1490. .. _enum_RenderingServer_LightProjectorFilter:
  1491. .. rst-class:: classref-enumeration
  1492. enum **LightProjectorFilter**: :ref:`🔗<enum_RenderingServer_LightProjectorFilter>`
  1493. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
  1494. .. rst-class:: classref-enumeration-constant
  1495. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
  1496. Nearest-neighbor filter for light projectors (use for pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
  1497. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
  1498. .. rst-class:: classref-enumeration-constant
  1499. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
  1500. Linear filter for light projectors (use for non-pixel art light projectors). No mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
  1501. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
  1502. .. rst-class:: classref-enumeration-constant
  1503. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
  1504. Nearest-neighbor filter for light projectors (use for pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
  1505. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
  1506. .. rst-class:: classref-enumeration-constant
  1507. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
  1508. Linear filter for light projectors (use for non-pixel art light projectors). Isotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
  1509. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1510. .. rst-class:: classref-enumeration-constant
  1511. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1512. Nearest-neighbor filter for light projectors (use for pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  1513. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1514. .. rst-class:: classref-enumeration-constant
  1515. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1516. Linear filter for light projectors (use for non-pixel art light projectors). Anisotropic mipmaps are used for rendering, which means light projectors at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  1517. .. rst-class:: classref-item-separator
  1518. ----
  1519. .. _enum_RenderingServer_LightType:
  1520. .. rst-class:: classref-enumeration
  1521. enum **LightType**: :ref:`🔗<enum_RenderingServer_LightType>`
  1522. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
  1523. .. rst-class:: classref-enumeration-constant
  1524. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
  1525. Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
  1526. .. _class_RenderingServer_constant_LIGHT_OMNI:
  1527. .. rst-class:: classref-enumeration-constant
  1528. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
  1529. Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
  1530. .. _class_RenderingServer_constant_LIGHT_SPOT:
  1531. .. rst-class:: classref-enumeration-constant
  1532. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
  1533. Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
  1534. .. rst-class:: classref-item-separator
  1535. ----
  1536. .. _enum_RenderingServer_LightParam:
  1537. .. rst-class:: classref-enumeration
  1538. enum **LightParam**: :ref:`🔗<enum_RenderingServer_LightParam>`
  1539. .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
  1540. .. rst-class:: classref-enumeration-constant
  1541. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
  1542. The light's energy multiplier.
  1543. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
  1544. .. rst-class:: classref-enumeration-constant
  1545. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
  1546. The light's indirect energy multiplier (final indirect energy is :ref:`LIGHT_PARAM_ENERGY<class_RenderingServer_constant_LIGHT_PARAM_ENERGY>` \* :ref:`LIGHT_PARAM_INDIRECT_ENERGY<class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY>`).
  1547. .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
  1548. .. rst-class:: classref-enumeration-constant
  1549. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
  1550. The light's volumetric fog energy multiplier (final volumetric fog energy is :ref:`LIGHT_PARAM_ENERGY<class_RenderingServer_constant_LIGHT_PARAM_ENERGY>` \* :ref:`LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY<class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY>`).
  1551. .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
  1552. .. rst-class:: classref-enumeration-constant
  1553. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
  1554. The light's influence on specularity.
  1555. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
  1556. .. rst-class:: classref-enumeration-constant
  1557. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
  1558. The light's range.
  1559. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
  1560. .. rst-class:: classref-enumeration-constant
  1561. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
  1562. The size of the light when using spot light or omni light. The angular size of the light when using directional light.
  1563. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
  1564. .. rst-class:: classref-enumeration-constant
  1565. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
  1566. The light's attenuation.
  1567. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
  1568. .. rst-class:: classref-enumeration-constant
  1569. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
  1570. The spotlight's angle.
  1571. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
  1572. .. rst-class:: classref-enumeration-constant
  1573. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
  1574. The spotlight's attenuation.
  1575. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
  1576. .. rst-class:: classref-enumeration-constant
  1577. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
  1578. The maximum distance for shadow splits. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (since more objects need to be included in the directional shadow rendering).
  1579. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
  1580. .. rst-class:: classref-enumeration-constant
  1581. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
  1582. Proportion of shadow atlas occupied by the first split.
  1583. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
  1584. .. rst-class:: classref-enumeration-constant
  1585. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
  1586. Proportion of shadow atlas occupied by the second split.
  1587. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
  1588. .. rst-class:: classref-enumeration-constant
  1589. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
  1590. Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
  1591. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
  1592. .. rst-class:: classref-enumeration-constant
  1593. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
  1594. Proportion of shadow max distance where the shadow will start to fade out.
  1595. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
  1596. .. rst-class:: classref-enumeration-constant
  1597. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
  1598. Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
  1599. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
  1600. .. rst-class:: classref-enumeration-constant
  1601. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
  1602. Bias the shadow lookup to fix self-shadowing artifacts.
  1603. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
  1604. .. rst-class:: classref-enumeration-constant
  1605. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
  1606. Sets the size of the directional shadow pancake. The pancake offsets the start of the shadow's camera frustum to provide a higher effective depth resolution for the shadow. However, a high pancake size can cause artifacts in the shadows of large objects that are close to the edge of the frustum. Reducing the pancake size can help. Setting the size to ``0`` turns off the pancaking effect.
  1607. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
  1608. .. rst-class:: classref-enumeration-constant
  1609. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
  1610. The light's shadow opacity. Values lower than ``1.0`` make the light appear through shadows. This can be used to fake global illumination at a low performance cost.
  1611. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
  1612. .. rst-class:: classref-enumeration-constant
  1613. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
  1614. Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible.
  1615. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
  1616. .. rst-class:: classref-enumeration-constant
  1617. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
  1618. .. container:: contribute
  1619. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1620. .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
  1621. .. rst-class:: classref-enumeration-constant
  1622. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
  1623. Constant representing the intensity of the light, measured in Lumens when dealing with a :ref:`SpotLight3D<class_SpotLight3D>` or :ref:`OmniLight3D<class_OmniLight3D>`, or measured in Lux with a :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Only used when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units<class_ProjectSettings_property_rendering/lights_and_shadows/use_physical_light_units>` is ``true``.
  1624. .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
  1625. .. rst-class:: classref-enumeration-constant
  1626. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
  1627. Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _enum_RenderingServer_LightBakeMode:
  1631. .. rst-class:: classref-enumeration
  1632. enum **LightBakeMode**: :ref:`🔗<enum_RenderingServer_LightBakeMode>`
  1633. .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
  1634. .. rst-class:: classref-enumeration-constant
  1635. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
  1636. Light is ignored when baking. This is the fastest mode, but the light will be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights.
  1637. .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
  1638. .. rst-class:: classref-enumeration-constant
  1639. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
  1640. Light is taken into account in static baking (:ref:`VoxelGI<class_VoxelGI>`, :ref:`LightmapGI<class_LightmapGI>`, SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`)). The light can be moved around or modified, but its global illumination will not update in real-time. This is suitable for subtle changes (such as flickering torches), but generally not large changes such as toggling a light on and off.
  1641. .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
  1642. .. rst-class:: classref-enumeration-constant
  1643. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
  1644. Light is taken into account in dynamic baking (:ref:`VoxelGI<class_VoxelGI>` and SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`) only). The light can be moved around or modified with global illumination updating in real-time. The light's global illumination appearance will be slightly different compared to :ref:`LIGHT_BAKE_STATIC<class_RenderingServer_constant_LIGHT_BAKE_STATIC>`. This has a greater performance cost compared to :ref:`LIGHT_BAKE_STATIC<class_RenderingServer_constant_LIGHT_BAKE_STATIC>`. When using SDFGI, the update speed of dynamic lights is affected by :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights<class_ProjectSettings_property_rendering/global_illumination/sdfgi/frames_to_update_lights>`.
  1645. .. rst-class:: classref-item-separator
  1646. ----
  1647. .. _enum_RenderingServer_LightOmniShadowMode:
  1648. .. rst-class:: classref-enumeration
  1649. enum **LightOmniShadowMode**: :ref:`🔗<enum_RenderingServer_LightOmniShadowMode>`
  1650. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
  1651. .. rst-class:: classref-enumeration-constant
  1652. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
  1653. Use a dual paraboloid shadow map for omni lights.
  1654. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
  1655. .. rst-class:: classref-enumeration-constant
  1656. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
  1657. Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
  1658. .. rst-class:: classref-item-separator
  1659. ----
  1660. .. _enum_RenderingServer_LightDirectionalShadowMode:
  1661. .. rst-class:: classref-enumeration
  1662. enum **LightDirectionalShadowMode**: :ref:`🔗<enum_RenderingServer_LightDirectionalShadowMode>`
  1663. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
  1664. .. rst-class:: classref-enumeration-constant
  1665. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
  1666. Use orthogonal shadow projection for directional light.
  1667. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
  1668. .. rst-class:: classref-enumeration-constant
  1669. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
  1670. Use 2 splits for shadow projection when using directional light.
  1671. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
  1672. .. rst-class:: classref-enumeration-constant
  1673. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
  1674. Use 4 splits for shadow projection when using directional light.
  1675. .. rst-class:: classref-item-separator
  1676. ----
  1677. .. _enum_RenderingServer_LightDirectionalSkyMode:
  1678. .. rst-class:: classref-enumeration
  1679. enum **LightDirectionalSkyMode**: :ref:`🔗<enum_RenderingServer_LightDirectionalSkyMode>`
  1680. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
  1681. .. rst-class:: classref-enumeration-constant
  1682. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
  1683. Use DirectionalLight3D in both sky rendering and scene lighting.
  1684. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
  1685. .. rst-class:: classref-enumeration-constant
  1686. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
  1687. Only use DirectionalLight3D in scene lighting.
  1688. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
  1689. .. rst-class:: classref-enumeration-constant
  1690. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
  1691. Only use DirectionalLight3D in sky rendering.
  1692. .. rst-class:: classref-item-separator
  1693. ----
  1694. .. _enum_RenderingServer_ShadowQuality:
  1695. .. rst-class:: classref-enumeration
  1696. enum **ShadowQuality**: :ref:`🔗<enum_RenderingServer_ShadowQuality>`
  1697. .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
  1698. .. rst-class:: classref-enumeration-constant
  1699. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
  1700. Lowest shadow filtering quality (fastest). Soft shadows are not available with this quality setting, which means the :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` property is ignored if :ref:`Light3D.light_size<class_Light3D_property_light_size>` and :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``.
  1701. \ **Note:** The variable shadow blur performed by :ref:`Light3D.light_size<class_Light3D_property_light_size>` and :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is still effective when using hard shadow filtering. In this case, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` *is* taken into account. However, the results will not be blurred, instead the blur amount is treated as a maximum radius for the penumbra.
  1702. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
  1703. .. rst-class:: classref-enumeration-constant
  1704. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
  1705. Very low shadow filtering quality (faster). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 0.75× to avoid introducing too much noise. This division only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
  1706. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
  1707. .. rst-class:: classref-enumeration-constant
  1708. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
  1709. Low shadow filtering quality (fast).
  1710. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
  1711. .. rst-class:: classref-enumeration-constant
  1712. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
  1713. Medium low shadow filtering quality (average).
  1714. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
  1715. .. rst-class:: classref-enumeration-constant
  1716. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
  1717. High low shadow filtering quality (slow). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 1.5× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
  1718. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
  1719. .. rst-class:: classref-enumeration-constant
  1720. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
  1721. Highest low shadow filtering quality (slowest). When using this quality setting, :ref:`Light3D.shadow_blur<class_Light3D_property_shadow_blur>` is automatically multiplied by 2× to better make use of the high sample count. This increased blur also improves the stability of dynamic object shadows. This multiplier only applies to lights whose :ref:`Light3D.light_size<class_Light3D_property_light_size>` or :ref:`Light3D.light_angular_distance<class_Light3D_property_light_angular_distance>` is ``0.0``).
  1722. .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
  1723. .. rst-class:: classref-enumeration-constant
  1724. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
  1725. Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
  1726. .. rst-class:: classref-item-separator
  1727. ----
  1728. .. _enum_RenderingServer_ReflectionProbeUpdateMode:
  1729. .. rst-class:: classref-enumeration
  1730. enum **ReflectionProbeUpdateMode**: :ref:`🔗<enum_RenderingServer_ReflectionProbeUpdateMode>`
  1731. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
  1732. .. rst-class:: classref-enumeration-constant
  1733. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
  1734. Reflection probe will update reflections once and then stop.
  1735. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
  1736. .. rst-class:: classref-enumeration-constant
  1737. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
  1738. Reflection probe will update each frame. This mode is necessary to capture moving objects.
  1739. .. rst-class:: classref-item-separator
  1740. ----
  1741. .. _enum_RenderingServer_ReflectionProbeAmbientMode:
  1742. .. rst-class:: classref-enumeration
  1743. enum **ReflectionProbeAmbientMode**: :ref:`🔗<enum_RenderingServer_ReflectionProbeAmbientMode>`
  1744. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
  1745. .. rst-class:: classref-enumeration-constant
  1746. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
  1747. Do not apply any ambient lighting inside the reflection probe's box defined by its size.
  1748. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
  1749. .. rst-class:: classref-enumeration-constant
  1750. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
  1751. Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
  1752. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
  1753. .. rst-class:: classref-enumeration-constant
  1754. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
  1755. Apply custom ambient lighting inside the reflection probe's box defined by its size. See :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>` and :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>`.
  1756. .. rst-class:: classref-item-separator
  1757. ----
  1758. .. _enum_RenderingServer_DecalTexture:
  1759. .. rst-class:: classref-enumeration
  1760. enum **DecalTexture**: :ref:`🔗<enum_RenderingServer_DecalTexture>`
  1761. .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
  1762. .. rst-class:: classref-enumeration-constant
  1763. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
  1764. Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
  1765. .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
  1766. .. rst-class:: classref-enumeration-constant
  1767. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
  1768. Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
  1769. .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
  1770. .. rst-class:: classref-enumeration-constant
  1771. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
  1772. Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
  1773. .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
  1774. .. rst-class:: classref-enumeration-constant
  1775. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
  1776. Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
  1777. .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
  1778. .. rst-class:: classref-enumeration-constant
  1779. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
  1780. Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
  1781. .. rst-class:: classref-item-separator
  1782. ----
  1783. .. _enum_RenderingServer_DecalFilter:
  1784. .. rst-class:: classref-enumeration
  1785. enum **DecalFilter**: :ref:`🔗<enum_RenderingServer_DecalFilter>`
  1786. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
  1787. .. rst-class:: classref-enumeration-constant
  1788. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
  1789. Nearest-neighbor filter for decals (use for pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look sharp but grainy. This has roughly the same performance cost as using mipmaps.
  1790. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
  1791. .. rst-class:: classref-enumeration-constant
  1792. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
  1793. Linear filter for decals (use for non-pixel art decals). No mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as using mipmaps.
  1794. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
  1795. .. rst-class:: classref-enumeration-constant
  1796. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
  1797. Nearest-neighbor filter for decals (use for pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
  1798. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
  1799. .. rst-class:: classref-enumeration-constant
  1800. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
  1801. Linear filter for decals (use for non-pixel art decals). Isotropic mipmaps are used for rendering, which means decals at a distance will look smooth but blurry. This has roughly the same performance cost as not using mipmaps.
  1802. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1803. .. rst-class:: classref-enumeration-constant
  1804. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1805. Nearest-neighbor filter for decals (use for pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  1806. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1807. .. rst-class:: classref-enumeration-constant
  1808. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1809. Linear filter for decals (use for non-pixel art decals). Anisotropic mipmaps are used for rendering, which means decals at a distance will look smooth and sharp when viewed from oblique angles. This looks better compared to isotropic mipmaps, but is slower. The level of anisotropic filtering is defined by :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  1810. .. rst-class:: classref-item-separator
  1811. ----
  1812. .. _enum_RenderingServer_VoxelGIQuality:
  1813. .. rst-class:: classref-enumeration
  1814. enum **VoxelGIQuality**: :ref:`🔗<enum_RenderingServer_VoxelGIQuality>`
  1815. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
  1816. .. rst-class:: classref-enumeration-constant
  1817. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
  1818. Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
  1819. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
  1820. .. rst-class:: classref-enumeration-constant
  1821. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
  1822. High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _enum_RenderingServer_ParticlesMode:
  1826. .. rst-class:: classref-enumeration
  1827. enum **ParticlesMode**: :ref:`🔗<enum_RenderingServer_ParticlesMode>`
  1828. .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
  1829. .. rst-class:: classref-enumeration-constant
  1830. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
  1831. 2D particles.
  1832. .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
  1833. .. rst-class:: classref-enumeration-constant
  1834. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
  1835. 3D particles.
  1836. .. rst-class:: classref-item-separator
  1837. ----
  1838. .. _enum_RenderingServer_ParticlesTransformAlign:
  1839. .. rst-class:: classref-enumeration
  1840. enum **ParticlesTransformAlign**: :ref:`🔗<enum_RenderingServer_ParticlesTransformAlign>`
  1841. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
  1842. .. rst-class:: classref-enumeration-constant
  1843. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
  1844. .. container:: contribute
  1845. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1846. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
  1847. .. rst-class:: classref-enumeration-constant
  1848. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
  1849. .. container:: contribute
  1850. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1851. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
  1852. .. rst-class:: classref-enumeration-constant
  1853. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
  1854. .. container:: contribute
  1855. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1856. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
  1857. .. rst-class:: classref-enumeration-constant
  1858. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
  1859. .. container:: contribute
  1860. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1861. .. rst-class:: classref-item-separator
  1862. ----
  1863. .. _enum_RenderingServer_ParticlesDrawOrder:
  1864. .. rst-class:: classref-enumeration
  1865. enum **ParticlesDrawOrder**: :ref:`🔗<enum_RenderingServer_ParticlesDrawOrder>`
  1866. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
  1867. .. rst-class:: classref-enumeration-constant
  1868. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
  1869. Draw particles in the order that they appear in the particles array.
  1870. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
  1871. .. rst-class:: classref-enumeration-constant
  1872. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
  1873. Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front.
  1874. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
  1875. .. rst-class:: classref-enumeration-constant
  1876. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
  1877. Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front.
  1878. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
  1879. .. rst-class:: classref-enumeration-constant
  1880. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
  1881. Sort particles based on their distance to the camera.
  1882. .. rst-class:: classref-item-separator
  1883. ----
  1884. .. _enum_RenderingServer_ParticlesCollisionType:
  1885. .. rst-class:: classref-enumeration
  1886. enum **ParticlesCollisionType**: :ref:`🔗<enum_RenderingServer_ParticlesCollisionType>`
  1887. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1888. .. rst-class:: classref-enumeration-constant
  1889. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
  1890. .. container:: contribute
  1891. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1892. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
  1893. .. rst-class:: classref-enumeration-constant
  1894. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
  1895. .. container:: contribute
  1896. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1897. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
  1898. .. rst-class:: classref-enumeration-constant
  1899. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
  1900. .. container:: contribute
  1901. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1902. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
  1903. .. rst-class:: classref-enumeration-constant
  1904. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
  1905. .. container:: contribute
  1906. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1907. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
  1908. .. rst-class:: classref-enumeration-constant
  1909. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
  1910. .. container:: contribute
  1911. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1912. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
  1913. .. rst-class:: classref-enumeration-constant
  1914. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
  1915. .. container:: contribute
  1916. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1917. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
  1918. .. rst-class:: classref-enumeration-constant
  1919. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
  1920. .. container:: contribute
  1921. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1922. .. rst-class:: classref-item-separator
  1923. ----
  1924. .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
  1925. .. rst-class:: classref-enumeration
  1926. enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`
  1927. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
  1928. .. rst-class:: classref-enumeration-constant
  1929. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
  1930. .. container:: contribute
  1931. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1932. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
  1933. .. rst-class:: classref-enumeration-constant
  1934. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
  1935. .. container:: contribute
  1936. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1937. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
  1938. .. rst-class:: classref-enumeration-constant
  1939. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
  1940. .. container:: contribute
  1941. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1942. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
  1943. .. rst-class:: classref-enumeration-constant
  1944. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
  1945. .. container:: contribute
  1946. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1947. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
  1948. .. rst-class:: classref-enumeration-constant
  1949. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
  1950. .. container:: contribute
  1951. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1952. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
  1953. .. rst-class:: classref-enumeration-constant
  1954. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
  1955. .. container:: contribute
  1956. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1957. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
  1958. .. rst-class:: classref-enumeration-constant
  1959. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
  1960. Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
  1961. .. rst-class:: classref-item-separator
  1962. ----
  1963. .. _enum_RenderingServer_FogVolumeShape:
  1964. .. rst-class:: classref-enumeration
  1965. enum **FogVolumeShape**: :ref:`🔗<enum_RenderingServer_FogVolumeShape>`
  1966. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
  1967. .. rst-class:: classref-enumeration-constant
  1968. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
  1969. :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
  1970. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
  1971. .. rst-class:: classref-enumeration-constant
  1972. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
  1973. :ref:`FogVolume<class_FogVolume>` will be shaped like a cone pointing upwards (in local coordinates). The cone's angle is set automatically to fill the size. The cone will be adjusted to fit within the size. Rotate the :ref:`FogVolume<class_FogVolume>` node to reorient the cone. Non-uniform scaling via size is not supported (scale the :ref:`FogVolume<class_FogVolume>` node instead).
  1974. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
  1975. .. rst-class:: classref-enumeration-constant
  1976. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
  1977. :ref:`FogVolume<class_FogVolume>` will be shaped like an upright cylinder (in local coordinates). Rotate the :ref:`FogVolume<class_FogVolume>` node to reorient the cylinder. The cylinder will be adjusted to fit within the size. Non-uniform scaling via size is not supported (scale the :ref:`FogVolume<class_FogVolume>` node instead).
  1978. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
  1979. .. rst-class:: classref-enumeration-constant
  1980. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
  1981. :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
  1982. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
  1983. .. rst-class:: classref-enumeration-constant
  1984. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
  1985. :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
  1986. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
  1987. .. rst-class:: classref-enumeration-constant
  1988. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
  1989. Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
  1990. .. rst-class:: classref-item-separator
  1991. ----
  1992. .. _enum_RenderingServer_ViewportScaling3DMode:
  1993. .. rst-class:: classref-enumeration
  1994. enum **ViewportScaling3DMode**: :ref:`🔗<enum_RenderingServer_ViewportScaling3DMode>`
  1995. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
  1996. .. rst-class:: classref-enumeration-constant
  1997. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
  1998. Use bilinear scaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will result in undersampling while values greater than ``1.0`` will result in supersampling. A value of ``1.0`` disables scaling.
  1999. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
  2000. .. rst-class:: classref-enumeration-constant
  2001. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
  2002. Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling.
  2003. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2:
  2004. .. rst-class:: classref-enumeration-constant
  2005. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2``
  2006. Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution.
  2007. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL:
  2008. .. rst-class:: classref-enumeration-constant
  2009. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL** = ``3``
  2010. Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling.
  2011. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
  2012. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL:
  2013. .. rst-class:: classref-enumeration-constant
  2014. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL** = ``4``
  2015. Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution.
  2016. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
  2017. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
  2018. .. rst-class:: classref-enumeration-constant
  2019. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``5``
  2020. Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _enum_RenderingServer_ViewportUpdateMode:
  2024. .. rst-class:: classref-enumeration
  2025. enum **ViewportUpdateMode**: :ref:`🔗<enum_RenderingServer_ViewportUpdateMode>`
  2026. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
  2027. .. rst-class:: classref-enumeration-constant
  2028. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
  2029. Do not update the viewport's render target.
  2030. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
  2031. .. rst-class:: classref-enumeration-constant
  2032. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
  2033. Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
  2034. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
  2035. .. rst-class:: classref-enumeration-constant
  2036. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
  2037. Update the viewport's render target only when it is visible. This is the default value.
  2038. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
  2039. .. rst-class:: classref-enumeration-constant
  2040. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
  2041. Update the viewport's render target only when its parent is visible.
  2042. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
  2043. .. rst-class:: classref-enumeration-constant
  2044. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
  2045. Always update the viewport's render target.
  2046. .. rst-class:: classref-item-separator
  2047. ----
  2048. .. _enum_RenderingServer_ViewportClearMode:
  2049. .. rst-class:: classref-enumeration
  2050. enum **ViewportClearMode**: :ref:`🔗<enum_RenderingServer_ViewportClearMode>`
  2051. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
  2052. .. rst-class:: classref-enumeration-constant
  2053. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
  2054. Always clear the viewport's render target before drawing.
  2055. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
  2056. .. rst-class:: classref-enumeration-constant
  2057. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
  2058. Never clear the viewport's render target.
  2059. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
  2060. .. rst-class:: classref-enumeration-constant
  2061. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
  2062. Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
  2063. .. rst-class:: classref-item-separator
  2064. ----
  2065. .. _enum_RenderingServer_ViewportEnvironmentMode:
  2066. .. rst-class:: classref-enumeration
  2067. enum **ViewportEnvironmentMode**: :ref:`🔗<enum_RenderingServer_ViewportEnvironmentMode>`
  2068. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
  2069. .. rst-class:: classref-enumeration-constant
  2070. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
  2071. Disable rendering of 3D environment over 2D canvas.
  2072. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
  2073. .. rst-class:: classref-enumeration-constant
  2074. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
  2075. Enable rendering of 3D environment over 2D canvas.
  2076. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
  2077. .. rst-class:: classref-enumeration-constant
  2078. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
  2079. Inherit enable/disable value from parent. If the topmost parent is also set to :ref:`VIEWPORT_ENVIRONMENT_INHERIT<class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT>`, then this has the same behavior as :ref:`VIEWPORT_ENVIRONMENT_ENABLED<class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED>`.
  2080. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
  2081. .. rst-class:: classref-enumeration-constant
  2082. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
  2083. Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
  2084. .. rst-class:: classref-item-separator
  2085. ----
  2086. .. _enum_RenderingServer_ViewportSDFOversize:
  2087. .. rst-class:: classref-enumeration
  2088. enum **ViewportSDFOversize**: :ref:`🔗<enum_RenderingServer_ViewportSDFOversize>`
  2089. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
  2090. .. rst-class:: classref-enumeration-constant
  2091. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
  2092. Do not oversize the 2D signed distance field. Occluders may disappear when touching the viewport's edges, and :ref:`GPUParticles3D<class_GPUParticles3D>` collision may stop working earlier than intended. This has the lowest GPU requirements.
  2093. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
  2094. .. rst-class:: classref-enumeration-constant
  2095. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
  2096. 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2097. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
  2098. .. rst-class:: classref-enumeration-constant
  2099. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
  2100. 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2101. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
  2102. .. rst-class:: classref-enumeration-constant
  2103. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
  2104. 2D signed distance field covers 100% of the viewport's size outside the viewport on each side (top, right, bottom, left). This has the highest GPU requirements.
  2105. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
  2106. .. rst-class:: classref-enumeration-constant
  2107. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
  2108. Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
  2109. .. rst-class:: classref-item-separator
  2110. ----
  2111. .. _enum_RenderingServer_ViewportSDFScale:
  2112. .. rst-class:: classref-enumeration
  2113. enum **ViewportSDFScale**: :ref:`🔗<enum_RenderingServer_ViewportSDFScale>`
  2114. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
  2115. .. rst-class:: classref-enumeration-constant
  2116. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
  2117. Full resolution 2D signed distance field scale. This has the highest GPU requirements.
  2118. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
  2119. .. rst-class:: classref-enumeration-constant
  2120. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
  2121. Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
  2122. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
  2123. .. rst-class:: classref-enumeration-constant
  2124. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
  2125. Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
  2126. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
  2127. .. rst-class:: classref-enumeration-constant
  2128. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
  2129. Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _enum_RenderingServer_ViewportMSAA:
  2133. .. rst-class:: classref-enumeration
  2134. enum **ViewportMSAA**: :ref:`🔗<enum_RenderingServer_ViewportMSAA>`
  2135. .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
  2136. .. rst-class:: classref-enumeration-constant
  2137. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
  2138. Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
  2139. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
  2140. .. rst-class:: classref-enumeration-constant
  2141. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
  2142. Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
  2143. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
  2144. .. rst-class:: classref-enumeration-constant
  2145. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
  2146. Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
  2147. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
  2148. .. rst-class:: classref-enumeration-constant
  2149. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
  2150. Multisample antialiasing uses 8 samples per pixel for 3D. This has a very high impact on performance. Likely unsupported on low-end and older hardware.
  2151. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
  2152. .. rst-class:: classref-enumeration-constant
  2153. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
  2154. Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
  2155. .. rst-class:: classref-item-separator
  2156. ----
  2157. .. _enum_RenderingServer_ViewportAnisotropicFiltering:
  2158. .. rst-class:: classref-enumeration
  2159. enum **ViewportAnisotropicFiltering**: :ref:`🔗<enum_RenderingServer_ViewportAnisotropicFiltering>`
  2160. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_DISABLED:
  2161. .. rst-class:: classref-enumeration-constant
  2162. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_DISABLED** = ``0``
  2163. Anisotropic filtering is disabled.
  2164. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_2X:
  2165. .. rst-class:: classref-enumeration-constant
  2166. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_2X** = ``1``
  2167. Use 2× anisotropic filtering.
  2168. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_4X:
  2169. .. rst-class:: classref-enumeration-constant
  2170. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_4X** = ``2``
  2171. Use 4× anisotropic filtering. This is the default value.
  2172. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_8X:
  2173. .. rst-class:: classref-enumeration-constant
  2174. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_8X** = ``3``
  2175. Use 8× anisotropic filtering.
  2176. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_16X:
  2177. .. rst-class:: classref-enumeration-constant
  2178. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_16X** = ``4``
  2179. Use 16× anisotropic filtering.
  2180. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_MAX:
  2181. .. rst-class:: classref-enumeration-constant
  2182. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_MAX** = ``5``
  2183. Represents the size of the :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` enum.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _enum_RenderingServer_ViewportScreenSpaceAA:
  2187. .. rst-class:: classref-enumeration
  2188. enum **ViewportScreenSpaceAA**: :ref:`🔗<enum_RenderingServer_ViewportScreenSpaceAA>`
  2189. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
  2190. .. rst-class:: classref-enumeration-constant
  2191. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
  2192. Do not perform any antialiasing in the full screen post-process.
  2193. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
  2194. .. rst-class:: classref-enumeration-constant
  2195. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
  2196. Use fast approximate antialiasing. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K.
  2197. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
  2198. .. rst-class:: classref-enumeration-constant
  2199. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2``
  2200. Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
  2201. .. rst-class:: classref-item-separator
  2202. ----
  2203. .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
  2204. .. rst-class:: classref-enumeration
  2205. enum **ViewportOcclusionCullingBuildQuality**: :ref:`🔗<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`
  2206. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
  2207. .. rst-class:: classref-enumeration-constant
  2208. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
  2209. Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
  2210. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
  2211. .. rst-class:: classref-enumeration-constant
  2212. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
  2213. Medium occlusion culling BVH build quality (as defined by Embree).
  2214. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
  2215. .. rst-class:: classref-enumeration-constant
  2216. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
  2217. High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
  2218. .. rst-class:: classref-item-separator
  2219. ----
  2220. .. _enum_RenderingServer_ViewportRenderInfo:
  2221. .. rst-class:: classref-enumeration
  2222. enum **ViewportRenderInfo**: :ref:`🔗<enum_RenderingServer_ViewportRenderInfo>`
  2223. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
  2224. .. rst-class:: classref-enumeration-constant
  2225. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
  2226. Number of objects drawn in a single frame.
  2227. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
  2228. .. rst-class:: classref-enumeration-constant
  2229. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
  2230. Number of points, lines, or triangles drawn in a single frame.
  2231. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
  2232. .. rst-class:: classref-enumeration-constant
  2233. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
  2234. Number of draw calls during this frame.
  2235. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
  2236. .. rst-class:: classref-enumeration-constant
  2237. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
  2238. Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
  2239. .. rst-class:: classref-item-separator
  2240. ----
  2241. .. _enum_RenderingServer_ViewportRenderInfoType:
  2242. .. rst-class:: classref-enumeration
  2243. enum **ViewportRenderInfoType**: :ref:`🔗<enum_RenderingServer_ViewportRenderInfoType>`
  2244. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
  2245. .. rst-class:: classref-enumeration-constant
  2246. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
  2247. Visible render pass (excluding shadows).
  2248. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
  2249. .. rst-class:: classref-enumeration-constant
  2250. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
  2251. Shadow render pass. Objects will be rendered several times depending on the number of amounts of lights with shadows and the number of directional shadow splits.
  2252. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_CANVAS:
  2253. .. rst-class:: classref-enumeration-constant
  2254. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_CANVAS** = ``2``
  2255. Canvas item rendering. This includes all 2D rendering.
  2256. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
  2257. .. rst-class:: classref-enumeration-constant
  2258. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``3``
  2259. Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
  2260. .. rst-class:: classref-item-separator
  2261. ----
  2262. .. _enum_RenderingServer_ViewportDebugDraw:
  2263. .. rst-class:: classref-enumeration
  2264. enum **ViewportDebugDraw**: :ref:`🔗<enum_RenderingServer_ViewportDebugDraw>`
  2265. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
  2266. .. rst-class:: classref-enumeration-constant
  2267. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
  2268. Debug draw is disabled. Default setting.
  2269. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
  2270. .. rst-class:: classref-enumeration-constant
  2271. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
  2272. Objects are displayed without light information.
  2273. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
  2274. .. rst-class:: classref-enumeration-constant
  2275. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
  2276. Objects are displayed with only light information.
  2277. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
  2278. .. rst-class:: classref-enumeration-constant
  2279. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
  2280. Objects are displayed semi-transparent with additive blending so you can see where they are drawing over top of one another. A higher overdraw (represented by brighter colors) means you are wasting performance on drawing pixels that are being hidden behind others.
  2281. \ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
  2282. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
  2283. .. rst-class:: classref-enumeration-constant
  2284. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
  2285. Debug draw draws objects in wireframe.
  2286. \ **Note:** :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>` must be called before loading any meshes for wireframes to be visible when using the Compatibility renderer.
  2287. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
  2288. .. rst-class:: classref-enumeration-constant
  2289. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
  2290. Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
  2291. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
  2292. .. rst-class:: classref-enumeration-constant
  2293. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
  2294. Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2295. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
  2296. .. rst-class:: classref-enumeration-constant
  2297. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
  2298. Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2299. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
  2300. .. rst-class:: classref-enumeration-constant
  2301. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
  2302. Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2303. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
  2304. .. rst-class:: classref-enumeration-constant
  2305. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
  2306. Draws the shadow atlas that stores shadows from :ref:`OmniLight3D<class_OmniLight3D>`\ s and :ref:`SpotLight3D<class_SpotLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2307. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
  2308. .. rst-class:: classref-enumeration-constant
  2309. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
  2310. Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2311. The slice of the camera frustum related to the shadow map cascade is superimposed to visualize coverage. The color of each slice matches the colors used for :ref:`VIEWPORT_DEBUG_DRAW_PSSM_SPLITS<class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS>`. When shadow cascades are blended the overlap is taken into account when drawing the frustum slices.
  2312. The last cascade shows all frustum slices to illustrate the coverage of all slices.
  2313. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
  2314. .. rst-class:: classref-enumeration-constant
  2315. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
  2316. Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
  2317. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
  2318. .. rst-class:: classref-enumeration-constant
  2319. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
  2320. Draws the screen space ambient occlusion texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssao_enabled<class_Environment_property_ssao_enabled>` set in your :ref:`WorldEnvironment<class_WorldEnvironment>`.
  2321. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
  2322. .. rst-class:: classref-enumeration-constant
  2323. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
  2324. Draws the screen space indirect lighting texture instead of the scene so that you can clearly see how it is affecting objects. In order for this display mode to work, you must have :ref:`Environment.ssil_enabled<class_Environment_property_ssil_enabled>` set in your :ref:`WorldEnvironment<class_WorldEnvironment>`.
  2325. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
  2326. .. rst-class:: classref-enumeration-constant
  2327. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
  2328. Colors each PSSM split for the :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow.
  2329. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
  2330. .. rst-class:: classref-enumeration-constant
  2331. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
  2332. Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
  2333. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
  2334. .. rst-class:: classref-enumeration-constant
  2335. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
  2336. Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
  2337. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
  2338. .. rst-class:: classref-enumeration-constant
  2339. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
  2340. Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
  2341. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
  2342. .. rst-class:: classref-enumeration-constant
  2343. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
  2344. Draws the global illumination buffer (:ref:`VoxelGI<class_VoxelGI>` or SDFGI).
  2345. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
  2346. .. rst-class:: classref-enumeration-constant
  2347. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
  2348. Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
  2349. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
  2350. .. rst-class:: classref-enumeration-constant
  2351. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
  2352. Draws the :ref:`OmniLight3D<class_OmniLight3D>` cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
  2353. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
  2354. .. rst-class:: classref-enumeration-constant
  2355. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
  2356. Draws the :ref:`SpotLight3D<class_SpotLight3D>` cluster. Clustering determines where lights are positioned in screen-space, which allows the engine to only process these portions of the screen for lighting.
  2357. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
  2358. .. rst-class:: classref-enumeration-constant
  2359. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
  2360. Draws the :ref:`Decal<class_Decal>` cluster. Clustering determines where decals are positioned in screen-space, which allows the engine to only process these portions of the screen for decals.
  2361. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
  2362. .. rst-class:: classref-enumeration-constant
  2363. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
  2364. Draws the :ref:`ReflectionProbe<class_ReflectionProbe>` cluster. Clustering determines where reflection probes are positioned in screen-space, which allows the engine to only process these portions of the screen for reflection probes.
  2365. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
  2366. .. rst-class:: classref-enumeration-constant
  2367. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
  2368. Draws the occlusion culling buffer. This low-resolution occlusion culling buffer is rasterized on the CPU and is used to check whether instances are occluded by other objects.
  2369. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
  2370. .. rst-class:: classref-enumeration-constant
  2371. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
  2372. Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
  2373. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER:
  2374. .. rst-class:: classref-enumeration-constant
  2375. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26``
  2376. Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
  2377. .. rst-class:: classref-item-separator
  2378. ----
  2379. .. _enum_RenderingServer_ViewportVRSMode:
  2380. .. rst-class:: classref-enumeration
  2381. enum **ViewportVRSMode**: :ref:`🔗<enum_RenderingServer_ViewportVRSMode>`
  2382. .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
  2383. .. rst-class:: classref-enumeration-constant
  2384. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
  2385. Variable rate shading is disabled.
  2386. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
  2387. .. rst-class:: classref-enumeration-constant
  2388. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
  2389. Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
  2390. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
  2391. .. rst-class:: classref-enumeration-constant
  2392. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
  2393. Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`. Note that this may override the update mode.
  2394. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
  2395. .. rst-class:: classref-enumeration-constant
  2396. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
  2397. Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
  2398. .. rst-class:: classref-item-separator
  2399. ----
  2400. .. _enum_RenderingServer_ViewportVRSUpdateMode:
  2401. .. rst-class:: classref-enumeration
  2402. enum **ViewportVRSUpdateMode**: :ref:`🔗<enum_RenderingServer_ViewportVRSUpdateMode>`
  2403. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED:
  2404. .. rst-class:: classref-enumeration-constant
  2405. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_DISABLED** = ``0``
  2406. The input texture for variable rate shading will not be processed.
  2407. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE:
  2408. .. rst-class:: classref-enumeration-constant
  2409. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ONCE** = ``1``
  2410. The input texture for variable rate shading will be processed once.
  2411. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ALWAYS:
  2412. .. rst-class:: classref-enumeration-constant
  2413. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ALWAYS** = ``2``
  2414. The input texture for variable rate shading will be processed each frame.
  2415. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_MAX:
  2416. .. rst-class:: classref-enumeration-constant
  2417. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_MAX** = ``3``
  2418. Represents the size of the :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` enum.
  2419. .. rst-class:: classref-item-separator
  2420. ----
  2421. .. _enum_RenderingServer_SkyMode:
  2422. .. rst-class:: classref-enumeration
  2423. enum **SkyMode**: :ref:`🔗<enum_RenderingServer_SkyMode>`
  2424. .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
  2425. .. rst-class:: classref-enumeration-constant
  2426. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
  2427. Automatically selects the appropriate process mode based on your sky shader. If your shader uses ``TIME`` or ``POSITION``, this will use :ref:`SKY_MODE_REALTIME<class_RenderingServer_constant_SKY_MODE_REALTIME>`. If your shader uses any of the ``LIGHT_*`` variables or any custom uniforms, this uses :ref:`SKY_MODE_INCREMENTAL<class_RenderingServer_constant_SKY_MODE_INCREMENTAL>`. Otherwise, this defaults to :ref:`SKY_MODE_QUALITY<class_RenderingServer_constant_SKY_MODE_QUALITY>`.
  2428. .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
  2429. .. rst-class:: classref-enumeration-constant
  2430. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
  2431. Uses high quality importance sampling to process the radiance map. In general, this results in much higher quality than :ref:`SKY_MODE_REALTIME<class_RenderingServer_constant_SKY_MODE_REALTIME>` but takes much longer to generate. This should not be used if you plan on changing the sky at runtime. If you are finding that the reflection is not blurry enough and is showing sparkles or fireflies, try increasing :ref:`ProjectSettings.rendering/reflections/sky_reflections/ggx_samples<class_ProjectSettings_property_rendering/reflections/sky_reflections/ggx_samples>`.
  2432. .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
  2433. .. rst-class:: classref-enumeration-constant
  2434. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
  2435. Uses the same high quality importance sampling to process the radiance map as :ref:`SKY_MODE_QUALITY<class_RenderingServer_constant_SKY_MODE_QUALITY>`, but updates over several frames. The number of frames is determined by :ref:`ProjectSettings.rendering/reflections/sky_reflections/roughness_layers<class_ProjectSettings_property_rendering/reflections/sky_reflections/roughness_layers>`. Use this when you need highest quality radiance maps, but have a sky that updates slowly.
  2436. .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
  2437. .. rst-class:: classref-enumeration-constant
  2438. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
  2439. Uses the fast filtering algorithm to process the radiance map. In general this results in lower quality, but substantially faster run times. If you need better quality, but still need to update the sky every frame, consider turning on :ref:`ProjectSettings.rendering/reflections/sky_reflections/fast_filter_high_quality<class_ProjectSettings_property_rendering/reflections/sky_reflections/fast_filter_high_quality>`.
  2440. \ **Note:** The fast filtering algorithm is limited to 256×256 cubemaps, so :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>` must be set to ``256``. Otherwise, a warning is printed and the overridden radiance size is ignored.
  2441. .. rst-class:: classref-item-separator
  2442. ----
  2443. .. _enum_RenderingServer_CompositorEffectFlags:
  2444. .. rst-class:: classref-enumeration
  2445. enum **CompositorEffectFlags**: :ref:`🔗<enum_RenderingServer_CompositorEffectFlags>`
  2446. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR:
  2447. .. rst-class:: classref-enumeration-constant
  2448. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR** = ``1``
  2449. The rendering effect requires the color buffer to be resolved if MSAA is enabled.
  2450. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH:
  2451. .. rst-class:: classref-enumeration-constant
  2452. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH** = ``2``
  2453. The rendering effect requires the depth buffer to be resolved if MSAA is enabled.
  2454. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS:
  2455. .. rst-class:: classref-enumeration-constant
  2456. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS** = ``4``
  2457. The rendering effect requires motion vectors to be produced.
  2458. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS:
  2459. .. rst-class:: classref-enumeration-constant
  2460. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS** = ``8``
  2461. The rendering effect requires normals and roughness g-buffer to be produced (Forward+ only).
  2462. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR:
  2463. .. rst-class:: classref-enumeration-constant
  2464. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR** = ``16``
  2465. The rendering effect requires specular data to be separated out (Forward+ only).
  2466. .. rst-class:: classref-item-separator
  2467. ----
  2468. .. _enum_RenderingServer_CompositorEffectCallbackType:
  2469. .. rst-class:: classref-enumeration
  2470. enum **CompositorEffectCallbackType**: :ref:`🔗<enum_RenderingServer_CompositorEffectCallbackType>`
  2471. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE:
  2472. .. rst-class:: classref-enumeration-constant
  2473. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0``
  2474. The callback is called before our opaque rendering pass, but after depth prepass (if applicable).
  2475. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE:
  2476. .. rst-class:: classref-enumeration-constant
  2477. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1``
  2478. The callback is called after our opaque rendering pass, but before our sky is rendered.
  2479. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY:
  2480. .. rst-class:: classref-enumeration-constant
  2481. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY** = ``2``
  2482. The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections).
  2483. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT:
  2484. .. rst-class:: classref-enumeration-constant
  2485. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3``
  2486. The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.
  2487. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT:
  2488. .. rst-class:: classref-enumeration-constant
  2489. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4``
  2490. The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target.
  2491. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY:
  2492. .. rst-class:: classref-enumeration-constant
  2493. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY** = ``-1``
  2494. .. container:: contribute
  2495. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2496. .. rst-class:: classref-item-separator
  2497. ----
  2498. .. _enum_RenderingServer_EnvironmentBG:
  2499. .. rst-class:: classref-enumeration
  2500. enum **EnvironmentBG**: :ref:`🔗<enum_RenderingServer_EnvironmentBG>`
  2501. .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
  2502. .. rst-class:: classref-enumeration-constant
  2503. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
  2504. Use the clear color as background.
  2505. .. _class_RenderingServer_constant_ENV_BG_COLOR:
  2506. .. rst-class:: classref-enumeration-constant
  2507. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
  2508. Use a specified color as the background.
  2509. .. _class_RenderingServer_constant_ENV_BG_SKY:
  2510. .. rst-class:: classref-enumeration-constant
  2511. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
  2512. Use a sky resource for the background.
  2513. .. _class_RenderingServer_constant_ENV_BG_CANVAS:
  2514. .. rst-class:: classref-enumeration-constant
  2515. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
  2516. Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
  2517. .. _class_RenderingServer_constant_ENV_BG_KEEP:
  2518. .. rst-class:: classref-enumeration-constant
  2519. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
  2520. Do not clear the background, use whatever was rendered last frame as the background.
  2521. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
  2522. .. rst-class:: classref-enumeration-constant
  2523. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
  2524. Displays a camera feed in the background.
  2525. .. _class_RenderingServer_constant_ENV_BG_MAX:
  2526. .. rst-class:: classref-enumeration-constant
  2527. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
  2528. Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
  2529. .. rst-class:: classref-item-separator
  2530. ----
  2531. .. _enum_RenderingServer_EnvironmentAmbientSource:
  2532. .. rst-class:: classref-enumeration
  2533. enum **EnvironmentAmbientSource**: :ref:`🔗<enum_RenderingServer_EnvironmentAmbientSource>`
  2534. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
  2535. .. rst-class:: classref-enumeration-constant
  2536. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
  2537. Gather ambient light from whichever source is specified as the background.
  2538. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
  2539. .. rst-class:: classref-enumeration-constant
  2540. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
  2541. Disable ambient light.
  2542. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
  2543. .. rst-class:: classref-enumeration-constant
  2544. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
  2545. Specify a specific :ref:`Color<class_Color>` for ambient light.
  2546. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
  2547. .. rst-class:: classref-enumeration-constant
  2548. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
  2549. Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
  2550. .. rst-class:: classref-item-separator
  2551. ----
  2552. .. _enum_RenderingServer_EnvironmentReflectionSource:
  2553. .. rst-class:: classref-enumeration
  2554. enum **EnvironmentReflectionSource**: :ref:`🔗<enum_RenderingServer_EnvironmentReflectionSource>`
  2555. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
  2556. .. rst-class:: classref-enumeration-constant
  2557. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
  2558. Use the background for reflections.
  2559. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
  2560. .. rst-class:: classref-enumeration-constant
  2561. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
  2562. Disable reflections.
  2563. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
  2564. .. rst-class:: classref-enumeration-constant
  2565. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
  2566. Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
  2567. .. rst-class:: classref-item-separator
  2568. ----
  2569. .. _enum_RenderingServer_EnvironmentGlowBlendMode:
  2570. .. rst-class:: classref-enumeration
  2571. enum **EnvironmentGlowBlendMode**: :ref:`🔗<enum_RenderingServer_EnvironmentGlowBlendMode>`
  2572. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
  2573. .. rst-class:: classref-enumeration-constant
  2574. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
  2575. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  2576. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
  2577. .. rst-class:: classref-enumeration-constant
  2578. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
  2579. Screen glow blending mode. Increases brightness, used frequently with bloom.
  2580. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
  2581. .. rst-class:: classref-enumeration-constant
  2582. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
  2583. Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
  2584. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
  2585. .. rst-class:: classref-enumeration-constant
  2586. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
  2587. Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness.
  2588. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
  2589. .. rst-class:: classref-enumeration-constant
  2590. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
  2591. Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
  2592. .. rst-class:: classref-item-separator
  2593. ----
  2594. .. _enum_RenderingServer_EnvironmentFogMode:
  2595. .. rst-class:: classref-enumeration
  2596. enum **EnvironmentFogMode**: :ref:`🔗<enum_RenderingServer_EnvironmentFogMode>`
  2597. .. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL:
  2598. .. rst-class:: classref-enumeration-constant
  2599. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_EXPONENTIAL** = ``0``
  2600. Use a physically-based fog model defined primarily by fog density.
  2601. .. _class_RenderingServer_constant_ENV_FOG_MODE_DEPTH:
  2602. .. rst-class:: classref-enumeration-constant
  2603. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_DEPTH** = ``1``
  2604. Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control.
  2605. .. rst-class:: classref-item-separator
  2606. ----
  2607. .. _enum_RenderingServer_EnvironmentToneMapper:
  2608. .. rst-class:: classref-enumeration
  2609. enum **EnvironmentToneMapper**: :ref:`🔗<enum_RenderingServer_EnvironmentToneMapper>`
  2610. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
  2611. .. rst-class:: classref-enumeration-constant
  2612. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
  2613. Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
  2614. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
  2615. .. rst-class:: classref-enumeration-constant
  2616. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
  2617. Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: ``color = color * (1 + color / (white * white)) / (1 + color)``. This avoids clipping bright highlights, but the resulting image can look a bit dull. When :ref:`Environment.tonemap_white<class_Environment_property_tonemap_white>` is left at the default value of ``1.0`` this is identical to :ref:`ENV_TONE_MAPPER_LINEAR<class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR>` while also being slightly less performant.
  2618. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
  2619. .. rst-class:: classref-enumeration-constant
  2620. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
  2621. Use the filmic tonemapper. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>`.
  2622. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
  2623. .. rst-class:: classref-enumeration-constant
  2624. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
  2625. Use the Academy Color Encoding System tonemapper. ACES is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. ACES typically has a more contrasted output compared to :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>` and :ref:`ENV_TONE_MAPPER_FILMIC<class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC>`.
  2626. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
  2627. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_AGX:
  2628. .. rst-class:: classref-enumeration-constant
  2629. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_AGX** = ``4``
  2630. Use the AgX tonemapper. AgX is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. AgX is less likely to darken parts of the scene compared to :ref:`ENV_TONE_MAPPER_ACES<class_RenderingServer_constant_ENV_TONE_MAPPER_ACES>`, and can match :ref:`ENV_TONE_MAPPER_FILMIC<class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC>` more closely.
  2631. .. rst-class:: classref-item-separator
  2632. ----
  2633. .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
  2634. .. rst-class:: classref-enumeration
  2635. enum **EnvironmentSSRRoughnessQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`
  2636. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
  2637. .. rst-class:: classref-enumeration-constant
  2638. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
  2639. Lowest quality of roughness filter for screen-space reflections. Rough materials will not have blurrier screen-space reflections compared to smooth (non-rough) materials. This is the fastest option.
  2640. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
  2641. .. rst-class:: classref-enumeration-constant
  2642. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
  2643. Low quality of roughness filter for screen-space reflections.
  2644. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
  2645. .. rst-class:: classref-enumeration-constant
  2646. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
  2647. Medium quality of roughness filter for screen-space reflections.
  2648. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
  2649. .. rst-class:: classref-enumeration-constant
  2650. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
  2651. High quality of roughness filter for screen-space reflections. This is the slowest option.
  2652. .. rst-class:: classref-item-separator
  2653. ----
  2654. .. _enum_RenderingServer_EnvironmentSSAOQuality:
  2655. .. rst-class:: classref-enumeration
  2656. enum **EnvironmentSSAOQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSAOQuality>`
  2657. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
  2658. .. rst-class:: classref-enumeration-constant
  2659. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
  2660. Lowest quality of screen-space ambient occlusion.
  2661. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
  2662. .. rst-class:: classref-enumeration-constant
  2663. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
  2664. Low quality screen-space ambient occlusion.
  2665. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
  2666. .. rst-class:: classref-enumeration-constant
  2667. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
  2668. Medium quality screen-space ambient occlusion.
  2669. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
  2670. .. rst-class:: classref-enumeration-constant
  2671. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
  2672. High quality screen-space ambient occlusion.
  2673. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
  2674. .. rst-class:: classref-enumeration-constant
  2675. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
  2676. Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2677. .. rst-class:: classref-item-separator
  2678. ----
  2679. .. _enum_RenderingServer_EnvironmentSSILQuality:
  2680. .. rst-class:: classref-enumeration
  2681. enum **EnvironmentSSILQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSILQuality>`
  2682. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
  2683. .. rst-class:: classref-enumeration-constant
  2684. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
  2685. Lowest quality of screen-space indirect lighting.
  2686. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
  2687. .. rst-class:: classref-enumeration-constant
  2688. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
  2689. Low quality screen-space indirect lighting.
  2690. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
  2691. .. rst-class:: classref-enumeration-constant
  2692. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
  2693. High quality screen-space indirect lighting.
  2694. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
  2695. .. rst-class:: classref-enumeration-constant
  2696. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
  2697. High quality screen-space indirect lighting.
  2698. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
  2699. .. rst-class:: classref-enumeration-constant
  2700. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
  2701. Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2702. .. rst-class:: classref-item-separator
  2703. ----
  2704. .. _enum_RenderingServer_EnvironmentSDFGIYScale:
  2705. .. rst-class:: classref-enumeration
  2706. enum **EnvironmentSDFGIYScale**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIYScale>`
  2707. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
  2708. .. rst-class:: classref-enumeration-constant
  2709. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
  2710. Use 50% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be twice as short as they are wide. This allows providing increased GI detail and reduced light leaking with thin floors and ceilings. This is usually the best choice for scenes that don't feature much verticality.
  2711. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
  2712. .. rst-class:: classref-enumeration-constant
  2713. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
  2714. Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
  2715. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
  2716. .. rst-class:: classref-enumeration-constant
  2717. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
  2718. Use 100% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be as tall as they are wide. This is usually the best choice for highly vertical scenes. The downside is that light leaking may become more noticeable with thin floors and ceilings.
  2719. .. rst-class:: classref-item-separator
  2720. ----
  2721. .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
  2722. .. rst-class:: classref-enumeration
  2723. enum **EnvironmentSDFGIRayCount**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIRayCount>`
  2724. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
  2725. .. rst-class:: classref-enumeration-constant
  2726. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
  2727. Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
  2728. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
  2729. .. rst-class:: classref-enumeration-constant
  2730. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
  2731. Throw 8 rays per frame when converging SDFGI.
  2732. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
  2733. .. rst-class:: classref-enumeration-constant
  2734. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
  2735. Throw 16 rays per frame when converging SDFGI.
  2736. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
  2737. .. rst-class:: classref-enumeration-constant
  2738. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
  2739. Throw 32 rays per frame when converging SDFGI.
  2740. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
  2741. .. rst-class:: classref-enumeration-constant
  2742. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
  2743. Throw 64 rays per frame when converging SDFGI.
  2744. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
  2745. .. rst-class:: classref-enumeration-constant
  2746. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
  2747. Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
  2748. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
  2749. .. rst-class:: classref-enumeration-constant
  2750. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
  2751. Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
  2752. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
  2753. .. rst-class:: classref-enumeration-constant
  2754. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
  2755. Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
  2756. .. rst-class:: classref-item-separator
  2757. ----
  2758. .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
  2759. .. rst-class:: classref-enumeration
  2760. enum **EnvironmentSDFGIFramesToConverge**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`
  2761. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
  2762. .. rst-class:: classref-enumeration-constant
  2763. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
  2764. Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
  2765. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
  2766. .. rst-class:: classref-enumeration-constant
  2767. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
  2768. Configure SDFGI to fully converge over 10 frames.
  2769. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
  2770. .. rst-class:: classref-enumeration-constant
  2771. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
  2772. Configure SDFGI to fully converge over 15 frames.
  2773. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
  2774. .. rst-class:: classref-enumeration-constant
  2775. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
  2776. Configure SDFGI to fully converge over 20 frames.
  2777. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
  2778. .. rst-class:: classref-enumeration-constant
  2779. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
  2780. Configure SDFGI to fully converge over 25 frames.
  2781. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
  2782. .. rst-class:: classref-enumeration-constant
  2783. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
  2784. Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
  2785. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
  2786. .. rst-class:: classref-enumeration-constant
  2787. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
  2788. Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
  2789. .. rst-class:: classref-item-separator
  2790. ----
  2791. .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
  2792. .. rst-class:: classref-enumeration
  2793. enum **EnvironmentSDFGIFramesToUpdateLight**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`
  2794. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
  2795. .. rst-class:: classref-enumeration-constant
  2796. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
  2797. Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
  2798. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
  2799. .. rst-class:: classref-enumeration-constant
  2800. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
  2801. Update indirect light from dynamic lights in SDFGI over 2 frames.
  2802. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
  2803. .. rst-class:: classref-enumeration-constant
  2804. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
  2805. Update indirect light from dynamic lights in SDFGI over 4 frames.
  2806. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
  2807. .. rst-class:: classref-enumeration-constant
  2808. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
  2809. Update indirect light from dynamic lights in SDFGI over 8 frames.
  2810. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
  2811. .. rst-class:: classref-enumeration-constant
  2812. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
  2813. Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
  2814. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
  2815. .. rst-class:: classref-enumeration-constant
  2816. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
  2817. Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
  2818. .. rst-class:: classref-item-separator
  2819. ----
  2820. .. _enum_RenderingServer_SubSurfaceScatteringQuality:
  2821. .. rst-class:: classref-enumeration
  2822. enum **SubSurfaceScatteringQuality**: :ref:`🔗<enum_RenderingServer_SubSurfaceScatteringQuality>`
  2823. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
  2824. .. rst-class:: classref-enumeration-constant
  2825. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
  2826. Disables subsurface scattering entirely, even on materials that have :ref:`BaseMaterial3D.subsurf_scatter_enabled<class_BaseMaterial3D_property_subsurf_scatter_enabled>` set to ``true``. This has the lowest GPU requirements.
  2827. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
  2828. .. rst-class:: classref-enumeration-constant
  2829. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
  2830. Low subsurface scattering quality.
  2831. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
  2832. .. rst-class:: classref-enumeration-constant
  2833. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
  2834. Medium subsurface scattering quality.
  2835. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
  2836. .. rst-class:: classref-enumeration-constant
  2837. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
  2838. High subsurface scattering quality. This has the highest GPU requirements.
  2839. .. rst-class:: classref-item-separator
  2840. ----
  2841. .. _enum_RenderingServer_DOFBokehShape:
  2842. .. rst-class:: classref-enumeration
  2843. enum **DOFBokehShape**: :ref:`🔗<enum_RenderingServer_DOFBokehShape>`
  2844. .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
  2845. .. rst-class:: classref-enumeration-constant
  2846. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
  2847. Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
  2848. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
  2849. .. rst-class:: classref-enumeration-constant
  2850. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
  2851. Calculates DOF blur using a hexagon shaped filter.
  2852. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
  2853. .. rst-class:: classref-enumeration-constant
  2854. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
  2855. Calculates DOF blur using a circle shaped filter. Best quality and most realistic, but slowest. Use only for areas where a lot of performance can be dedicated to post-processing (e.g. cutscenes).
  2856. .. rst-class:: classref-item-separator
  2857. ----
  2858. .. _enum_RenderingServer_DOFBlurQuality:
  2859. .. rst-class:: classref-enumeration
  2860. enum **DOFBlurQuality**: :ref:`🔗<enum_RenderingServer_DOFBlurQuality>`
  2861. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
  2862. .. rst-class:: classref-enumeration-constant
  2863. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
  2864. Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
  2865. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
  2866. .. rst-class:: classref-enumeration-constant
  2867. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
  2868. Low quality DOF blur.
  2869. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
  2870. .. rst-class:: classref-enumeration-constant
  2871. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
  2872. Medium quality DOF blur.
  2873. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
  2874. .. rst-class:: classref-enumeration-constant
  2875. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
  2876. Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
  2877. .. rst-class:: classref-item-separator
  2878. ----
  2879. .. _enum_RenderingServer_InstanceType:
  2880. .. rst-class:: classref-enumeration
  2881. enum **InstanceType**: :ref:`🔗<enum_RenderingServer_InstanceType>`
  2882. .. _class_RenderingServer_constant_INSTANCE_NONE:
  2883. .. rst-class:: classref-enumeration-constant
  2884. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
  2885. The instance does not have a type.
  2886. .. _class_RenderingServer_constant_INSTANCE_MESH:
  2887. .. rst-class:: classref-enumeration-constant
  2888. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
  2889. The instance is a mesh.
  2890. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
  2891. .. rst-class:: classref-enumeration-constant
  2892. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
  2893. The instance is a multimesh.
  2894. .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
  2895. .. rst-class:: classref-enumeration-constant
  2896. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
  2897. The instance is a particle emitter.
  2898. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
  2899. .. rst-class:: classref-enumeration-constant
  2900. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
  2901. The instance is a GPUParticles collision shape.
  2902. .. _class_RenderingServer_constant_INSTANCE_LIGHT:
  2903. .. rst-class:: classref-enumeration-constant
  2904. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
  2905. The instance is a light.
  2906. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
  2907. .. rst-class:: classref-enumeration-constant
  2908. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
  2909. The instance is a reflection probe.
  2910. .. _class_RenderingServer_constant_INSTANCE_DECAL:
  2911. .. rst-class:: classref-enumeration-constant
  2912. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
  2913. The instance is a decal.
  2914. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
  2915. .. rst-class:: classref-enumeration-constant
  2916. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
  2917. The instance is a VoxelGI.
  2918. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
  2919. .. rst-class:: classref-enumeration-constant
  2920. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
  2921. The instance is a lightmap.
  2922. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
  2923. .. rst-class:: classref-enumeration-constant
  2924. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
  2925. The instance is an occlusion culling occluder.
  2926. .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
  2927. .. rst-class:: classref-enumeration-constant
  2928. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
  2929. The instance is a visible on-screen notifier.
  2930. .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
  2931. .. rst-class:: classref-enumeration-constant
  2932. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
  2933. The instance is a fog volume.
  2934. .. _class_RenderingServer_constant_INSTANCE_MAX:
  2935. .. rst-class:: classref-enumeration-constant
  2936. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
  2937. Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
  2938. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
  2939. .. rst-class:: classref-enumeration-constant
  2940. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
  2941. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  2942. .. rst-class:: classref-item-separator
  2943. ----
  2944. .. _enum_RenderingServer_InstanceFlags:
  2945. .. rst-class:: classref-enumeration
  2946. enum **InstanceFlags**: :ref:`🔗<enum_RenderingServer_InstanceFlags>`
  2947. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
  2948. .. rst-class:: classref-enumeration-constant
  2949. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
  2950. Allows the instance to be used in baked lighting.
  2951. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
  2952. .. rst-class:: classref-enumeration-constant
  2953. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
  2954. Allows the instance to be used with dynamic global illumination.
  2955. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
  2956. .. rst-class:: classref-enumeration-constant
  2957. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
  2958. When set, manually requests to draw geometry on next frame.
  2959. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
  2960. .. rst-class:: classref-enumeration-constant
  2961. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
  2962. Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
  2963. .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
  2964. .. rst-class:: classref-enumeration-constant
  2965. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
  2966. Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
  2967. .. rst-class:: classref-item-separator
  2968. ----
  2969. .. _enum_RenderingServer_ShadowCastingSetting:
  2970. .. rst-class:: classref-enumeration
  2971. enum **ShadowCastingSetting**: :ref:`🔗<enum_RenderingServer_ShadowCastingSetting>`
  2972. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
  2973. .. rst-class:: classref-enumeration-constant
  2974. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
  2975. Disable shadows from this instance.
  2976. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
  2977. .. rst-class:: classref-enumeration-constant
  2978. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
  2979. Cast shadows from this instance.
  2980. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
  2981. .. rst-class:: classref-enumeration-constant
  2982. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
  2983. Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
  2984. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
  2985. .. rst-class:: classref-enumeration-constant
  2986. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
  2987. Only render the shadows from the object. The object itself will not be drawn.
  2988. .. rst-class:: classref-item-separator
  2989. ----
  2990. .. _enum_RenderingServer_VisibilityRangeFadeMode:
  2991. .. rst-class:: classref-enumeration
  2992. enum **VisibilityRangeFadeMode**: :ref:`🔗<enum_RenderingServer_VisibilityRangeFadeMode>`
  2993. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
  2994. .. rst-class:: classref-enumeration-constant
  2995. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
  2996. Disable visibility range fading for the given instance.
  2997. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
  2998. .. rst-class:: classref-enumeration-constant
  2999. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
  3000. Fade-out the given instance when it approaches its visibility range limits.
  3001. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
  3002. .. rst-class:: classref-enumeration-constant
  3003. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
  3004. Fade-in the given instance's dependencies when reaching its visibility range limits.
  3005. .. rst-class:: classref-item-separator
  3006. ----
  3007. .. _enum_RenderingServer_BakeChannels:
  3008. .. rst-class:: classref-enumeration
  3009. enum **BakeChannels**: :ref:`🔗<enum_RenderingServer_BakeChannels>`
  3010. .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
  3011. .. rst-class:: classref-enumeration-constant
  3012. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
  3013. Index of :ref:`Image<class_Image>` in array of :ref:`Image<class_Image>`\ s returned by :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`. Image uses :ref:`Image.FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` and contains albedo color in the ``.rgb`` channels and alpha in the ``.a`` channel.
  3014. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
  3015. .. rst-class:: classref-enumeration-constant
  3016. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
  3017. Index of :ref:`Image<class_Image>` in array of :ref:`Image<class_Image>`\ s returned by :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`. Image uses :ref:`Image.FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` and contains the per-pixel normal of the object in the ``.rgb`` channels and nothing in the ``.a`` channel. The per-pixel normal is encoded as ``normal * 0.5 + 0.5``.
  3018. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
  3019. .. rst-class:: classref-enumeration-constant
  3020. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
  3021. Index of :ref:`Image<class_Image>` in array of :ref:`Image<class_Image>`\ s returned by :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`. Image uses :ref:`Image.FORMAT_RGBA8<class_Image_constant_FORMAT_RGBA8>` and contains ambient occlusion (from material and decals only) in the ``.r`` channel, roughness in the ``.g`` channel, metallic in the ``.b`` channel and sub surface scattering amount in the ``.a`` channel.
  3022. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
  3023. .. rst-class:: classref-enumeration-constant
  3024. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
  3025. Index of :ref:`Image<class_Image>` in array of :ref:`Image<class_Image>`\ s returned by :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`. Image uses :ref:`Image.FORMAT_RGBAH<class_Image_constant_FORMAT_RGBAH>` and contains emission color in the ``.rgb`` channels and nothing in the ``.a`` channel.
  3026. .. rst-class:: classref-item-separator
  3027. ----
  3028. .. _enum_RenderingServer_CanvasTextureChannel:
  3029. .. rst-class:: classref-enumeration
  3030. enum **CanvasTextureChannel**: :ref:`🔗<enum_RenderingServer_CanvasTextureChannel>`
  3031. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
  3032. .. rst-class:: classref-enumeration-constant
  3033. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
  3034. Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
  3035. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
  3036. .. rst-class:: classref-enumeration-constant
  3037. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
  3038. Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
  3039. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
  3040. .. rst-class:: classref-enumeration-constant
  3041. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
  3042. Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
  3043. .. rst-class:: classref-item-separator
  3044. ----
  3045. .. _enum_RenderingServer_NinePatchAxisMode:
  3046. .. rst-class:: classref-enumeration
  3047. enum **NinePatchAxisMode**: :ref:`🔗<enum_RenderingServer_NinePatchAxisMode>`
  3048. .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
  3049. .. rst-class:: classref-enumeration-constant
  3050. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
  3051. The nine patch gets stretched where needed.
  3052. .. _class_RenderingServer_constant_NINE_PATCH_TILE:
  3053. .. rst-class:: classref-enumeration-constant
  3054. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
  3055. The nine patch gets filled with tiles where needed.
  3056. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
  3057. .. rst-class:: classref-enumeration-constant
  3058. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
  3059. The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  3060. .. rst-class:: classref-item-separator
  3061. ----
  3062. .. _enum_RenderingServer_CanvasItemTextureFilter:
  3063. .. rst-class:: classref-enumeration
  3064. enum **CanvasItemTextureFilter**: :ref:`🔗<enum_RenderingServer_CanvasItemTextureFilter>`
  3065. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
  3066. .. rst-class:: classref-enumeration-constant
  3067. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
  3068. Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
  3069. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
  3070. .. rst-class:: classref-enumeration-constant
  3071. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
  3072. The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).
  3073. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
  3074. .. rst-class:: classref-enumeration-constant
  3075. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
  3076. The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).
  3077. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
  3078. .. rst-class:: classref-enumeration-constant
  3079. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
  3080. The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance.
  3081. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
  3082. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
  3083. .. rst-class:: classref-enumeration-constant
  3084. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
  3085. The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance.
  3086. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
  3087. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
  3088. .. rst-class:: classref-enumeration-constant
  3089. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
  3090. The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  3091. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS>` is usually more appropriate in this case.
  3092. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
  3093. .. rst-class:: classref-enumeration-constant
  3094. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
  3095. The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  3096. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS>` is usually more appropriate in this case.
  3097. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
  3098. .. rst-class:: classref-enumeration-constant
  3099. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
  3100. Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
  3101. .. rst-class:: classref-item-separator
  3102. ----
  3103. .. _enum_RenderingServer_CanvasItemTextureRepeat:
  3104. .. rst-class:: classref-enumeration
  3105. enum **CanvasItemTextureRepeat**: :ref:`🔗<enum_RenderingServer_CanvasItemTextureRepeat>`
  3106. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
  3107. .. rst-class:: classref-enumeration-constant
  3108. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
  3109. Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
  3110. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
  3111. .. rst-class:: classref-enumeration-constant
  3112. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
  3113. Disables textures repeating. Instead, when reading UVs outside the 0-1 range, the value will be clamped to the edge of the texture, resulting in a stretched out look at the borders of the texture.
  3114. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
  3115. .. rst-class:: classref-enumeration-constant
  3116. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
  3117. Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
  3118. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
  3119. .. rst-class:: classref-enumeration-constant
  3120. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
  3121. Flip the texture when repeating so that the edge lines up instead of abruptly changing.
  3122. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
  3123. .. rst-class:: classref-enumeration-constant
  3124. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
  3125. Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
  3126. .. rst-class:: classref-item-separator
  3127. ----
  3128. .. _enum_RenderingServer_CanvasGroupMode:
  3129. .. rst-class:: classref-enumeration
  3130. enum **CanvasGroupMode**: :ref:`🔗<enum_RenderingServer_CanvasGroupMode>`
  3131. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
  3132. .. rst-class:: classref-enumeration-constant
  3133. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
  3134. Child draws over parent and is not clipped.
  3135. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
  3136. .. rst-class:: classref-enumeration-constant
  3137. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
  3138. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
  3139. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
  3140. .. rst-class:: classref-enumeration-constant
  3141. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
  3142. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
  3143. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
  3144. .. rst-class:: classref-enumeration-constant
  3145. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
  3146. .. container:: contribute
  3147. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3148. .. rst-class:: classref-item-separator
  3149. ----
  3150. .. _enum_RenderingServer_CanvasLightMode:
  3151. .. rst-class:: classref-enumeration
  3152. enum **CanvasLightMode**: :ref:`🔗<enum_RenderingServer_CanvasLightMode>`
  3153. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
  3154. .. rst-class:: classref-enumeration-constant
  3155. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
  3156. 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
  3157. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
  3158. .. rst-class:: classref-enumeration-constant
  3159. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
  3160. 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
  3161. .. rst-class:: classref-item-separator
  3162. ----
  3163. .. _enum_RenderingServer_CanvasLightBlendMode:
  3164. .. rst-class:: classref-enumeration
  3165. enum **CanvasLightBlendMode**: :ref:`🔗<enum_RenderingServer_CanvasLightBlendMode>`
  3166. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
  3167. .. rst-class:: classref-enumeration-constant
  3168. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
  3169. Adds light color additive to the canvas.
  3170. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
  3171. .. rst-class:: classref-enumeration-constant
  3172. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
  3173. Adds light color subtractive to the canvas.
  3174. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
  3175. .. rst-class:: classref-enumeration-constant
  3176. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
  3177. The light adds color depending on transparency.
  3178. .. rst-class:: classref-item-separator
  3179. ----
  3180. .. _enum_RenderingServer_CanvasLightShadowFilter:
  3181. .. rst-class:: classref-enumeration
  3182. enum **CanvasLightShadowFilter**: :ref:`🔗<enum_RenderingServer_CanvasLightShadowFilter>`
  3183. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
  3184. .. rst-class:: classref-enumeration-constant
  3185. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
  3186. Do not apply a filter to canvas light shadows.
  3187. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
  3188. .. rst-class:: classref-enumeration-constant
  3189. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
  3190. Use PCF5 filtering to filter canvas light shadows.
  3191. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
  3192. .. rst-class:: classref-enumeration-constant
  3193. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
  3194. Use PCF13 filtering to filter canvas light shadows.
  3195. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
  3196. .. rst-class:: classref-enumeration-constant
  3197. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
  3198. Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
  3199. .. rst-class:: classref-item-separator
  3200. ----
  3201. .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
  3202. .. rst-class:: classref-enumeration
  3203. enum **CanvasOccluderPolygonCullMode**: :ref:`🔗<enum_RenderingServer_CanvasOccluderPolygonCullMode>`
  3204. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
  3205. .. rst-class:: classref-enumeration-constant
  3206. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
  3207. Culling of the canvas occluder is disabled.
  3208. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
  3209. .. rst-class:: classref-enumeration-constant
  3210. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
  3211. Culling of the canvas occluder is clockwise.
  3212. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
  3213. .. rst-class:: classref-enumeration-constant
  3214. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
  3215. Culling of the canvas occluder is counterclockwise.
  3216. .. rst-class:: classref-item-separator
  3217. ----
  3218. .. _enum_RenderingServer_GlobalShaderParameterType:
  3219. .. rst-class:: classref-enumeration
  3220. enum **GlobalShaderParameterType**: :ref:`🔗<enum_RenderingServer_GlobalShaderParameterType>`
  3221. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
  3222. .. rst-class:: classref-enumeration-constant
  3223. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
  3224. Boolean global shader parameter (``global uniform bool ...``).
  3225. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
  3226. .. rst-class:: classref-enumeration-constant
  3227. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
  3228. 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
  3229. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
  3230. .. rst-class:: classref-enumeration-constant
  3231. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
  3232. 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
  3233. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
  3234. .. rst-class:: classref-enumeration-constant
  3235. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
  3236. 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
  3237. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
  3238. .. rst-class:: classref-enumeration-constant
  3239. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
  3240. Integer global shader parameter (``global uniform int ...``).
  3241. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
  3242. .. rst-class:: classref-enumeration-constant
  3243. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
  3244. 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
  3245. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
  3246. .. rst-class:: classref-enumeration-constant
  3247. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
  3248. 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
  3249. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
  3250. .. rst-class:: classref-enumeration-constant
  3251. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
  3252. 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
  3253. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
  3254. .. rst-class:: classref-enumeration-constant
  3255. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
  3256. 2-dimensional integer rectangle global shader parameter (``global uniform ivec4 ...``). Equivalent to :ref:`GLOBAL_VAR_TYPE_IVEC4<class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4>` in shader code, but exposed as a :ref:`Rect2i<class_Rect2i>` in the editor UI.
  3257. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
  3258. .. rst-class:: classref-enumeration-constant
  3259. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
  3260. Unsigned integer global shader parameter (``global uniform uint ...``).
  3261. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
  3262. .. rst-class:: classref-enumeration-constant
  3263. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
  3264. 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
  3265. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
  3266. .. rst-class:: classref-enumeration-constant
  3267. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
  3268. 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
  3269. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
  3270. .. rst-class:: classref-enumeration-constant
  3271. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
  3272. 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
  3273. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
  3274. .. rst-class:: classref-enumeration-constant
  3275. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
  3276. Single-precision floating-point global shader parameter (``global uniform float ...``).
  3277. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
  3278. .. rst-class:: classref-enumeration-constant
  3279. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
  3280. 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
  3281. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
  3282. .. rst-class:: classref-enumeration-constant
  3283. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
  3284. 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
  3285. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
  3286. .. rst-class:: classref-enumeration-constant
  3287. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
  3288. 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
  3289. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
  3290. .. rst-class:: classref-enumeration-constant
  3291. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
  3292. Color global shader parameter (``global uniform vec4 ...``). Equivalent to :ref:`GLOBAL_VAR_TYPE_VEC4<class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4>` in shader code, but exposed as a :ref:`Color<class_Color>` in the editor UI.
  3293. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
  3294. .. rst-class:: classref-enumeration-constant
  3295. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
  3296. 2-dimensional floating-point rectangle global shader parameter (``global uniform vec4 ...``). Equivalent to :ref:`GLOBAL_VAR_TYPE_VEC4<class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4>` in shader code, but exposed as a :ref:`Rect2<class_Rect2>` in the editor UI.
  3297. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
  3298. .. rst-class:: classref-enumeration-constant
  3299. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
  3300. 2×2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
  3301. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
  3302. .. rst-class:: classref-enumeration-constant
  3303. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
  3304. 3×3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
  3305. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
  3306. .. rst-class:: classref-enumeration-constant
  3307. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
  3308. 4×4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
  3309. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
  3310. .. rst-class:: classref-enumeration-constant
  3311. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
  3312. 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
  3313. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
  3314. .. rst-class:: classref-enumeration-constant
  3315. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
  3316. 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
  3317. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
  3318. .. rst-class:: classref-enumeration-constant
  3319. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
  3320. 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
  3321. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
  3322. .. rst-class:: classref-enumeration-constant
  3323. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
  3324. 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
  3325. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
  3326. .. rst-class:: classref-enumeration-constant
  3327. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
  3328. 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
  3329. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
  3330. .. rst-class:: classref-enumeration-constant
  3331. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
  3332. Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
  3333. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLEREXT:
  3334. .. rst-class:: classref-enumeration-constant
  3335. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLEREXT** = ``28``
  3336. External sampler global shader parameter (``global uniform samplerExternalOES ...``). Exposed as a :ref:`ExternalTexture<class_ExternalTexture>` in the editor UI.
  3337. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
  3338. .. rst-class:: classref-enumeration-constant
  3339. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``29``
  3340. Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
  3341. .. rst-class:: classref-item-separator
  3342. ----
  3343. .. _enum_RenderingServer_RenderingInfo:
  3344. .. rst-class:: classref-enumeration
  3345. enum **RenderingInfo**: :ref:`🔗<enum_RenderingServer_RenderingInfo>`
  3346. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
  3347. .. rst-class:: classref-enumeration-constant
  3348. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
  3349. Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
  3350. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
  3351. .. rst-class:: classref-enumeration-constant
  3352. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
  3353. Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
  3354. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
  3355. .. rst-class:: classref-enumeration-constant
  3356. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
  3357. Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
  3358. .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
  3359. .. rst-class:: classref-enumeration-constant
  3360. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
  3361. Texture memory used (in bytes).
  3362. .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
  3363. .. rst-class:: classref-enumeration-constant
  3364. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
  3365. Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
  3366. .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
  3367. .. rst-class:: classref-enumeration-constant
  3368. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
  3369. Video memory used (in bytes). When using the Forward+ or Mobile renderers, this is always greater than the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`, since there is miscellaneous data not accounted for by those two metrics. When using the Compatibility renderer, this is equal to the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`.
  3370. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS:
  3371. .. rst-class:: classref-enumeration-constant
  3372. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS** = ``6``
  3373. Number of pipeline compilations that were triggered by the 2D canvas renderer.
  3374. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_MESH:
  3375. .. rst-class:: classref-enumeration-constant
  3376. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_MESH** = ``7``
  3377. Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required.
  3378. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE:
  3379. .. rst-class:: classref-enumeration-constant
  3380. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE** = ``8``
  3381. Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading an scene the first time a user runs the game and the pipeline is required.
  3382. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW:
  3383. .. rst-class:: classref-enumeration-constant
  3384. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW** = ``9``
  3385. Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required.
  3386. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION:
  3387. .. rst-class:: classref-enumeration-constant
  3388. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION** = ``10``
  3389. Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever.
  3390. .. rst-class:: classref-item-separator
  3391. ----
  3392. .. _enum_RenderingServer_PipelineSource:
  3393. .. rst-class:: classref-enumeration
  3394. enum **PipelineSource**: :ref:`🔗<enum_RenderingServer_PipelineSource>`
  3395. .. _class_RenderingServer_constant_PIPELINE_SOURCE_CANVAS:
  3396. .. rst-class:: classref-enumeration-constant
  3397. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_CANVAS** = ``0``
  3398. Pipeline compilation that was triggered by the 2D canvas renderer.
  3399. .. _class_RenderingServer_constant_PIPELINE_SOURCE_MESH:
  3400. .. rst-class:: classref-enumeration-constant
  3401. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_MESH** = ``1``
  3402. Pipeline compilation that was triggered by loading a mesh.
  3403. .. _class_RenderingServer_constant_PIPELINE_SOURCE_SURFACE:
  3404. .. rst-class:: classref-enumeration-constant
  3405. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_SURFACE** = ``2``
  3406. Pipeline compilation that was triggered by building the surface cache before rendering the scene.
  3407. .. _class_RenderingServer_constant_PIPELINE_SOURCE_DRAW:
  3408. .. rst-class:: classref-enumeration-constant
  3409. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_DRAW** = ``3``
  3410. Pipeline compilation that was triggered while drawing the scene.
  3411. .. _class_RenderingServer_constant_PIPELINE_SOURCE_SPECIALIZATION:
  3412. .. rst-class:: classref-enumeration-constant
  3413. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_SPECIALIZATION** = ``4``
  3414. Pipeline compilation that was triggered to optimize the current scene.
  3415. .. _class_RenderingServer_constant_PIPELINE_SOURCE_MAX:
  3416. .. rst-class:: classref-enumeration-constant
  3417. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_MAX** = ``5``
  3418. Represents the size of the :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` enum.
  3419. .. rst-class:: classref-item-separator
  3420. ----
  3421. .. _enum_RenderingServer_Features:
  3422. .. rst-class:: classref-enumeration
  3423. enum **Features**: :ref:`🔗<enum_RenderingServer_Features>`
  3424. .. _class_RenderingServer_constant_FEATURE_SHADERS:
  3425. .. rst-class:: classref-enumeration-constant
  3426. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
  3427. **Deprecated:** This constant has not been used since Godot 3.0.
  3428. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
  3429. .. rst-class:: classref-enumeration-constant
  3430. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
  3431. **Deprecated:** This constant has not been used since Godot 3.0.
  3432. .. rst-class:: classref-section-separator
  3433. ----
  3434. .. rst-class:: classref-descriptions-group
  3435. Constants
  3436. ---------
  3437. .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
  3438. .. rst-class:: classref-constant
  3439. **NO_INDEX_ARRAY** = ``-1`` :ref:`🔗<class_RenderingServer_constant_NO_INDEX_ARRAY>`
  3440. Marks an error that shows that the index array is empty.
  3441. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
  3442. .. rst-class:: classref-constant
  3443. **ARRAY_WEIGHTS_SIZE** = ``4`` :ref:`🔗<class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE>`
  3444. Number of weights/bones per vertex.
  3445. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
  3446. .. rst-class:: classref-constant
  3447. **CANVAS_ITEM_Z_MIN** = ``-4096`` :ref:`🔗<class_RenderingServer_constant_CANVAS_ITEM_Z_MIN>`
  3448. The minimum Z-layer for canvas items.
  3449. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
  3450. .. rst-class:: classref-constant
  3451. **CANVAS_ITEM_Z_MAX** = ``4096`` :ref:`🔗<class_RenderingServer_constant_CANVAS_ITEM_Z_MAX>`
  3452. The maximum Z-layer for canvas items.
  3453. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
  3454. .. rst-class:: classref-constant
  3455. **MAX_GLOW_LEVELS** = ``7`` :ref:`🔗<class_RenderingServer_constant_MAX_GLOW_LEVELS>`
  3456. The maximum number of glow levels that can be used with the glow post-processing effect.
  3457. .. _class_RenderingServer_constant_MAX_CURSORS:
  3458. .. rst-class:: classref-constant
  3459. **MAX_CURSORS** = ``8`` :ref:`🔗<class_RenderingServer_constant_MAX_CURSORS>`
  3460. **Deprecated:** This constant is not used by the engine.
  3461. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
  3462. .. rst-class:: classref-constant
  3463. **MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` :ref:`🔗<class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS>`
  3464. The maximum number of directional lights that can be rendered at a given time in 2D.
  3465. .. _class_RenderingServer_constant_MAX_MESH_SURFACES:
  3466. .. rst-class:: classref-constant
  3467. **MAX_MESH_SURFACES** = ``256`` :ref:`🔗<class_RenderingServer_constant_MAX_MESH_SURFACES>`
  3468. The maximum number of surfaces a mesh can have.
  3469. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
  3470. .. rst-class:: classref-constant
  3471. **MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` :ref:`🔗<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN>`
  3472. The minimum renderpriority of all materials.
  3473. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
  3474. .. rst-class:: classref-constant
  3475. **MATERIAL_RENDER_PRIORITY_MAX** = ``127`` :ref:`🔗<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX>`
  3476. The maximum renderpriority of all materials.
  3477. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
  3478. .. rst-class:: classref-constant
  3479. **ARRAY_CUSTOM_COUNT** = ``4`` :ref:`🔗<class_RenderingServer_constant_ARRAY_CUSTOM_COUNT>`
  3480. The number of custom data arrays available (:ref:`ARRAY_CUSTOM0<class_RenderingServer_constant_ARRAY_CUSTOM0>`, :ref:`ARRAY_CUSTOM1<class_RenderingServer_constant_ARRAY_CUSTOM1>`, :ref:`ARRAY_CUSTOM2<class_RenderingServer_constant_ARRAY_CUSTOM2>`, :ref:`ARRAY_CUSTOM3<class_RenderingServer_constant_ARRAY_CUSTOM3>`).
  3481. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
  3482. .. rst-class:: classref-constant
  3483. **PARTICLES_EMIT_FLAG_POSITION** = ``1`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION>`
  3484. .. container:: contribute
  3485. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3486. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
  3487. .. rst-class:: classref-constant
  3488. **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE>`
  3489. .. container:: contribute
  3490. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3491. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
  3492. .. rst-class:: classref-constant
  3493. **PARTICLES_EMIT_FLAG_VELOCITY** = ``4`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY>`
  3494. .. container:: contribute
  3495. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3496. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
  3497. .. rst-class:: classref-constant
  3498. **PARTICLES_EMIT_FLAG_COLOR** = ``8`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR>`
  3499. .. container:: contribute
  3500. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3501. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
  3502. .. rst-class:: classref-constant
  3503. **PARTICLES_EMIT_FLAG_CUSTOM** = ``16`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM>`
  3504. .. container:: contribute
  3505. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3506. .. rst-class:: classref-section-separator
  3507. ----
  3508. .. rst-class:: classref-descriptions-group
  3509. Property Descriptions
  3510. ---------------------
  3511. .. _class_RenderingServer_property_render_loop_enabled:
  3512. .. rst-class:: classref-property
  3513. :ref:`bool<class_bool>` **render_loop_enabled** :ref:`🔗<class_RenderingServer_property_render_loop_enabled>`
  3514. .. rst-class:: classref-property-setget
  3515. - |void| **set_render_loop_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  3516. - :ref:`bool<class_bool>` **is_render_loop_enabled**\ (\ )
  3517. If ``false``, disables rendering completely, but the engine logic is still being processed. You can call :ref:`force_draw<class_RenderingServer_method_force_draw>` to draw a frame even with rendering disabled.
  3518. .. rst-class:: classref-section-separator
  3519. ----
  3520. .. rst-class:: classref-descriptions-group
  3521. Method Descriptions
  3522. -------------------
  3523. .. _class_RenderingServer_method_bake_render_uv2:
  3524. .. rst-class:: classref-method
  3525. :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] **bake_render_uv2**\ (\ base\: :ref:`RID<class_RID>`, material_overrides\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], image_size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_bake_render_uv2>`
  3526. Bakes the material data of the Mesh passed in the ``base`` parameter with optional ``material_overrides`` to a set of :ref:`Image<class_Image>`\ s of size ``image_size``. Returns an array of :ref:`Image<class_Image>`\ s containing material properties as specified in :ref:`BakeChannels<enum_RenderingServer_BakeChannels>`.
  3527. .. rst-class:: classref-item-separator
  3528. ----
  3529. .. _class_RenderingServer_method_call_on_render_thread:
  3530. .. rst-class:: classref-method
  3531. |void| **call_on_render_thread**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_call_on_render_thread>`
  3532. As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as :ref:`RenderingDevice<class_RenderingDevice>` and similar RD classes), push a callable via this function so it will be executed on the render thread.
  3533. .. rst-class:: classref-item-separator
  3534. ----
  3535. .. _class_RenderingServer_method_camera_attributes_create:
  3536. .. rst-class:: classref-method
  3537. :ref:`RID<class_RID>` **camera_attributes_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_create>`
  3538. Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_attributes_`` RenderingServer functions.
  3539. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3540. \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
  3541. .. rst-class:: classref-item-separator
  3542. ----
  3543. .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
  3544. .. rst-class:: classref-method
  3545. |void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, min_sensitivity\: :ref:`float<class_float>`, max_sensitivity\: :ref:`float<class_float>`, speed\: :ref:`float<class_float>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_auto_exposure>`
  3546. Sets the parameters to use with the auto-exposure effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributes<class_CameraAttributes>` and :ref:`CameraAttributesPractical<class_CameraAttributesPractical>`.
  3547. .. rst-class:: classref-item-separator
  3548. ----
  3549. .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
  3550. .. rst-class:: classref-method
  3551. |void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID<class_RID>`, far_enable\: :ref:`bool<class_bool>`, far_distance\: :ref:`float<class_float>`, far_transition\: :ref:`float<class_float>`, near_enable\: :ref:`bool<class_bool>`, near_distance\: :ref:`float<class_float>`, near_transition\: :ref:`float<class_float>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur>`
  3552. Sets the parameters to use with the DOF blur effect. These parameters take on the same meaning as their counterparts in :ref:`CameraAttributesPractical<class_CameraAttributesPractical>`.
  3553. .. rst-class:: classref-item-separator
  3554. ----
  3555. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
  3556. .. rst-class:: classref-method
  3557. |void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>`
  3558. Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`.
  3559. .. rst-class:: classref-item-separator
  3560. ----
  3561. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
  3562. .. rst-class:: classref-method
  3563. |void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`, use_jitter\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>`
  3564. Sets the quality level of the DOF blur effect to one of the options in :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
  3565. .. rst-class:: classref-item-separator
  3566. ----
  3567. .. _class_RenderingServer_method_camera_attributes_set_exposure:
  3568. .. rst-class:: classref-method
  3569. |void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, normalization\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_exposure>`
  3570. Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene.
  3571. The normalization factor can be calculated from exposure value (EV100) as follows:
  3572. ::
  3573. func get_exposure_normalization(ev100: float):
  3574. return 1.0 / (pow(2.0, ev100) * 1.2)
  3575. The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
  3576. ::
  3577. func get_exposure(aperture: float, shutter_speed: float, sensitivity: float):
  3578. return log((aperture * aperture) / shutter_speed * (100.0 / sensitivity)) / log(2)
  3579. .. rst-class:: classref-item-separator
  3580. ----
  3581. .. _class_RenderingServer_method_camera_create:
  3582. .. rst-class:: classref-method
  3583. :ref:`RID<class_RID>` **camera_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_camera_create>`
  3584. Creates a 3D camera and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_*`` RenderingServer functions.
  3585. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3586. \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
  3587. .. rst-class:: classref-item-separator
  3588. ----
  3589. .. _class_RenderingServer_method_camera_set_camera_attributes:
  3590. .. rst-class:: classref-method
  3591. |void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_camera_attributes>`
  3592. Sets the camera_attributes created with :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` to the given camera.
  3593. .. rst-class:: classref-item-separator
  3594. ----
  3595. .. _class_RenderingServer_method_camera_set_compositor:
  3596. .. rst-class:: classref-method
  3597. |void| **camera_set_compositor**\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_compositor>`
  3598. Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor<class_Camera3D_property_compositor>`.
  3599. .. rst-class:: classref-item-separator
  3600. ----
  3601. .. _class_RenderingServer_method_camera_set_cull_mask:
  3602. .. rst-class:: classref-method
  3603. |void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_cull_mask>`
  3604. Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to :ref:`Camera3D.cull_mask<class_Camera3D_property_cull_mask>`.
  3605. .. rst-class:: classref-item-separator
  3606. ----
  3607. .. _class_RenderingServer_method_camera_set_environment:
  3608. .. rst-class:: classref-method
  3609. |void| **camera_set_environment**\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_environment>`
  3610. Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
  3611. .. rst-class:: classref-item-separator
  3612. ----
  3613. .. _class_RenderingServer_method_camera_set_frustum:
  3614. .. rst-class:: classref-method
  3615. |void| **camera_set_frustum**\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, offset\: :ref:`Vector2<class_Vector2>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_frustum>`
  3616. Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
  3617. .. rst-class:: classref-item-separator
  3618. ----
  3619. .. _class_RenderingServer_method_camera_set_orthogonal:
  3620. .. rst-class:: classref-method
  3621. |void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_orthogonal>`
  3622. Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are.
  3623. .. rst-class:: classref-item-separator
  3624. ----
  3625. .. _class_RenderingServer_method_camera_set_perspective:
  3626. .. rst-class:: classref-method
  3627. |void| **camera_set_perspective**\ (\ camera\: :ref:`RID<class_RID>`, fovy_degrees\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_perspective>`
  3628. Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
  3629. .. rst-class:: classref-item-separator
  3630. ----
  3631. .. _class_RenderingServer_method_camera_set_transform:
  3632. .. rst-class:: classref-method
  3633. |void| **camera_set_transform**\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_transform>`
  3634. Sets :ref:`Transform3D<class_Transform3D>` of camera.
  3635. .. rst-class:: classref-item-separator
  3636. ----
  3637. .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
  3638. .. rst-class:: classref-method
  3639. |void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_use_vertical_aspect>`
  3640. If ``true``, preserves the horizontal aspect ratio which is equivalent to :ref:`Camera3D.KEEP_WIDTH<class_Camera3D_constant_KEEP_WIDTH>`. If ``false``, preserves the vertical aspect ratio which is equivalent to :ref:`Camera3D.KEEP_HEIGHT<class_Camera3D_constant_KEEP_HEIGHT>`.
  3641. .. rst-class:: classref-item-separator
  3642. ----
  3643. .. _class_RenderingServer_method_canvas_create:
  3644. .. rst-class:: classref-method
  3645. :ref:`RID<class_RID>` **canvas_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_create>`
  3646. Creates a canvas and returns the assigned :ref:`RID<class_RID>`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_*`` RenderingServer functions.
  3647. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3648. Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
  3649. .. rst-class:: classref-item-separator
  3650. ----
  3651. .. _class_RenderingServer_method_canvas_item_add_animation_slice:
  3652. .. rst-class:: classref-method
  3653. |void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID<class_RID>`, animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_animation_slice>`
  3654. Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
  3655. .. rst-class:: classref-item-separator
  3656. ----
  3657. .. _class_RenderingServer_method_canvas_item_add_circle:
  3658. .. rst-class:: classref-method
  3659. |void| **canvas_item_add_circle**\ (\ item\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_circle>`
  3660. Draws a circle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_circle<class_CanvasItem_method_draw_circle>`.
  3661. .. rst-class:: classref-item-separator
  3662. ----
  3663. .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
  3664. .. rst-class:: classref-method
  3665. |void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID<class_RID>`, ignore\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_clip_ignore>`
  3666. If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to ``false``.
  3667. .. rst-class:: classref-item-separator
  3668. ----
  3669. .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
  3670. .. rst-class:: classref-method
  3671. |void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>`
  3672. See also :ref:`CanvasItem.draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
  3673. .. rst-class:: classref-item-separator
  3674. ----
  3675. .. _class_RenderingServer_method_canvas_item_add_line:
  3676. .. rst-class:: classref-method
  3677. |void| **canvas_item_add_line**\ (\ item\: :ref:`RID<class_RID>`, from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_line>`
  3678. Draws a line on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_line<class_CanvasItem_method_draw_line>`.
  3679. .. rst-class:: classref-item-separator
  3680. ----
  3681. .. _class_RenderingServer_method_canvas_item_add_mesh:
  3682. .. rst-class:: classref-method
  3683. |void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_mesh>`
  3684. Draws a mesh created with :ref:`mesh_create<class_RenderingServer_method_mesh_create>` with given ``transform``, ``modulate`` color, and ``texture``. This is used internally by :ref:`MeshInstance2D<class_MeshInstance2D>`.
  3685. .. rst-class:: classref-item-separator
  3686. ----
  3687. .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
  3688. .. rst-class:: classref-method
  3689. |void| **canvas_item_add_msdf_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline_size\: :ref:`int<class_int>` = 0, px_range\: :ref:`float<class_float>` = 1.0, scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>`
  3690. See also :ref:`CanvasItem.draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
  3691. .. rst-class:: classref-item-separator
  3692. ----
  3693. .. _class_RenderingServer_method_canvas_item_add_multiline:
  3694. .. rst-class:: classref-method
  3695. |void| **canvas_item_add_multiline**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_multiline>`
  3696. Draws a 2D multiline on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_multiline<class_CanvasItem_method_draw_multiline>` and :ref:`CanvasItem.draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>`.
  3697. .. rst-class:: classref-item-separator
  3698. ----
  3699. .. _class_RenderingServer_method_canvas_item_add_multimesh:
  3700. .. rst-class:: classref-method
  3701. |void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_multimesh>`
  3702. Draws a 2D :ref:`MultiMesh<class_MultiMesh>` on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_multimesh<class_CanvasItem_method_draw_multimesh>`.
  3703. .. rst-class:: classref-item-separator
  3704. ----
  3705. .. _class_RenderingServer_method_canvas_item_add_nine_patch:
  3706. .. rst-class:: classref-method
  3707. |void| **canvas_item_add_nine_patch**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, source\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, topleft\: :ref:`Vector2<class_Vector2>`, bottomright\: :ref:`Vector2<class_Vector2>`, x_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, y_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, draw_center\: :ref:`bool<class_bool>` = true, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_nine_patch>`
  3708. Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3709. .. rst-class:: classref-item-separator
  3710. ----
  3711. .. _class_RenderingServer_method_canvas_item_add_particles:
  3712. .. rst-class:: classref-method
  3713. |void| **canvas_item_add_particles**\ (\ item\: :ref:`RID<class_RID>`, particles\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_particles>`
  3714. Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3715. .. rst-class:: classref-item-separator
  3716. ----
  3717. .. _class_RenderingServer_method_canvas_item_add_polygon:
  3718. .. rst-class:: classref-method
  3719. |void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_polygon>`
  3720. Draws a 2D polygon on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. If you need more flexibility (such as being able to use bones), use :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` instead. See also :ref:`CanvasItem.draw_polygon<class_CanvasItem_method_draw_polygon>`.
  3721. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon<class_Geometry2D_method_triangulate_polygon>` and using :ref:`CanvasItem.draw_mesh<class_CanvasItem_method_draw_mesh>`, :ref:`CanvasItem.draw_multimesh<class_CanvasItem_method_draw_multimesh>`, or :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`.
  3722. .. rst-class:: classref-item-separator
  3723. ----
  3724. .. _class_RenderingServer_method_canvas_item_add_polyline:
  3725. .. rst-class:: classref-method
  3726. |void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_polyline>`
  3727. Draws a 2D polyline on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_polyline<class_CanvasItem_method_draw_polyline>` and :ref:`CanvasItem.draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>`.
  3728. .. rst-class:: classref-item-separator
  3729. ----
  3730. .. _class_RenderingServer_method_canvas_item_add_primitive:
  3731. .. rst-class:: classref-method
  3732. |void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_primitive>`
  3733. Draws a 2D primitive on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_primitive<class_CanvasItem_method_draw_primitive>`.
  3734. .. rst-class:: classref-item-separator
  3735. ----
  3736. .. _class_RenderingServer_method_canvas_item_add_rect:
  3737. .. rst-class:: classref-method
  3738. |void| **canvas_item_add_rect**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_rect>`
  3739. Draws a rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_rect<class_CanvasItem_method_draw_rect>`.
  3740. .. rst-class:: classref-item-separator
  3741. ----
  3742. .. _class_RenderingServer_method_canvas_item_add_set_transform:
  3743. .. rst-class:: classref-method
  3744. |void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_set_transform>`
  3745. Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
  3746. .. rst-class:: classref-item-separator
  3747. ----
  3748. .. _class_RenderingServer_method_canvas_item_add_texture_rect:
  3749. .. rst-class:: classref-method
  3750. |void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, tile\: :ref:`bool<class_bool>` = false, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_texture_rect>`
  3751. Draws a 2D textured rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_texture_rect<class_CanvasItem_method_draw_texture_rect>` and :ref:`Texture2D.draw_rect<class_Texture2D_method_draw_rect>`.
  3752. .. rst-class:: classref-item-separator
  3753. ----
  3754. .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
  3755. .. rst-class:: classref-method
  3756. |void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_texture_rect_region>`
  3757. Draws the specified region of a 2D textured rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. See also :ref:`CanvasItem.draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>` and :ref:`Texture2D.draw_rect_region<class_Texture2D_method_draw_rect_region>`.
  3758. .. rst-class:: classref-item-separator
  3759. ----
  3760. .. _class_RenderingServer_method_canvas_item_add_triangle_array:
  3761. .. rst-class:: classref-method
  3762. |void| **canvas_item_add_triangle_array**\ (\ item\: :ref:`RID<class_RID>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), bones\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array<class_PackedFloat32Array>` = PackedFloat32Array(), texture\: :ref:`RID<class_RID>` = RID(), count\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_triangle_array>`
  3763. Draws a triangle array on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`. This is internally used by :ref:`Line2D<class_Line2D>` and :ref:`StyleBoxFlat<class_StyleBoxFlat>` for rendering. :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` is highly flexible, but more complex to use than :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>`.
  3764. \ **Note:** ``count`` is unused and can be left unspecified.
  3765. .. rst-class:: classref-item-separator
  3766. ----
  3767. .. _class_RenderingServer_method_canvas_item_attach_skeleton:
  3768. .. rst-class:: classref-method
  3769. |void| **canvas_item_attach_skeleton**\ (\ item\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_attach_skeleton>`
  3770. Attaches a skeleton to the :ref:`CanvasItem<class_CanvasItem>`. Removes the previous skeleton.
  3771. .. rst-class:: classref-item-separator
  3772. ----
  3773. .. _class_RenderingServer_method_canvas_item_clear:
  3774. .. rst-class:: classref-method
  3775. |void| **canvas_item_clear**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_clear>`
  3776. Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
  3777. .. rst-class:: classref-item-separator
  3778. ----
  3779. .. _class_RenderingServer_method_canvas_item_create:
  3780. .. rst-class:: classref-method
  3781. :ref:`RID<class_RID>` **canvas_item_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_create>`
  3782. Creates a new CanvasItem instance and returns its :ref:`RID<class_RID>`. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_item_*`` RenderingServer functions.
  3783. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3784. \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
  3785. .. rst-class:: classref-item-separator
  3786. ----
  3787. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter:
  3788. .. rst-class:: classref-method
  3789. :ref:`Variant<class_Variant>` **canvas_item_get_instance_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_canvas_item_get_instance_shader_parameter>`
  3790. Returns the value of the per-instance shader uniform from the specified canvas item instance. Equivalent to :ref:`CanvasItem.get_instance_shader_parameter<class_CanvasItem_method_get_instance_shader_parameter>`.
  3791. .. rst-class:: classref-item-separator
  3792. ----
  3793. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value:
  3794. .. rst-class:: classref-method
  3795. :ref:`Variant<class_Variant>` **canvas_item_get_instance_shader_parameter_default_value**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value>`
  3796. Returns the default value of the per-instance shader uniform from the specified canvas item instance. Equivalent to :ref:`CanvasItem.get_instance_shader_parameter<class_CanvasItem_method_get_instance_shader_parameter>`.
  3797. .. rst-class:: classref-item-separator
  3798. ----
  3799. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list:
  3800. .. rst-class:: classref-method
  3801. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **canvas_item_get_instance_shader_parameter_list**\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list>`
  3802. Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified canvas item instance.
  3803. The returned dictionary is in PropertyInfo format, with the keys ``name``, ``class_name``, ``type``, ``hint``, ``hint_string``, and ``usage``.
  3804. .. rst-class:: classref-item-separator
  3805. ----
  3806. .. _class_RenderingServer_method_canvas_item_reset_physics_interpolation:
  3807. .. rst-class:: classref-method
  3808. |void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`
  3809. Prevents physics interpolation for the current physics tick.
  3810. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  3811. .. rst-class:: classref-item-separator
  3812. ----
  3813. .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
  3814. .. rst-class:: classref-method
  3815. |void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>`, clear_margin\: :ref:`float<class_float>` = 5.0, fit_empty\: :ref:`bool<class_bool>` = false, fit_margin\: :ref:`float<class_float>` = 0.0, blur_mipmaps\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_canvas_group_mode>`
  3816. Sets the canvas group mode used during 2D rendering for the canvas item specified by the ``item`` RID. For faster but more limited clipping, use :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>` instead.
  3817. \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
  3818. .. rst-class:: classref-item-separator
  3819. ----
  3820. .. _class_RenderingServer_method_canvas_item_set_clip:
  3821. .. rst-class:: classref-method
  3822. |void| **canvas_item_set_clip**\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_clip>`
  3823. If ``clip`` is ``true``, makes the canvas item specified by the ``item`` RID not draw anything outside of its rect's coordinates. This clipping is fast, but works only with axis-aligned rectangles. This means that rotation is ignored by the clipping rectangle. For more advanced clipping shapes, use :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>` instead.
  3824. \ **Note:** The equivalent node functionality is found in :ref:`Label.clip_text<class_Label_property_clip_text>`, :ref:`RichTextLabel<class_RichTextLabel>` (always enabled) and more.
  3825. .. rst-class:: classref-item-separator
  3826. ----
  3827. .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
  3828. .. rst-class:: classref-method
  3829. |void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>`
  3830. Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
  3831. .. rst-class:: classref-item-separator
  3832. ----
  3833. .. _class_RenderingServer_method_canvas_item_set_custom_rect:
  3834. .. rst-class:: classref-method
  3835. |void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID<class_RID>`, use_custom_rect\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_custom_rect>`
  3836. If ``use_custom_rect`` is ``true``, sets the custom visibility rectangle (used for culling) to ``rect`` for the canvas item specified by ``item``. Setting a custom visibility rect can reduce CPU load when drawing lots of 2D instances. If ``use_custom_rect`` is ``false``, automatically computes a visibility rectangle based on the canvas item's draw commands.
  3837. .. rst-class:: classref-item-separator
  3838. ----
  3839. .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
  3840. .. rst-class:: classref-method
  3841. |void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_default_texture_filter>`
  3842. Sets the default texture filter mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_filter<class_CanvasItem_property_texture_filter>`.
  3843. .. rst-class:: classref-item-separator
  3844. ----
  3845. .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
  3846. .. rst-class:: classref-method
  3847. |void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_default_texture_repeat>`
  3848. Sets the default texture repeat mode for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.texture_repeat<class_CanvasItem_property_texture_repeat>`.
  3849. .. rst-class:: classref-item-separator
  3850. ----
  3851. .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
  3852. .. rst-class:: classref-method
  3853. |void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_distance_field_mode>`
  3854. If ``enabled`` is ``true``, enables multichannel signed distance field rendering mode for the canvas item specified by the ``item`` RID. This is meant to be used for font rendering, or with specially generated images using `msdfgen <https://github.com/Chlumsky/msdfgen>`__.
  3855. .. rst-class:: classref-item-separator
  3856. ----
  3857. .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
  3858. .. rst-class:: classref-method
  3859. |void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_draw_behind_parent>`
  3860. If ``enabled`` is ``true``, draws the canvas item specified by the ``item`` RID behind its parent. Equivalent to :ref:`CanvasItem.show_behind_parent<class_CanvasItem_property_show_behind_parent>`.
  3861. .. rst-class:: classref-item-separator
  3862. ----
  3863. .. _class_RenderingServer_method_canvas_item_set_draw_index:
  3864. .. rst-class:: classref-method
  3865. |void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_draw_index>`
  3866. Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
  3867. .. rst-class:: classref-item-separator
  3868. ----
  3869. .. _class_RenderingServer_method_canvas_item_set_instance_shader_parameter:
  3870. .. rst-class:: classref-method
  3871. |void| **canvas_item_set_instance_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_instance_shader_parameter>`
  3872. Sets the per-instance shader uniform on the specified canvas item instance. Equivalent to :ref:`CanvasItem.set_instance_shader_parameter<class_CanvasItem_method_set_instance_shader_parameter>`.
  3873. .. rst-class:: classref-item-separator
  3874. ----
  3875. .. _class_RenderingServer_method_canvas_item_set_interpolated:
  3876. .. rst-class:: classref-method
  3877. |void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_interpolated>`
  3878. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas item.
  3879. .. rst-class:: classref-item-separator
  3880. ----
  3881. .. _class_RenderingServer_method_canvas_item_set_light_mask:
  3882. .. rst-class:: classref-method
  3883. |void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_light_mask>`
  3884. Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
  3885. .. rst-class:: classref-item-separator
  3886. ----
  3887. .. _class_RenderingServer_method_canvas_item_set_material:
  3888. .. rst-class:: classref-method
  3889. |void| **canvas_item_set_material**\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_material>`
  3890. Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
  3891. .. rst-class:: classref-item-separator
  3892. ----
  3893. .. _class_RenderingServer_method_canvas_item_set_modulate:
  3894. .. rst-class:: classref-method
  3895. |void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_modulate>`
  3896. Multiplies the color of the canvas item specified by the ``item`` RID, while affecting its children. See also :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>`. Equivalent to :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`.
  3897. .. rst-class:: classref-item-separator
  3898. ----
  3899. .. _class_RenderingServer_method_canvas_item_set_parent:
  3900. .. rst-class:: classref-method
  3901. |void| **canvas_item_set_parent**\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_parent>`
  3902. Sets a parent :ref:`CanvasItem<class_CanvasItem>` to the :ref:`CanvasItem<class_CanvasItem>`. The item will inherit transform, modulation and visibility from its parent, like :ref:`CanvasItem<class_CanvasItem>` nodes in the scene tree.
  3903. .. rst-class:: classref-item-separator
  3904. ----
  3905. .. _class_RenderingServer_method_canvas_item_set_self_modulate:
  3906. .. rst-class:: classref-method
  3907. |void| **canvas_item_set_self_modulate**\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_self_modulate>`
  3908. Multiplies the color of the canvas item specified by the ``item`` RID, without affecting its children. See also :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>`. Equivalent to :ref:`CanvasItem.self_modulate<class_CanvasItem_property_self_modulate>`.
  3909. .. rst-class:: classref-item-separator
  3910. ----
  3911. .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
  3912. .. rst-class:: classref-method
  3913. |void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_sort_children_by_y>`
  3914. If ``enabled`` is ``true``, child nodes with the lowest Y position are drawn before those with a higher Y position. Y-sorting only affects children that inherit from the canvas item specified by the ``item`` RID, not the canvas item itself. Equivalent to :ref:`CanvasItem.y_sort_enabled<class_CanvasItem_property_y_sort_enabled>`.
  3915. .. rst-class:: classref-item-separator
  3916. ----
  3917. .. _class_RenderingServer_method_canvas_item_set_transform:
  3918. .. rst-class:: classref-method
  3919. |void| **canvas_item_set_transform**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_transform>`
  3920. Sets the ``transform`` of the canvas item specified by the ``item`` RID. This affects where and how the item will be drawn. Child canvas items' transforms are multiplied by their parent's transform. Equivalent to :ref:`Node2D.transform<class_Node2D_property_transform>`.
  3921. .. rst-class:: classref-item-separator
  3922. ----
  3923. .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
  3924. .. rst-class:: classref-method
  3925. |void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_use_parent_material>`
  3926. Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
  3927. .. rst-class:: classref-item-separator
  3928. ----
  3929. .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
  3930. .. rst-class:: classref-method
  3931. |void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID<class_RID>`, visibility_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visibility_layer>`
  3932. Sets the rendering visibility layer associated with this :ref:`CanvasItem<class_CanvasItem>`. Only :ref:`Viewport<class_Viewport>` nodes with a matching rendering mask will render this :ref:`CanvasItem<class_CanvasItem>`.
  3933. .. rst-class:: classref-item-separator
  3934. ----
  3935. .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
  3936. .. rst-class:: classref-method
  3937. |void| **canvas_item_set_visibility_notifier**\ (\ item\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, area\: :ref:`Rect2<class_Rect2>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visibility_notifier>`
  3938. Sets the given :ref:`CanvasItem<class_CanvasItem>` as visibility notifier. ``area`` defines the area of detecting visibility. ``enter_callable`` is called when the :ref:`CanvasItem<class_CanvasItem>` enters the screen, ``exit_callable`` is called when the :ref:`CanvasItem<class_CanvasItem>` exits the screen. If ``enable`` is ``false``, the item will no longer function as notifier.
  3939. This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
  3940. .. rst-class:: classref-item-separator
  3941. ----
  3942. .. _class_RenderingServer_method_canvas_item_set_visible:
  3943. .. rst-class:: classref-method
  3944. |void| **canvas_item_set_visible**\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visible>`
  3945. Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
  3946. .. rst-class:: classref-item-separator
  3947. ----
  3948. .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
  3949. .. rst-class:: classref-method
  3950. |void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>`
  3951. If this is enabled, the Z index of the parent will be added to the children's Z index.
  3952. .. rst-class:: classref-item-separator
  3953. ----
  3954. .. _class_RenderingServer_method_canvas_item_set_z_index:
  3955. .. rst-class:: classref-method
  3956. |void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID<class_RID>`, z_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_z_index>`
  3957. Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
  3958. .. rst-class:: classref-item-separator
  3959. ----
  3960. .. _class_RenderingServer_method_canvas_item_transform_physics_interpolation:
  3961. .. rst-class:: classref-method
  3962. |void| **canvas_item_transform_physics_interpolation**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_transform_physics_interpolation>`
  3963. Transforms both the current and previous stored transform for a canvas item.
  3964. This allows transforming a canvas item without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  3965. .. rst-class:: classref-item-separator
  3966. ----
  3967. .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
  3968. .. rst-class:: classref-method
  3969. |void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_attach_to_canvas>`
  3970. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  3971. .. rst-class:: classref-item-separator
  3972. ----
  3973. .. _class_RenderingServer_method_canvas_light_create:
  3974. .. rst-class:: classref-method
  3975. :ref:`RID<class_RID>` **canvas_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_create>`
  3976. Creates a canvas light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_*`` RenderingServer functions.
  3977. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3978. \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
  3979. .. rst-class:: classref-item-separator
  3980. ----
  3981. .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
  3982. .. rst-class:: classref-method
  3983. |void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>`
  3984. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  3985. .. rst-class:: classref-item-separator
  3986. ----
  3987. .. _class_RenderingServer_method_canvas_light_occluder_create:
  3988. .. rst-class:: classref-method
  3989. :ref:`RID<class_RID>` **canvas_light_occluder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_create>`
  3990. Creates a light occluder and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_light_occluder_*`` RenderingServer functions.
  3991. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  3992. \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
  3993. .. rst-class:: classref-item-separator
  3994. ----
  3995. .. _class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation:
  3996. .. rst-class:: classref-method
  3997. |void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`
  3998. Prevents physics interpolation for the current physics tick.
  3999. This is useful when moving an occluder to a new location, to give an instantaneous change rather than interpolation from the previous location.
  4000. .. rst-class:: classref-item-separator
  4001. ----
  4002. .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
  4003. .. rst-class:: classref-method
  4004. |void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>`
  4005. .. container:: contribute
  4006. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4007. .. rst-class:: classref-item-separator
  4008. ----
  4009. .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
  4010. .. rst-class:: classref-method
  4011. |void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_enabled>`
  4012. Enables or disables light occluder.
  4013. .. rst-class:: classref-item-separator
  4014. ----
  4015. .. _class_RenderingServer_method_canvas_light_occluder_set_interpolated:
  4016. .. rst-class:: classref-method
  4017. |void| **canvas_light_occluder_set_interpolated**\ (\ occluder\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_interpolated>`
  4018. If ``interpolated`` is ``true``, turns on physics interpolation for the light occluder.
  4019. .. rst-class:: classref-item-separator
  4020. ----
  4021. .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
  4022. .. rst-class:: classref-method
  4023. |void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_light_mask>`
  4024. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  4025. .. rst-class:: classref-item-separator
  4026. ----
  4027. .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
  4028. .. rst-class:: classref-method
  4029. |void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID<class_RID>`, polygon\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_polygon>`
  4030. Sets a light occluder's polygon.
  4031. .. rst-class:: classref-item-separator
  4032. ----
  4033. .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
  4034. .. rst-class:: classref-method
  4035. |void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_transform>`
  4036. Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
  4037. .. rst-class:: classref-item-separator
  4038. ----
  4039. .. _class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation:
  4040. .. rst-class:: classref-method
  4041. |void| **canvas_light_occluder_transform_physics_interpolation**\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation>`
  4042. Transforms both the current and previous stored transform for a light occluder.
  4043. This allows transforming an occluder without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  4044. .. rst-class:: classref-item-separator
  4045. ----
  4046. .. _class_RenderingServer_method_canvas_light_reset_physics_interpolation:
  4047. .. rst-class:: classref-method
  4048. |void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`
  4049. Prevents physics interpolation for the current physics tick.
  4050. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  4051. .. rst-class:: classref-item-separator
  4052. ----
  4053. .. _class_RenderingServer_method_canvas_light_set_blend_mode:
  4054. .. rst-class:: classref-method
  4055. |void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_blend_mode>`
  4056. Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` for options. Equivalent to :ref:`Light2D.blend_mode<class_Light2D_property_blend_mode>`.
  4057. .. rst-class:: classref-item-separator
  4058. ----
  4059. .. _class_RenderingServer_method_canvas_light_set_color:
  4060. .. rst-class:: classref-method
  4061. |void| **canvas_light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_color>`
  4062. Sets the color for a light.
  4063. .. rst-class:: classref-item-separator
  4064. ----
  4065. .. _class_RenderingServer_method_canvas_light_set_enabled:
  4066. .. rst-class:: classref-method
  4067. |void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_enabled>`
  4068. Enables or disables a canvas light.
  4069. .. rst-class:: classref-item-separator
  4070. ----
  4071. .. _class_RenderingServer_method_canvas_light_set_energy:
  4072. .. rst-class:: classref-method
  4073. |void| **canvas_light_set_energy**\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_energy>`
  4074. Sets a canvas light's energy.
  4075. .. rst-class:: classref-item-separator
  4076. ----
  4077. .. _class_RenderingServer_method_canvas_light_set_height:
  4078. .. rst-class:: classref-method
  4079. |void| **canvas_light_set_height**\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_height>`
  4080. Sets a canvas light's height.
  4081. .. rst-class:: classref-item-separator
  4082. ----
  4083. .. _class_RenderingServer_method_canvas_light_set_interpolated:
  4084. .. rst-class:: classref-method
  4085. |void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_interpolated>`
  4086. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas light.
  4087. .. rst-class:: classref-item-separator
  4088. ----
  4089. .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
  4090. .. rst-class:: classref-method
  4091. |void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_item_cull_mask>`
  4092. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  4093. .. rst-class:: classref-item-separator
  4094. ----
  4095. .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
  4096. .. rst-class:: classref-method
  4097. |void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>`
  4098. The binary mask used to determine which layers this canvas light's shadows affects. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  4099. .. rst-class:: classref-item-separator
  4100. ----
  4101. .. _class_RenderingServer_method_canvas_light_set_layer_range:
  4102. .. rst-class:: classref-method
  4103. |void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID<class_RID>`, min_layer\: :ref:`int<class_int>`, max_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_layer_range>`
  4104. The layer range that gets rendered with this light.
  4105. .. rst-class:: classref-item-separator
  4106. ----
  4107. .. _class_RenderingServer_method_canvas_light_set_mode:
  4108. .. rst-class:: classref-method
  4109. |void| **canvas_light_set_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_mode>`
  4110. The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
  4111. .. rst-class:: classref-item-separator
  4112. ----
  4113. .. _class_RenderingServer_method_canvas_light_set_shadow_color:
  4114. .. rst-class:: classref-method
  4115. |void| **canvas_light_set_shadow_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_color>`
  4116. Sets the color of the canvas light's shadow.
  4117. .. rst-class:: classref-item-separator
  4118. ----
  4119. .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
  4120. .. rst-class:: classref-method
  4121. |void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_enabled>`
  4122. Enables or disables the canvas light's shadow.
  4123. .. rst-class:: classref-item-separator
  4124. ----
  4125. .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
  4126. .. rst-class:: classref-method
  4127. |void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_filter>`
  4128. Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
  4129. .. rst-class:: classref-item-separator
  4130. ----
  4131. .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
  4132. .. rst-class:: classref-method
  4133. |void| **canvas_light_set_shadow_smooth**\ (\ light\: :ref:`RID<class_RID>`, smooth\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_smooth>`
  4134. Smoothens the shadow. The lower, the smoother.
  4135. .. rst-class:: classref-item-separator
  4136. ----
  4137. .. _class_RenderingServer_method_canvas_light_set_texture:
  4138. .. rst-class:: classref-method
  4139. |void| **canvas_light_set_texture**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture>`
  4140. Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
  4141. .. rst-class:: classref-item-separator
  4142. ----
  4143. .. _class_RenderingServer_method_canvas_light_set_texture_offset:
  4144. .. rst-class:: classref-method
  4145. |void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID<class_RID>`, offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture_offset>`
  4146. Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
  4147. .. rst-class:: classref-item-separator
  4148. ----
  4149. .. _class_RenderingServer_method_canvas_light_set_texture_scale:
  4150. .. rst-class:: classref-method
  4151. |void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture_scale>`
  4152. Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
  4153. .. rst-class:: classref-item-separator
  4154. ----
  4155. .. _class_RenderingServer_method_canvas_light_set_transform:
  4156. .. rst-class:: classref-method
  4157. |void| **canvas_light_set_transform**\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_transform>`
  4158. Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
  4159. .. rst-class:: classref-item-separator
  4160. ----
  4161. .. _class_RenderingServer_method_canvas_light_set_z_range:
  4162. .. rst-class:: classref-method
  4163. |void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID<class_RID>`, min_z\: :ref:`int<class_int>`, max_z\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_z_range>`
  4164. Sets the Z range of objects that will be affected by this light. Equivalent to :ref:`Light2D.range_z_min<class_Light2D_property_range_z_min>` and :ref:`Light2D.range_z_max<class_Light2D_property_range_z_max>`.
  4165. .. rst-class:: classref-item-separator
  4166. ----
  4167. .. _class_RenderingServer_method_canvas_light_transform_physics_interpolation:
  4168. .. rst-class:: classref-method
  4169. |void| **canvas_light_transform_physics_interpolation**\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_transform_physics_interpolation>`
  4170. Transforms both the current and previous stored transform for a canvas light.
  4171. This allows transforming a light without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  4172. .. rst-class:: classref-item-separator
  4173. ----
  4174. .. _class_RenderingServer_method_canvas_occluder_polygon_create:
  4175. .. rst-class:: classref-method
  4176. :ref:`RID<class_RID>` **canvas_occluder_polygon_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_create>`
  4177. Creates a new light occluder polygon and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_occluder_polygon_*`` RenderingServer functions.
  4178. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4179. \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
  4180. .. rst-class:: classref-item-separator
  4181. ----
  4182. .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
  4183. .. rst-class:: classref-method
  4184. |void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>`
  4185. Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
  4186. .. rst-class:: classref-item-separator
  4187. ----
  4188. .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
  4189. .. rst-class:: classref-method
  4190. |void| **canvas_occluder_polygon_set_shape**\ (\ occluder_polygon\: :ref:`RID<class_RID>`, shape\: :ref:`PackedVector2Array<class_PackedVector2Array>`, closed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_set_shape>`
  4191. Sets the shape of the occluder polygon.
  4192. .. rst-class:: classref-item-separator
  4193. ----
  4194. .. _class_RenderingServer_method_canvas_set_disable_scale:
  4195. .. rst-class:: classref-method
  4196. |void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_disable_scale>`
  4197. .. container:: contribute
  4198. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4199. .. rst-class:: classref-item-separator
  4200. ----
  4201. .. _class_RenderingServer_method_canvas_set_item_mirroring:
  4202. .. rst-class:: classref-method
  4203. |void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID<class_RID>`, item\: :ref:`RID<class_RID>`, mirroring\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_item_mirroring>`
  4204. A copy of the canvas item will be drawn with a local offset of the ``mirroring``.
  4205. \ **Note:** This is equivalent to calling :ref:`canvas_set_item_repeat<class_RenderingServer_method_canvas_set_item_repeat>` like ``canvas_set_item_repeat(item, mirroring, 1)``, with an additional check ensuring ``canvas`` is a parent of ``item``.
  4206. .. rst-class:: classref-item-separator
  4207. ----
  4208. .. _class_RenderingServer_method_canvas_set_item_repeat:
  4209. .. rst-class:: classref-method
  4210. |void| **canvas_set_item_repeat**\ (\ item\: :ref:`RID<class_RID>`, repeat_size\: :ref:`Vector2<class_Vector2>`, repeat_times\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_item_repeat>`
  4211. A copy of the canvas item will be drawn with a local offset of the ``repeat_size`` by the number of times of the ``repeat_times``. As the ``repeat_times`` increases, the copies will spread away from the origin texture.
  4212. .. rst-class:: classref-item-separator
  4213. ----
  4214. .. _class_RenderingServer_method_canvas_set_modulate:
  4215. .. rst-class:: classref-method
  4216. |void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_modulate>`
  4217. Modulates all colors in the given canvas.
  4218. .. rst-class:: classref-item-separator
  4219. ----
  4220. .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
  4221. .. rst-class:: classref-method
  4222. |void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_shadow_texture_size>`
  4223. Sets the :ref:`ProjectSettings.rendering/2d/shadow_atlas/size<class_ProjectSettings_property_rendering/2d/shadow_atlas/size>` to use for :ref:`Light2D<class_Light2D>` shadow rendering (in pixels). The value is rounded up to the nearest power of 2.
  4224. .. rst-class:: classref-item-separator
  4225. ----
  4226. .. _class_RenderingServer_method_canvas_texture_create:
  4227. .. rst-class:: classref-method
  4228. :ref:`RID<class_RID>` **canvas_texture_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_create>`
  4229. Creates a canvas texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``canvas_texture_*`` RenderingServer functions.
  4230. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method. See also :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>`.
  4231. \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
  4232. .. rst-class:: classref-item-separator
  4233. ----
  4234. .. _class_RenderingServer_method_canvas_texture_set_channel:
  4235. .. rst-class:: classref-method
  4236. |void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID<class_RID>`, channel\: :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_channel>`
  4237. Sets the ``channel``'s ``texture`` for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`, :ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>` and :ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`.
  4238. .. rst-class:: classref-item-separator
  4239. ----
  4240. .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
  4241. .. rst-class:: classref-method
  4242. |void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID<class_RID>`, base_color\: :ref:`Color<class_Color>`, shininess\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_shading_parameters>`
  4243. Sets the ``base_color`` and ``shininess`` to use for the canvas texture specified by the ``canvas_texture`` RID. Equivalent to :ref:`CanvasTexture.specular_color<class_CanvasTexture_property_specular_color>` and :ref:`CanvasTexture.specular_shininess<class_CanvasTexture_property_specular_shininess>`.
  4244. .. rst-class:: classref-item-separator
  4245. ----
  4246. .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
  4247. .. rst-class:: classref-method
  4248. |void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_texture_filter>`
  4249. Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4250. .. rst-class:: classref-item-separator
  4251. ----
  4252. .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
  4253. .. rst-class:: classref-method
  4254. |void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_texture_repeat>`
  4255. Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4256. .. rst-class:: classref-item-separator
  4257. ----
  4258. .. _class_RenderingServer_method_compositor_create:
  4259. .. rst-class:: classref-method
  4260. :ref:`RID<class_RID>` **compositor_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_compositor_create>`
  4261. Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4262. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4263. .. rst-class:: classref-item-separator
  4264. ----
  4265. .. _class_RenderingServer_method_compositor_effect_create:
  4266. .. rst-class:: classref-method
  4267. :ref:`RID<class_RID>` **compositor_effect_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_create>`
  4268. Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4269. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4270. .. rst-class:: classref-item-separator
  4271. ----
  4272. .. _class_RenderingServer_method_compositor_effect_set_callback:
  4273. .. rst-class:: classref-method
  4274. |void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID<class_RID>`, callback_type\: :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_callback>`
  4275. Sets the callback type (``callback_type``) and callback method(``callback``) for this rendering effect.
  4276. .. rst-class:: classref-item-separator
  4277. ----
  4278. .. _class_RenderingServer_method_compositor_effect_set_enabled:
  4279. .. rst-class:: classref-method
  4280. |void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_enabled>`
  4281. Enables/disables this rendering effect.
  4282. .. rst-class:: classref-item-separator
  4283. ----
  4284. .. _class_RenderingServer_method_compositor_effect_set_flag:
  4285. .. rst-class:: classref-method
  4286. |void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID<class_RID>`, flag\: :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>`, set\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_flag>`
  4287. Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``set``).
  4288. .. rst-class:: classref-item-separator
  4289. ----
  4290. .. _class_RenderingServer_method_compositor_set_compositor_effects:
  4291. .. rst-class:: classref-method
  4292. |void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID<class_RID>`, effects\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ ) :ref:`🔗<class_RenderingServer_method_compositor_set_compositor_effects>`
  4293. Sets the compositor effects for the specified compositor RID. ``effects`` should be an array containing RIDs created with :ref:`compositor_effect_create<class_RenderingServer_method_compositor_effect_create>`.
  4294. .. rst-class:: classref-item-separator
  4295. ----
  4296. .. _class_RenderingServer_method_create_local_rendering_device:
  4297. .. rst-class:: classref-method
  4298. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_create_local_rendering_device>`
  4299. Creates a RenderingDevice that can be used to do draw and compute operations on a separate thread. Cannot draw to the screen nor share data with the global RenderingDevice.
  4300. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns ``null``.
  4301. .. rst-class:: classref-item-separator
  4302. ----
  4303. .. _class_RenderingServer_method_debug_canvas_item_get_rect:
  4304. .. rst-class:: classref-method
  4305. :ref:`Rect2<class_Rect2>` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_debug_canvas_item_get_rect>`
  4306. Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling.
  4307. \ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2<class_Rect2>` in exported projects.
  4308. .. rst-class:: classref-item-separator
  4309. ----
  4310. .. _class_RenderingServer_method_decal_create:
  4311. .. rst-class:: classref-method
  4312. :ref:`RID<class_RID>` **decal_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_decal_create>`
  4313. Creates a decal and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``decal_*`` RenderingServer functions.
  4314. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4315. To place in a scene, attach this decal to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  4316. \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
  4317. .. rst-class:: classref-item-separator
  4318. ----
  4319. .. _class_RenderingServer_method_decal_set_albedo_mix:
  4320. .. rst-class:: classref-method
  4321. |void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_albedo_mix>`
  4322. Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
  4323. .. rst-class:: classref-item-separator
  4324. ----
  4325. .. _class_RenderingServer_method_decal_set_cull_mask:
  4326. .. rst-class:: classref-method
  4327. |void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_cull_mask>`
  4328. Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
  4329. .. rst-class:: classref-item-separator
  4330. ----
  4331. .. _class_RenderingServer_method_decal_set_distance_fade:
  4332. .. rst-class:: classref-method
  4333. |void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_distance_fade>`
  4334. Sets the distance fade parameters in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.distance_fade_enabled<class_Decal_property_distance_fade_enabled>`, :ref:`Decal.distance_fade_begin<class_Decal_property_distance_fade_begin>` and :ref:`Decal.distance_fade_length<class_Decal_property_distance_fade_length>`.
  4335. .. rst-class:: classref-item-separator
  4336. ----
  4337. .. _class_RenderingServer_method_decal_set_emission_energy:
  4338. .. rst-class:: classref-method
  4339. |void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_emission_energy>`
  4340. Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
  4341. .. rst-class:: classref-item-separator
  4342. ----
  4343. .. _class_RenderingServer_method_decal_set_fade:
  4344. .. rst-class:: classref-method
  4345. |void| **decal_set_fade**\ (\ decal\: :ref:`RID<class_RID>`, above\: :ref:`float<class_float>`, below\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_fade>`
  4346. Sets the upper fade (``above``) and lower fade (``below``) in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.upper_fade<class_Decal_property_upper_fade>` and :ref:`Decal.lower_fade<class_Decal_property_lower_fade>`.
  4347. .. rst-class:: classref-item-separator
  4348. ----
  4349. .. _class_RenderingServer_method_decal_set_modulate:
  4350. .. rst-class:: classref-method
  4351. |void| **decal_set_modulate**\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_modulate>`
  4352. Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
  4353. .. rst-class:: classref-item-separator
  4354. ----
  4355. .. _class_RenderingServer_method_decal_set_normal_fade:
  4356. .. rst-class:: classref-method
  4357. |void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_normal_fade>`
  4358. Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
  4359. .. rst-class:: classref-item-separator
  4360. ----
  4361. .. _class_RenderingServer_method_decal_set_size:
  4362. .. rst-class:: classref-method
  4363. |void| **decal_set_size**\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_size>`
  4364. Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
  4365. .. rst-class:: classref-item-separator
  4366. ----
  4367. .. _class_RenderingServer_method_decal_set_texture:
  4368. .. rst-class:: classref-method
  4369. |void| **decal_set_texture**\ (\ decal\: :ref:`RID<class_RID>`, type\: :ref:`DecalTexture<enum_RenderingServer_DecalTexture>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_texture>`
  4370. Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture<class_Decal_method_set_texture>`.
  4371. .. rst-class:: classref-item-separator
  4372. ----
  4373. .. _class_RenderingServer_method_decals_set_filter:
  4374. .. rst-class:: classref-method
  4375. |void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) :ref:`🔗<class_RenderingServer_method_decals_set_filter>`
  4376. Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
  4377. .. rst-class:: classref-item-separator
  4378. ----
  4379. .. _class_RenderingServer_method_directional_light_create:
  4380. .. rst-class:: classref-method
  4381. :ref:`RID<class_RID>` **directional_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_directional_light_create>`
  4382. Creates a directional light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
  4383. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4384. To place in a scene, attach this directional light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  4385. \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
  4386. .. rst-class:: classref-item-separator
  4387. ----
  4388. .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
  4389. .. rst-class:: classref-method
  4390. |void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int<class_int>`, is_16bits\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_directional_shadow_atlas_set_size>`
  4391. Sets the ``size`` of the directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/size<class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/size>`. This parameter is global and cannot be set on a per-viewport basis.
  4392. .. rst-class:: classref-item-separator
  4393. ----
  4394. .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
  4395. .. rst-class:: classref-method
  4396. |void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`🔗<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`
  4397. Sets the filter ``quality`` for directional light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality<class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality>`. This parameter is global and cannot be set on a per-viewport basis.
  4398. .. rst-class:: classref-item-separator
  4399. ----
  4400. .. _class_RenderingServer_method_environment_bake_panorama:
  4401. .. rst-class:: classref-method
  4402. :ref:`Image<class_Image>` **environment_bake_panorama**\ (\ environment\: :ref:`RID<class_RID>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_environment_bake_panorama>`
  4403. Generates and returns an :ref:`Image<class_Image>` containing the radiance map for the specified ``environment`` RID's sky. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>`.
  4404. \ **Note:** The image is saved in linear color space without any tonemapping performed, which means it will look too dark if viewed directly in an image editor.
  4405. \ **Note:** ``size`` should be a 2:1 aspect ratio for the generated panorama to have square pixels. For radiance maps, there is no point in using a height greater than :ref:`Sky.radiance_size<class_Sky_property_radiance_size>`, as it won't increase detail. Irradiance maps only contain low-frequency data, so there is usually no point in going past a size of 128×64 pixels when saving an irradiance map.
  4406. .. rst-class:: classref-item-separator
  4407. ----
  4408. .. _class_RenderingServer_method_environment_create:
  4409. .. rst-class:: classref-method
  4410. :ref:`RID<class_RID>` **environment_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_environment_create>`
  4411. Creates an environment and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``environment_*`` RenderingServer functions.
  4412. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4413. \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
  4414. .. rst-class:: classref-item-separator
  4415. ----
  4416. .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
  4417. .. rst-class:: classref-method
  4418. |void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`
  4419. If ``enable`` is ``true``, enables bicubic upscaling for glow which improves quality at the cost of performance. Equivalent to :ref:`ProjectSettings.rendering/environment/glow/upscale_mode<class_ProjectSettings_property_rendering/environment/glow/upscale_mode>`.
  4420. .. rst-class:: classref-item-separator
  4421. ----
  4422. .. _class_RenderingServer_method_environment_set_adjustment:
  4423. .. rst-class:: classref-method
  4424. |void| **environment_set_adjustment**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`, use_1d_color_correction\: :ref:`bool<class_bool>`, color_correction\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_adjustment>`
  4425. Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4426. .. rst-class:: classref-item-separator
  4427. ----
  4428. .. _class_RenderingServer_method_environment_set_ambient_light:
  4429. .. rst-class:: classref-method
  4430. |void| **environment_set_ambient_light**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contribution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ambient_light>`
  4431. Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
  4432. .. rst-class:: classref-item-separator
  4433. ----
  4434. .. _class_RenderingServer_method_environment_set_background:
  4435. .. rst-class:: classref-method
  4436. |void| **environment_set_background**\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_background>`
  4437. Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
  4438. .. rst-class:: classref-item-separator
  4439. ----
  4440. .. _class_RenderingServer_method_environment_set_bg_color:
  4441. .. rst-class:: classref-method
  4442. |void| **environment_set_bg_color**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_bg_color>`
  4443. Color displayed for clear areas of the scene. Only effective if using the :ref:`ENV_BG_COLOR<class_RenderingServer_constant_ENV_BG_COLOR>` background mode.
  4444. .. rst-class:: classref-item-separator
  4445. ----
  4446. .. _class_RenderingServer_method_environment_set_bg_energy:
  4447. .. rst-class:: classref-method
  4448. |void| **environment_set_bg_energy**\ (\ env\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, exposure_value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_bg_energy>`
  4449. Sets the intensity of the background color.
  4450. .. rst-class:: classref-item-separator
  4451. ----
  4452. .. _class_RenderingServer_method_environment_set_camera_id:
  4453. .. rst-class:: classref-method
  4454. |void| **environment_set_camera_id**\ (\ env\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_camera_id>`
  4455. Sets the camera ID to be used as environment background.
  4456. .. rst-class:: classref-item-separator
  4457. ----
  4458. .. _class_RenderingServer_method_environment_set_canvas_max_layer:
  4459. .. rst-class:: classref-method
  4460. |void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID<class_RID>`, max_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_canvas_max_layer>`
  4461. Sets the maximum layer to use if using Canvas background mode.
  4462. .. rst-class:: classref-item-separator
  4463. ----
  4464. .. _class_RenderingServer_method_environment_set_fog:
  4465. .. rst-class:: classref-method
  4466. |void| **environment_set_fog**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, light_color\: :ref:`Color<class_Color>`, light_energy\: :ref:`float<class_float>`, sun_scatter\: :ref:`float<class_float>`, density\: :ref:`float<class_float>`, height\: :ref:`float<class_float>`, height_density\: :ref:`float<class_float>`, aerial_perspective\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`, fog_mode\: :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` = 0\ ) :ref:`🔗<class_RenderingServer_method_environment_set_fog>`
  4467. Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4468. .. rst-class:: classref-item-separator
  4469. ----
  4470. .. _class_RenderingServer_method_environment_set_glow:
  4471. .. rst-class:: classref-method
  4472. |void| **environment_set_glow**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, levels\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, intensity\: :ref:`float<class_float>`, strength\: :ref:`float<class_float>`, mix\: :ref:`float<class_float>`, bloom_threshold\: :ref:`float<class_float>`, blend_mode\: :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>`, hdr_bleed_threshold\: :ref:`float<class_float>`, hdr_bleed_scale\: :ref:`float<class_float>`, hdr_luminance_cap\: :ref:`float<class_float>`, glow_map_strength\: :ref:`float<class_float>`, glow_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_glow>`
  4473. Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4474. .. rst-class:: classref-item-separator
  4475. ----
  4476. .. _class_RenderingServer_method_environment_set_sdfgi:
  4477. .. rst-class:: classref-method
  4478. |void| **environment_set_sdfgi**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, cascades\: :ref:`int<class_int>`, min_cell_size\: :ref:`float<class_float>`, y_scale\: :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>`, use_occlusion\: :ref:`bool<class_bool>`, bounce_feedback\: :ref:`float<class_float>`, read_sky\: :ref:`bool<class_bool>`, energy\: :ref:`float<class_float>`, normal_bias\: :ref:`float<class_float>`, probe_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi>`
  4479. Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4480. .. rst-class:: classref-item-separator
  4481. ----
  4482. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
  4483. .. rst-class:: classref-method
  4484. |void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`
  4485. Sets the number of frames to use for converging signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_converge<class_ProjectSettings_property_rendering/global_illumination/sdfgi/frames_to_converge>`.
  4486. .. rst-class:: classref-item-separator
  4487. ----
  4488. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
  4489. .. rst-class:: classref-method
  4490. |void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>`
  4491. Sets the update speed for dynamic lights' indirect lighting when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights<class_ProjectSettings_property_rendering/global_illumination/sdfgi/frames_to_update_lights>`.
  4492. .. rst-class:: classref-item-separator
  4493. ----
  4494. .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
  4495. .. rst-class:: classref-method
  4496. |void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_ray_count>`
  4497. Sets the number of rays to throw per frame when computing signed distance field global illumination. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/sdfgi/probe_ray_count<class_ProjectSettings_property_rendering/global_illumination/sdfgi/probe_ray_count>`.
  4498. .. rst-class:: classref-item-separator
  4499. ----
  4500. .. _class_RenderingServer_method_environment_set_sky:
  4501. .. rst-class:: classref-method
  4502. |void| **environment_set_sky**\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky>`
  4503. Sets the :ref:`Sky<class_Sky>` to be used as the environment's background when using *BGMode* sky. Equivalent to :ref:`Environment.sky<class_Environment_property_sky>`.
  4504. .. rst-class:: classref-item-separator
  4505. ----
  4506. .. _class_RenderingServer_method_environment_set_sky_custom_fov:
  4507. .. rst-class:: classref-method
  4508. |void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky_custom_fov>`
  4509. Sets a custom field of view for the background :ref:`Sky<class_Sky>`. Equivalent to :ref:`Environment.sky_custom_fov<class_Environment_property_sky_custom_fov>`.
  4510. .. rst-class:: classref-item-separator
  4511. ----
  4512. .. _class_RenderingServer_method_environment_set_sky_orientation:
  4513. .. rst-class:: classref-method
  4514. |void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky_orientation>`
  4515. Sets the rotation of the background :ref:`Sky<class_Sky>` expressed as a :ref:`Basis<class_Basis>`. Equivalent to :ref:`Environment.sky_rotation<class_Environment_property_sky_rotation>`, where the rotation vector is used to construct the :ref:`Basis<class_Basis>`.
  4516. .. rst-class:: classref-item-separator
  4517. ----
  4518. .. _class_RenderingServer_method_environment_set_ssao:
  4519. .. rst-class:: classref-method
  4520. |void| **environment_set_ssao**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, radius\: :ref:`float<class_float>`, intensity\: :ref:`float<class_float>`, power\: :ref:`float<class_float>`, detail\: :ref:`float<class_float>`, horizon\: :ref:`float<class_float>`, sharpness\: :ref:`float<class_float>`, light_affect\: :ref:`float<class_float>`, ao_channel_affect\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssao>`
  4521. Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4522. .. rst-class:: classref-item-separator
  4523. ----
  4524. .. _class_RenderingServer_method_environment_set_ssao_quality:
  4525. .. rst-class:: classref-method
  4526. |void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssao_quality>`
  4527. Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4528. .. rst-class:: classref-item-separator
  4529. ----
  4530. .. _class_RenderingServer_method_environment_set_ssil_quality:
  4531. .. rst-class:: classref-method
  4532. |void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssil_quality>`
  4533. Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4534. .. rst-class:: classref-item-separator
  4535. ----
  4536. .. _class_RenderingServer_method_environment_set_ssr:
  4537. .. rst-class:: classref-method
  4538. |void| **environment_set_ssr**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, max_steps\: :ref:`int<class_int>`, fade_in\: :ref:`float<class_float>`, fade_out\: :ref:`float<class_float>`, depth_tolerance\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssr>`
  4539. Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4540. .. rst-class:: classref-item-separator
  4541. ----
  4542. .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
  4543. .. rst-class:: classref-method
  4544. |void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssr_roughness_quality>`
  4545. .. container:: contribute
  4546. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4547. .. rst-class:: classref-item-separator
  4548. ----
  4549. .. _class_RenderingServer_method_environment_set_tonemap:
  4550. .. rst-class:: classref-method
  4551. |void| **environment_set_tonemap**\ (\ env\: :ref:`RID<class_RID>`, tone_mapper\: :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>`, exposure\: :ref:`float<class_float>`, white\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_tonemap>`
  4552. Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4553. .. rst-class:: classref-item-separator
  4554. ----
  4555. .. _class_RenderingServer_method_environment_set_volumetric_fog:
  4556. .. rst-class:: classref-method
  4557. |void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, density\: :ref:`float<class_float>`, albedo\: :ref:`Color<class_Color>`, emission\: :ref:`Color<class_Color>`, emission_energy\: :ref:`float<class_float>`, anisotropy\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`, p_detail_spread\: :ref:`float<class_float>`, gi_inject\: :ref:`float<class_float>`, temporal_reprojection\: :ref:`bool<class_bool>`, temporal_reprojection_amount\: :ref:`float<class_float>`, ambient_inject\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog>`
  4558. Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4559. .. rst-class:: classref-item-separator
  4560. ----
  4561. .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
  4562. .. rst-class:: classref-method
  4563. |void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`
  4564. Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
  4565. .. rst-class:: classref-item-separator
  4566. ----
  4567. .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
  4568. .. rst-class:: classref-method
  4569. |void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>`
  4570. Sets the resolution of the volumetric fog's froxel buffer. ``size`` is modified by the screen's aspect ratio and then used to set the width and height of the buffer. While ``depth`` is directly used to set the depth of the buffer.
  4571. .. rst-class:: classref-item-separator
  4572. ----
  4573. .. _class_RenderingServer_method_fog_volume_create:
  4574. .. rst-class:: classref-method
  4575. :ref:`RID<class_RID>` **fog_volume_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_create>`
  4576. Creates a new fog volume and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``fog_volume_*`` RenderingServer functions.
  4577. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4578. \ **Note:** The equivalent node is :ref:`FogVolume<class_FogVolume>`.
  4579. .. rst-class:: classref-item-separator
  4580. ----
  4581. .. _class_RenderingServer_method_fog_volume_set_material:
  4582. .. rst-class:: classref-method
  4583. |void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_material>`
  4584. Sets the :ref:`Material<class_Material>` of the fog volume. Can be either a :ref:`FogMaterial<class_FogMaterial>` or a custom :ref:`ShaderMaterial<class_ShaderMaterial>`.
  4585. .. rst-class:: classref-item-separator
  4586. ----
  4587. .. _class_RenderingServer_method_fog_volume_set_shape:
  4588. .. rst-class:: classref-method
  4589. |void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID<class_RID>`, shape\: :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_shape>`
  4590. Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>`, :ref:`FOG_VOLUME_SHAPE_CONE<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE>`, :ref:`FOG_VOLUME_SHAPE_CYLINDER<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER>`, :ref:`FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>` or :ref:`FOG_VOLUME_SHAPE_WORLD<class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD>`.
  4591. .. rst-class:: classref-item-separator
  4592. ----
  4593. .. _class_RenderingServer_method_fog_volume_set_size:
  4594. .. rst-class:: classref-method
  4595. |void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_size>`
  4596. Sets the size of the fog volume when shape is :ref:`FOG_VOLUME_SHAPE_ELLIPSOID<class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID>`, :ref:`FOG_VOLUME_SHAPE_CONE<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE>`, :ref:`FOG_VOLUME_SHAPE_CYLINDER<class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER>` or :ref:`FOG_VOLUME_SHAPE_BOX<class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX>`.
  4597. .. rst-class:: classref-item-separator
  4598. ----
  4599. .. _class_RenderingServer_method_force_draw:
  4600. .. rst-class:: classref-method
  4601. |void| **force_draw**\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_RenderingServer_method_force_draw>`
  4602. Forces redrawing of all viewports at once. Must be called from the main thread.
  4603. .. rst-class:: classref-item-separator
  4604. ----
  4605. .. _class_RenderingServer_method_force_sync:
  4606. .. rst-class:: classref-method
  4607. |void| **force_sync**\ (\ ) :ref:`🔗<class_RenderingServer_method_force_sync>`
  4608. Forces a synchronization between the CPU and GPU, which may be required in certain cases. Only call this when needed, as CPU-GPU synchronization has a performance cost.
  4609. .. rst-class:: classref-item-separator
  4610. ----
  4611. .. _class_RenderingServer_method_free_rid:
  4612. .. rst-class:: classref-method
  4613. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_free_rid>`
  4614. Tries to free an object in the RenderingServer. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingServer directly.
  4615. .. rst-class:: classref-item-separator
  4616. ----
  4617. .. _class_RenderingServer_method_get_current_rendering_driver_name:
  4618. .. rst-class:: classref-method
  4619. :ref:`String<class_String>` **get_current_rendering_driver_name**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_current_rendering_driver_name>`
  4620. Returns the name of the current rendering driver. This can be ``vulkan``, ``d3d12``, ``metal``, ``opengl3``, ``opengl3_es``, or ``opengl3_angle``. See also :ref:`get_current_rendering_method<class_RenderingServer_method_get_current_rendering_method>`.
  4621. The rendering driver is determined by :ref:`ProjectSettings.rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`, the ``--rendering-driver`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
  4622. .. rst-class:: classref-item-separator
  4623. ----
  4624. .. _class_RenderingServer_method_get_current_rendering_method:
  4625. .. rst-class:: classref-method
  4626. :ref:`String<class_String>` **get_current_rendering_method**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_current_rendering_method>`
  4627. Returns the name of the current rendering method. This can be ``forward_plus``, ``mobile``, or ``gl_compatibility``. See also :ref:`get_current_rendering_driver_name<class_RenderingServer_method_get_current_rendering_driver_name>`.
  4628. The rendering method is determined by :ref:`ProjectSettings.rendering/renderer/rendering_method<class_ProjectSettings_property_rendering/renderer/rendering_method>`, the ``--rendering-method`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
  4629. .. rst-class:: classref-item-separator
  4630. ----
  4631. .. _class_RenderingServer_method_get_default_clear_color:
  4632. .. rst-class:: classref-method
  4633. :ref:`Color<class_Color>` **get_default_clear_color**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_default_clear_color>`
  4634. Returns the default clear color which is used when a specific clear color has not been selected. See also :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>`.
  4635. .. rst-class:: classref-item-separator
  4636. ----
  4637. .. _class_RenderingServer_method_get_frame_setup_time_cpu:
  4638. .. rst-class:: classref-method
  4639. :ref:`float<class_float>` **get_frame_setup_time_cpu**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_frame_setup_time_cpu>`
  4640. Returns the time taken to setup rendering on the CPU in milliseconds. This value is shared across all viewports and does *not* require :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>` to be enabled on a viewport to be queried. See also :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`.
  4641. .. rst-class:: classref-item-separator
  4642. ----
  4643. .. _class_RenderingServer_method_get_rendering_device:
  4644. .. rst-class:: classref-method
  4645. :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_rendering_device>`
  4646. Returns the global RenderingDevice.
  4647. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns ``null``.
  4648. .. rst-class:: classref-item-separator
  4649. ----
  4650. .. _class_RenderingServer_method_get_rendering_info:
  4651. .. rst-class:: classref-method
  4652. :ref:`int<class_int>` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) :ref:`🔗<class_RenderingServer_method_get_rendering_info>`
  4653. Returns a statistic about the rendering engine which can be used for performance profiling. See :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` for a list of values that can be queried. See also :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>`, which returns information specific to a viewport.
  4654. \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
  4655. \ **Note:** Rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>` returns ``0``. To print rendering information in ``_ready()`` successfully, use the following:
  4656. ::
  4657. func _ready():
  4658. for _i in 2:
  4659. await get_tree().process_frame
  4660. print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
  4661. .. rst-class:: classref-item-separator
  4662. ----
  4663. .. _class_RenderingServer_method_get_shader_parameter_list:
  4664. .. rst-class:: classref-method
  4665. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_get_shader_parameter_list>`
  4666. Returns the parameters of a shader.
  4667. .. rst-class:: classref-item-separator
  4668. ----
  4669. .. _class_RenderingServer_method_get_test_cube:
  4670. .. rst-class:: classref-method
  4671. :ref:`RID<class_RID>` **get_test_cube**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_test_cube>`
  4672. Returns the RID of the test cube. This mesh will be created and returned on the first call to :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>`, then it will be cached for subsequent calls. See also :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>`.
  4673. .. rst-class:: classref-item-separator
  4674. ----
  4675. .. _class_RenderingServer_method_get_test_texture:
  4676. .. rst-class:: classref-method
  4677. :ref:`RID<class_RID>` **get_test_texture**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_test_texture>`
  4678. Returns the RID of a 256×256 texture with a testing pattern on it (in :ref:`Image.FORMAT_RGB8<class_Image_constant_FORMAT_RGB8>` format). This texture will be created and returned on the first call to :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>`, then it will be cached for subsequent calls. See also :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>`.
  4679. \ **Example:** Get the test texture and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4680. ::
  4681. var texture_rid = RenderingServer.get_test_texture()
  4682. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4683. $Sprite2D.texture = texture
  4684. .. rst-class:: classref-item-separator
  4685. ----
  4686. .. _class_RenderingServer_method_get_video_adapter_api_version:
  4687. .. rst-class:: classref-method
  4688. :ref:`String<class_String>` **get_video_adapter_api_version**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_api_version>`
  4689. Returns the version of the graphics video adapter *currently in use* (e.g. "1.2.189" for Vulkan, "3.3.0 NVIDIA 510.60.02" for OpenGL). This version may be different from the actual latest version supported by the hardware, as Godot may not always request the latest version. See also :ref:`OS.get_video_adapter_driver_info<class_OS_method_get_video_adapter_driver_info>`.
  4690. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4691. .. rst-class:: classref-item-separator
  4692. ----
  4693. .. _class_RenderingServer_method_get_video_adapter_name:
  4694. .. rst-class:: classref-method
  4695. :ref:`String<class_String>` **get_video_adapter_name**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_name>`
  4696. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
  4697. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4698. \ **Note:** On the web platform, some browsers such as Firefox may report a different, fixed GPU name such as "GeForce GTX 980" (regardless of the user's actual GPU model). This is done to make fingerprinting more difficult.
  4699. .. rst-class:: classref-item-separator
  4700. ----
  4701. .. _class_RenderingServer_method_get_video_adapter_type:
  4702. .. rst-class:: classref-method
  4703. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_type>`
  4704. Returns the type of the video adapter. Since dedicated graphics cards from a given generation will *usually* be significantly faster than integrated graphics made in the same generation, the device type can be used as a basis for automatic graphics settings adjustment. However, this is not always true, so make sure to provide users with a way to manually override graphics settings.
  4705. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns :ref:`RenderingDevice.DEVICE_TYPE_OTHER<class_RenderingDevice_constant_DEVICE_TYPE_OTHER>`.
  4706. .. rst-class:: classref-item-separator
  4707. ----
  4708. .. _class_RenderingServer_method_get_video_adapter_vendor:
  4709. .. rst-class:: classref-method
  4710. :ref:`String<class_String>` **get_video_adapter_vendor**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_vendor>`
  4711. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
  4712. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4713. .. rst-class:: classref-item-separator
  4714. ----
  4715. .. _class_RenderingServer_method_get_white_texture:
  4716. .. rst-class:: classref-method
  4717. :ref:`RID<class_RID>` **get_white_texture**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_white_texture>`
  4718. Returns the ID of a 4×4 white texture (in :ref:`Image.FORMAT_RGB8<class_Image_constant_FORMAT_RGB8>` format). This texture will be created and returned on the first call to :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>`, then it will be cached for subsequent calls. See also :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>`.
  4719. \ **Example:** Get the white texture and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4720. ::
  4721. var texture_rid = RenderingServer.get_white_texture()
  4722. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4723. $Sprite2D.texture = texture
  4724. .. rst-class:: classref-item-separator
  4725. ----
  4726. .. _class_RenderingServer_method_gi_set_use_half_resolution:
  4727. .. rst-class:: classref-method
  4728. |void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_gi_set_use_half_resolution>`
  4729. If ``half_resolution`` is ``true``, renders :ref:`VoxelGI<class_VoxelGI>` and SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`) buffers at halved resolution on each axis (e.g. 960×540 when the viewport size is 1920×1080). This improves performance significantly when VoxelGI or SDFGI is enabled, at the cost of artifacts that may be visible on polygon edges. The loss in quality becomes less noticeable as the viewport resolution increases. :ref:`LightmapGI<class_LightmapGI>` rendering is not affected by this setting. Equivalent to :ref:`ProjectSettings.rendering/global_illumination/gi/use_half_resolution<class_ProjectSettings_property_rendering/global_illumination/gi/use_half_resolution>`.
  4730. .. rst-class:: classref-item-separator
  4731. ----
  4732. .. _class_RenderingServer_method_global_shader_parameter_add:
  4733. .. rst-class:: classref-method
  4734. |void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName<class_StringName>`, type\: :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>`, default_value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_add>`
  4735. Creates a new global shader uniform.
  4736. \ **Note:** Global shader parameter names are case-sensitive.
  4737. .. rst-class:: classref-item-separator
  4738. ----
  4739. .. _class_RenderingServer_method_global_shader_parameter_get:
  4740. .. rst-class:: classref-method
  4741. :ref:`Variant<class_Variant>` **global_shader_parameter_get**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get>`
  4742. Returns the value of the global shader uniform specified by ``name``.
  4743. \ **Note:** :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` has a large performance penalty as the rendering thread needs to synchronize with the calling thread, which is slow. Do not use this method during gameplay to avoid stuttering. If you need to read values in a script after setting them, consider creating an autoload where you store the values you need to query at the same time you're setting them as global parameters.
  4744. .. rst-class:: classref-item-separator
  4745. ----
  4746. .. _class_RenderingServer_method_global_shader_parameter_get_list:
  4747. .. rst-class:: classref-method
  4748. :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **global_shader_parameter_get_list**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get_list>`
  4749. Returns the list of global shader uniform names.
  4750. \ **Note:** :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` has a large performance penalty as the rendering thread needs to synchronize with the calling thread, which is slow. Do not use this method during gameplay to avoid stuttering. If you need to read values in a script after setting them, consider creating an autoload where you store the values you need to query at the same time you're setting them as global parameters.
  4751. .. rst-class:: classref-item-separator
  4752. ----
  4753. .. _class_RenderingServer_method_global_shader_parameter_get_type:
  4754. .. rst-class:: classref-method
  4755. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get_type>`
  4756. Returns the type associated to the global shader uniform specified by ``name``.
  4757. \ **Note:** :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` has a large performance penalty as the rendering thread needs to synchronize with the calling thread, which is slow. Do not use this method during gameplay to avoid stuttering. If you need to read values in a script after setting them, consider creating an autoload where you store the values you need to query at the same time you're setting them as global parameters.
  4758. .. rst-class:: classref-item-separator
  4759. ----
  4760. .. _class_RenderingServer_method_global_shader_parameter_remove:
  4761. .. rst-class:: classref-method
  4762. |void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_remove>`
  4763. Removes the global shader uniform specified by ``name``.
  4764. .. rst-class:: classref-item-separator
  4765. ----
  4766. .. _class_RenderingServer_method_global_shader_parameter_set:
  4767. .. rst-class:: classref-method
  4768. |void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_set>`
  4769. Sets the global shader uniform ``name`` to ``value``.
  4770. .. rst-class:: classref-item-separator
  4771. ----
  4772. .. _class_RenderingServer_method_global_shader_parameter_set_override:
  4773. .. rst-class:: classref-method
  4774. |void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_set_override>`
  4775. Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
  4776. .. rst-class:: classref-item-separator
  4777. ----
  4778. .. _class_RenderingServer_method_has_changed:
  4779. .. rst-class:: classref-method
  4780. :ref:`bool<class_bool>` **has_changed**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_has_changed>`
  4781. Returns ``true`` if changes have been made to the RenderingServer's data. :ref:`force_draw<class_RenderingServer_method_force_draw>` is usually called if this happens.
  4782. .. rst-class:: classref-item-separator
  4783. ----
  4784. .. _class_RenderingServer_method_has_feature:
  4785. .. rst-class:: classref-method
  4786. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| :ref:`🔗<class_RenderingServer_method_has_feature>`
  4787. **Deprecated:** This method has not been used since Godot 3.0.
  4788. This method does nothing and always returns ``false``.
  4789. .. rst-class:: classref-item-separator
  4790. ----
  4791. .. _class_RenderingServer_method_has_os_feature:
  4792. .. rst-class:: classref-method
  4793. :ref:`bool<class_bool>` **has_os_feature**\ (\ feature\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_RenderingServer_method_has_os_feature>`
  4794. Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
  4795. .. rst-class:: classref-item-separator
  4796. ----
  4797. .. _class_RenderingServer_method_instance_attach_object_instance_id:
  4798. .. rst-class:: classref-method
  4799. |void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_attach_object_instance_id>`
  4800. Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`, and :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`.
  4801. .. rst-class:: classref-item-separator
  4802. ----
  4803. .. _class_RenderingServer_method_instance_attach_skeleton:
  4804. .. rst-class:: classref-method
  4805. |void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_attach_skeleton>`
  4806. Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
  4807. .. rst-class:: classref-item-separator
  4808. ----
  4809. .. _class_RenderingServer_method_instance_create:
  4810. .. rst-class:: classref-method
  4811. :ref:`RID<class_RID>` **instance_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_instance_create>`
  4812. Creates a visual instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions.
  4813. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  4814. An instance is a way of placing a 3D object in the scenario. Objects like particles, meshes, reflection probes and decals need to be associated with an instance to be visible in the scenario using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`.
  4815. \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
  4816. .. rst-class:: classref-item-separator
  4817. ----
  4818. .. _class_RenderingServer_method_instance_create2:
  4819. .. rst-class:: classref-method
  4820. :ref:`RID<class_RID>` **instance_create2**\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_create2>`
  4821. Creates a visual instance, adds it to the RenderingServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all ``instance_*`` RenderingServer functions.
  4822. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method. This is a shorthand for using :ref:`instance_create<class_RenderingServer_method_instance_create>` and setting the base and scenario manually.
  4823. .. rst-class:: classref-item-separator
  4824. ----
  4825. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
  4826. .. rst-class:: classref-method
  4827. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter>`
  4828. Returns the value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter<class_GeometryInstance3D_method_get_instance_shader_parameter>`.
  4829. \ **Note:** Per-instance shader parameter names are case-sensitive.
  4830. .. rst-class:: classref-item-separator
  4831. ----
  4832. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
  4833. .. rst-class:: classref-method
  4834. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>`
  4835. Returns the default value of the per-instance shader uniform from the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter<class_GeometryInstance3D_method_get_instance_shader_parameter>`.
  4836. .. rst-class:: classref-item-separator
  4837. ----
  4838. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
  4839. .. rst-class:: classref-method
  4840. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>`
  4841. Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified 3D geometry instance. The returned dictionary is in PropertyInfo format, with the keys ``name``, ``class_name``, ``type``, ``hint``, ``hint_string`` and ``usage``. Equivalent to :ref:`GeometryInstance3D.get_instance_shader_parameter<class_GeometryInstance3D_method_get_instance_shader_parameter>`.
  4842. .. rst-class:: classref-item-separator
  4843. ----
  4844. .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
  4845. .. rst-class:: classref-method
  4846. |void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID<class_RID>`, shadow_casting_setting\: :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`
  4847. Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
  4848. .. rst-class:: classref-item-separator
  4849. ----
  4850. .. _class_RenderingServer_method_instance_geometry_set_flag:
  4851. .. rst-class:: classref-method
  4852. |void| **instance_geometry_set_flag**\ (\ instance\: :ref:`RID<class_RID>`, flag\: :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_flag>`
  4853. Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
  4854. .. rst-class:: classref-item-separator
  4855. ----
  4856. .. _class_RenderingServer_method_instance_geometry_set_lightmap:
  4857. .. rst-class:: classref-method
  4858. |void| **instance_geometry_set_lightmap**\ (\ instance\: :ref:`RID<class_RID>`, lightmap\: :ref:`RID<class_RID>`, lightmap_uv_scale\: :ref:`Rect2<class_Rect2>`, lightmap_slice\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_lightmap>`
  4859. Sets the lightmap GI instance to use for the specified 3D geometry instance. The lightmap UV scale for the specified instance (equivalent to :ref:`GeometryInstance3D.gi_lightmap_scale<class_GeometryInstance3D_property_gi_lightmap_scale>`) and lightmap atlas slice must also be specified.
  4860. .. rst-class:: classref-item-separator
  4861. ----
  4862. .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
  4863. .. rst-class:: classref-method
  4864. |void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID<class_RID>`, lod_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_lod_bias>`
  4865. Sets the level of detail bias to use when rendering the specified 3D geometry instance. Higher values result in higher detail from further away. Equivalent to :ref:`GeometryInstance3D.lod_bias<class_GeometryInstance3D_property_lod_bias>`.
  4866. .. rst-class:: classref-item-separator
  4867. ----
  4868. .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
  4869. .. rst-class:: classref-method
  4870. |void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_material_overlay>`
  4871. Sets a material that will be rendered for all surfaces on top of active materials for the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_overlay<class_GeometryInstance3D_property_material_overlay>`.
  4872. .. rst-class:: classref-item-separator
  4873. ----
  4874. .. _class_RenderingServer_method_instance_geometry_set_material_override:
  4875. .. rst-class:: classref-method
  4876. |void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_material_override>`
  4877. Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to :ref:`GeometryInstance3D.material_override<class_GeometryInstance3D_property_material_override>`.
  4878. .. rst-class:: classref-item-separator
  4879. ----
  4880. .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
  4881. .. rst-class:: classref-method
  4882. |void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_shader_parameter>`
  4883. Sets the per-instance shader uniform on the specified 3D geometry instance. Equivalent to :ref:`GeometryInstance3D.set_instance_shader_parameter<class_GeometryInstance3D_method_set_instance_shader_parameter>`.
  4884. .. rst-class:: classref-item-separator
  4885. ----
  4886. .. _class_RenderingServer_method_instance_geometry_set_transparency:
  4887. .. rst-class:: classref-method
  4888. |void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_transparency>`
  4889. Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
  4890. A transparency of ``0.0`` is fully opaque, while ``1.0`` is fully transparent. Values greater than ``0.0`` (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting ``transparency`` to a value greater than ``0.0`` (exclusive) will *not* disable shadow rendering.
  4891. In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
  4892. \ **Note:** ``transparency`` is clamped between ``0.0`` and ``1.0``, so this property cannot be used to make transparent materials more opaque than they originally are.
  4893. .. rst-class:: classref-item-separator
  4894. ----
  4895. .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
  4896. .. rst-class:: classref-method
  4897. |void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`, min_margin\: :ref:`float<class_float>`, max_margin\: :ref:`float<class_float>`, fade_mode\: :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_visibility_range>`
  4898. Sets the visibility range values for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.visibility_range_begin<class_GeometryInstance3D_property_visibility_range_begin>` and related properties.
  4899. .. rst-class:: classref-item-separator
  4900. ----
  4901. .. _class_RenderingServer_method_instance_reset_physics_interpolation:
  4902. .. rst-class:: classref-method
  4903. |void| **instance_reset_physics_interpolation**\ (\ instance\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_reset_physics_interpolation>`
  4904. Prevents physics interpolation for the current physics tick.
  4905. This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location.
  4906. .. rst-class:: classref-item-separator
  4907. ----
  4908. .. _class_RenderingServer_method_instance_set_base:
  4909. .. rst-class:: classref-method
  4910. |void| **instance_set_base**\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_base>`
  4911. Sets the base of the instance. A base can be any of the 3D objects that are created in the RenderingServer that can be displayed. For example, any of the light types, mesh, multimesh, particle system, reflection probe, decal, lightmap, voxel GI and visibility notifiers are all types that can be set as the base of an instance in order to be displayed in the scenario.
  4912. .. rst-class:: classref-item-separator
  4913. ----
  4914. .. _class_RenderingServer_method_instance_set_blend_shape_weight:
  4915. .. rst-class:: classref-method
  4916. |void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID<class_RID>`, shape\: :ref:`int<class_int>`, weight\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_blend_shape_weight>`
  4917. Sets the weight for a given blend shape associated with this instance.
  4918. .. rst-class:: classref-item-separator
  4919. ----
  4920. .. _class_RenderingServer_method_instance_set_custom_aabb:
  4921. .. rst-class:: classref-method
  4922. |void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_custom_aabb>`
  4923. Sets a custom AABB to use when culling objects from the view frustum. Equivalent to setting :ref:`GeometryInstance3D.custom_aabb<class_GeometryInstance3D_property_custom_aabb>`.
  4924. .. rst-class:: classref-item-separator
  4925. ----
  4926. .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
  4927. .. rst-class:: classref-method
  4928. |void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_extra_visibility_margin>`
  4929. Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to :ref:`GeometryInstance3D.extra_cull_margin<class_GeometryInstance3D_property_extra_cull_margin>`.
  4930. .. rst-class:: classref-item-separator
  4931. ----
  4932. .. _class_RenderingServer_method_instance_set_ignore_culling:
  4933. .. rst-class:: classref-method
  4934. |void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_ignore_culling>`
  4935. If ``true``, ignores both frustum and occlusion culling on the specified 3D geometry instance. This is not the same as :ref:`GeometryInstance3D.ignore_occlusion_culling<class_GeometryInstance3D_property_ignore_occlusion_culling>`, which only ignores occlusion culling and leaves frustum culling intact.
  4936. .. rst-class:: classref-item-separator
  4937. ----
  4938. .. _class_RenderingServer_method_instance_set_interpolated:
  4939. .. rst-class:: classref-method
  4940. |void| **instance_set_interpolated**\ (\ instance\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_interpolated>`
  4941. Turns on and off physics interpolation for the instance.
  4942. .. rst-class:: classref-item-separator
  4943. ----
  4944. .. _class_RenderingServer_method_instance_set_layer_mask:
  4945. .. rst-class:: classref-method
  4946. |void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_layer_mask>`
  4947. Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
  4948. .. rst-class:: classref-item-separator
  4949. ----
  4950. .. _class_RenderingServer_method_instance_set_pivot_data:
  4951. .. rst-class:: classref-method
  4952. |void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID<class_RID>`, sorting_offset\: :ref:`float<class_float>`, use_aabb_center\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_pivot_data>`
  4953. Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
  4954. .. rst-class:: classref-item-separator
  4955. ----
  4956. .. _class_RenderingServer_method_instance_set_scenario:
  4957. .. rst-class:: classref-method
  4958. |void| **instance_set_scenario**\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_scenario>`
  4959. Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
  4960. .. rst-class:: classref-item-separator
  4961. ----
  4962. .. _class_RenderingServer_method_instance_set_surface_override_material:
  4963. .. rst-class:: classref-method
  4964. |void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_surface_override_material>`
  4965. Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
  4966. .. rst-class:: classref-item-separator
  4967. ----
  4968. .. _class_RenderingServer_method_instance_set_transform:
  4969. .. rst-class:: classref-method
  4970. |void| **instance_set_transform**\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_transform>`
  4971. Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform<class_Node3D_property_global_transform>`.
  4972. .. rst-class:: classref-item-separator
  4973. ----
  4974. .. _class_RenderingServer_method_instance_set_visibility_parent:
  4975. .. rst-class:: classref-method
  4976. |void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_visibility_parent>`
  4977. Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
  4978. .. rst-class:: classref-item-separator
  4979. ----
  4980. .. _class_RenderingServer_method_instance_set_visible:
  4981. .. rst-class:: classref-method
  4982. |void| **instance_set_visible**\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_visible>`
  4983. Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
  4984. .. rst-class:: classref-item-separator
  4985. ----
  4986. .. _class_RenderingServer_method_instances_cull_aabb:
  4987. .. rst-class:: classref-method
  4988. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB<class_AABB>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_aabb>`
  4989. Returns an array of object IDs intersecting with the provided AABB. Only 3D nodes that inherit from :ref:`VisualInstance3D<class_VisualInstance3D>` are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
  4990. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4991. .. rst-class:: classref-item-separator
  4992. ----
  4993. .. _class_RenderingServer_method_instances_cull_convex:
  4994. .. rst-class:: classref-method
  4995. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_convex**\ (\ convex\: :ref:`Array<class_Array>`\[:ref:`Plane<class_Plane>`\], scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_convex>`
  4996. Returns an array of object IDs intersecting with the provided convex shape. Only 3D nodes that inherit from :ref:`VisualInstance3D<class_VisualInstance3D>` are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
  4997. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4998. .. rst-class:: classref-item-separator
  4999. ----
  5000. .. _class_RenderingServer_method_instances_cull_ray:
  5001. .. rst-class:: classref-method
  5002. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_ray**\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_ray>`
  5003. Returns an array of object IDs intersecting with the provided 3D ray. Only 3D nodes that inherit from :ref:`VisualInstance3D<class_VisualInstance3D>` are considered, such as :ref:`MeshInstance3D<class_MeshInstance3D>` or :ref:`DirectionalLight3D<class_DirectionalLight3D>`. Use :ref:`@GlobalScope.instance_from_id<class_@GlobalScope_method_instance_from_id>` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D<class_World3D>` you want to query. This forces an update for all resources queued to update.
  5004. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  5005. .. rst-class:: classref-item-separator
  5006. ----
  5007. .. _class_RenderingServer_method_is_on_render_thread:
  5008. .. rst-class:: classref-method
  5009. :ref:`bool<class_bool>` **is_on_render_thread**\ (\ ) :ref:`🔗<class_RenderingServer_method_is_on_render_thread>`
  5010. Returns ``true`` if our code is currently executing on the rendering thread.
  5011. .. rst-class:: classref-item-separator
  5012. ----
  5013. .. _class_RenderingServer_method_light_directional_set_blend_splits:
  5014. .. rst-class:: classref-method
  5015. |void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_blend_splits>`
  5016. If ``true``, this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to :ref:`DirectionalLight3D.directional_shadow_blend_splits<class_DirectionalLight3D_property_directional_shadow_blend_splits>`.
  5017. .. rst-class:: classref-item-separator
  5018. ----
  5019. .. _class_RenderingServer_method_light_directional_set_shadow_mode:
  5020. .. rst-class:: classref-method
  5021. |void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_shadow_mode>`
  5022. Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode<class_DirectionalLight3D_property_directional_shadow_mode>`. See :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` for options.
  5023. .. rst-class:: classref-item-separator
  5024. ----
  5025. .. _class_RenderingServer_method_light_directional_set_sky_mode:
  5026. .. rst-class:: classref-method
  5027. |void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_sky_mode>`
  5028. If ``true``, this light will not be used for anything except sky shaders. Use this for lights that impact your sky shader that you may want to hide from affecting the rest of the scene. For example, you may want to enable this when the sun in your sky shader falls below the horizon.
  5029. .. rst-class:: classref-item-separator
  5030. ----
  5031. .. _class_RenderingServer_method_light_omni_set_shadow_mode:
  5032. .. rst-class:: classref-method
  5033. |void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_omni_set_shadow_mode>`
  5034. Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to :ref:`OmniLight3D.omni_shadow_mode<class_OmniLight3D_property_omni_shadow_mode>`.
  5035. .. rst-class:: classref-item-separator
  5036. ----
  5037. .. _class_RenderingServer_method_light_projectors_set_filter:
  5038. .. rst-class:: classref-method
  5039. |void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) :ref:`🔗<class_RenderingServer_method_light_projectors_set_filter>`
  5040. Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
  5041. .. rst-class:: classref-item-separator
  5042. ----
  5043. .. _class_RenderingServer_method_light_set_bake_mode:
  5044. .. rst-class:: classref-method
  5045. |void| **light_set_bake_mode**\ (\ light\: :ref:`RID<class_RID>`, bake_mode\: :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_bake_mode>`
  5046. Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
  5047. .. rst-class:: classref-item-separator
  5048. ----
  5049. .. _class_RenderingServer_method_light_set_color:
  5050. .. rst-class:: classref-method
  5051. |void| **light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_color>`
  5052. Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
  5053. .. rst-class:: classref-item-separator
  5054. ----
  5055. .. _class_RenderingServer_method_light_set_cull_mask:
  5056. .. rst-class:: classref-method
  5057. |void| **light_set_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_cull_mask>`
  5058. Sets the cull mask for this 3D light. Lights only affect objects in the selected layers. Equivalent to :ref:`Light3D.light_cull_mask<class_Light3D_property_light_cull_mask>`.
  5059. .. rst-class:: classref-item-separator
  5060. ----
  5061. .. _class_RenderingServer_method_light_set_distance_fade:
  5062. .. rst-class:: classref-method
  5063. |void| **light_set_distance_fade**\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, shadow\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_distance_fade>`
  5064. Sets the distance fade for this 3D light. This acts as a form of level of detail (LOD) and can be used to improve performance. Equivalent to :ref:`Light3D.distance_fade_enabled<class_Light3D_property_distance_fade_enabled>`, :ref:`Light3D.distance_fade_begin<class_Light3D_property_distance_fade_begin>`, :ref:`Light3D.distance_fade_shadow<class_Light3D_property_distance_fade_shadow>`, and :ref:`Light3D.distance_fade_length<class_Light3D_property_distance_fade_length>`.
  5065. .. rst-class:: classref-item-separator
  5066. ----
  5067. .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
  5068. .. rst-class:: classref-method
  5069. |void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID<class_RID>`, cascade\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_max_sdfgi_cascade>`
  5070. Sets the maximum SDFGI cascade in which the 3D light's indirect lighting is rendered. Higher values allow the light to be rendered in SDFGI further away from the camera.
  5071. .. rst-class:: classref-item-separator
  5072. ----
  5073. .. _class_RenderingServer_method_light_set_negative:
  5074. .. rst-class:: classref-method
  5075. |void| **light_set_negative**\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_negative>`
  5076. If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
  5077. .. rst-class:: classref-item-separator
  5078. ----
  5079. .. _class_RenderingServer_method_light_set_param:
  5080. .. rst-class:: classref-method
  5081. |void| **light_set_param**\ (\ light\: :ref:`RID<class_RID>`, param\: :ref:`LightParam<enum_RenderingServer_LightParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_param>`
  5082. Sets the specified 3D light parameter. See :ref:`LightParam<enum_RenderingServer_LightParam>` for options. Equivalent to :ref:`Light3D.set_param<class_Light3D_method_set_param>`.
  5083. .. rst-class:: classref-item-separator
  5084. ----
  5085. .. _class_RenderingServer_method_light_set_projector:
  5086. .. rst-class:: classref-method
  5087. |void| **light_set_projector**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_projector>`
  5088. Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
  5089. .. rst-class:: classref-item-separator
  5090. ----
  5091. .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
  5092. .. rst-class:: classref-method
  5093. |void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_reverse_cull_face_mode>`
  5094. If ``true``, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`. Equivalent to :ref:`Light3D.shadow_reverse_cull_face<class_Light3D_property_shadow_reverse_cull_face>`.
  5095. .. rst-class:: classref-item-separator
  5096. ----
  5097. .. _class_RenderingServer_method_light_set_shadow:
  5098. .. rst-class:: classref-method
  5099. |void| **light_set_shadow**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_shadow>`
  5100. If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
  5101. .. rst-class:: classref-item-separator
  5102. ----
  5103. .. _class_RenderingServer_method_light_set_shadow_caster_mask:
  5104. .. rst-class:: classref-method
  5105. |void| **light_set_shadow_caster_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_shadow_caster_mask>`
  5106. Sets the shadow caster mask for this 3D light. Shadows will only be cast using objects in the selected layers. Equivalent to :ref:`Light3D.shadow_caster_mask<class_Light3D_property_shadow_caster_mask>`.
  5107. .. rst-class:: classref-item-separator
  5108. ----
  5109. .. _class_RenderingServer_method_lightmap_create:
  5110. .. rst-class:: classref-method
  5111. :ref:`RID<class_RID>` **lightmap_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_lightmap_create>`
  5112. Creates a new lightmap global illumination instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``lightmap_*`` RenderingServer functions.
  5113. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5114. \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
  5115. .. rst-class:: classref-item-separator
  5116. ----
  5117. .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
  5118. .. rst-class:: classref-method
  5119. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>`
  5120. .. container:: contribute
  5121. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5122. .. rst-class:: classref-item-separator
  5123. ----
  5124. .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
  5125. .. rst-class:: classref-method
  5126. :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_points>`
  5127. .. container:: contribute
  5128. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5129. .. rst-class:: classref-item-separator
  5130. ----
  5131. .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
  5132. .. rst-class:: classref-method
  5133. :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_sh>`
  5134. .. container:: contribute
  5135. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5136. .. rst-class:: classref-item-separator
  5137. ----
  5138. .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
  5139. .. rst-class:: classref-method
  5140. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`
  5141. .. container:: contribute
  5142. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5143. .. rst-class:: classref-item-separator
  5144. ----
  5145. .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
  5146. .. rst-class:: classref-method
  5147. |void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>`
  5148. Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>`.
  5149. .. rst-class:: classref-item-separator
  5150. ----
  5151. .. _class_RenderingServer_method_lightmap_set_probe_bounds:
  5152. .. rst-class:: classref-method
  5153. |void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_bounds>`
  5154. .. container:: contribute
  5155. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5156. .. rst-class:: classref-item-separator
  5157. ----
  5158. .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
  5159. .. rst-class:: classref-method
  5160. |void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector3Array<class_PackedVector3Array>`, point_sh\: :ref:`PackedColorArray<class_PackedColorArray>`, tetrahedra\: :ref:`PackedInt32Array<class_PackedInt32Array>`, bsp_tree\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_capture_data>`
  5161. .. container:: contribute
  5162. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5163. .. rst-class:: classref-item-separator
  5164. ----
  5165. .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
  5166. .. rst-class:: classref-method
  5167. |void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`
  5168. .. container:: contribute
  5169. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5170. .. rst-class:: classref-item-separator
  5171. ----
  5172. .. _class_RenderingServer_method_lightmap_set_probe_interior:
  5173. .. rst-class:: classref-method
  5174. |void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_interior>`
  5175. .. container:: contribute
  5176. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5177. .. rst-class:: classref-item-separator
  5178. ----
  5179. .. _class_RenderingServer_method_lightmap_set_textures:
  5180. .. rst-class:: classref-method
  5181. |void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID<class_RID>`, light\: :ref:`RID<class_RID>`, uses_sh\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_textures>`
  5182. Set the textures on the given ``lightmap`` GI instance to the texture array pointed to by the ``light`` RID. If the lightmap texture was baked with :ref:`LightmapGI.directional<class_LightmapGI_property_directional>` set to ``true``, then ``uses_sh`` must also be ``true``.
  5183. .. rst-class:: classref-item-separator
  5184. ----
  5185. .. _class_RenderingServer_method_lightmaps_set_bicubic_filter:
  5186. .. rst-class:: classref-method
  5187. |void| **lightmaps_set_bicubic_filter**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_lightmaps_set_bicubic_filter>`
  5188. Toggles whether a bicubic filter should be used when lightmaps are sampled. This smoothens their appearance at a performance cost.
  5189. .. rst-class:: classref-item-separator
  5190. ----
  5191. .. _class_RenderingServer_method_make_sphere_mesh:
  5192. .. rst-class:: classref-method
  5193. :ref:`RID<class_RID>` **make_sphere_mesh**\ (\ latitudes\: :ref:`int<class_int>`, longitudes\: :ref:`int<class_int>`, radius\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_make_sphere_mesh>`
  5194. Returns a mesh of a sphere with the given number of horizontal subdivisions, vertical subdivisions and radius. See also :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>`.
  5195. .. rst-class:: classref-item-separator
  5196. ----
  5197. .. _class_RenderingServer_method_material_create:
  5198. .. rst-class:: classref-method
  5199. :ref:`RID<class_RID>` **material_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_material_create>`
  5200. Creates an empty material and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``material_*`` RenderingServer functions.
  5201. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5202. \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
  5203. .. rst-class:: classref-item-separator
  5204. ----
  5205. .. _class_RenderingServer_method_material_get_param:
  5206. .. rst-class:: classref-method
  5207. :ref:`Variant<class_Variant>` **material_get_param**\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_material_get_param>`
  5208. Returns the value of a certain material's parameter.
  5209. .. rst-class:: classref-item-separator
  5210. ----
  5211. .. _class_RenderingServer_method_material_set_next_pass:
  5212. .. rst-class:: classref-method
  5213. |void| **material_set_next_pass**\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_next_pass>`
  5214. Sets an object's next material.
  5215. .. rst-class:: classref-item-separator
  5216. ----
  5217. .. _class_RenderingServer_method_material_set_param:
  5218. .. rst-class:: classref-method
  5219. |void| **material_set_param**\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_param>`
  5220. Sets a material's parameter.
  5221. .. rst-class:: classref-item-separator
  5222. ----
  5223. .. _class_RenderingServer_method_material_set_render_priority:
  5224. .. rst-class:: classref-method
  5225. |void| **material_set_render_priority**\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_render_priority>`
  5226. Sets a material's render priority.
  5227. .. rst-class:: classref-item-separator
  5228. ----
  5229. .. _class_RenderingServer_method_material_set_shader:
  5230. .. rst-class:: classref-method
  5231. |void| **material_set_shader**\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_shader>`
  5232. Sets a shader material's shader.
  5233. .. rst-class:: classref-item-separator
  5234. ----
  5235. .. _class_RenderingServer_method_mesh_add_surface:
  5236. .. rst-class:: classref-method
  5237. |void| **mesh_add_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_add_surface>`
  5238. .. container:: contribute
  5239. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5240. .. rst-class:: classref-item-separator
  5241. ----
  5242. .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
  5243. .. rst-class:: classref-method
  5244. |void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, primitive\: :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>` = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\] = 0\ ) :ref:`🔗<class_RenderingServer_method_mesh_add_surface_from_arrays>`
  5245. .. container:: contribute
  5246. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5247. .. rst-class:: classref-item-separator
  5248. ----
  5249. .. _class_RenderingServer_method_mesh_clear:
  5250. .. rst-class:: classref-method
  5251. |void| **mesh_clear**\ (\ mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_clear>`
  5252. Removes all surfaces from a mesh.
  5253. .. rst-class:: classref-item-separator
  5254. ----
  5255. .. _class_RenderingServer_method_mesh_create:
  5256. .. rst-class:: classref-method
  5257. :ref:`RID<class_RID>` **mesh_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_mesh_create>`
  5258. Creates a new mesh and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``mesh_*`` RenderingServer functions.
  5259. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5260. To place in a scene, attach this mesh to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  5261. \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
  5262. .. rst-class:: classref-item-separator
  5263. ----
  5264. .. _class_RenderingServer_method_mesh_create_from_surfaces:
  5265. .. rst-class:: classref-method
  5266. :ref:`RID<class_RID>` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], blend_shape_count\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_mesh_create_from_surfaces>`
  5267. .. container:: contribute
  5268. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5269. .. rst-class:: classref-item-separator
  5270. ----
  5271. .. _class_RenderingServer_method_mesh_get_blend_shape_count:
  5272. .. rst-class:: classref-method
  5273. :ref:`int<class_int>` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_blend_shape_count>`
  5274. Returns a mesh's blend shape count.
  5275. .. rst-class:: classref-item-separator
  5276. ----
  5277. .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
  5278. .. rst-class:: classref-method
  5279. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_blend_shape_mode>`
  5280. Returns a mesh's blend shape mode.
  5281. .. rst-class:: classref-item-separator
  5282. ----
  5283. .. _class_RenderingServer_method_mesh_get_custom_aabb:
  5284. .. rst-class:: classref-method
  5285. :ref:`AABB<class_AABB>` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_custom_aabb>`
  5286. Returns a mesh's custom aabb.
  5287. .. rst-class:: classref-item-separator
  5288. ----
  5289. .. _class_RenderingServer_method_mesh_get_surface:
  5290. .. rst-class:: classref-method
  5291. :ref:`Dictionary<class_Dictionary>` **mesh_get_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_get_surface>`
  5292. .. container:: contribute
  5293. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5294. .. rst-class:: classref-item-separator
  5295. ----
  5296. .. _class_RenderingServer_method_mesh_get_surface_count:
  5297. .. rst-class:: classref-method
  5298. :ref:`int<class_int>` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_surface_count>`
  5299. Returns a mesh's number of surfaces.
  5300. .. rst-class:: classref-item-separator
  5301. ----
  5302. .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
  5303. .. rst-class:: classref-method
  5304. |void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID<class_RID>`, mode\: :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_blend_shape_mode>`
  5305. Sets a mesh's blend shape mode.
  5306. .. rst-class:: classref-item-separator
  5307. ----
  5308. .. _class_RenderingServer_method_mesh_set_custom_aabb:
  5309. .. rst-class:: classref-method
  5310. |void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_custom_aabb>`
  5311. Sets a mesh's custom aabb.
  5312. .. rst-class:: classref-item-separator
  5313. ----
  5314. .. _class_RenderingServer_method_mesh_set_shadow_mesh:
  5315. .. rst-class:: classref-method
  5316. |void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_shadow_mesh>`
  5317. .. container:: contribute
  5318. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5319. .. rst-class:: classref-item-separator
  5320. ----
  5321. .. _class_RenderingServer_method_mesh_surface_get_arrays:
  5322. .. rst-class:: classref-method
  5323. :ref:`Array<class_Array>` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_arrays>`
  5324. Returns a mesh's surface's buffer arrays.
  5325. .. rst-class:: classref-item-separator
  5326. ----
  5327. .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
  5328. .. rst-class:: classref-method
  5329. :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>`
  5330. Returns a mesh's surface's arrays for blend shapes.
  5331. .. rst-class:: classref-item-separator
  5332. ----
  5333. .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
  5334. .. rst-class:: classref-method
  5335. :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>`
  5336. Returns the stride of the attribute buffer for a mesh with given ``format``.
  5337. .. rst-class:: classref-item-separator
  5338. ----
  5339. .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride:
  5340. .. rst-class:: classref-method
  5341. :ref:`int<class_int>` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride>`
  5342. Returns the stride of the combined normals and tangents for a mesh with given ``format``. Note importantly that, while normals and tangents are in the vertex buffer with vertices, they are only interleaved with each other and so have a different stride than vertex positions.
  5343. .. rst-class:: classref-item-separator
  5344. ----
  5345. .. _class_RenderingServer_method_mesh_surface_get_format_offset:
  5346. .. rst-class:: classref-method
  5347. :ref:`int<class_int>` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`, array_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_offset>`
  5348. Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer.
  5349. .. rst-class:: classref-item-separator
  5350. ----
  5351. .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
  5352. .. rst-class:: classref-method
  5353. :ref:`int<class_int>` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_skin_stride>`
  5354. Returns the stride of the skin buffer for a mesh with given ``format``.
  5355. .. rst-class:: classref-item-separator
  5356. ----
  5357. .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
  5358. .. rst-class:: classref-method
  5359. :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>`
  5360. Returns the stride of the vertex positions for a mesh with given ``format``. Note importantly that vertex positions are stored consecutively and are not interleaved with the other attributes in the vertex buffer (normals and tangents).
  5361. .. rst-class:: classref-item-separator
  5362. ----
  5363. .. _class_RenderingServer_method_mesh_surface_get_material:
  5364. .. rst-class:: classref-method
  5365. :ref:`RID<class_RID>` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_material>`
  5366. Returns a mesh's surface's material.
  5367. .. rst-class:: classref-item-separator
  5368. ----
  5369. .. _class_RenderingServer_method_mesh_surface_remove:
  5370. .. rst-class:: classref-method
  5371. |void| **mesh_surface_remove**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_remove>`
  5372. Removes the surface at the given index from the Mesh, shifting surfaces with higher index down by one.
  5373. .. rst-class:: classref-item-separator
  5374. ----
  5375. .. _class_RenderingServer_method_mesh_surface_set_material:
  5376. .. rst-class:: classref-method
  5377. |void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_set_material>`
  5378. Sets a mesh's surface's material.
  5379. .. rst-class:: classref-item-separator
  5380. ----
  5381. .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
  5382. .. rst-class:: classref-method
  5383. |void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_attribute_region>`
  5384. .. container:: contribute
  5385. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5386. .. rst-class:: classref-item-separator
  5387. ----
  5388. .. _class_RenderingServer_method_mesh_surface_update_skin_region:
  5389. .. rst-class:: classref-method
  5390. |void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_skin_region>`
  5391. .. container:: contribute
  5392. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5393. .. rst-class:: classref-item-separator
  5394. ----
  5395. .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
  5396. .. rst-class:: classref-method
  5397. |void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_vertex_region>`
  5398. .. container:: contribute
  5399. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5400. .. rst-class:: classref-item-separator
  5401. ----
  5402. .. _class_RenderingServer_method_multimesh_allocate_data:
  5403. .. rst-class:: classref-method
  5404. |void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false, use_indirect\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_multimesh_allocate_data>`
  5405. .. container:: contribute
  5406. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5407. .. rst-class:: classref-item-separator
  5408. ----
  5409. .. _class_RenderingServer_method_multimesh_create:
  5410. .. rst-class:: classref-method
  5411. :ref:`RID<class_RID>` **multimesh_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_multimesh_create>`
  5412. Creates a new multimesh on the RenderingServer and returns an :ref:`RID<class_RID>` handle. This RID will be used in all ``multimesh_*`` RenderingServer functions.
  5413. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5414. To place in a scene, attach this multimesh to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  5415. \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
  5416. .. rst-class:: classref-item-separator
  5417. ----
  5418. .. _class_RenderingServer_method_multimesh_get_aabb:
  5419. .. rst-class:: classref-method
  5420. :ref:`AABB<class_AABB>` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_aabb>`
  5421. Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
  5422. .. rst-class:: classref-item-separator
  5423. ----
  5424. .. _class_RenderingServer_method_multimesh_get_buffer:
  5425. .. rst-class:: classref-method
  5426. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_buffer>`
  5427. Returns the MultiMesh data (such as instance transforms, colors, etc.). See :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` for details on the returned data.
  5428. \ **Note:** If the buffer is in the engine's internal cache, it will have to be fetched from GPU memory and possibly decompressed. This means :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>` is potentially a slow operation and should be avoided whenever possible.
  5429. .. rst-class:: classref-item-separator
  5430. ----
  5431. .. _class_RenderingServer_method_multimesh_get_buffer_rd_rid:
  5432. .. rst-class:: classref-method
  5433. :ref:`RID<class_RID>` **multimesh_get_buffer_rd_rid**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_buffer_rd_rid>`
  5434. Returns the :ref:`RenderingDevice<class_RenderingDevice>` :ref:`RID<class_RID>` handle of the :ref:`MultiMesh<class_MultiMesh>`, which can be used as any other buffer on the Rendering Device.
  5435. .. rst-class:: classref-item-separator
  5436. ----
  5437. .. _class_RenderingServer_method_multimesh_get_command_buffer_rd_rid:
  5438. .. rst-class:: classref-method
  5439. :ref:`RID<class_RID>` **multimesh_get_command_buffer_rd_rid**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_command_buffer_rd_rid>`
  5440. Returns the :ref:`RenderingDevice<class_RenderingDevice>` :ref:`RID<class_RID>` handle of the :ref:`MultiMesh<class_MultiMesh>` command buffer. This :ref:`RID<class_RID>` is only valid if ``use_indirect`` is set to ``true`` when allocating data through :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>`. It can be used to directly modify the instance count via buffer.
  5441. The data structure is dependent on both how many surfaces the mesh contains and whether it is indexed or not, the buffer has 5 integers in it, with the last unused if the mesh is not indexed.
  5442. Each of the values in the buffer correspond to these options:
  5443. .. code:: text
  5444. Indexed:
  5445. 0 - indexCount;
  5446. 1 - instanceCount;
  5447. 2 - firstIndex;
  5448. 3 - vertexOffset;
  5449. 4 - firstInstance;
  5450. Non Indexed:
  5451. 0 - vertexCount;
  5452. 1 - instanceCount;
  5453. 2 - firstVertex;
  5454. 3 - firstInstance;
  5455. 4 - unused;
  5456. .. rst-class:: classref-item-separator
  5457. ----
  5458. .. _class_RenderingServer_method_multimesh_get_custom_aabb:
  5459. .. rst-class:: classref-method
  5460. :ref:`AABB<class_AABB>` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_custom_aabb>`
  5461. Returns the custom AABB defined for this MultiMesh resource.
  5462. .. rst-class:: classref-item-separator
  5463. ----
  5464. .. _class_RenderingServer_method_multimesh_get_instance_count:
  5465. .. rst-class:: classref-method
  5466. :ref:`int<class_int>` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_instance_count>`
  5467. Returns the number of instances allocated for this multimesh.
  5468. .. rst-class:: classref-item-separator
  5469. ----
  5470. .. _class_RenderingServer_method_multimesh_get_mesh:
  5471. .. rst-class:: classref-method
  5472. :ref:`RID<class_RID>` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_mesh>`
  5473. Returns the RID of the mesh that will be used in drawing this multimesh.
  5474. .. rst-class:: classref-item-separator
  5475. ----
  5476. .. _class_RenderingServer_method_multimesh_get_visible_instances:
  5477. .. rst-class:: classref-method
  5478. :ref:`int<class_int>` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_visible_instances>`
  5479. Returns the number of visible instances for this multimesh.
  5480. .. rst-class:: classref-item-separator
  5481. ----
  5482. .. _class_RenderingServer_method_multimesh_instance_get_color:
  5483. .. rst-class:: classref-method
  5484. :ref:`Color<class_Color>` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_color>`
  5485. Returns the color by which the specified instance will be modulated.
  5486. .. rst-class:: classref-item-separator
  5487. ----
  5488. .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
  5489. .. rst-class:: classref-method
  5490. :ref:`Color<class_Color>` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_custom_data>`
  5491. Returns the custom data associated with the specified instance.
  5492. .. rst-class:: classref-item-separator
  5493. ----
  5494. .. _class_RenderingServer_method_multimesh_instance_get_transform:
  5495. .. rst-class:: classref-method
  5496. :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_transform>`
  5497. Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
  5498. .. rst-class:: classref-item-separator
  5499. ----
  5500. .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
  5501. .. rst-class:: classref-method
  5502. :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_transform_2d>`
  5503. Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
  5504. .. rst-class:: classref-item-separator
  5505. ----
  5506. .. _class_RenderingServer_method_multimesh_instance_reset_physics_interpolation:
  5507. .. rst-class:: classref-method
  5508. |void| **multimesh_instance_reset_physics_interpolation**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_reset_physics_interpolation>`
  5509. Prevents physics interpolation for the specified instance during the current physics tick.
  5510. This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location.
  5511. .. rst-class:: classref-item-separator
  5512. ----
  5513. .. _class_RenderingServer_method_multimesh_instance_set_color:
  5514. .. rst-class:: classref-method
  5515. |void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_color>`
  5516. Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
  5517. .. rst-class:: classref-item-separator
  5518. ----
  5519. .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
  5520. .. rst-class:: classref-method
  5521. |void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, custom_data\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_custom_data>`
  5522. Sets the custom data for this instance. Custom data is passed as a :ref:`Color<class_Color>`, but is interpreted as a ``vec4`` in the shader. Equivalent to :ref:`MultiMesh.set_instance_custom_data<class_MultiMesh_method_set_instance_custom_data>`.
  5523. .. rst-class:: classref-item-separator
  5524. ----
  5525. .. _class_RenderingServer_method_multimesh_instance_set_transform:
  5526. .. rst-class:: classref-method
  5527. |void| **multimesh_instance_set_transform**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_transform>`
  5528. Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
  5529. .. rst-class:: classref-item-separator
  5530. ----
  5531. .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
  5532. .. rst-class:: classref-method
  5533. |void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_transform_2d>`
  5534. Sets the :ref:`Transform2D<class_Transform2D>` for this instance. For use when multimesh is used in 2D. Equivalent to :ref:`MultiMesh.set_instance_transform_2d<class_MultiMesh_method_set_instance_transform_2d>`.
  5535. .. rst-class:: classref-item-separator
  5536. ----
  5537. .. _class_RenderingServer_method_multimesh_set_buffer:
  5538. .. rst-class:: classref-method
  5539. |void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_buffer>`
  5540. Set the entire data to use for drawing the ``multimesh`` at once to ``buffer`` (such as instance transforms and colors). ``buffer``'s size must match the number of instances multiplied by the per-instance data size (which depends on the enabled MultiMesh fields). Otherwise, an error message is printed and nothing is rendered. See also :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>`.
  5541. The per-instance data size and expected data order is:
  5542. .. code:: text
  5543. 2D:
  5544. - Position: 8 floats (8 floats for Transform2D)
  5545. - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
  5546. - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
  5547. - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
  5548. 3D:
  5549. - Position: 12 floats (12 floats for Transform3D)
  5550. - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
  5551. - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
  5552. - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
  5553. Instance transforms are in row-major order. Specifically:
  5554. - For :ref:`Transform2D<class_Transform2D>` the float-order is: ``(x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y)``.
  5555. - For :ref:`Transform3D<class_Transform3D>` the float-order is: ``(basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z)``.
  5556. .. rst-class:: classref-item-separator
  5557. ----
  5558. .. _class_RenderingServer_method_multimesh_set_buffer_interpolated:
  5559. .. rst-class:: classref-method
  5560. |void| **multimesh_set_buffer_interpolated**\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, buffer_previous\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_buffer_interpolated>`
  5561. Alternative version of :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` for use with physics interpolation.
  5562. Takes both an array of current data and an array of data for the previous physics tick.
  5563. .. rst-class:: classref-item-separator
  5564. ----
  5565. .. _class_RenderingServer_method_multimesh_set_custom_aabb:
  5566. .. rst-class:: classref-method
  5567. |void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_custom_aabb>`
  5568. Sets the custom AABB for this MultiMesh resource.
  5569. .. rst-class:: classref-item-separator
  5570. ----
  5571. .. _class_RenderingServer_method_multimesh_set_mesh:
  5572. .. rst-class:: classref-method
  5573. |void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_mesh>`
  5574. Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
  5575. .. rst-class:: classref-item-separator
  5576. ----
  5577. .. _class_RenderingServer_method_multimesh_set_physics_interpolated:
  5578. .. rst-class:: classref-method
  5579. |void| **multimesh_set_physics_interpolated**\ (\ multimesh\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_physics_interpolated>`
  5580. Turns on and off physics interpolation for this MultiMesh resource.
  5581. .. rst-class:: classref-item-separator
  5582. ----
  5583. .. _class_RenderingServer_method_multimesh_set_physics_interpolation_quality:
  5584. .. rst-class:: classref-method
  5585. |void| **multimesh_set_physics_interpolation_quality**\ (\ multimesh\: :ref:`RID<class_RID>`, quality\: :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_physics_interpolation_quality>`
  5586. Sets the physics interpolation quality for the :ref:`MultiMesh<class_MultiMesh>`.
  5587. A value of :ref:`MULTIMESH_INTERP_QUALITY_FAST<class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_FAST>` gives fast but low quality interpolation, a value of :ref:`MULTIMESH_INTERP_QUALITY_HIGH<class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_HIGH>` gives slower but higher quality interpolation.
  5588. .. rst-class:: classref-item-separator
  5589. ----
  5590. .. _class_RenderingServer_method_multimesh_set_visible_instances:
  5591. .. rst-class:: classref-method
  5592. |void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_visible_instances>`
  5593. Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to :ref:`MultiMesh.visible_instance_count<class_MultiMesh_property_visible_instance_count>`.
  5594. .. rst-class:: classref-item-separator
  5595. ----
  5596. .. _class_RenderingServer_method_occluder_create:
  5597. .. rst-class:: classref-method
  5598. :ref:`RID<class_RID>` **occluder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_occluder_create>`
  5599. Creates an occluder instance and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``occluder_*`` RenderingServer functions.
  5600. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5601. \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
  5602. .. rst-class:: classref-item-separator
  5603. ----
  5604. .. _class_RenderingServer_method_occluder_set_mesh:
  5605. .. rst-class:: classref-method
  5606. |void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_occluder_set_mesh>`
  5607. Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
  5608. .. rst-class:: classref-item-separator
  5609. ----
  5610. .. _class_RenderingServer_method_omni_light_create:
  5611. .. rst-class:: classref-method
  5612. :ref:`RID<class_RID>` **omni_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_omni_light_create>`
  5613. Creates a new omni light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
  5614. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5615. To place in a scene, attach this omni light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  5616. \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
  5617. .. rst-class:: classref-item-separator
  5618. ----
  5619. .. _class_RenderingServer_method_particles_collision_create:
  5620. .. rst-class:: classref-method
  5621. :ref:`RID<class_RID>` **particles_collision_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_create>`
  5622. Creates a new 3D GPU particle collision or attractor and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``particles_collision_*`` RenderingServer functions.
  5623. \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
  5624. .. rst-class:: classref-item-separator
  5625. ----
  5626. .. _class_RenderingServer_method_particles_collision_height_field_update:
  5627. .. rst-class:: classref-method
  5628. |void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_height_field_update>`
  5629. Requests an update for the 3D GPU particle collision heightfield. This may be automatically called by the 3D GPU particle collision heightfield depending on its :ref:`GPUParticlesCollisionHeightField3D.update_mode<class_GPUParticlesCollisionHeightField3D_property_update_mode>`.
  5630. .. rst-class:: classref-item-separator
  5631. ----
  5632. .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
  5633. .. rst-class:: classref-method
  5634. |void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_attenuation>`
  5635. Sets the attenuation ``curve`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.attenuation<class_GPUParticlesAttractor3D_property_attenuation>`.
  5636. .. rst-class:: classref-item-separator
  5637. ----
  5638. .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
  5639. .. rst-class:: classref-method
  5640. |void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_directionality>`
  5641. Sets the directionality ``amount`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.directionality<class_GPUParticlesAttractor3D_property_directionality>`.
  5642. .. rst-class:: classref-item-separator
  5643. ----
  5644. .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
  5645. .. rst-class:: classref-method
  5646. |void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_strength>`
  5647. Sets the ``strength`` for the 3D GPU particles attractor specified by the ``particles_collision`` RID. Only used for attractors, not colliders. Equivalent to :ref:`GPUParticlesAttractor3D.strength<class_GPUParticlesAttractor3D_property_strength>`.
  5648. .. rst-class:: classref-item-separator
  5649. ----
  5650. .. _class_RenderingServer_method_particles_collision_set_box_extents:
  5651. .. rst-class:: classref-method
  5652. |void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID<class_RID>`, extents\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_box_extents>`
  5653. Sets the ``extents`` for the 3D GPU particles collision by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionBox3D.size<class_GPUParticlesCollisionBox3D_property_size>`, :ref:`GPUParticlesCollisionSDF3D.size<class_GPUParticlesCollisionSDF3D_property_size>`, :ref:`GPUParticlesCollisionHeightField3D.size<class_GPUParticlesCollisionHeightField3D_property_size>`, :ref:`GPUParticlesAttractorBox3D.size<class_GPUParticlesAttractorBox3D_property_size>` or :ref:`GPUParticlesAttractorVectorField3D.size<class_GPUParticlesAttractorVectorField3D_property_size>` depending on the ``particles_collision`` type.
  5654. .. rst-class:: classref-item-separator
  5655. ----
  5656. .. _class_RenderingServer_method_particles_collision_set_collision_type:
  5657. .. rst-class:: classref-method
  5658. |void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID<class_RID>`, type\: :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_collision_type>`
  5659. Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
  5660. .. rst-class:: classref-item-separator
  5661. ----
  5662. .. _class_RenderingServer_method_particles_collision_set_cull_mask:
  5663. .. rst-class:: classref-method
  5664. |void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_cull_mask>`
  5665. Sets the cull ``mask`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollision3D.cull_mask<class_GPUParticlesCollision3D_property_cull_mask>` or :ref:`GPUParticlesAttractor3D.cull_mask<class_GPUParticlesAttractor3D_property_cull_mask>` depending on the ``particles_collision`` type.
  5666. .. rst-class:: classref-item-separator
  5667. ----
  5668. .. _class_RenderingServer_method_particles_collision_set_field_texture:
  5669. .. rst-class:: classref-method
  5670. |void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_field_texture>`
  5671. Sets the signed distance field ``texture`` for the 3D GPU particles collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSDF3D.texture<class_GPUParticlesCollisionSDF3D_property_texture>` or :ref:`GPUParticlesAttractorVectorField3D.texture<class_GPUParticlesAttractorVectorField3D_property_texture>` depending on the ``particles_collision`` type.
  5672. .. rst-class:: classref-item-separator
  5673. ----
  5674. .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
  5675. .. rst-class:: classref-method
  5676. |void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID<class_RID>`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_height_field_resolution>`
  5677. Sets the heightmap ``resolution`` for the 3D GPU particles heightfield collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionHeightField3D.resolution<class_GPUParticlesCollisionHeightField3D_property_resolution>`.
  5678. .. rst-class:: classref-item-separator
  5679. ----
  5680. .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
  5681. .. rst-class:: classref-method
  5682. |void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_sphere_radius>`
  5683. Sets the ``radius`` for the 3D GPU particles sphere collision or attractor specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionSphere3D.radius<class_GPUParticlesCollisionSphere3D_property_radius>` or :ref:`GPUParticlesAttractorSphere3D.radius<class_GPUParticlesAttractorSphere3D_property_radius>` depending on the ``particles_collision`` type.
  5684. .. rst-class:: classref-item-separator
  5685. ----
  5686. .. _class_RenderingServer_method_particles_create:
  5687. .. rst-class:: classref-method
  5688. :ref:`RID<class_RID>` **particles_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_particles_create>`
  5689. Creates a GPU-based particle system and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``particles_*`` RenderingServer functions.
  5690. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5691. To place in a scene, attach these particles to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  5692. \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
  5693. \ **Note:** All ``particles_*`` methods only apply to GPU-based particles, not CPU-based particles. :ref:`CPUParticles2D<class_CPUParticles2D>` and :ref:`CPUParticles3D<class_CPUParticles3D>` do not have equivalent RenderingServer functions available, as these use :ref:`MultiMeshInstance2D<class_MultiMeshInstance2D>` and :ref:`MultiMeshInstance3D<class_MultiMeshInstance3D>` under the hood (see ``multimesh_*`` methods).
  5694. .. rst-class:: classref-item-separator
  5695. ----
  5696. .. _class_RenderingServer_method_particles_emit:
  5697. .. rst-class:: classref-method
  5698. |void| **particles_emit**\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, emit_flags\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_emit>`
  5699. Manually emits particles from the ``particles`` instance.
  5700. .. rst-class:: classref-item-separator
  5701. ----
  5702. .. _class_RenderingServer_method_particles_get_current_aabb:
  5703. .. rst-class:: classref-method
  5704. :ref:`AABB<class_AABB>` **particles_get_current_aabb**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_get_current_aabb>`
  5705. Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
  5706. .. rst-class:: classref-item-separator
  5707. ----
  5708. .. _class_RenderingServer_method_particles_get_emitting:
  5709. .. rst-class:: classref-method
  5710. :ref:`bool<class_bool>` **particles_get_emitting**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_get_emitting>`
  5711. Returns ``true`` if particles are currently set to emitting.
  5712. .. rst-class:: classref-item-separator
  5713. ----
  5714. .. _class_RenderingServer_method_particles_is_inactive:
  5715. .. rst-class:: classref-method
  5716. :ref:`bool<class_bool>` **particles_is_inactive**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_is_inactive>`
  5717. Returns ``true`` if particles are not emitting and particles are set to inactive.
  5718. .. rst-class:: classref-item-separator
  5719. ----
  5720. .. _class_RenderingServer_method_particles_request_process:
  5721. .. rst-class:: classref-method
  5722. |void| **particles_request_process**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_request_process>`
  5723. Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`, :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`, or :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`.
  5724. .. rst-class:: classref-item-separator
  5725. ----
  5726. .. _class_RenderingServer_method_particles_request_process_time:
  5727. .. rst-class:: classref-method
  5728. |void| **particles_request_process_time**\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_request_process_time>`
  5729. Requests particles to process for extra process time during a single frame.
  5730. .. rst-class:: classref-item-separator
  5731. ----
  5732. .. _class_RenderingServer_method_particles_restart:
  5733. .. rst-class:: classref-method
  5734. |void| **particles_restart**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_restart>`
  5735. Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
  5736. .. rst-class:: classref-item-separator
  5737. ----
  5738. .. _class_RenderingServer_method_particles_set_amount:
  5739. .. rst-class:: classref-method
  5740. |void| **particles_set_amount**\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_amount>`
  5741. Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
  5742. .. rst-class:: classref-item-separator
  5743. ----
  5744. .. _class_RenderingServer_method_particles_set_amount_ratio:
  5745. .. rst-class:: classref-method
  5746. |void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_amount_ratio>`
  5747. Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio<class_GPUParticles3D_property_amount_ratio>`.
  5748. .. rst-class:: classref-item-separator
  5749. ----
  5750. .. _class_RenderingServer_method_particles_set_collision_base_size:
  5751. .. rst-class:: classref-method
  5752. |void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_collision_base_size>`
  5753. .. container:: contribute
  5754. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5755. .. rst-class:: classref-item-separator
  5756. ----
  5757. .. _class_RenderingServer_method_particles_set_custom_aabb:
  5758. .. rst-class:: classref-method
  5759. |void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_custom_aabb>`
  5760. Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  5761. .. rst-class:: classref-item-separator
  5762. ----
  5763. .. _class_RenderingServer_method_particles_set_draw_order:
  5764. .. rst-class:: classref-method
  5765. |void| **particles_set_draw_order**\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_order>`
  5766. Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`. See :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` for options. Equivalent to :ref:`GPUParticles3D.draw_order<class_GPUParticles3D_property_draw_order>`.
  5767. .. rst-class:: classref-item-separator
  5768. ----
  5769. .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
  5770. .. rst-class:: classref-method
  5771. |void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID<class_RID>`, pass\: :ref:`int<class_int>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_pass_mesh>`
  5772. Sets the mesh to be used for the specified draw pass. Equivalent to :ref:`GPUParticles3D.draw_pass_1<class_GPUParticles3D_property_draw_pass_1>`, :ref:`GPUParticles3D.draw_pass_2<class_GPUParticles3D_property_draw_pass_2>`, :ref:`GPUParticles3D.draw_pass_3<class_GPUParticles3D_property_draw_pass_3>`, and :ref:`GPUParticles3D.draw_pass_4<class_GPUParticles3D_property_draw_pass_4>`.
  5773. .. rst-class:: classref-item-separator
  5774. ----
  5775. .. _class_RenderingServer_method_particles_set_draw_passes:
  5776. .. rst-class:: classref-method
  5777. |void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_passes>`
  5778. Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
  5779. .. rst-class:: classref-item-separator
  5780. ----
  5781. .. _class_RenderingServer_method_particles_set_emission_transform:
  5782. .. rst-class:: classref-method
  5783. |void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emission_transform>`
  5784. Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
  5785. .. rst-class:: classref-item-separator
  5786. ----
  5787. .. _class_RenderingServer_method_particles_set_emitter_velocity:
  5788. .. rst-class:: classref-method
  5789. |void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emitter_velocity>`
  5790. Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`.
  5791. .. rst-class:: classref-item-separator
  5792. ----
  5793. .. _class_RenderingServer_method_particles_set_emitting:
  5794. .. rst-class:: classref-method
  5795. |void| **particles_set_emitting**\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emitting>`
  5796. If ``true``, particles will emit over time. Setting to ``false`` does not reset the particles, but only stops their emission. Equivalent to :ref:`GPUParticles3D.emitting<class_GPUParticles3D_property_emitting>`.
  5797. .. rst-class:: classref-item-separator
  5798. ----
  5799. .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
  5800. .. rst-class:: classref-method
  5801. |void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_explosiveness_ratio>`
  5802. Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
  5803. .. rst-class:: classref-item-separator
  5804. ----
  5805. .. _class_RenderingServer_method_particles_set_fixed_fps:
  5806. .. rst-class:: classref-method
  5807. |void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_fixed_fps>`
  5808. Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
  5809. .. rst-class:: classref-item-separator
  5810. ----
  5811. .. _class_RenderingServer_method_particles_set_fractional_delta:
  5812. .. rst-class:: classref-method
  5813. |void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_fractional_delta>`
  5814. If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
  5815. .. rst-class:: classref-item-separator
  5816. ----
  5817. .. _class_RenderingServer_method_particles_set_interp_to_end:
  5818. .. rst-class:: classref-method
  5819. |void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID<class_RID>`, factor\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_interp_to_end>`
  5820. Sets the value that informs a :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>` to rush all particles towards the end of their lifetime.
  5821. .. rst-class:: classref-item-separator
  5822. ----
  5823. .. _class_RenderingServer_method_particles_set_interpolate:
  5824. .. rst-class:: classref-method
  5825. |void| **particles_set_interpolate**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_interpolate>`
  5826. .. container:: contribute
  5827. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5828. .. rst-class:: classref-item-separator
  5829. ----
  5830. .. _class_RenderingServer_method_particles_set_lifetime:
  5831. .. rst-class:: classref-method
  5832. |void| **particles_set_lifetime**\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_lifetime>`
  5833. Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
  5834. .. rst-class:: classref-item-separator
  5835. ----
  5836. .. _class_RenderingServer_method_particles_set_mode:
  5837. .. rst-class:: classref-method
  5838. |void| **particles_set_mode**\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_mode>`
  5839. Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
  5840. .. rst-class:: classref-item-separator
  5841. ----
  5842. .. _class_RenderingServer_method_particles_set_one_shot:
  5843. .. rst-class:: classref-method
  5844. |void| **particles_set_one_shot**\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_one_shot>`
  5845. If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
  5846. .. rst-class:: classref-item-separator
  5847. ----
  5848. .. _class_RenderingServer_method_particles_set_pre_process_time:
  5849. .. rst-class:: classref-method
  5850. |void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_pre_process_time>`
  5851. Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to :ref:`GPUParticles3D.preprocess<class_GPUParticles3D_property_preprocess>`.
  5852. .. rst-class:: classref-item-separator
  5853. ----
  5854. .. _class_RenderingServer_method_particles_set_process_material:
  5855. .. rst-class:: classref-method
  5856. |void| **particles_set_process_material**\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_process_material>`
  5857. Sets the material for processing the particles.
  5858. \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
  5859. .. rst-class:: classref-item-separator
  5860. ----
  5861. .. _class_RenderingServer_method_particles_set_randomness_ratio:
  5862. .. rst-class:: classref-method
  5863. |void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_randomness_ratio>`
  5864. Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
  5865. .. rst-class:: classref-item-separator
  5866. ----
  5867. .. _class_RenderingServer_method_particles_set_speed_scale:
  5868. .. rst-class:: classref-method
  5869. |void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_speed_scale>`
  5870. Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
  5871. .. rst-class:: classref-item-separator
  5872. ----
  5873. .. _class_RenderingServer_method_particles_set_subemitter:
  5874. .. rst-class:: classref-method
  5875. |void| **particles_set_subemitter**\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_subemitter>`
  5876. .. container:: contribute
  5877. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5878. .. rst-class:: classref-item-separator
  5879. ----
  5880. .. _class_RenderingServer_method_particles_set_trail_bind_poses:
  5881. .. rst-class:: classref-method
  5882. |void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID<class_RID>`, bind_poses\: :ref:`Array<class_Array>`\[:ref:`Transform3D<class_Transform3D>`\]\ ) :ref:`🔗<class_RenderingServer_method_particles_set_trail_bind_poses>`
  5883. .. container:: contribute
  5884. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5885. .. rst-class:: classref-item-separator
  5886. ----
  5887. .. _class_RenderingServer_method_particles_set_trails:
  5888. .. rst-class:: classref-method
  5889. |void| **particles_set_trails**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, length_sec\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_trails>`
  5890. If ``enable`` is ``true``, enables trails for the ``particles`` with the specified ``length_sec`` in seconds. Equivalent to :ref:`GPUParticles3D.trail_enabled<class_GPUParticles3D_property_trail_enabled>` and :ref:`GPUParticles3D.trail_lifetime<class_GPUParticles3D_property_trail_lifetime>`.
  5891. .. rst-class:: classref-item-separator
  5892. ----
  5893. .. _class_RenderingServer_method_particles_set_transform_align:
  5894. .. rst-class:: classref-method
  5895. |void| **particles_set_transform_align**\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_transform_align>`
  5896. .. container:: contribute
  5897. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5898. .. rst-class:: classref-item-separator
  5899. ----
  5900. .. _class_RenderingServer_method_particles_set_use_local_coordinates:
  5901. .. rst-class:: classref-method
  5902. |void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_use_local_coordinates>`
  5903. If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
  5904. .. rst-class:: classref-item-separator
  5905. ----
  5906. .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
  5907. .. rst-class:: classref-method
  5908. |void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`🔗<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`
  5909. Sets the filter quality for omni and spot light shadows in 3D. See also :ref:`ProjectSettings.rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality<class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality>`. This parameter is global and cannot be set on a per-viewport basis.
  5910. .. rst-class:: classref-item-separator
  5911. ----
  5912. .. _class_RenderingServer_method_reflection_probe_create:
  5913. .. rst-class:: classref-method
  5914. :ref:`RID<class_RID>` **reflection_probe_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_create>`
  5915. Creates a reflection probe and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``reflection_probe_*`` RenderingServer functions.
  5916. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  5917. To place in a scene, attach this reflection probe to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  5918. \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
  5919. .. rst-class:: classref-item-separator
  5920. ----
  5921. .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
  5922. .. rst-class:: classref-method
  5923. |void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_color>`
  5924. Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
  5925. .. rst-class:: classref-item-separator
  5926. ----
  5927. .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
  5928. .. rst-class:: classref-method
  5929. |void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_energy>`
  5930. Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
  5931. .. rst-class:: classref-item-separator
  5932. ----
  5933. .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
  5934. .. rst-class:: classref-method
  5935. |void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_mode>`
  5936. Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
  5937. .. rst-class:: classref-item-separator
  5938. ----
  5939. .. _class_RenderingServer_method_reflection_probe_set_as_interior:
  5940. .. rst-class:: classref-method
  5941. |void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_as_interior>`
  5942. If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
  5943. .. rst-class:: classref-item-separator
  5944. ----
  5945. .. _class_RenderingServer_method_reflection_probe_set_blend_distance:
  5946. .. rst-class:: classref-method
  5947. |void| **reflection_probe_set_blend_distance**\ (\ probe\: :ref:`RID<class_RID>`, blend_distance\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_blend_distance>`
  5948. Sets the distance in meters over which a probe blends into the scene.
  5949. .. rst-class:: classref-item-separator
  5950. ----
  5951. .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
  5952. .. rst-class:: classref-method
  5953. |void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_cull_mask>`
  5954. Sets the render cull mask for this reflection probe. Only instances with a matching layer will be reflected by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
  5955. .. rst-class:: classref-item-separator
  5956. ----
  5957. .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
  5958. .. rst-class:: classref-method
  5959. |void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_enable_box_projection>`
  5960. If ``true``, uses box projection. This can make reflections look more correct in certain situations. Equivalent to :ref:`ReflectionProbe.box_projection<class_ReflectionProbe_property_box_projection>`.
  5961. .. rst-class:: classref-item-separator
  5962. ----
  5963. .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
  5964. .. rst-class:: classref-method
  5965. |void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_enable_shadows>`
  5966. If ``true``, computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to :ref:`ReflectionProbe.enable_shadows<class_ReflectionProbe_property_enable_shadows>`.
  5967. .. rst-class:: classref-item-separator
  5968. ----
  5969. .. _class_RenderingServer_method_reflection_probe_set_intensity:
  5970. .. rst-class:: classref-method
  5971. |void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_intensity>`
  5972. Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
  5973. .. rst-class:: classref-item-separator
  5974. ----
  5975. .. _class_RenderingServer_method_reflection_probe_set_max_distance:
  5976. .. rst-class:: classref-method
  5977. |void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_max_distance>`
  5978. Sets the max distance away from the probe an object can be before it is culled. Equivalent to :ref:`ReflectionProbe.max_distance<class_ReflectionProbe_property_max_distance>`.
  5979. .. rst-class:: classref-item-separator
  5980. ----
  5981. .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
  5982. .. rst-class:: classref-method
  5983. |void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID<class_RID>`, pixels\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>`
  5984. Sets the mesh level of detail to use in the reflection probe rendering. Higher values will use less detailed versions of meshes that have LOD variations generated, which can improve performance. Equivalent to :ref:`ReflectionProbe.mesh_lod_threshold<class_ReflectionProbe_property_mesh_lod_threshold>`.
  5985. .. rst-class:: classref-item-separator
  5986. ----
  5987. .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
  5988. .. rst-class:: classref-method
  5989. |void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID<class_RID>`, offset\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_origin_offset>`
  5990. Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to :ref:`ReflectionProbe.origin_offset<class_ReflectionProbe_property_origin_offset>`.
  5991. .. rst-class:: classref-item-separator
  5992. ----
  5993. .. _class_RenderingServer_method_reflection_probe_set_reflection_mask:
  5994. .. rst-class:: classref-method
  5995. |void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_reflection_mask>`
  5996. Sets the render reflection mask for this reflection probe. Only instances with a matching layer will have reflections applied from this probe. Equivalent to :ref:`ReflectionProbe.reflection_mask<class_ReflectionProbe_property_reflection_mask>`.
  5997. .. rst-class:: classref-item-separator
  5998. ----
  5999. .. _class_RenderingServer_method_reflection_probe_set_resolution:
  6000. .. rst-class:: classref-method
  6001. |void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_resolution>`
  6002. Sets the resolution to use when rendering the specified reflection probe. The ``resolution`` is specified for each cubemap face: for instance, specifying ``512`` will allocate 6 faces of 512×512 each (plus mipmaps for roughness levels).
  6003. .. rst-class:: classref-item-separator
  6004. ----
  6005. .. _class_RenderingServer_method_reflection_probe_set_size:
  6006. .. rst-class:: classref-method
  6007. |void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_size>`
  6008. Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
  6009. .. rst-class:: classref-item-separator
  6010. ----
  6011. .. _class_RenderingServer_method_reflection_probe_set_update_mode:
  6012. .. rst-class:: classref-method
  6013. |void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_update_mode>`
  6014. Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
  6015. .. rst-class:: classref-item-separator
  6016. ----
  6017. .. _class_RenderingServer_method_request_frame_drawn_callback:
  6018. .. rst-class:: classref-method
  6019. |void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_request_frame_drawn_callback>`
  6020. Schedules a callback to the given callable after a frame has been drawn.
  6021. .. rst-class:: classref-item-separator
  6022. ----
  6023. .. _class_RenderingServer_method_scenario_create:
  6024. .. rst-class:: classref-method
  6025. :ref:`RID<class_RID>` **scenario_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_scenario_create>`
  6026. Creates a scenario and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``scenario_*`` RenderingServer functions.
  6027. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6028. The scenario is the 3D world that all the visual instances exist in.
  6029. .. rst-class:: classref-item-separator
  6030. ----
  6031. .. _class_RenderingServer_method_scenario_set_camera_attributes:
  6032. .. rst-class:: classref-method
  6033. |void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_camera_attributes>`
  6034. Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
  6035. .. rst-class:: classref-item-separator
  6036. ----
  6037. .. _class_RenderingServer_method_scenario_set_compositor:
  6038. .. rst-class:: classref-method
  6039. |void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_compositor>`
  6040. Sets the compositor (``compositor``) that will be used with this scenario. See also :ref:`Compositor<class_Compositor>`.
  6041. .. rst-class:: classref-item-separator
  6042. ----
  6043. .. _class_RenderingServer_method_scenario_set_environment:
  6044. .. rst-class:: classref-method
  6045. |void| **scenario_set_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_environment>`
  6046. Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
  6047. .. rst-class:: classref-item-separator
  6048. ----
  6049. .. _class_RenderingServer_method_scenario_set_fallback_environment:
  6050. .. rst-class:: classref-method
  6051. |void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_fallback_environment>`
  6052. Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment.
  6053. .. rst-class:: classref-item-separator
  6054. ----
  6055. .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
  6056. .. rst-class:: classref-method
  6057. |void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool<class_bool>`, amount\: :ref:`float<class_float>`, limit\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_screen_space_roughness_limiter_set_active>`
  6058. Sets the screen-space roughness limiter parameters, such as whether it should be enabled and its thresholds. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/enabled<class_ProjectSettings_property_rendering/anti_aliasing/screen_space_roughness_limiter/enabled>`, :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/amount<class_ProjectSettings_property_rendering/anti_aliasing/screen_space_roughness_limiter/amount>` and :ref:`ProjectSettings.rendering/anti_aliasing/screen_space_roughness_limiter/limit<class_ProjectSettings_property_rendering/anti_aliasing/screen_space_roughness_limiter/limit>`.
  6059. .. rst-class:: classref-item-separator
  6060. ----
  6061. .. _class_RenderingServer_method_set_boot_image:
  6062. .. rst-class:: classref-method
  6063. |void| **set_boot_image**\ (\ image\: :ref:`Image<class_Image>`, color\: :ref:`Color<class_Color>`, scale\: :ref:`bool<class_bool>`, use_filter\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_RenderingServer_method_set_boot_image>`
  6064. Sets a boot image. The color defines the background color. If ``scale`` is ``true``, the image will be scaled to fit the screen size. If ``use_filter`` is ``true``, the image will be scaled with linear interpolation. If ``use_filter`` is ``false``, the image will be scaled with nearest-neighbor interpolation.
  6065. .. rst-class:: classref-item-separator
  6066. ----
  6067. .. _class_RenderingServer_method_set_debug_generate_wireframes:
  6068. .. rst-class:: classref-method
  6069. |void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_set_debug_generate_wireframes>`
  6070. If ``generate`` is ``true``, generates debug wireframes for all meshes that are loaded when using the Compatibility renderer. By default, the engine does not generate debug wireframes at runtime, since they slow down loading of assets and take up VRAM.
  6071. \ **Note:** You must call this method before loading any meshes when using the Compatibility renderer, otherwise wireframes will not be used.
  6072. .. rst-class:: classref-item-separator
  6073. ----
  6074. .. _class_RenderingServer_method_set_default_clear_color:
  6075. .. rst-class:: classref-method
  6076. |void| **set_default_clear_color**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_set_default_clear_color>`
  6077. Sets the default clear color which is used when a specific clear color has not been selected. See also :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>`.
  6078. .. rst-class:: classref-item-separator
  6079. ----
  6080. .. _class_RenderingServer_method_shader_create:
  6081. .. rst-class:: classref-method
  6082. :ref:`RID<class_RID>` **shader_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_shader_create>`
  6083. Creates an empty shader and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``shader_*`` RenderingServer functions.
  6084. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6085. \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
  6086. .. rst-class:: classref-item-separator
  6087. ----
  6088. .. _class_RenderingServer_method_shader_get_code:
  6089. .. rst-class:: classref-method
  6090. :ref:`String<class_String>` **shader_get_code**\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_code>`
  6091. Returns a shader's source code as a string.
  6092. .. rst-class:: classref-item-separator
  6093. ----
  6094. .. _class_RenderingServer_method_shader_get_default_texture_parameter:
  6095. .. rst-class:: classref-method
  6096. :ref:`RID<class_RID>` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, index\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_default_texture_parameter>`
  6097. Returns a default texture from a shader searched by name.
  6098. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  6099. .. rst-class:: classref-item-separator
  6100. ----
  6101. .. _class_RenderingServer_method_shader_get_parameter_default:
  6102. .. rst-class:: classref-method
  6103. :ref:`Variant<class_Variant>` **shader_get_parameter_default**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_parameter_default>`
  6104. Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
  6105. .. rst-class:: classref-item-separator
  6106. ----
  6107. .. _class_RenderingServer_method_shader_set_code:
  6108. .. rst-class:: classref-method
  6109. |void| **shader_set_code**\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_shader_set_code>`
  6110. Sets the shader's source code (which triggers recompilation after being changed).
  6111. .. rst-class:: classref-item-separator
  6112. ----
  6113. .. _class_RenderingServer_method_shader_set_default_texture_parameter:
  6114. .. rst-class:: classref-method
  6115. |void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, texture\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_shader_set_default_texture_parameter>`
  6116. Sets a shader's default texture. Overwrites the texture given by name.
  6117. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  6118. .. rst-class:: classref-item-separator
  6119. ----
  6120. .. _class_RenderingServer_method_shader_set_path_hint:
  6121. .. rst-class:: classref-method
  6122. |void| **shader_set_path_hint**\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_shader_set_path_hint>`
  6123. Sets the path hint for the specified shader. This should generally match the :ref:`Shader<class_Shader>` resource's :ref:`Resource.resource_path<class_Resource_property_resource_path>`.
  6124. .. rst-class:: classref-item-separator
  6125. ----
  6126. .. _class_RenderingServer_method_skeleton_allocate_data:
  6127. .. rst-class:: classref-method
  6128. |void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID<class_RID>`, bones\: :ref:`int<class_int>`, is_2d_skeleton\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_skeleton_allocate_data>`
  6129. .. container:: contribute
  6130. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6131. .. rst-class:: classref-item-separator
  6132. ----
  6133. .. _class_RenderingServer_method_skeleton_bone_get_transform:
  6134. .. rst-class:: classref-method
  6135. :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_bone_get_transform>`
  6136. Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
  6137. .. rst-class:: classref-item-separator
  6138. ----
  6139. .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
  6140. .. rst-class:: classref-method
  6141. :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_bone_get_transform_2d>`
  6142. Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
  6143. .. rst-class:: classref-item-separator
  6144. ----
  6145. .. _class_RenderingServer_method_skeleton_bone_set_transform:
  6146. .. rst-class:: classref-method
  6147. |void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_bone_set_transform>`
  6148. Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
  6149. .. rst-class:: classref-item-separator
  6150. ----
  6151. .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
  6152. .. rst-class:: classref-method
  6153. |void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_bone_set_transform_2d>`
  6154. Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
  6155. .. rst-class:: classref-item-separator
  6156. ----
  6157. .. _class_RenderingServer_method_skeleton_create:
  6158. .. rst-class:: classref-method
  6159. :ref:`RID<class_RID>` **skeleton_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_skeleton_create>`
  6160. Creates a skeleton and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``skeleton_*`` RenderingServer functions.
  6161. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6162. .. rst-class:: classref-item-separator
  6163. ----
  6164. .. _class_RenderingServer_method_skeleton_get_bone_count:
  6165. .. rst-class:: classref-method
  6166. :ref:`int<class_int>` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_get_bone_count>`
  6167. Returns the number of bones allocated for this skeleton.
  6168. .. rst-class:: classref-item-separator
  6169. ----
  6170. .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
  6171. .. rst-class:: classref-method
  6172. |void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, base_transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_set_base_transform_2d>`
  6173. .. container:: contribute
  6174. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6175. .. rst-class:: classref-item-separator
  6176. ----
  6177. .. _class_RenderingServer_method_sky_bake_panorama:
  6178. .. rst-class:: classref-method
  6179. :ref:`Image<class_Image>` **sky_bake_panorama**\ (\ sky\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_sky_bake_panorama>`
  6180. Generates and returns an :ref:`Image<class_Image>` containing the radiance map for the specified ``sky`` RID. This supports built-in sky material and custom sky shaders. If ``bake_irradiance`` is ``true``, the irradiance map is saved instead of the radiance map. The radiance map is used to render reflected light, while the irradiance map is used to render ambient light. See also :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>`.
  6181. \ **Note:** The image is saved in linear color space without any tonemapping performed, which means it will look too dark if viewed directly in an image editor. ``energy`` values above ``1.0`` can be used to brighten the resulting image.
  6182. \ **Note:** ``size`` should be a 2:1 aspect ratio for the generated panorama to have square pixels. For radiance maps, there is no point in using a height greater than :ref:`Sky.radiance_size<class_Sky_property_radiance_size>`, as it won't increase detail. Irradiance maps only contain low-frequency data, so there is usually no point in going past a size of 128×64 pixels when saving an irradiance map.
  6183. .. rst-class:: classref-item-separator
  6184. ----
  6185. .. _class_RenderingServer_method_sky_create:
  6186. .. rst-class:: classref-method
  6187. :ref:`RID<class_RID>` **sky_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_sky_create>`
  6188. Creates an empty sky and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``sky_*`` RenderingServer functions.
  6189. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6190. .. rst-class:: classref-item-separator
  6191. ----
  6192. .. _class_RenderingServer_method_sky_set_material:
  6193. .. rst-class:: classref-method
  6194. |void| **sky_set_material**\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_material>`
  6195. Sets the material that the sky uses to render the background, ambient and reflection maps.
  6196. .. rst-class:: classref-item-separator
  6197. ----
  6198. .. _class_RenderingServer_method_sky_set_mode:
  6199. .. rst-class:: classref-method
  6200. |void| **sky_set_mode**\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_mode>`
  6201. Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
  6202. .. rst-class:: classref-item-separator
  6203. ----
  6204. .. _class_RenderingServer_method_sky_set_radiance_size:
  6205. .. rst-class:: classref-method
  6206. |void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_radiance_size>`
  6207. Sets the ``radiance_size`` of the sky specified by the ``sky`` RID (in pixels). Equivalent to :ref:`Sky.radiance_size<class_Sky_property_radiance_size>`.
  6208. .. rst-class:: classref-item-separator
  6209. ----
  6210. .. _class_RenderingServer_method_spot_light_create:
  6211. .. rst-class:: classref-method
  6212. :ref:`RID<class_RID>` **spot_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_spot_light_create>`
  6213. Creates a spot light and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID can be used in most ``light_*`` RenderingServer functions.
  6214. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6215. To place in a scene, attach this spot light to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  6216. .. rst-class:: classref-item-separator
  6217. ----
  6218. .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
  6219. .. rst-class:: classref-method
  6220. |void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) :ref:`🔗<class_RenderingServer_method_sub_surface_scattering_set_quality>`
  6221. Sets :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality<class_ProjectSettings_property_rendering/environment/subsurface_scattering/subsurface_scattering_quality>` to use when rendering materials that have subsurface scattering enabled.
  6222. .. rst-class:: classref-item-separator
  6223. ----
  6224. .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
  6225. .. rst-class:: classref-method
  6226. |void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float<class_float>`, depth_scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_sub_surface_scattering_set_scale>`
  6227. Sets the :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale<class_ProjectSettings_property_rendering/environment/subsurface_scattering/subsurface_scattering_scale>` and :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale<class_ProjectSettings_property_rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale>` to use when rendering materials that have subsurface scattering enabled.
  6228. .. rst-class:: classref-item-separator
  6229. ----
  6230. .. _class_RenderingServer_method_texture_2d_create:
  6231. .. rst-class:: classref-method
  6232. :ref:`RID<class_RID>` **texture_2d_create**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_create>`
  6233. Creates a 2-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_*`` RenderingServer functions.
  6234. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6235. \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
  6236. \ **Note:** Not to be confused with :ref:`RenderingDevice.texture_create<class_RenderingDevice_method_texture_create>`, which creates the graphics API's own texture type as opposed to the Godot-specific :ref:`Texture2D<class_Texture2D>` resource.
  6237. .. rst-class:: classref-item-separator
  6238. ----
  6239. .. _class_RenderingServer_method_texture_2d_get:
  6240. .. rst-class:: classref-method
  6241. :ref:`Image<class_Image>` **texture_2d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_2d_get>`
  6242. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
  6243. \ **Example:** Get the test texture from :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  6244. ::
  6245. var texture_rid = RenderingServer.get_test_texture()
  6246. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  6247. $Sprite2D.texture = texture
  6248. .. rst-class:: classref-item-separator
  6249. ----
  6250. .. _class_RenderingServer_method_texture_2d_layer_get:
  6251. .. rst-class:: classref-method
  6252. :ref:`Image<class_Image>` **texture_2d_layer_get**\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_2d_layer_get>`
  6253. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
  6254. .. rst-class:: classref-item-separator
  6255. ----
  6256. .. _class_RenderingServer_method_texture_2d_layered_create:
  6257. .. rst-class:: classref-method
  6258. :ref:`RID<class_RID>` **texture_2d_layered_create**\ (\ layers\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\], layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_layered_create>`
  6259. Creates a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions.
  6260. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6261. \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
  6262. .. rst-class:: classref-item-separator
  6263. ----
  6264. .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
  6265. .. rst-class:: classref-method
  6266. :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_layered_placeholder_create>`
  6267. Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>`.
  6268. \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
  6269. .. rst-class:: classref-item-separator
  6270. ----
  6271. .. _class_RenderingServer_method_texture_2d_placeholder_create:
  6272. .. rst-class:: classref-method
  6273. :ref:`RID<class_RID>` **texture_2d_placeholder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_placeholder_create>`
  6274. Creates a placeholder for a 2-dimensional layered texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_2d_layered_*`` RenderingServer functions, although it does nothing when used. See also :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>`.
  6275. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6276. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
  6277. .. rst-class:: classref-item-separator
  6278. ----
  6279. .. _class_RenderingServer_method_texture_2d_update:
  6280. .. rst-class:: classref-method
  6281. |void| **texture_2d_update**\ (\ texture\: :ref:`RID<class_RID>`, image\: :ref:`Image<class_Image>`, layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_update>`
  6282. Updates the texture specified by the ``texture`` :ref:`RID<class_RID>` with the data in ``image``. A ``layer`` must also be specified, which should be ``0`` when updating a single-layer texture (:ref:`Texture2D<class_Texture2D>`).
  6283. \ **Note:** The ``image`` must have the same width, height and format as the current ``texture`` data. Otherwise, an error will be printed and the original texture won't be modified. If you need to use different width, height or format, use :ref:`texture_replace<class_RenderingServer_method_texture_replace>` instead.
  6284. .. rst-class:: classref-item-separator
  6285. ----
  6286. .. _class_RenderingServer_method_texture_3d_create:
  6287. .. rst-class:: classref-method
  6288. :ref:`RID<class_RID>` **texture_3d_create**\ (\ format\: :ref:`Format<enum_Image_Format>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, mipmaps\: :ref:`bool<class_bool>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_create>`
  6289. **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
  6290. .. rst-class:: classref-item-separator
  6291. ----
  6292. .. _class_RenderingServer_method_texture_3d_get:
  6293. .. rst-class:: classref-method
  6294. :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] **texture_3d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_3d_get>`
  6295. Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
  6296. .. rst-class:: classref-item-separator
  6297. ----
  6298. .. _class_RenderingServer_method_texture_3d_placeholder_create:
  6299. .. rst-class:: classref-method
  6300. :ref:`RID<class_RID>` **texture_3d_placeholder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_placeholder_create>`
  6301. Creates a placeholder for a 3-dimensional texture and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``texture_3d_*`` RenderingServer functions, although it does nothing when used.
  6302. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6303. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
  6304. .. rst-class:: classref-item-separator
  6305. ----
  6306. .. _class_RenderingServer_method_texture_3d_update:
  6307. .. rst-class:: classref-method
  6308. |void| **texture_3d_update**\ (\ texture\: :ref:`RID<class_RID>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_update>`
  6309. Updates the texture specified by the ``texture`` :ref:`RID<class_RID>`'s data with the data in ``data``. All the texture's layers must be replaced at once.
  6310. \ **Note:** The ``texture`` must have the same width, height, depth and format as the current texture data. Otherwise, an error will be printed and the original texture won't be modified. If you need to use different width, height, depth or format, use :ref:`texture_replace<class_RenderingServer_method_texture_replace>` instead.
  6311. .. rst-class:: classref-item-separator
  6312. ----
  6313. .. _class_RenderingServer_method_texture_create_from_native_handle:
  6314. .. rst-class:: classref-method
  6315. :ref:`RID<class_RID>` **texture_create_from_native_handle**\ (\ type\: :ref:`TextureType<enum_RenderingServer_TextureType>`, format\: :ref:`Format<enum_Image_Format>`, native_handle\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>` = 1, layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) :ref:`🔗<class_RenderingServer_method_texture_create_from_native_handle>`
  6316. Creates a texture based on a native handle that was created outside of Godot's renderer.
  6317. \ **Note:** If using the rendering device renderer, using :ref:`RenderingDevice.texture_create_from_extension<class_RenderingDevice_method_texture_create_from_extension>` rather than this method is recommended. It will give you much more control over the texture's format and usage.
  6318. .. rst-class:: classref-item-separator
  6319. ----
  6320. .. _class_RenderingServer_method_texture_get_format:
  6321. .. rst-class:: classref-method
  6322. :ref:`Format<enum_Image_Format>` **texture_get_format**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_format>`
  6323. Returns the format for the texture.
  6324. .. rst-class:: classref-item-separator
  6325. ----
  6326. .. _class_RenderingServer_method_texture_get_native_handle:
  6327. .. rst-class:: classref-method
  6328. :ref:`int<class_int>` **texture_get_native_handle**\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_native_handle>`
  6329. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  6330. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  6331. .. rst-class:: classref-item-separator
  6332. ----
  6333. .. _class_RenderingServer_method_texture_get_path:
  6334. .. rst-class:: classref-method
  6335. :ref:`String<class_String>` **texture_get_path**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_path>`
  6336. .. container:: contribute
  6337. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6338. .. rst-class:: classref-item-separator
  6339. ----
  6340. .. _class_RenderingServer_method_texture_get_rd_texture:
  6341. .. rst-class:: classref-method
  6342. :ref:`RID<class_RID>` **texture_get_rd_texture**\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_rd_texture>`
  6343. Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
  6344. .. rst-class:: classref-item-separator
  6345. ----
  6346. .. _class_RenderingServer_method_texture_proxy_create:
  6347. .. rst-class:: classref-method
  6348. :ref:`RID<class_RID>` **texture_proxy_create**\ (\ base\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_proxy_create>`
  6349. **Deprecated:** ProxyTexture was removed in Godot 4.
  6350. This method does nothing and always returns an invalid :ref:`RID<class_RID>`.
  6351. .. rst-class:: classref-item-separator
  6352. ----
  6353. .. _class_RenderingServer_method_texture_proxy_update:
  6354. .. rst-class:: classref-method
  6355. |void| **texture_proxy_update**\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_proxy_update>`
  6356. **Deprecated:** ProxyTexture was removed in Godot 4.
  6357. This method does nothing.
  6358. .. rst-class:: classref-item-separator
  6359. ----
  6360. .. _class_RenderingServer_method_texture_rd_create:
  6361. .. rst-class:: classref-method
  6362. :ref:`RID<class_RID>` **texture_rd_create**\ (\ rd_texture\: :ref:`RID<class_RID>`, layer_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) :ref:`🔗<class_RenderingServer_method_texture_rd_create>`
  6363. Creates a new texture object based on a texture created directly on the :ref:`RenderingDevice<class_RenderingDevice>`. If the texture contains layers, ``layer_type`` is used to define the layer type.
  6364. .. rst-class:: classref-item-separator
  6365. ----
  6366. .. _class_RenderingServer_method_texture_replace:
  6367. .. rst-class:: classref-method
  6368. |void| **texture_replace**\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_replace>`
  6369. Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
  6370. .. rst-class:: classref-item-separator
  6371. ----
  6372. .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
  6373. .. rst-class:: classref-method
  6374. |void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_force_redraw_if_visible>`
  6375. .. container:: contribute
  6376. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6377. .. rst-class:: classref-item-separator
  6378. ----
  6379. .. _class_RenderingServer_method_texture_set_path:
  6380. .. rst-class:: classref-method
  6381. |void| **texture_set_path**\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_path>`
  6382. .. container:: contribute
  6383. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6384. .. rst-class:: classref-item-separator
  6385. ----
  6386. .. _class_RenderingServer_method_texture_set_size_override:
  6387. .. rst-class:: classref-method
  6388. |void| **texture_set_size_override**\ (\ texture\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_size_override>`
  6389. .. container:: contribute
  6390. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6391. .. rst-class:: classref-item-separator
  6392. ----
  6393. .. _class_RenderingServer_method_viewport_attach_camera:
  6394. .. rst-class:: classref-method
  6395. |void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_camera>`
  6396. Sets a viewport's camera.
  6397. .. rst-class:: classref-item-separator
  6398. ----
  6399. .. _class_RenderingServer_method_viewport_attach_canvas:
  6400. .. rst-class:: classref-method
  6401. |void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_canvas>`
  6402. Sets a viewport's canvas.
  6403. .. rst-class:: classref-item-separator
  6404. ----
  6405. .. _class_RenderingServer_method_viewport_attach_to_screen:
  6406. .. rst-class:: classref-method
  6407. |void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), screen\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_to_screen>`
  6408. Copies the viewport to a region of the screen specified by ``rect``. If :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>` is ``true``, then the viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to.
  6409. For example, you can set the root viewport to not render at all with the following code:
  6410. .. tabs::
  6411. .. code-tab:: gdscript
  6412. func _ready():
  6413. RenderingServer.viewport_attach_to_screen(get_viewport().get_viewport_rid(), Rect2())
  6414. RenderingServer.viewport_attach_to_screen($Viewport.get_viewport_rid(), Rect2(0, 0, 600, 600))
  6415. Using this can result in significant optimization, especially on lower-end devices. However, it comes at the cost of having to manage your viewports manually. For further optimization, see :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>`.
  6416. .. rst-class:: classref-item-separator
  6417. ----
  6418. .. _class_RenderingServer_method_viewport_create:
  6419. .. rst-class:: classref-method
  6420. :ref:`RID<class_RID>` **viewport_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_viewport_create>`
  6421. Creates an empty viewport and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``viewport_*`` RenderingServer functions.
  6422. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6423. \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
  6424. .. rst-class:: classref-item-separator
  6425. ----
  6426. .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
  6427. .. rst-class:: classref-method
  6428. :ref:`float<class_float>` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`
  6429. Returns the CPU time taken to render the last frame in milliseconds. This *only* includes time spent in rendering-related operations; scripts' ``_process`` functions and other engine subsystems are not included in this readout. To get a complete readout of CPU time spent to render the scene, sum the render times of all viewports that are drawn every frame plus :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>`. Unlike :ref:`Engine.get_frames_per_second<class_Engine_method_get_frames_per_second>`, this method will accurately reflect CPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps<class_Engine_property_max_fps>`. See also :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`.
  6430. \ **Note:** Requires measurements to be enabled on the specified ``viewport`` using :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>`. Otherwise, this method returns ``0.0``.
  6431. .. rst-class:: classref-item-separator
  6432. ----
  6433. .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
  6434. .. rst-class:: classref-method
  6435. :ref:`float<class_float>` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`
  6436. Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike :ref:`Engine.get_frames_per_second<class_Engine_method_get_frames_per_second>`, this method accurately reflects GPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps<class_Engine_property_max_fps>`. See also :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`.
  6437. \ **Note:** Requires measurements to be enabled on the specified ``viewport`` using :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>`. Otherwise, this method returns ``0.0``.
  6438. \ **Note:** When GPU utilization is low enough during a certain period of time, GPUs will decrease their power state (which in turn decreases core and memory clock speeds). This can cause the reported GPU time to increase if GPU utilization is kept low enough by a framerate cap (compared to what it would be at the GPU's highest power state). Keep this in mind when benchmarking using :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`. This behavior can be overridden in the graphics driver settings at the cost of higher power usage.
  6439. .. rst-class:: classref-item-separator
  6440. ----
  6441. .. _class_RenderingServer_method_viewport_get_render_info:
  6442. .. rst-class:: classref-method
  6443. :ref:`int<class_int>` **viewport_get_render_info**\ (\ viewport\: :ref:`RID<class_RID>`, type\: :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>`, info\: :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_get_render_info>`
  6444. Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass ``type``\ s, each of them having the same ``info``\ s you can query (different passes will return different values). See :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` for a list of render pass types and :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` for a list of information that can be queried.
  6445. See also :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
  6446. \ **Note:** Viewport rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>` returns ``0``. To print rendering information in ``_ready()`` successfully, use the following:
  6447. ::
  6448. func _ready():
  6449. for _i in 2:
  6450. await get_tree().process_frame
  6451. print(
  6452. RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
  6453. RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  6454. RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
  6455. )
  6456. .. rst-class:: classref-item-separator
  6457. ----
  6458. .. _class_RenderingServer_method_viewport_get_render_target:
  6459. .. rst-class:: classref-method
  6460. :ref:`RID<class_RID>` **viewport_get_render_target**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_render_target>`
  6461. Returns the render target for the viewport.
  6462. .. rst-class:: classref-item-separator
  6463. ----
  6464. .. _class_RenderingServer_method_viewport_get_texture:
  6465. .. rst-class:: classref-method
  6466. :ref:`RID<class_RID>` **viewport_get_texture**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_texture>`
  6467. Returns the viewport's last rendered frame.
  6468. .. rst-class:: classref-item-separator
  6469. ----
  6470. .. _class_RenderingServer_method_viewport_get_update_mode:
  6471. .. rst-class:: classref-method
  6472. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_update_mode>`
  6473. Returns the viewport's update mode. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  6474. \ **Warning:** Calling this from any thread other than the rendering thread will be detrimental to performance.
  6475. .. rst-class:: classref-item-separator
  6476. ----
  6477. .. _class_RenderingServer_method_viewport_remove_canvas:
  6478. .. rst-class:: classref-method
  6479. |void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_remove_canvas>`
  6480. Detaches a viewport from a canvas.
  6481. .. rst-class:: classref-item-separator
  6482. ----
  6483. .. _class_RenderingServer_method_viewport_set_active:
  6484. .. rst-class:: classref-method
  6485. |void| **viewport_set_active**\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_active>`
  6486. If ``true``, sets the viewport active, else sets it inactive.
  6487. .. rst-class:: classref-item-separator
  6488. ----
  6489. .. _class_RenderingServer_method_viewport_set_anisotropic_filtering_level:
  6490. .. rst-class:: classref-method
  6491. |void| **viewport_set_anisotropic_filtering_level**\ (\ viewport\: :ref:`RID<class_RID>`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_anisotropic_filtering_level>`
  6492. Sets the maximum number of samples to take when using anisotropic filtering on textures (as a power of two). A higher sample count will result in sharper textures at oblique angles, but is more expensive to compute. A value of ``0`` forcibly disables anisotropic filtering, even on materials where it is enabled.
  6493. The anisotropic filtering level also affects decals and light projectors if they are configured to use anisotropic filtering. See :ref:`ProjectSettings.rendering/textures/decals/filter<class_ProjectSettings_property_rendering/textures/decals/filter>` and :ref:`ProjectSettings.rendering/textures/light_projectors/filter<class_ProjectSettings_property_rendering/textures/light_projectors/filter>`.
  6494. \ **Note:** In 3D, for this setting to have an effect, set :ref:`BaseMaterial3D.texture_filter<class_BaseMaterial3D_property_texture_filter>` to :ref:`BaseMaterial3D.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` or :ref:`BaseMaterial3D.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` on materials.
  6495. \ **Note:** In 2D, for this setting to have an effect, set :ref:`CanvasItem.texture_filter<class_CanvasItem_property_texture_filter>` to :ref:`CanvasItem.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` or :ref:`CanvasItem.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` on the :ref:`CanvasItem<class_CanvasItem>` node displaying the texture (or in :ref:`CanvasTexture<class_CanvasTexture>`). However, anisotropic filtering is rarely useful in 2D, so only enable it for textures in 2D if it makes a meaningful visual difference.
  6496. .. rst-class:: classref-item-separator
  6497. ----
  6498. .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
  6499. .. rst-class:: classref-method
  6500. |void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID<class_RID>`, canvas_cull_mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_cull_mask>`
  6501. Sets the rendering mask associated with this :ref:`Viewport<class_Viewport>`. Only :ref:`CanvasItem<class_CanvasItem>` nodes with a matching rendering visibility layer will be rendered by this :ref:`Viewport<class_Viewport>`.
  6502. .. rst-class:: classref-item-separator
  6503. ----
  6504. .. _class_RenderingServer_method_viewport_set_canvas_stacking:
  6505. .. rst-class:: classref-method
  6506. |void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, sublayer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_stacking>`
  6507. Sets the stacking order for a viewport's canvas.
  6508. \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
  6509. .. rst-class:: classref-item-separator
  6510. ----
  6511. .. _class_RenderingServer_method_viewport_set_canvas_transform:
  6512. .. rst-class:: classref-method
  6513. |void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, offset\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_transform>`
  6514. Sets the transformation of a viewport's canvas.
  6515. .. rst-class:: classref-item-separator
  6516. ----
  6517. .. _class_RenderingServer_method_viewport_set_clear_mode:
  6518. .. rst-class:: classref-method
  6519. |void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID<class_RID>`, clear_mode\: :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_clear_mode>`
  6520. Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
  6521. .. rst-class:: classref-item-separator
  6522. ----
  6523. .. _class_RenderingServer_method_viewport_set_debug_draw:
  6524. .. rst-class:: classref-method
  6525. |void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_debug_draw>`
  6526. Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
  6527. .. rst-class:: classref-item-separator
  6528. ----
  6529. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
  6530. .. rst-class:: classref-method
  6531. |void| **viewport_set_default_canvas_item_texture_filter**\ (\ viewport\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>`
  6532. Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` for options.
  6533. .. rst-class:: classref-item-separator
  6534. ----
  6535. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
  6536. .. rst-class:: classref-method
  6537. |void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>`
  6538. Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` for options.
  6539. .. rst-class:: classref-item-separator
  6540. ----
  6541. .. _class_RenderingServer_method_viewport_set_disable_2d:
  6542. .. rst-class:: classref-method
  6543. |void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_disable_2d>`
  6544. If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
  6545. .. rst-class:: classref-item-separator
  6546. ----
  6547. .. _class_RenderingServer_method_viewport_set_disable_3d:
  6548. .. rst-class:: classref-method
  6549. |void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_disable_3d>`
  6550. If ``true``, the viewport's 3D elements are not rendered.
  6551. .. rst-class:: classref-item-separator
  6552. ----
  6553. .. _class_RenderingServer_method_viewport_set_environment_mode:
  6554. .. rst-class:: classref-method
  6555. |void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_environment_mode>`
  6556. Sets the viewport's environment mode which allows enabling or disabling rendering of 3D environment over 2D canvas. When disabled, 2D will not be affected by the environment. When enabled, 2D will be affected by the environment if the environment background mode is :ref:`ENV_BG_CANVAS<class_RenderingServer_constant_ENV_BG_CANVAS>`. The default behavior is to inherit the setting from the viewport's parent. If the topmost parent is also set to :ref:`VIEWPORT_ENVIRONMENT_INHERIT<class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT>`, then the behavior will be the same as if it was set to :ref:`VIEWPORT_ENVIRONMENT_ENABLED<class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED>`.
  6557. .. rst-class:: classref-item-separator
  6558. ----
  6559. .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
  6560. .. rst-class:: classref-method
  6561. |void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_fsr_sharpness>`
  6562. Determines how sharp the upscaled image will be when using the FSR upscaling mode. Sharpness halves with every whole number. Values go from 0.0 (sharpest) to 2.0. Values above 2.0 won't make a visible difference.
  6563. .. rst-class:: classref-item-separator
  6564. ----
  6565. .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
  6566. .. rst-class:: classref-method
  6567. |void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_global_canvas_transform>`
  6568. Sets the viewport's global transformation matrix.
  6569. .. rst-class:: classref-item-separator
  6570. ----
  6571. .. _class_RenderingServer_method_viewport_set_measure_render_time:
  6572. .. rst-class:: classref-method
  6573. |void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_measure_render_time>`
  6574. Sets the measurement for the given ``viewport`` RID (obtained using :ref:`Viewport.get_viewport_rid<class_Viewport_method_get_viewport_rid>`). Once enabled, :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>` and :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>` will return values greater than ``0.0`` when queried with the given ``viewport``.
  6575. .. rst-class:: classref-item-separator
  6576. ----
  6577. .. _class_RenderingServer_method_viewport_set_msaa_2d:
  6578. .. rst-class:: classref-method
  6579. |void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_msaa_2d>`
  6580. Sets the multisample antialiasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d>` or :ref:`Viewport.msaa_2d<class_Viewport_property_msaa_2d>`.
  6581. .. rst-class:: classref-item-separator
  6582. ----
  6583. .. _class_RenderingServer_method_viewport_set_msaa_3d:
  6584. .. rst-class:: classref-method
  6585. |void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_msaa_3d>`
  6586. Sets the multisample antialiasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>` or :ref:`Viewport.msaa_3d<class_Viewport_property_msaa_3d>`.
  6587. .. rst-class:: classref-item-separator
  6588. ----
  6589. .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
  6590. .. rst-class:: classref-method
  6591. |void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`
  6592. Sets the :ref:`ProjectSettings.rendering/occlusion_culling/bvh_build_quality<class_ProjectSettings_property_rendering/occlusion_culling/bvh_build_quality>` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis.
  6593. .. rst-class:: classref-item-separator
  6594. ----
  6595. .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
  6596. .. rst-class:: classref-method
  6597. |void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`
  6598. Sets the :ref:`ProjectSettings.rendering/occlusion_culling/occlusion_rays_per_thread<class_ProjectSettings_property_rendering/occlusion_culling/occlusion_rays_per_thread>` to use for occlusion culling. This parameter is global and cannot be set on a per-viewport basis.
  6599. .. rst-class:: classref-item-separator
  6600. ----
  6601. .. _class_RenderingServer_method_viewport_set_parent_viewport:
  6602. .. rst-class:: classref-method
  6603. |void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_parent_viewport>`
  6604. Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
  6605. .. rst-class:: classref-item-separator
  6606. ----
  6607. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
  6608. .. rst-class:: classref-method
  6609. |void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID<class_RID>`, quadrant\: :ref:`int<class_int>`, subdivision\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>`
  6610. Sets the number of subdivisions to use in the specified shadow atlas ``quadrant`` for omni and spot shadows. See also :ref:`Viewport.set_positional_shadow_atlas_quadrant_subdiv<class_Viewport_method_set_positional_shadow_atlas_quadrant_subdiv>`.
  6611. .. rst-class:: classref-item-separator
  6612. ----
  6613. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
  6614. .. rst-class:: classref-method
  6615. |void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, use_16_bits\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>`
  6616. Sets the ``size`` of the shadow atlas's images (used for omni and spot lights) on the viewport specified by the ``viewport`` RID. The value is rounded up to the nearest power of 2. If ``use_16_bits`` is ``true``, use 16 bits for the omni/spot shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices.
  6617. \ **Note:** If this is set to ``0``, no positional shadows will be visible at all. This can improve performance significantly on low-end systems by reducing both the CPU and GPU load (as fewer draw calls are needed to draw the scene without shadows).
  6618. .. rst-class:: classref-item-separator
  6619. ----
  6620. .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
  6621. .. rst-class:: classref-method
  6622. |void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_render_direct_to_screen>`
  6623. If ``true``, render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the screen_texture. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size.
  6624. .. rst-class:: classref-item-separator
  6625. ----
  6626. .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
  6627. .. rst-class:: classref-method
  6628. |void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID<class_RID>`, scaling_3d_mode\: :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scaling_3d_mode>`
  6629. Sets the 3D resolution scaling mode. Bilinear scaling renders at different resolution to either undersample or supersample the viewport. FidelityFX Super Resolution 1.0, abbreviated to FSR, is an upscaling technology that produces high quality images at fast framerates by using a spatially aware upscaling algorithm. FSR is slightly more expensive than bilinear, but it produces significantly higher image quality. FSR should be used where possible.
  6630. .. rst-class:: classref-item-separator
  6631. ----
  6632. .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
  6633. .. rst-class:: classref-method
  6634. |void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scaling_3d_scale>`
  6635. Scales the 3D render buffer based on the viewport size uses an image filter specified in :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` to scale the output image to the full viewport size. Values lower than ``1.0`` can be used to speed up 3D rendering at the cost of quality (undersampling). Values greater than ``1.0`` are only valid for bilinear mode and can be used to improve 3D rendering quality at a high performance cost (supersampling). See also :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for multi-sample antialiasing, which is significantly cheaper but only smoothens the edges of polygons.
  6636. When using FSR upscaling, AMD recommends exposing the following values as preset options to users "Ultra Quality: 0.77", "Quality: 0.67", "Balanced: 0.59", "Performance: 0.5" instead of exposing the entire scale.
  6637. .. rst-class:: classref-item-separator
  6638. ----
  6639. .. _class_RenderingServer_method_viewport_set_scenario:
  6640. .. rst-class:: classref-method
  6641. |void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scenario>`
  6642. Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
  6643. .. rst-class:: classref-item-separator
  6644. ----
  6645. .. _class_RenderingServer_method_viewport_set_screen_space_aa:
  6646. .. rst-class:: classref-method
  6647. |void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_screen_space_aa>`
  6648. Sets the viewport's screen-space antialiasing mode. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa<class_ProjectSettings_property_rendering/anti_aliasing/quality/screen_space_aa>` or :ref:`Viewport.screen_space_aa<class_Viewport_property_screen_space_aa>`.
  6649. .. rst-class:: classref-item-separator
  6650. ----
  6651. .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
  6652. .. rst-class:: classref-method
  6653. |void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID<class_RID>`, oversize\: :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>`, scale\: :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>`
  6654. Sets the viewport's 2D signed distance field :ref:`ProjectSettings.rendering/2d/sdf/oversize<class_ProjectSettings_property_rendering/2d/sdf/oversize>` and :ref:`ProjectSettings.rendering/2d/sdf/scale<class_ProjectSettings_property_rendering/2d/sdf/scale>`. This is used when sampling the signed distance field in :ref:`CanvasItem<class_CanvasItem>` shaders as well as :ref:`GPUParticles2D<class_GPUParticles2D>` collision. This is *not* used by SDFGI in 3D rendering.
  6655. .. rst-class:: classref-item-separator
  6656. ----
  6657. .. _class_RenderingServer_method_viewport_set_size:
  6658. .. rst-class:: classref-method
  6659. |void| **viewport_set_size**\ (\ viewport\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_size>`
  6660. Sets the viewport's width and height in pixels.
  6661. .. rst-class:: classref-item-separator
  6662. ----
  6663. .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
  6664. .. rst-class:: classref-method
  6665. |void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>`
  6666. If ``true``, canvas item transforms (i.e. origin position) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D<class_Camera2D>` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel<class_ProjectSettings_property_rendering/2d/snap/snap_2d_transforms_to_pixel>`.
  6667. .. rst-class:: classref-item-separator
  6668. ----
  6669. .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
  6670. .. rst-class:: classref-method
  6671. |void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>`
  6672. If ``true``, canvas item vertices (i.e. polygon points) are snapped to the nearest pixel when rendering. This can lead to a crisper appearance at the cost of less smooth movement, especially when :ref:`Camera2D<class_Camera2D>` smoothing is enabled. Equivalent to :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel<class_ProjectSettings_property_rendering/2d/snap/snap_2d_vertices_to_pixel>`.
  6673. .. rst-class:: classref-item-separator
  6674. ----
  6675. .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
  6676. .. rst-class:: classref-method
  6677. |void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID<class_RID>`, mipmap_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_texture_mipmap_bias>`
  6678. Affects the final texture sharpness by reading from a lower or higher mipmap (also called "texture LOD bias"). Negative values make mipmapped textures sharper but grainier when viewed at a distance, while positive values make mipmapped textures blurrier (even when up close). To get sharper textures at a distance without introducing too much graininess, set this between ``-0.75`` and ``0.0``. Enabling temporal antialiasing (:ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>`) can help reduce the graininess visible when using negative mipmap bias.
  6679. \ **Note:** When the 3D scaling mode is set to FSR 1.0, this value is used to adjust the automatic mipmap bias which is calculated internally based on the scale factor. The formula for this is ``-log2(1.0 / scale) + mipmap_bias``.
  6680. .. rst-class:: classref-item-separator
  6681. ----
  6682. .. _class_RenderingServer_method_viewport_set_transparent_background:
  6683. .. rst-class:: classref-method
  6684. |void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_transparent_background>`
  6685. If ``true``, the viewport renders its background as transparent.
  6686. .. rst-class:: classref-item-separator
  6687. ----
  6688. .. _class_RenderingServer_method_viewport_set_update_mode:
  6689. .. rst-class:: classref-method
  6690. |void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`, update_mode\: :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_update_mode>`
  6691. Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  6692. .. rst-class:: classref-item-separator
  6693. ----
  6694. .. _class_RenderingServer_method_viewport_set_use_debanding:
  6695. .. rst-class:: classref-method
  6696. |void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_debanding>`
  6697. If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>` or :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>`.
  6698. .. rst-class:: classref-item-separator
  6699. ----
  6700. .. _class_RenderingServer_method_viewport_set_use_hdr_2d:
  6701. .. rst-class:: classref-method
  6702. |void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_hdr_2d>`
  6703. If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d<class_Viewport_property_use_hdr_2d>`.
  6704. \ **Note:** This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons.
  6705. .. rst-class:: classref-item-separator
  6706. ----
  6707. .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
  6708. .. rst-class:: classref-method
  6709. |void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_occlusion_culling>`
  6710. If ``true``, enables occlusion culling on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/occlusion_culling/use_occlusion_culling<class_ProjectSettings_property_rendering/occlusion_culling/use_occlusion_culling>`.
  6711. .. rst-class:: classref-item-separator
  6712. ----
  6713. .. _class_RenderingServer_method_viewport_set_use_taa:
  6714. .. rst-class:: classref-method
  6715. |void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_taa>`
  6716. If ``true``, use temporal antialiasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>` or :ref:`Viewport.use_taa<class_Viewport_property_use_taa>`.
  6717. .. rst-class:: classref-item-separator
  6718. ----
  6719. .. _class_RenderingServer_method_viewport_set_use_xr:
  6720. .. rst-class:: classref-method
  6721. |void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_xr>`
  6722. If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
  6723. .. rst-class:: classref-item-separator
  6724. ----
  6725. .. _class_RenderingServer_method_viewport_set_vrs_mode:
  6726. .. rst-class:: classref-method
  6727. |void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_mode>`
  6728. Sets the Variable Rate Shading (VRS) mode for the viewport. If the GPU does not support VRS, this property is ignored. Equivalent to :ref:`ProjectSettings.rendering/vrs/mode<class_ProjectSettings_property_rendering/vrs/mode>`.
  6729. .. rst-class:: classref-item-separator
  6730. ----
  6731. .. _class_RenderingServer_method_viewport_set_vrs_texture:
  6732. .. rst-class:: classref-method
  6733. |void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_texture>`
  6734. The texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE<class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE>`. Equivalent to :ref:`ProjectSettings.rendering/vrs/texture<class_ProjectSettings_property_rendering/vrs/texture>`.
  6735. .. rst-class:: classref-item-separator
  6736. ----
  6737. .. _class_RenderingServer_method_viewport_set_vrs_update_mode:
  6738. .. rst-class:: classref-method
  6739. |void| **viewport_set_vrs_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_update_mode>`
  6740. Sets the update mode for Variable Rate Shading (VRS) for the viewport. VRS requires the input texture to be converted to the format usable by the VRS method supported by the hardware. The update mode defines how often this happens. If the GPU does not support VRS, or VRS is not enabled, this property is ignored.
  6741. If set to :ref:`VIEWPORT_VRS_UPDATE_ONCE<class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE>`, the input texture is copied once and the mode is changed to :ref:`VIEWPORT_VRS_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED>`.
  6742. .. rst-class:: classref-item-separator
  6743. ----
  6744. .. _class_RenderingServer_method_visibility_notifier_create:
  6745. .. rst-class:: classref-method
  6746. :ref:`RID<class_RID>` **visibility_notifier_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_create>`
  6747. Creates a new 3D visibility notifier object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``visibility_notifier_*`` RenderingServer functions.
  6748. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6749. To place in a scene, attach this notifier to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` using the returned RID.
  6750. \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
  6751. .. rst-class:: classref-item-separator
  6752. ----
  6753. .. _class_RenderingServer_method_visibility_notifier_set_aabb:
  6754. .. rst-class:: classref-method
  6755. |void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_set_aabb>`
  6756. .. container:: contribute
  6757. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6758. .. rst-class:: classref-item-separator
  6759. ----
  6760. .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
  6761. .. rst-class:: classref-method
  6762. |void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID<class_RID>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_set_callbacks>`
  6763. .. container:: contribute
  6764. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6765. .. rst-class:: classref-item-separator
  6766. ----
  6767. .. _class_RenderingServer_method_voxel_gi_allocate_data:
  6768. .. rst-class:: classref-method
  6769. |void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID<class_RID>`, to_cell_xform\: :ref:`Transform3D<class_Transform3D>`, aabb\: :ref:`AABB<class_AABB>`, octree_size\: :ref:`Vector3i<class_Vector3i>`, octree_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, data_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, distance_field\: :ref:`PackedByteArray<class_PackedByteArray>`, level_counts\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_allocate_data>`
  6770. .. container:: contribute
  6771. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6772. .. rst-class:: classref-item-separator
  6773. ----
  6774. .. _class_RenderingServer_method_voxel_gi_create:
  6775. .. rst-class:: classref-method
  6776. :ref:`RID<class_RID>` **voxel_gi_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_create>`
  6777. Creates a new voxel-based global illumination object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``voxel_gi_*`` RenderingServer functions.
  6778. Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid<class_RenderingServer_method_free_rid>` method.
  6779. \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
  6780. .. rst-class:: classref-item-separator
  6781. ----
  6782. .. _class_RenderingServer_method_voxel_gi_get_data_cells:
  6783. .. rst-class:: classref-method
  6784. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_data_cells>`
  6785. .. container:: contribute
  6786. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6787. .. rst-class:: classref-item-separator
  6788. ----
  6789. .. _class_RenderingServer_method_voxel_gi_get_distance_field:
  6790. .. rst-class:: classref-method
  6791. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_distance_field>`
  6792. .. container:: contribute
  6793. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6794. .. rst-class:: classref-item-separator
  6795. ----
  6796. .. _class_RenderingServer_method_voxel_gi_get_level_counts:
  6797. .. rst-class:: classref-method
  6798. :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_level_counts>`
  6799. .. container:: contribute
  6800. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6801. .. rst-class:: classref-item-separator
  6802. ----
  6803. .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
  6804. .. rst-class:: classref-method
  6805. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_octree_cells>`
  6806. .. container:: contribute
  6807. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6808. .. rst-class:: classref-item-separator
  6809. ----
  6810. .. _class_RenderingServer_method_voxel_gi_get_octree_size:
  6811. .. rst-class:: classref-method
  6812. :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_octree_size>`
  6813. .. container:: contribute
  6814. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6815. .. rst-class:: classref-item-separator
  6816. ----
  6817. .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
  6818. .. rst-class:: classref-method
  6819. :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_to_cell_xform>`
  6820. .. container:: contribute
  6821. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6822. .. rst-class:: classref-item-separator
  6823. ----
  6824. .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
  6825. .. rst-class:: classref-method
  6826. |void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>`
  6827. Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>`.
  6828. .. rst-class:: classref-item-separator
  6829. ----
  6830. .. _class_RenderingServer_method_voxel_gi_set_bias:
  6831. .. rst-class:: classref-method
  6832. |void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_bias>`
  6833. Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6834. .. rst-class:: classref-item-separator
  6835. ----
  6836. .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
  6837. .. rst-class:: classref-method
  6838. |void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID<class_RID>`, range\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_dynamic_range>`
  6839. Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6840. .. rst-class:: classref-item-separator
  6841. ----
  6842. .. _class_RenderingServer_method_voxel_gi_set_energy:
  6843. .. rst-class:: classref-method
  6844. |void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_energy>`
  6845. Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6846. .. rst-class:: classref-item-separator
  6847. ----
  6848. .. _class_RenderingServer_method_voxel_gi_set_interior:
  6849. .. rst-class:: classref-method
  6850. |void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_interior>`
  6851. Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6852. .. rst-class:: classref-item-separator
  6853. ----
  6854. .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
  6855. .. rst-class:: classref-method
  6856. |void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_normal_bias>`
  6857. Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6858. .. rst-class:: classref-item-separator
  6859. ----
  6860. .. _class_RenderingServer_method_voxel_gi_set_propagation:
  6861. .. rst-class:: classref-method
  6862. |void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_propagation>`
  6863. Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6864. .. rst-class:: classref-item-separator
  6865. ----
  6866. .. _class_RenderingServer_method_voxel_gi_set_quality:
  6867. .. rst-class:: classref-method
  6868. |void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_quality>`
  6869. Sets the :ref:`ProjectSettings.rendering/global_illumination/voxel_gi/quality<class_ProjectSettings_property_rendering/global_illumination/voxel_gi/quality>` value to use when rendering. This parameter is global and cannot be set on a per-VoxelGI basis.
  6870. .. rst-class:: classref-item-separator
  6871. ----
  6872. .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
  6873. .. rst-class:: classref-method
  6874. |void| **voxel_gi_set_use_two_bounces**\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_use_two_bounces>`
  6875. Sets the :ref:`VoxelGIData.use_two_bounces<class_VoxelGIData_property_use_two_bounces>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6876. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  6877. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  6878. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  6879. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  6880. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  6881. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  6882. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  6883. .. |void| replace:: :abbr:`void (No return value.)`