class_renderingserver.rst 1.0 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235
  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/4.1/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.1/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:`Image[]<class_Image>` | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>` **(** :ref:`RID<class_RID>` base, :ref:`RID[]<class_RID>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)** |
  42. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | :ref:`RID<class_RID>` | :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` **(** **)** |
  44. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`camera_attributes_set_auto_exposure<class_RenderingServer_method_camera_attributes_set_auto_exposure>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_sensitivity, :ref:`float<class_float>` max_sensitivity, :ref:`float<class_float>` speed, :ref:`float<class_float>` scale **)** |
  46. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`camera_attributes_set_dof_blur<class_RenderingServer_method_camera_attributes_set_dof_blur>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)** |
  48. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`camera_attributes_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>` **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)** |
  50. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`camera_attributes_set_dof_blur_quality<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>` **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)** |
  52. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` normalization **)** |
  54. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>` **(** **)** |
  56. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`camera_set_camera_attributes<class_RenderingServer_method_camera_set_camera_attributes>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)** |
  58. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>` **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)** |
  60. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)** |
  62. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  64. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  66. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  68. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>` **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)** |
  70. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>` **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)** |
  72. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>` **(** **)** |
  74. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`canvas_item_add_animation_slice<class_RenderingServer_method_canvas_item_add_animation_slice>` **(** :ref:`RID<class_RID>` item, :ref:`float<class_float>` animation_length, :ref:`float<class_float>` slice_begin, :ref:`float<class_float>` slice_end, :ref:`float<class_float>` offset=0.0 **)** |
  76. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
  78. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)** |
  80. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`canvas_item_add_lcd_texture_rect_region<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate **)** |
  82. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  84. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture=RID() **)** |
  86. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0, :ref:`float<class_float>` scale=1.0 **)** |
  88. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`canvas_item_add_multiline<class_RenderingServer_method_canvas_item_add_multiline>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0 **)** |
  90. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture=RID() **)** |
  92. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)** |
  94. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)** |
  96. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture=RID() **)** |
  98. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  100. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture **)** |
  102. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)** |
  104. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
  106. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | void | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)** |
  108. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | void | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)** |
  110. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | void | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture=RID(), :ref:`int<class_int>` count=-1 **)** |
  112. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | void | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>` **(** :ref:`RID<class_RID>` item **)** |
  114. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>` **(** **)** |
  116. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | void | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)** |
  118. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | void | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)** |
  120. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | void | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)** |
  122. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | void | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)** |
  124. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | void | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  126. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | void | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  128. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | void | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  130. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  132. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)** |
  134. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)** |
  136. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)** |
  138. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
  140. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)** |
  142. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
  144. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  146. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
  148. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  150. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`canvas_item_set_visibility_layer<class_RenderingServer_method_canvas_item_set_visibility_layer>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` visibility_layer **)** |
  152. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
  154. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)** |
  156. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  158. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)** |
  160. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)** |
  162. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>` **(** **)** |
  164. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | void | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)** |
  166. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>` **(** **)** |
  168. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | void | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)** |
  170. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | void | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)** |
  172. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | void | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>` **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)** |
  174. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | void | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)** |
  176. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | void | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>` **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)** |
  178. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`canvas_light_set_blend_mode<class_RenderingServer_method_canvas_light_set_blend_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` mode **)** |
  180. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | void | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  182. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | void | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  184. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | void | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)** |
  186. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | void | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)** |
  188. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | void | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  190. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | void | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  192. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | void | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)** |
  194. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | void | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)** |
  196. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | void | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  198. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | void | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  200. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)** |
  202. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | void | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)** |
  204. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | void | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
  206. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>` **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)** |
  208. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | void | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)** |
  210. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | void | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>` **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)** |
  212. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)** |
  214. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>` **(** **)** |
  216. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | void | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)** |
  218. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | void | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)** |
  220. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | void | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>` **(** :ref:`bool<class_bool>` disable **)** |
  222. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | void | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>` **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)** |
  224. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | void | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>` **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)** |
  226. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | void | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>` **(** :ref:`int<class_int>` size **)** |
  228. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>` **(** **)** |
  230. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | void | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)** |
  232. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | void | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)** |
  234. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | void | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  236. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | void | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  238. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>` **(** **)** |const| |
  240. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>` **(** **)** |
  242. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | void | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)** |
  244. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | void | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>` **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)** |
  246. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | void | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)** |
  248. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | void | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)** |
  250. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | void | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)** |
  252. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | void | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>` **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)** |
  254. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | void | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)** |
  256. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | void | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>` **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)** |
  258. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | void | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>` **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)** |
  260. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | void | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>` **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)** |
  262. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>` **(** **)** |
  264. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | void | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>` **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)** |
  266. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | void | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
  268. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>` **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
  270. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>` **(** **)** |
  272. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | void | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>` **(** :ref:`bool<class_bool>` enable **)** |
  274. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | void | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)** |
  276. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | void | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)** |
  278. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | void | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)** |
  280. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | void | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)** |
  282. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | void | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` exposure_value **)** |
  284. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | void | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>` **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)** |
  286. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | void | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` 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 **)** |
  288. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | void | :ref:`environment_set_glow<class_RenderingServer_method_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` 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:`RID<class_RID>` glow_map **)** |
  290. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | void | :ref:`environment_set_sdfgi<class_RenderingServer_method_environment_set_sdfgi>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)** |
  292. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | void | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>` **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)** |
  294. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | void | :ref:`environment_set_sdfgi_frames_to_update_light<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)** |
  296. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | void | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>` **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)** |
  298. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | void | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
  300. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | void | :ref:`environment_set_sky_custom_fov<class_RenderingServer_method_environment_set_sky_custom_fov>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)** |
  302. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | void | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>` **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)** |
  304. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | void | :ref:`environment_set_ssao<class_RenderingServer_method_environment_set_ssao>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` 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 **)** |
  306. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | void | :ref:`environment_set_ssao_quality<class_RenderingServer_method_environment_set_ssao_quality>` **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
  308. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | void | :ref:`environment_set_ssil_quality<class_RenderingServer_method_environment_set_ssil_quality>` **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
  310. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | void | :ref:`environment_set_ssr<class_RenderingServer_method_environment_set_ssr>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)** |
  312. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | void | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>` **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)** |
  314. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | void | :ref:`environment_set_tonemap<class_RenderingServer_method_environment_set_tonemap>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white **)** |
  316. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | void | :ref:`environment_set_volumetric_fog<class_RenderingServer_method_environment_set_volumetric_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` 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:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject, :ref:`float<class_float>` sky_affect **)** |
  318. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | void | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>` **(** :ref:`bool<class_bool>` active **)** |
  320. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | void | :ref:`environment_set_volumetric_fog_volume_size<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)** |
  322. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>` **(** **)** |
  324. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | void | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)** |
  326. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | void | :ref:`fog_volume_set_shape<class_RenderingServer_method_fog_volume_set_shape>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)** |
  328. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | void | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)** |
  330. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | void | :ref:`force_draw<class_RenderingServer_method_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
  332. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | void | :ref:`force_sync<class_RenderingServer_method_force_sync>` **(** **)** |
  334. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | void | :ref:`free_rid<class_RenderingServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  336. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>` **(** **)** |
  338. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>` **(** **)** |const| |
  340. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>` **(** **)** |const| |
  342. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>` **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)** |
  344. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`get_shader_parameter_list<class_RenderingServer_method_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` shader **)** |const| |
  346. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>` **(** **)** |
  348. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` **(** **)** |
  350. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>` **(** **)** |const| |
  352. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>` **(** **)** |const| |
  354. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>` **(** **)** |const| |
  356. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>` **(** **)** |const| |
  358. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>` **(** **)** |
  360. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | void | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>` **(** :ref:`bool<class_bool>` half_resolution **)** |
  362. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | void | :ref:`global_shader_parameter_add<class_RenderingServer_method_global_shader_parameter_add>` **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` type, :ref:`Variant<class_Variant>` default_value **)** |
  364. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  366. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :ref:`StringName[]<class_StringName>` | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>` **(** **)** |const| |
  368. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` | :ref:`global_shader_parameter_get_type<class_RenderingServer_method_global_shader_parameter_get_type>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  370. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | void | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>` **(** :ref:`StringName<class_StringName>` name **)** |
  372. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | void | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
  374. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | void | :ref:`global_shader_parameter_set_override<class_RenderingServer_method_global_shader_parameter_set_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
  376. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>` **(** **)** |const| |
  378. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>` **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const| |
  380. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>` **(** :ref:`String<class_String>` feature **)** |const| |
  382. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | void | :ref:`instance_attach_object_instance_id<class_RenderingServer_method_instance_attach_object_instance_id>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)** |
  384. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | void | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)** |
  386. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>` **(** **)** |
  388. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>` **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)** |
  390. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter<class_RenderingServer_method_instance_geometry_get_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
  392. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter_default_value<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
  394. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`instance_geometry_get_shader_parameter_list<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` instance **)** |const| |
  396. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | void | :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>` **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)** |
  398. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | void | :ref:`instance_geometry_set_flag<class_RenderingServer_method_instance_geometry_set_flag>` **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)** |
  400. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | void | :ref:`instance_geometry_set_lightmap<class_RenderingServer_method_instance_geometry_set_lightmap>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)** |
  402. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | void | :ref:`instance_geometry_set_lod_bias<class_RenderingServer_method_instance_geometry_set_lod_bias>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)** |
  404. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | void | :ref:`instance_geometry_set_material_overlay<class_RenderingServer_method_instance_geometry_set_material_overlay>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
  406. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | void | :ref:`instance_geometry_set_material_override<class_RenderingServer_method_instance_geometry_set_material_override>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
  408. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | void | :ref:`instance_geometry_set_shader_parameter<class_RenderingServer_method_instance_geometry_set_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
  410. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | void | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)** |
  412. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | void | :ref:`instance_geometry_set_visibility_range<class_RenderingServer_method_instance_geometry_set_visibility_range>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)** |
  414. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | void | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)** |
  416. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | void | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)** |
  418. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | void | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>` **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)** |
  420. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | void | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)** |
  422. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | void | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)** |
  424. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | void | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)** |
  426. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | void | :ref:`instance_set_pivot_data<class_RenderingServer_method_instance_set_pivot_data>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` sorting_offset, :ref:`bool<class_bool>` use_aabb_center **)** |
  428. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | void | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)** |
  430. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | void | :ref:`instance_set_surface_override_material<class_RenderingServer_method_instance_set_surface_override_material>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
  432. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | void | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>` **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)** |
  434. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | void | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)** |
  436. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | void | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)** |
  438. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>` **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  440. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>` **(** :ref:`Plane[]<class_Plane>` convex, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  442. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  444. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | void | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
  446. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | void | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)** |
  448. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | void | :ref:`light_directional_set_sky_mode<class_RenderingServer_method_light_directional_set_sky_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` mode **)** |
  450. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | void | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)** |
  452. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | void | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>` **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)** |
  454. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | void | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)** |
  456. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | void | :ref:`light_set_color<class_RenderingServer_method_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  458. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | void | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  460. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | void | :ref:`light_set_distance_fade<class_RenderingServer_method_light_set_distance_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` shadow, :ref:`float<class_float>` length **)** |
  462. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | void | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)** |
  464. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | void | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
  466. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | void | :ref:`light_set_param<class_RenderingServer_method_light_set_param>` **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)** |
  468. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | void | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
  470. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | void | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  472. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | void | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  474. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>` **(** **)** |
  476. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  478. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  480. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  482. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  484. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | void | :ref:`lightmap_set_baked_exposure_normalization<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>` **(** :ref:`RID<class_RID>` lightmap, :ref:`float<class_float>` baked_exposure **)** |
  486. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | void | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>` **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)** |
  488. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | void | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>` **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)** |
  490. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | void | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>` **(** :ref:`float<class_float>` speed **)** |
  492. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | void | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>` **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)** |
  494. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | void | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>` **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)** |
  496. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>` **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)** |
  498. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>` **(** **)** |
  500. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  501. | :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const| |
  502. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  503. | void | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>` **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)** |
  504. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  505. | void | :ref:`material_set_param<class_RenderingServer_method_material_set_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
  506. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  507. | void | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>` **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)** |
  508. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  509. | void | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>` **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)** |
  510. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  511. | void | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)** |
  512. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  513. | void | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> compress_format=0 **)** |
  514. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  515. | void | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>` **(** :ref:`RID<class_RID>` mesh **)** |
  516. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  517. | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>` **(** **)** |
  518. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  519. | :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>` **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)** |
  520. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  521. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  522. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  523. | :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  524. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  525. | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  526. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  527. | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |
  528. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  529. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  530. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  531. | void | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)** |
  532. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  533. | void | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)** |
  534. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  535. | void | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>` **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)** |
  536. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  537. | :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  538. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  539. | :ref:`Array[]<class_Array>` | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  540. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  541. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  542. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  543. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_RenderingServer_method_mesh_surface_get_format_offset>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const| |
  544. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  545. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_skin_stride<class_RenderingServer_method_mesh_surface_get_format_skin_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  546. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  547. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_vertex_stride<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  548. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  549. | :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_RenderingServer_method_mesh_surface_get_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  550. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  551. | void | :ref:`mesh_surface_set_material<class_RenderingServer_method_mesh_surface_set_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
  552. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  553. | void | :ref:`mesh_surface_update_attribute_region<class_RenderingServer_method_mesh_surface_update_attribute_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  554. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  555. | void | :ref:`mesh_surface_update_skin_region<class_RenderingServer_method_mesh_surface_update_skin_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  556. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  557. | void | :ref:`mesh_surface_update_vertex_region<class_RenderingServer_method_mesh_surface_update_vertex_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  558. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  559. | void | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)** |
  560. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  561. | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>` **(** **)** |
  562. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  563. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  564. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  565. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  566. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  567. | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  568. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  569. | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  570. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  571. | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  572. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  573. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_RenderingServer_method_multimesh_instance_get_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  574. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  575. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_RenderingServer_method_multimesh_instance_get_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  576. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  577. | :ref:`Transform3D<class_Transform3D>` | :ref:`multimesh_instance_get_transform<class_RenderingServer_method_multimesh_instance_get_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  578. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  579. | :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_RenderingServer_method_multimesh_instance_get_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  580. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  581. | void | :ref:`multimesh_instance_set_color<class_RenderingServer_method_multimesh_instance_set_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |
  582. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  583. | void | :ref:`multimesh_instance_set_custom_data<class_RenderingServer_method_multimesh_instance_set_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)** |
  584. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  585. | void | :ref:`multimesh_instance_set_transform<class_RenderingServer_method_multimesh_instance_set_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)** |
  586. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  587. | void | :ref:`multimesh_instance_set_transform_2d<class_RenderingServer_method_multimesh_instance_set_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)** |
  588. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  589. | void | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)** |
  590. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  591. | void | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>` **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)** |
  592. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  593. | void | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)** |
  594. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  595. | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>` **(** **)** |
  596. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  597. | void | :ref:`occluder_set_mesh<class_RenderingServer_method_occluder_set_mesh>` **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)** |
  598. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  599. | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>` **(** **)** |
  600. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  601. | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>` **(** **)** |
  602. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  603. | void | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>` **(** :ref:`RID<class_RID>` particles_collision **)** |
  604. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  605. | void | :ref:`particles_collision_set_attractor_attenuation<class_RenderingServer_method_particles_collision_set_attractor_attenuation>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)** |
  606. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  607. | void | :ref:`particles_collision_set_attractor_directionality<class_RenderingServer_method_particles_collision_set_attractor_directionality>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)** |
  608. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  609. | void | :ref:`particles_collision_set_attractor_strength<class_RenderingServer_method_particles_collision_set_attractor_strength>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` strength **)** |
  610. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  611. | void | :ref:`particles_collision_set_box_extents<class_RenderingServer_method_particles_collision_set_box_extents>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)** |
  612. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  613. | void | :ref:`particles_collision_set_collision_type<class_RenderingServer_method_particles_collision_set_collision_type>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)** |
  614. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  615. | void | :ref:`particles_collision_set_cull_mask<class_RenderingServer_method_particles_collision_set_cull_mask>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)** |
  616. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  617. | void | :ref:`particles_collision_set_field_texture<class_RenderingServer_method_particles_collision_set_field_texture>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)** |
  618. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  619. | void | :ref:`particles_collision_set_height_field_resolution<class_RenderingServer_method_particles_collision_set_height_field_resolution>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)** |
  620. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  621. | void | :ref:`particles_collision_set_sphere_radius<class_RenderingServer_method_particles_collision_set_sphere_radius>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)** |
  622. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  623. | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>` **(** **)** |
  624. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  625. | void | :ref:`particles_emit<class_RenderingServer_method_particles_emit>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)** |
  626. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  627. | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>` **(** :ref:`RID<class_RID>` particles **)** |
  628. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  629. | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
  630. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  631. | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
  632. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  633. | void | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
  634. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  635. | void | :ref:`particles_restart<class_RenderingServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
  636. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  637. | void | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
  638. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  639. | void | :ref:`particles_set_collision_base_size<class_RenderingServer_method_particles_set_collision_base_size>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)** |
  640. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  641. | void | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>` **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)** |
  642. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  643. | void | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)** |
  644. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  645. | void | :ref:`particles_set_draw_pass_mesh<class_RenderingServer_method_particles_set_draw_pass_mesh>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)** |
  646. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  647. | void | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)** |
  648. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  649. | void | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)** |
  650. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  651. | void | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)** |
  652. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  653. | void | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
  654. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  655. | void | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)** |
  656. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  657. | void | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  658. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  659. | void | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  660. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  661. | void | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)** |
  662. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  663. | void | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)** |
  664. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  665. | void | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)** |
  666. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  667. | void | :ref:`particles_set_pre_process_time<class_RenderingServer_method_particles_set_pre_process_time>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)** |
  668. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  669. | void | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)** |
  670. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  671. | void | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
  672. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  673. | void | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)** |
  674. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  675. | void | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)** |
  676. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  677. | void | :ref:`particles_set_trail_bind_poses<class_RenderingServer_method_particles_set_trail_bind_poses>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)** |
  678. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  679. | void | :ref:`particles_set_trails<class_RenderingServer_method_particles_set_trails>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)** |
  680. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  681. | void | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)** |
  682. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  683. | void | :ref:`particles_set_use_local_coordinates<class_RenderingServer_method_particles_set_use_local_coordinates>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  684. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  685. | void | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
  686. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  687. | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>` **(** **)** |
  688. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  689. | void | :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>` **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)** |
  690. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  691. | void | :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)** |
  692. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  693. | void | :ref:`reflection_probe_set_ambient_mode<class_RenderingServer_method_reflection_probe_set_ambient_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)** |
  694. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  695. | void | :ref:`reflection_probe_set_as_interior<class_RenderingServer_method_reflection_probe_set_as_interior>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  696. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  697. | void | :ref:`reflection_probe_set_cull_mask<class_RenderingServer_method_reflection_probe_set_cull_mask>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)** |
  698. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  699. | void | :ref:`reflection_probe_set_enable_box_projection<class_RenderingServer_method_reflection_probe_set_enable_box_projection>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  700. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  701. | void | :ref:`reflection_probe_set_enable_shadows<class_RenderingServer_method_reflection_probe_set_enable_shadows>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  702. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  703. | void | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)** |
  704. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  705. | void | :ref:`reflection_probe_set_max_distance<class_RenderingServer_method_reflection_probe_set_max_distance>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)** |
  706. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  707. | void | :ref:`reflection_probe_set_mesh_lod_threshold<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)** |
  708. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  709. | void | :ref:`reflection_probe_set_origin_offset<class_RenderingServer_method_reflection_probe_set_origin_offset>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)** |
  710. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  711. | void | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)** |
  712. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  713. | void | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)** |
  714. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  715. | void | :ref:`reflection_probe_set_update_mode<class_RenderingServer_method_reflection_probe_set_update_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)** |
  716. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  717. | void | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>` **(** :ref:`Callable<class_Callable>` callable **)** |
  718. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  719. | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>` **(** **)** |
  720. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  721. | void | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)** |
  722. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  723. | void | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
  724. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  725. | void | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
  726. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  727. | void | :ref:`screen_space_roughness_limiter_set_active<class_RenderingServer_method_screen_space_roughness_limiter_set_active>` **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)** |
  728. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  729. | void | :ref:`set_boot_image<class_RenderingServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)** |
  730. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  731. | void | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
  732. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  733. | void | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>` **(** :ref:`Color<class_Color>` color **)** |
  734. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  735. | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>` **(** **)** |
  736. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  737. | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>` **(** :ref:`RID<class_RID>` shader **)** |const| |
  738. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  739. | :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_parameter<class_RenderingServer_method_shader_get_default_texture_parameter>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` index=0 **)** |const| |
  740. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  741. | :ref:`Variant<class_Variant>` | :ref:`shader_get_parameter_default<class_RenderingServer_method_shader_get_parameter_default>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name **)** |const| |
  742. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  743. | void | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)** |
  744. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  745. | void | :ref:`shader_set_default_texture_parameter<class_RenderingServer_method_shader_set_default_texture_parameter>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)** |
  746. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  747. | void | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)** |
  748. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  749. | void | :ref:`skeleton_allocate_data<class_RenderingServer_method_skeleton_allocate_data>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)** |
  750. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  751. | :ref:`Transform3D<class_Transform3D>` | :ref:`skeleton_bone_get_transform<class_RenderingServer_method_skeleton_bone_get_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
  752. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  753. | :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_RenderingServer_method_skeleton_bone_get_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
  754. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  755. | void | :ref:`skeleton_bone_set_transform<class_RenderingServer_method_skeleton_bone_set_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)** |
  756. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  757. | void | :ref:`skeleton_bone_set_transform_2d<class_RenderingServer_method_skeleton_bone_set_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)** |
  758. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  759. | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>` **(** **)** |
  760. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  761. | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>` **(** :ref:`RID<class_RID>` skeleton **)** |const| |
  762. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  763. | void | :ref:`skeleton_set_base_transform_2d<class_RenderingServer_method_skeleton_set_base_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)** |
  764. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  765. | :ref:`Image<class_Image>` | :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>` **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
  766. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  767. | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>` **(** **)** |
  768. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  769. | void | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>` **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)** |
  770. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  771. | void | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>` **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)** |
  772. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  773. | void | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>` **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)** |
  774. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  775. | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>` **(** **)** |
  776. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  777. | void | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>` **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)** |
  778. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  779. | void | :ref:`sub_surface_scattering_set_scale<class_RenderingServer_method_sub_surface_scattering_set_scale>` **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)** |
  780. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  781. | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>` **(** :ref:`Image<class_Image>` image **)** |
  782. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  783. | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  784. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  785. | :ref:`Image<class_Image>` | :ref:`texture_2d_layer_get<class_RenderingServer_method_texture_2d_layer_get>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const| |
  786. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  787. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_create<class_RenderingServer_method_texture_2d_layered_create>` **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
  788. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  789. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>` **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
  790. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  791. | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>` **(** **)** |
  792. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  793. | void | :ref:`texture_2d_update<class_RenderingServer_method_texture_2d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)** |
  794. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  795. | :ref:`RID<class_RID>` | :ref:`texture_3d_create<class_RenderingServer_method_texture_3d_create>` **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)** |
  796. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  797. | :ref:`Image[]<class_Image>` | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  798. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  799. | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>` **(** **)** |
  800. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  801. | void | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)** |
  802. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  803. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingServer_method_texture_get_native_handle>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const| |
  804. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  805. | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  806. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  807. | :ref:`RID<class_RID>` | :ref:`texture_get_rd_texture<class_RenderingServer_method_texture_get_rd_texture>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const| |
  808. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  809. | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>` **(** :ref:`RID<class_RID>` base **)** |
  810. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  811. | void | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)** |
  812. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  813. | void | :ref:`texture_replace<class_RenderingServer_method_texture_replace>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)** |
  814. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  815. | void | :ref:`texture_set_force_redraw_if_visible<class_RenderingServer_method_texture_set_force_redraw_if_visible>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)** |
  816. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  817. | void | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>` **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)** |
  818. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  819. | void | :ref:`texture_set_size_override<class_RenderingServer_method_texture_set_size_override>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  820. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  821. | void | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)** |
  822. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  823. | void | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
  824. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  825. | void | :ref:`viewport_attach_to_screen<class_RenderingServer_method_viewport_attach_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)** |
  826. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  827. | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>` **(** **)** |
  828. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  829. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  830. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  831. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  832. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  833. | :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)** |
  834. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  835. | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  836. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  837. | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  838. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  839. | void | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
  840. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  841. | void | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)** |
  842. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  843. | void | :ref:`viewport_set_canvas_cull_mask<class_RenderingServer_method_viewport_set_canvas_cull_mask>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` canvas_cull_mask **)** |
  844. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  845. | void | :ref:`viewport_set_canvas_stacking<class_RenderingServer_method_viewport_set_canvas_stacking>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)** |
  846. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  847. | void | :ref:`viewport_set_canvas_transform<class_RenderingServer_method_viewport_set_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)** |
  848. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  849. | void | :ref:`viewport_set_clear_mode<class_RenderingServer_method_viewport_set_clear_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)** |
  850. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  851. | void | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)** |
  852. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  853. | void | :ref:`viewport_set_default_canvas_item_texture_filter<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  854. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  855. | void | :ref:`viewport_set_default_canvas_item_texture_repeat<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  856. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  857. | void | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
  858. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  859. | void | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
  860. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  861. | void | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)** |
  862. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  863. | void | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)** |
  864. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  865. | void | :ref:`viewport_set_global_canvas_transform<class_RenderingServer_method_viewport_set_global_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)** |
  866. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  867. | void | :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  868. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  869. | void | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
  870. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  871. | void | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
  872. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  873. | void | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>` **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)** |
  874. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  875. | void | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>` **(** :ref:`int<class_int>` rays_per_thread **)** |
  876. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  877. | void | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)** |
  878. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  879. | void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)** |
  880. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  881. | void | :ref:`viewport_set_positional_shadow_atlas_size<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)** |
  882. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  883. | void | :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  884. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  885. | void | :ref:`viewport_set_scaling_3d_mode<class_RenderingServer_method_viewport_set_scaling_3d_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)** |
  886. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  887. | void | :ref:`viewport_set_scaling_3d_scale<class_RenderingServer_method_viewport_set_scaling_3d_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)** |
  888. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  889. | void | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)** |
  890. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  891. | void | :ref:`viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)** |
  892. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  893. | void | :ref:`viewport_set_sdf_oversize_and_scale<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)** |
  894. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  895. | void | :ref:`viewport_set_size<class_RenderingServer_method_viewport_set_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  896. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  897. | void | :ref:`viewport_set_snap_2d_transforms_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  898. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  899. | void | :ref:`viewport_set_snap_2d_vertices_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  900. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  901. | void | :ref:`viewport_set_texture_mipmap_bias<class_RenderingServer_method_viewport_set_texture_mipmap_bias>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)** |
  902. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  903. | void | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  904. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  905. | void | :ref:`viewport_set_update_mode<class_RenderingServer_method_viewport_set_update_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)** |
  906. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  907. | void | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  908. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  909. | void | :ref:`viewport_set_use_occlusion_culling<class_RenderingServer_method_viewport_set_use_occlusion_culling>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  910. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  911. | void | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  912. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  913. | void | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)** |
  914. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  915. | void | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)** |
  916. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  917. | void | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)** |
  918. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  919. | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>` **(** **)** |
  920. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  921. | void | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>` **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)** |
  922. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  923. | void | :ref:`visibility_notifier_set_callbacks<class_RenderingServer_method_visibility_notifier_set_callbacks>` **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
  924. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  925. | void | :ref:`voxel_gi_allocate_data<class_RenderingServer_method_voxel_gi_allocate_data>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)** |
  926. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  927. | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>` **(** **)** |
  928. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  929. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_data_cells<class_RenderingServer_method_voxel_gi_get_data_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  930. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  931. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_distance_field<class_RenderingServer_method_voxel_gi_get_distance_field>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  932. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  933. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`voxel_gi_get_level_counts<class_RenderingServer_method_voxel_gi_get_level_counts>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  934. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  935. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_octree_cells<class_RenderingServer_method_voxel_gi_get_octree_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  936. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  937. | :ref:`Vector3i<class_Vector3i>` | :ref:`voxel_gi_get_octree_size<class_RenderingServer_method_voxel_gi_get_octree_size>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  938. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  939. | :ref:`Transform3D<class_Transform3D>` | :ref:`voxel_gi_get_to_cell_xform<class_RenderingServer_method_voxel_gi_get_to_cell_xform>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  940. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  941. | void | :ref:`voxel_gi_set_baked_exposure_normalization<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` baked_exposure **)** |
  942. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  943. | void | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
  944. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  945. | void | :ref:`voxel_gi_set_dynamic_range<class_RenderingServer_method_voxel_gi_set_dynamic_range>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)** |
  946. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  947. | void | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)** |
  948. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  949. | void | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
  950. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  951. | void | :ref:`voxel_gi_set_normal_bias<class_RenderingServer_method_voxel_gi_set_normal_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
  952. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  953. | void | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)** |
  954. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  955. | void | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>` **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)** |
  956. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  957. | void | :ref:`voxel_gi_set_use_two_bounces<class_RenderingServer_method_voxel_gi_set_use_two_bounces>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
  958. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  959. .. rst-class:: classref-section-separator
  960. ----
  961. .. rst-class:: classref-descriptions-group
  962. Signals
  963. -------
  964. .. _class_RenderingServer_signal_frame_post_draw:
  965. .. rst-class:: classref-signal
  966. **frame_post_draw** **(** **)**
  967. Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
  968. .. rst-class:: classref-item-separator
  969. ----
  970. .. _class_RenderingServer_signal_frame_pre_draw:
  971. .. rst-class:: classref-signal
  972. **frame_pre_draw** **(** **)**
  973. Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
  974. .. rst-class:: classref-section-separator
  975. ----
  976. .. rst-class:: classref-descriptions-group
  977. Enumerations
  978. ------------
  979. .. _enum_RenderingServer_TextureLayeredType:
  980. .. rst-class:: classref-enumeration
  981. enum **TextureLayeredType**:
  982. .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
  983. .. rst-class:: classref-enumeration-constant
  984. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
  985. Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
  986. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
  987. .. rst-class:: classref-enumeration-constant
  988. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
  989. Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
  990. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
  993. Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
  994. .. rst-class:: classref-item-separator
  995. ----
  996. .. _enum_RenderingServer_CubeMapLayer:
  997. .. rst-class:: classref-enumeration
  998. enum **CubeMapLayer**:
  999. .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
  1000. .. rst-class:: classref-enumeration-constant
  1001. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
  1002. Left face of a :ref:`Cubemap<class_Cubemap>`.
  1003. .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
  1004. .. rst-class:: classref-enumeration-constant
  1005. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
  1006. Right face of a :ref:`Cubemap<class_Cubemap>`.
  1007. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
  1008. .. rst-class:: classref-enumeration-constant
  1009. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
  1010. Bottom face of a :ref:`Cubemap<class_Cubemap>`.
  1011. .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
  1012. .. rst-class:: classref-enumeration-constant
  1013. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
  1014. Top face of a :ref:`Cubemap<class_Cubemap>`.
  1015. .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
  1016. .. rst-class:: classref-enumeration-constant
  1017. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
  1018. Front face of a :ref:`Cubemap<class_Cubemap>`.
  1019. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
  1020. .. rst-class:: classref-enumeration-constant
  1021. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
  1022. Back face of a :ref:`Cubemap<class_Cubemap>`.
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _enum_RenderingServer_ShaderMode:
  1026. .. rst-class:: classref-enumeration
  1027. enum **ShaderMode**:
  1028. .. _class_RenderingServer_constant_SHADER_SPATIAL:
  1029. .. rst-class:: classref-enumeration-constant
  1030. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
  1031. Shader is a 3D shader.
  1032. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
  1033. .. rst-class:: classref-enumeration-constant
  1034. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
  1035. Shader is a 2D shader.
  1036. .. _class_RenderingServer_constant_SHADER_PARTICLES:
  1037. .. rst-class:: classref-enumeration-constant
  1038. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
  1039. Shader is a particle shader (can be used in both 2D and 3D).
  1040. .. _class_RenderingServer_constant_SHADER_SKY:
  1041. .. rst-class:: classref-enumeration-constant
  1042. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
  1043. Shader is a 3D sky shader.
  1044. .. _class_RenderingServer_constant_SHADER_FOG:
  1045. .. rst-class:: classref-enumeration-constant
  1046. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
  1047. Shader is a 3D fog shader.
  1048. .. _class_RenderingServer_constant_SHADER_MAX:
  1049. .. rst-class:: classref-enumeration-constant
  1050. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
  1051. Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
  1052. .. rst-class:: classref-item-separator
  1053. ----
  1054. .. _enum_RenderingServer_ArrayType:
  1055. .. rst-class:: classref-enumeration
  1056. enum **ArrayType**:
  1057. .. _class_RenderingServer_constant_ARRAY_VERTEX:
  1058. .. rst-class:: classref-enumeration-constant
  1059. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
  1060. Array is a vertex position array.
  1061. .. _class_RenderingServer_constant_ARRAY_NORMAL:
  1062. .. rst-class:: classref-enumeration-constant
  1063. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
  1064. Array is a normal array.
  1065. .. _class_RenderingServer_constant_ARRAY_TANGENT:
  1066. .. rst-class:: classref-enumeration-constant
  1067. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
  1068. Array is a tangent array.
  1069. .. _class_RenderingServer_constant_ARRAY_COLOR:
  1070. .. rst-class:: classref-enumeration-constant
  1071. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
  1072. Array is a vertex color array.
  1073. .. _class_RenderingServer_constant_ARRAY_TEX_UV:
  1074. .. rst-class:: classref-enumeration-constant
  1075. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
  1076. Array is a UV coordinates array.
  1077. .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
  1078. .. rst-class:: classref-enumeration-constant
  1079. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
  1080. Array is a UV coordinates array for the second set of UV coordinates.
  1081. .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
  1082. .. rst-class:: classref-enumeration-constant
  1083. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
  1084. Array is a custom data array for the first set of custom data.
  1085. .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
  1086. .. rst-class:: classref-enumeration-constant
  1087. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
  1088. Array is a custom data array for the second set of custom data.
  1089. .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
  1090. .. rst-class:: classref-enumeration-constant
  1091. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
  1092. Array is a custom data array for the third set of custom data.
  1093. .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
  1094. .. rst-class:: classref-enumeration-constant
  1095. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
  1096. Array is a custom data array for the fourth set of custom data.
  1097. .. _class_RenderingServer_constant_ARRAY_BONES:
  1098. .. rst-class:: classref-enumeration-constant
  1099. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
  1100. Array contains bone information.
  1101. .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
  1102. .. rst-class:: classref-enumeration-constant
  1103. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
  1104. Array is weight information.
  1105. .. _class_RenderingServer_constant_ARRAY_INDEX:
  1106. .. rst-class:: classref-enumeration-constant
  1107. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
  1108. Array is an index array.
  1109. .. _class_RenderingServer_constant_ARRAY_MAX:
  1110. .. rst-class:: classref-enumeration-constant
  1111. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
  1112. Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _enum_RenderingServer_ArrayCustomFormat:
  1116. .. rst-class:: classref-enumeration
  1117. enum **ArrayCustomFormat**:
  1118. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
  1119. .. rst-class:: classref-enumeration-constant
  1120. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
  1121. 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.
  1122. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
  1123. .. rst-class:: classref-enumeration-constant
  1124. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
  1125. 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.
  1126. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
  1127. .. rst-class:: classref-enumeration-constant
  1128. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
  1129. Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
  1130. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
  1131. .. rst-class:: classref-enumeration-constant
  1132. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
  1133. Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
  1134. .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
  1135. .. rst-class:: classref-enumeration-constant
  1136. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
  1137. Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
  1138. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
  1139. .. rst-class:: classref-enumeration-constant
  1140. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
  1141. Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
  1142. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
  1143. .. rst-class:: classref-enumeration-constant
  1144. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
  1145. Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
  1146. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
  1147. .. rst-class:: classref-enumeration-constant
  1148. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
  1149. Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
  1150. .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
  1151. .. rst-class:: classref-enumeration-constant
  1152. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
  1153. Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
  1154. .. rst-class:: classref-item-separator
  1155. ----
  1156. .. _enum_RenderingServer_ArrayFormat:
  1157. .. rst-class:: classref-enumeration
  1158. flags **ArrayFormat**:
  1159. .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
  1160. .. rst-class:: classref-enumeration-constant
  1161. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
  1162. Flag used to mark a vertex position array.
  1163. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
  1164. .. rst-class:: classref-enumeration-constant
  1165. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
  1166. Flag used to mark a normal array.
  1167. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
  1168. .. rst-class:: classref-enumeration-constant
  1169. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
  1170. Flag used to mark a tangent array.
  1171. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
  1172. .. rst-class:: classref-enumeration-constant
  1173. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
  1174. Flag used to mark a vertex color array.
  1175. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
  1176. .. rst-class:: classref-enumeration-constant
  1177. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
  1178. Flag used to mark a UV coordinates array.
  1179. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
  1180. .. rst-class:: classref-enumeration-constant
  1181. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
  1182. Flag used to mark a UV coordinates array for the second UV coordinates.
  1183. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
  1184. .. rst-class:: classref-enumeration-constant
  1185. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
  1186. Flag used to mark an array of custom per-vertex data for the first set of custom data.
  1187. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
  1188. .. rst-class:: classref-enumeration-constant
  1189. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
  1190. Flag used to mark an array of custom per-vertex data for the second set of custom data.
  1191. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
  1192. .. rst-class:: classref-enumeration-constant
  1193. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
  1194. Flag used to mark an array of custom per-vertex data for the third set of custom data.
  1195. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
  1196. .. rst-class:: classref-enumeration-constant
  1197. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
  1198. Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
  1199. .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
  1200. .. rst-class:: classref-enumeration-constant
  1201. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
  1202. Flag used to mark a bone information array.
  1203. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
  1204. .. rst-class:: classref-enumeration-constant
  1205. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
  1206. Flag used to mark a weights array.
  1207. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
  1208. .. rst-class:: classref-enumeration-constant
  1209. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
  1210. Flag used to mark an index array.
  1211. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
  1212. .. rst-class:: classref-enumeration-constant
  1213. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
  1214. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
  1215. .. rst-class:: classref-enumeration-constant
  1216. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
  1217. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
  1218. .. rst-class:: classref-enumeration-constant
  1219. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
  1220. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
  1221. .. rst-class:: classref-enumeration-constant
  1222. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
  1223. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
  1224. .. rst-class:: classref-enumeration-constant
  1225. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
  1226. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
  1227. .. rst-class:: classref-enumeration-constant
  1228. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
  1229. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
  1230. .. rst-class:: classref-enumeration-constant
  1231. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
  1232. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
  1233. .. rst-class:: classref-enumeration-constant
  1234. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
  1235. .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
  1236. .. rst-class:: classref-enumeration-constant
  1237. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
  1238. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
  1239. .. rst-class:: classref-enumeration-constant
  1240. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
  1241. Flag used to mark that the array contains 2D vertices.
  1242. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
  1243. .. rst-class:: classref-enumeration-constant
  1244. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
  1245. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
  1246. .. rst-class:: classref-enumeration-constant
  1247. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
  1248. Flag used to mark that the array uses 8 bone weighs instead of 4.
  1249. .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
  1250. .. rst-class:: classref-enumeration-constant
  1251. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _enum_RenderingServer_PrimitiveType:
  1255. .. rst-class:: classref-enumeration
  1256. enum **PrimitiveType**:
  1257. .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
  1258. .. rst-class:: classref-enumeration-constant
  1259. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
  1260. Primitive to draw consists of points.
  1261. .. _class_RenderingServer_constant_PRIMITIVE_LINES:
  1262. .. rst-class:: classref-enumeration-constant
  1263. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
  1264. Primitive to draw consists of lines.
  1265. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
  1266. .. rst-class:: classref-enumeration-constant
  1267. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
  1268. Primitive to draw consists of a line strip from start to end.
  1269. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
  1270. .. rst-class:: classref-enumeration-constant
  1271. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
  1272. Primitive to draw consists of triangles.
  1273. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
  1274. .. rst-class:: classref-enumeration-constant
  1275. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
  1276. Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  1277. .. _class_RenderingServer_constant_PRIMITIVE_MAX:
  1278. .. rst-class:: classref-enumeration-constant
  1279. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
  1280. Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
  1281. .. rst-class:: classref-item-separator
  1282. ----
  1283. .. _enum_RenderingServer_BlendShapeMode:
  1284. .. rst-class:: classref-enumeration
  1285. enum **BlendShapeMode**:
  1286. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
  1287. .. rst-class:: classref-enumeration-constant
  1288. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
  1289. Blend shapes are normalized.
  1290. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
  1291. .. rst-class:: classref-enumeration-constant
  1292. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
  1293. Blend shapes are relative to base weight.
  1294. .. rst-class:: classref-item-separator
  1295. ----
  1296. .. _enum_RenderingServer_MultimeshTransformFormat:
  1297. .. rst-class:: classref-enumeration
  1298. enum **MultimeshTransformFormat**:
  1299. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
  1300. .. rst-class:: classref-enumeration-constant
  1301. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
  1302. Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
  1303. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
  1304. .. rst-class:: classref-enumeration-constant
  1305. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
  1306. Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _enum_RenderingServer_LightProjectorFilter:
  1310. .. rst-class:: classref-enumeration
  1311. enum **LightProjectorFilter**:
  1312. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
  1313. .. rst-class:: classref-enumeration-constant
  1314. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
  1315. 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.
  1316. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
  1317. .. rst-class:: classref-enumeration-constant
  1318. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
  1319. 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.
  1320. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
  1321. .. rst-class:: classref-enumeration-constant
  1322. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
  1323. 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.
  1324. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
  1325. .. rst-class:: classref-enumeration-constant
  1326. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
  1327. 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.
  1328. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1329. .. rst-class:: classref-enumeration-constant
  1330. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1331. 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>`.
  1332. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1335. 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>`.
  1336. .. rst-class:: classref-item-separator
  1337. ----
  1338. .. _enum_RenderingServer_LightType:
  1339. .. rst-class:: classref-enumeration
  1340. enum **LightType**:
  1341. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
  1342. .. rst-class:: classref-enumeration-constant
  1343. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
  1344. Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
  1345. .. _class_RenderingServer_constant_LIGHT_OMNI:
  1346. .. rst-class:: classref-enumeration-constant
  1347. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
  1348. Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
  1349. .. _class_RenderingServer_constant_LIGHT_SPOT:
  1350. .. rst-class:: classref-enumeration-constant
  1351. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
  1352. Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
  1353. .. rst-class:: classref-item-separator
  1354. ----
  1355. .. _enum_RenderingServer_LightParam:
  1356. .. rst-class:: classref-enumeration
  1357. enum **LightParam**:
  1358. .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
  1359. .. rst-class:: classref-enumeration-constant
  1360. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
  1361. The light's energy multiplier.
  1362. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
  1363. .. rst-class:: classref-enumeration-constant
  1364. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
  1365. 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>`).
  1366. .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
  1367. .. rst-class:: classref-enumeration-constant
  1368. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
  1369. 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>`).
  1370. .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
  1371. .. rst-class:: classref-enumeration-constant
  1372. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
  1373. The light's influence on specularity.
  1374. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
  1375. .. rst-class:: classref-enumeration-constant
  1376. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
  1377. The light's range.
  1378. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
  1379. .. rst-class:: classref-enumeration-constant
  1380. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
  1381. The size of the light when using spot light or omni light. The angular size of the light when using directional light.
  1382. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
  1383. .. rst-class:: classref-enumeration-constant
  1384. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
  1385. The light's attenuation.
  1386. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
  1387. .. rst-class:: classref-enumeration-constant
  1388. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
  1389. The spotlight's angle.
  1390. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
  1391. .. rst-class:: classref-enumeration-constant
  1392. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
  1393. The spotlight's attenuation.
  1394. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
  1395. .. rst-class:: classref-enumeration-constant
  1396. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
  1397. 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).
  1398. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
  1399. .. rst-class:: classref-enumeration-constant
  1400. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
  1401. Proportion of shadow atlas occupied by the first split.
  1402. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
  1403. .. rst-class:: classref-enumeration-constant
  1404. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
  1405. Proportion of shadow atlas occupied by the second split.
  1406. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
  1407. .. rst-class:: classref-enumeration-constant
  1408. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
  1409. Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
  1410. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
  1411. .. rst-class:: classref-enumeration-constant
  1412. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
  1413. Proportion of shadow max distance where the shadow will start to fade out.
  1414. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
  1417. Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
  1418. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
  1421. Bias the shadow lookup to fix self-shadowing artifacts.
  1422. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
  1423. .. rst-class:: classref-enumeration-constant
  1424. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
  1425. 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.
  1426. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
  1427. .. rst-class:: classref-enumeration-constant
  1428. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
  1429. 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.
  1430. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
  1431. .. rst-class:: classref-enumeration-constant
  1432. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
  1433. 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.
  1434. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
  1435. .. rst-class:: classref-enumeration-constant
  1436. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
  1437. .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
  1438. .. rst-class:: classref-enumeration-constant
  1439. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
  1440. 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``.
  1441. .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
  1442. .. rst-class:: classref-enumeration-constant
  1443. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
  1444. Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
  1445. .. rst-class:: classref-item-separator
  1446. ----
  1447. .. _enum_RenderingServer_LightBakeMode:
  1448. .. rst-class:: classref-enumeration
  1449. enum **LightBakeMode**:
  1450. .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
  1451. .. rst-class:: classref-enumeration-constant
  1452. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
  1453. 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.
  1454. .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
  1455. .. rst-class:: classref-enumeration-constant
  1456. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
  1457. 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.
  1458. .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
  1459. .. rst-class:: classref-enumeration-constant
  1460. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
  1461. 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>`.
  1462. .. rst-class:: classref-item-separator
  1463. ----
  1464. .. _enum_RenderingServer_LightOmniShadowMode:
  1465. .. rst-class:: classref-enumeration
  1466. enum **LightOmniShadowMode**:
  1467. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
  1468. .. rst-class:: classref-enumeration-constant
  1469. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
  1470. Use a dual paraboloid shadow map for omni lights.
  1471. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
  1472. .. rst-class:: classref-enumeration-constant
  1473. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
  1474. Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
  1475. .. rst-class:: classref-item-separator
  1476. ----
  1477. .. _enum_RenderingServer_LightDirectionalShadowMode:
  1478. .. rst-class:: classref-enumeration
  1479. enum **LightDirectionalShadowMode**:
  1480. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
  1481. .. rst-class:: classref-enumeration-constant
  1482. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
  1483. Use orthogonal shadow projection for directional light.
  1484. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
  1485. .. rst-class:: classref-enumeration-constant
  1486. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
  1487. Use 2 splits for shadow projection when using directional light.
  1488. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
  1489. .. rst-class:: classref-enumeration-constant
  1490. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
  1491. Use 4 splits for shadow projection when using directional light.
  1492. .. rst-class:: classref-item-separator
  1493. ----
  1494. .. _enum_RenderingServer_LightDirectionalSkyMode:
  1495. .. rst-class:: classref-enumeration
  1496. enum **LightDirectionalSkyMode**:
  1497. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
  1498. .. rst-class:: classref-enumeration-constant
  1499. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
  1500. Use DirectionalLight3D in both sky rendering and scene lighting.
  1501. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
  1502. .. rst-class:: classref-enumeration-constant
  1503. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
  1504. Only use DirectionalLight3D in scene lighting.
  1505. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
  1506. .. rst-class:: classref-enumeration-constant
  1507. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
  1508. Only use DirectionalLight3D in sky rendering.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _enum_RenderingServer_ShadowQuality:
  1512. .. rst-class:: classref-enumeration
  1513. enum **ShadowQuality**:
  1514. .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
  1515. .. rst-class:: classref-enumeration-constant
  1516. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
  1517. 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``.
  1518. \ **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.
  1519. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
  1520. .. rst-class:: classref-enumeration-constant
  1521. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
  1522. 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``).
  1523. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
  1524. .. rst-class:: classref-enumeration-constant
  1525. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
  1526. Low shadow filtering quality (fast).
  1527. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
  1528. .. rst-class:: classref-enumeration-constant
  1529. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
  1530. Medium low shadow filtering quality (average).
  1531. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
  1532. .. rst-class:: classref-enumeration-constant
  1533. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
  1534. 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``).
  1535. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
  1536. .. rst-class:: classref-enumeration-constant
  1537. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
  1538. 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``).
  1539. .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
  1540. .. rst-class:: classref-enumeration-constant
  1541. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
  1542. Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
  1543. .. rst-class:: classref-item-separator
  1544. ----
  1545. .. _enum_RenderingServer_ReflectionProbeUpdateMode:
  1546. .. rst-class:: classref-enumeration
  1547. enum **ReflectionProbeUpdateMode**:
  1548. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
  1549. .. rst-class:: classref-enumeration-constant
  1550. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
  1551. Reflection probe will update reflections once and then stop.
  1552. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
  1553. .. rst-class:: classref-enumeration-constant
  1554. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
  1555. Reflection probe will update each frame. This mode is necessary to capture moving objects.
  1556. .. rst-class:: classref-item-separator
  1557. ----
  1558. .. _enum_RenderingServer_ReflectionProbeAmbientMode:
  1559. .. rst-class:: classref-enumeration
  1560. enum **ReflectionProbeAmbientMode**:
  1561. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
  1562. .. rst-class:: classref-enumeration-constant
  1563. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
  1564. Do not apply any ambient lighting inside the reflection probe's box defined by its size.
  1565. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
  1566. .. rst-class:: classref-enumeration-constant
  1567. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
  1568. Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
  1569. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
  1570. .. rst-class:: classref-enumeration-constant
  1571. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
  1572. 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>`.
  1573. .. rst-class:: classref-item-separator
  1574. ----
  1575. .. _enum_RenderingServer_DecalTexture:
  1576. .. rst-class:: classref-enumeration
  1577. enum **DecalTexture**:
  1578. .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
  1579. .. rst-class:: classref-enumeration-constant
  1580. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
  1581. Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
  1582. .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
  1583. .. rst-class:: classref-enumeration-constant
  1584. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
  1585. Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
  1586. .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
  1587. .. rst-class:: classref-enumeration-constant
  1588. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
  1589. Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
  1590. .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
  1591. .. rst-class:: classref-enumeration-constant
  1592. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
  1593. Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
  1594. .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
  1595. .. rst-class:: classref-enumeration-constant
  1596. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
  1597. Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
  1598. .. rst-class:: classref-item-separator
  1599. ----
  1600. .. _enum_RenderingServer_DecalFilter:
  1601. .. rst-class:: classref-enumeration
  1602. enum **DecalFilter**:
  1603. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
  1604. .. rst-class:: classref-enumeration-constant
  1605. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
  1606. 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.
  1607. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
  1608. .. rst-class:: classref-enumeration-constant
  1609. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
  1610. 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.
  1611. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
  1612. .. rst-class:: classref-enumeration-constant
  1613. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
  1614. 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.
  1615. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
  1616. .. rst-class:: classref-enumeration-constant
  1617. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
  1618. 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.
  1619. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1620. .. rst-class:: classref-enumeration-constant
  1621. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1622. 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>`.
  1623. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1624. .. rst-class:: classref-enumeration-constant
  1625. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1626. 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>`.
  1627. .. rst-class:: classref-item-separator
  1628. ----
  1629. .. _enum_RenderingServer_VoxelGIQuality:
  1630. .. rst-class:: classref-enumeration
  1631. enum **VoxelGIQuality**:
  1632. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
  1633. .. rst-class:: classref-enumeration-constant
  1634. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
  1635. Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
  1636. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
  1637. .. rst-class:: classref-enumeration-constant
  1638. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
  1639. High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _enum_RenderingServer_ParticlesMode:
  1643. .. rst-class:: classref-enumeration
  1644. enum **ParticlesMode**:
  1645. .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
  1646. .. rst-class:: classref-enumeration-constant
  1647. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
  1648. 2D particles.
  1649. .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
  1650. .. rst-class:: classref-enumeration-constant
  1651. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
  1652. 3D particles.
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _enum_RenderingServer_ParticlesTransformAlign:
  1656. .. rst-class:: classref-enumeration
  1657. enum **ParticlesTransformAlign**:
  1658. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
  1659. .. rst-class:: classref-enumeration-constant
  1660. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
  1661. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
  1662. .. rst-class:: classref-enumeration-constant
  1663. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
  1664. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
  1665. .. rst-class:: classref-enumeration-constant
  1666. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
  1667. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
  1668. .. rst-class:: classref-enumeration-constant
  1669. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
  1670. .. rst-class:: classref-item-separator
  1671. ----
  1672. .. _enum_RenderingServer_ParticlesDrawOrder:
  1673. .. rst-class:: classref-enumeration
  1674. enum **ParticlesDrawOrder**:
  1675. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
  1676. .. rst-class:: classref-enumeration-constant
  1677. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
  1678. Draw particles in the order that they appear in the particles array.
  1679. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
  1680. .. rst-class:: classref-enumeration-constant
  1681. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
  1682. Sort particles based on their lifetime.
  1683. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
  1684. .. rst-class:: classref-enumeration-constant
  1685. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
  1686. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
  1687. .. rst-class:: classref-enumeration-constant
  1688. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
  1689. Sort particles based on their distance to the camera.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _enum_RenderingServer_ParticlesCollisionType:
  1693. .. rst-class:: classref-enumeration
  1694. enum **ParticlesCollisionType**:
  1695. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1696. .. rst-class:: classref-enumeration-constant
  1697. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
  1698. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
  1699. .. rst-class:: classref-enumeration-constant
  1700. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
  1701. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
  1702. .. rst-class:: classref-enumeration-constant
  1703. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
  1704. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
  1705. .. rst-class:: classref-enumeration-constant
  1706. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
  1707. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
  1708. .. rst-class:: classref-enumeration-constant
  1709. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
  1710. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
  1711. .. rst-class:: classref-enumeration-constant
  1712. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
  1713. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
  1714. .. rst-class:: classref-enumeration-constant
  1715. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
  1716. .. rst-class:: classref-item-separator
  1717. ----
  1718. .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
  1719. .. rst-class:: classref-enumeration
  1720. enum **ParticlesCollisionHeightfieldResolution**:
  1721. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
  1722. .. rst-class:: classref-enumeration-constant
  1723. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
  1724. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
  1725. .. rst-class:: classref-enumeration-constant
  1726. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
  1727. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
  1728. .. rst-class:: classref-enumeration-constant
  1729. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
  1730. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
  1731. .. rst-class:: classref-enumeration-constant
  1732. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
  1733. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
  1734. .. rst-class:: classref-enumeration-constant
  1735. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
  1736. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
  1737. .. rst-class:: classref-enumeration-constant
  1738. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
  1739. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
  1740. .. rst-class:: classref-enumeration-constant
  1741. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
  1742. Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
  1743. .. rst-class:: classref-item-separator
  1744. ----
  1745. .. _enum_RenderingServer_FogVolumeShape:
  1746. .. rst-class:: classref-enumeration
  1747. enum **FogVolumeShape**:
  1748. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
  1749. .. rst-class:: classref-enumeration-constant
  1750. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
  1751. :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
  1752. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
  1753. .. rst-class:: classref-enumeration-constant
  1754. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
  1755. :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).
  1756. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
  1757. .. rst-class:: classref-enumeration-constant
  1758. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
  1759. :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).
  1760. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
  1761. .. rst-class:: classref-enumeration-constant
  1762. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
  1763. :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
  1764. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
  1765. .. rst-class:: classref-enumeration-constant
  1766. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
  1767. :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
  1768. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
  1769. .. rst-class:: classref-enumeration-constant
  1770. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
  1771. Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
  1772. .. rst-class:: classref-item-separator
  1773. ----
  1774. .. _enum_RenderingServer_ViewportScaling3DMode:
  1775. .. rst-class:: classref-enumeration
  1776. enum **ViewportScaling3DMode**:
  1777. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
  1778. .. rst-class:: classref-enumeration-constant
  1779. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
  1780. 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.
  1781. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
  1782. .. rst-class:: classref-enumeration-constant
  1783. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
  1784. 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.
  1785. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
  1786. .. rst-class:: classref-enumeration-constant
  1787. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``2``
  1788. Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
  1789. .. rst-class:: classref-item-separator
  1790. ----
  1791. .. _enum_RenderingServer_ViewportUpdateMode:
  1792. .. rst-class:: classref-enumeration
  1793. enum **ViewportUpdateMode**:
  1794. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
  1795. .. rst-class:: classref-enumeration-constant
  1796. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
  1797. Do not update the viewport's render target.
  1798. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
  1799. .. rst-class:: classref-enumeration-constant
  1800. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
  1801. Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
  1802. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
  1803. .. rst-class:: classref-enumeration-constant
  1804. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
  1805. Update the viewport's render target only when it is visible. This is the default value.
  1806. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
  1807. .. rst-class:: classref-enumeration-constant
  1808. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
  1809. Update the viewport's render target only when its parent is visible.
  1810. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
  1811. .. rst-class:: classref-enumeration-constant
  1812. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
  1813. Always update the viewport's render target.
  1814. .. rst-class:: classref-item-separator
  1815. ----
  1816. .. _enum_RenderingServer_ViewportClearMode:
  1817. .. rst-class:: classref-enumeration
  1818. enum **ViewportClearMode**:
  1819. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
  1820. .. rst-class:: classref-enumeration-constant
  1821. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
  1822. Always clear the viewport's render target before drawing.
  1823. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
  1824. .. rst-class:: classref-enumeration-constant
  1825. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
  1826. Never clear the viewport's render target.
  1827. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
  1828. .. rst-class:: classref-enumeration-constant
  1829. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
  1830. Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
  1831. .. rst-class:: classref-item-separator
  1832. ----
  1833. .. _enum_RenderingServer_ViewportEnvironmentMode:
  1834. .. rst-class:: classref-enumeration
  1835. enum **ViewportEnvironmentMode**:
  1836. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
  1837. .. rst-class:: classref-enumeration-constant
  1838. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
  1839. Disable rendering of 3D environment over 2D canvas.
  1840. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
  1841. .. rst-class:: classref-enumeration-constant
  1842. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
  1843. Enable rendering of 3D environment over 2D canvas.
  1844. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
  1845. .. rst-class:: classref-enumeration-constant
  1846. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
  1847. 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>`.
  1848. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
  1849. .. rst-class:: classref-enumeration-constant
  1850. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
  1851. Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
  1852. .. rst-class:: classref-item-separator
  1853. ----
  1854. .. _enum_RenderingServer_ViewportSDFOversize:
  1855. .. rst-class:: classref-enumeration
  1856. enum **ViewportSDFOversize**:
  1857. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
  1858. .. rst-class:: classref-enumeration-constant
  1859. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
  1860. 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.
  1861. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
  1862. .. rst-class:: classref-enumeration-constant
  1863. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
  1864. 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  1865. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
  1866. .. rst-class:: classref-enumeration-constant
  1867. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
  1868. 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  1869. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
  1870. .. rst-class:: classref-enumeration-constant
  1871. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
  1872. 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.
  1873. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
  1874. .. rst-class:: classref-enumeration-constant
  1875. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
  1876. Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
  1877. .. rst-class:: classref-item-separator
  1878. ----
  1879. .. _enum_RenderingServer_ViewportSDFScale:
  1880. .. rst-class:: classref-enumeration
  1881. enum **ViewportSDFScale**:
  1882. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
  1883. .. rst-class:: classref-enumeration-constant
  1884. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
  1885. Full resolution 2D signed distance field scale. This has the highest GPU requirements.
  1886. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
  1887. .. rst-class:: classref-enumeration-constant
  1888. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
  1889. Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
  1890. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
  1891. .. rst-class:: classref-enumeration-constant
  1892. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
  1893. Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
  1894. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
  1895. .. rst-class:: classref-enumeration-constant
  1896. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
  1897. Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
  1898. .. rst-class:: classref-item-separator
  1899. ----
  1900. .. _enum_RenderingServer_ViewportMSAA:
  1901. .. rst-class:: classref-enumeration
  1902. enum **ViewportMSAA**:
  1903. .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
  1904. .. rst-class:: classref-enumeration-constant
  1905. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
  1906. Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
  1907. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
  1908. .. rst-class:: classref-enumeration-constant
  1909. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
  1910. Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
  1911. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
  1912. .. rst-class:: classref-enumeration-constant
  1913. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
  1914. Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
  1915. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
  1916. .. rst-class:: classref-enumeration-constant
  1917. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
  1918. 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.
  1919. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
  1920. .. rst-class:: classref-enumeration-constant
  1921. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
  1922. Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
  1923. .. rst-class:: classref-item-separator
  1924. ----
  1925. .. _enum_RenderingServer_ViewportScreenSpaceAA:
  1926. .. rst-class:: classref-enumeration
  1927. enum **ViewportScreenSpaceAA**:
  1928. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
  1929. .. rst-class:: classref-enumeration-constant
  1930. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
  1931. Do not perform any antialiasing in the full screen post-process.
  1932. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
  1933. .. rst-class:: classref-enumeration-constant
  1934. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
  1935. 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.
  1936. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
  1937. .. rst-class:: classref-enumeration-constant
  1938. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2``
  1939. Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
  1940. .. rst-class:: classref-item-separator
  1941. ----
  1942. .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
  1943. .. rst-class:: classref-enumeration
  1944. enum **ViewportOcclusionCullingBuildQuality**:
  1945. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
  1946. .. rst-class:: classref-enumeration-constant
  1947. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
  1948. Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
  1949. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
  1950. .. rst-class:: classref-enumeration-constant
  1951. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
  1952. Medium occlusion culling BVH build quality (as defined by Embree).
  1953. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
  1954. .. rst-class:: classref-enumeration-constant
  1955. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
  1956. High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
  1957. .. rst-class:: classref-item-separator
  1958. ----
  1959. .. _enum_RenderingServer_ViewportRenderInfo:
  1960. .. rst-class:: classref-enumeration
  1961. enum **ViewportRenderInfo**:
  1962. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
  1963. .. rst-class:: classref-enumeration-constant
  1964. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
  1965. Number of objects drawn in a single frame.
  1966. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
  1967. .. rst-class:: classref-enumeration-constant
  1968. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
  1969. Number of points, lines, or triangles drawn in a single frame.
  1970. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
  1971. .. rst-class:: classref-enumeration-constant
  1972. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
  1973. Number of draw calls during this frame.
  1974. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
  1975. .. rst-class:: classref-enumeration-constant
  1976. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
  1977. Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
  1978. .. rst-class:: classref-item-separator
  1979. ----
  1980. .. _enum_RenderingServer_ViewportRenderInfoType:
  1981. .. rst-class:: classref-enumeration
  1982. enum **ViewportRenderInfoType**:
  1983. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
  1984. .. rst-class:: classref-enumeration-constant
  1985. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
  1986. Visible render pass (excluding shadows).
  1987. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
  1988. .. rst-class:: classref-enumeration-constant
  1989. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
  1990. 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.
  1991. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
  1992. .. rst-class:: classref-enumeration-constant
  1993. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``2``
  1994. Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
  1995. .. rst-class:: classref-item-separator
  1996. ----
  1997. .. _enum_RenderingServer_ViewportDebugDraw:
  1998. .. rst-class:: classref-enumeration
  1999. enum **ViewportDebugDraw**:
  2000. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
  2001. .. rst-class:: classref-enumeration-constant
  2002. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
  2003. Debug draw is disabled. Default setting.
  2004. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
  2005. .. rst-class:: classref-enumeration-constant
  2006. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
  2007. Objects are displayed without light information.
  2008. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
  2009. .. rst-class:: classref-enumeration-constant
  2010. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
  2011. Objects are displayed with only light information.
  2012. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
  2013. .. rst-class:: classref-enumeration-constant
  2014. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
  2015. 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.
  2016. \ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
  2017. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
  2018. .. rst-class:: classref-enumeration-constant
  2019. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
  2020. Debug draw draws objects in wireframe.
  2021. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
  2022. .. rst-class:: classref-enumeration-constant
  2023. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
  2024. Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
  2025. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
  2026. .. rst-class:: classref-enumeration-constant
  2027. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
  2028. Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2029. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
  2030. .. rst-class:: classref-enumeration-constant
  2031. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
  2032. Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2033. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
  2034. .. rst-class:: classref-enumeration-constant
  2035. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
  2036. Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2037. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
  2038. .. rst-class:: classref-enumeration-constant
  2039. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
  2040. 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>`.
  2041. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
  2042. .. rst-class:: classref-enumeration-constant
  2043. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
  2044. Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2045. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
  2046. .. rst-class:: classref-enumeration-constant
  2047. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
  2048. Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
  2049. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
  2050. .. rst-class:: classref-enumeration-constant
  2051. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
  2052. 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>`.
  2053. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
  2054. .. rst-class:: classref-enumeration-constant
  2055. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
  2056. 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>`.
  2057. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
  2058. .. rst-class:: classref-enumeration-constant
  2059. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
  2060. 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.
  2061. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
  2062. .. rst-class:: classref-enumeration-constant
  2063. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
  2064. Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
  2065. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
  2066. .. rst-class:: classref-enumeration-constant
  2067. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
  2068. Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
  2069. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
  2070. .. rst-class:: classref-enumeration-constant
  2071. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
  2072. Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
  2073. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
  2074. .. rst-class:: classref-enumeration-constant
  2075. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
  2076. Draws the global illumination buffer (:ref:`VoxelGI<class_VoxelGI>` or SDFGI).
  2077. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
  2078. .. rst-class:: classref-enumeration-constant
  2079. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
  2080. Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
  2081. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
  2082. .. rst-class:: classref-enumeration-constant
  2083. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
  2084. 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.
  2085. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
  2086. .. rst-class:: classref-enumeration-constant
  2087. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
  2088. 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.
  2089. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
  2090. .. rst-class:: classref-enumeration-constant
  2091. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
  2092. 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.
  2093. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
  2094. .. rst-class:: classref-enumeration-constant
  2095. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
  2096. 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.
  2097. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
  2098. .. rst-class:: classref-enumeration-constant
  2099. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
  2100. 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.
  2101. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
  2102. .. rst-class:: classref-enumeration-constant
  2103. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
  2104. Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
  2105. .. rst-class:: classref-item-separator
  2106. ----
  2107. .. _enum_RenderingServer_ViewportVRSMode:
  2108. .. rst-class:: classref-enumeration
  2109. enum **ViewportVRSMode**:
  2110. .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
  2111. .. rst-class:: classref-enumeration-constant
  2112. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
  2113. Variable rate shading is disabled.
  2114. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
  2115. .. rst-class:: classref-enumeration-constant
  2116. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
  2117. Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
  2118. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
  2119. .. rst-class:: classref-enumeration-constant
  2120. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
  2121. Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`.
  2122. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
  2123. .. rst-class:: classref-enumeration-constant
  2124. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
  2125. Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
  2126. .. rst-class:: classref-item-separator
  2127. ----
  2128. .. _enum_RenderingServer_SkyMode:
  2129. .. rst-class:: classref-enumeration
  2130. enum **SkyMode**:
  2131. .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
  2132. .. rst-class:: classref-enumeration-constant
  2133. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
  2134. 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>`.
  2135. .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
  2136. .. rst-class:: classref-enumeration-constant
  2137. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
  2138. 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>`.
  2139. .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
  2140. .. rst-class:: classref-enumeration-constant
  2141. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
  2142. 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.
  2143. .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
  2144. .. rst-class:: classref-enumeration-constant
  2145. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
  2146. 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>`.
  2147. \ **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.
  2148. .. rst-class:: classref-item-separator
  2149. ----
  2150. .. _enum_RenderingServer_EnvironmentBG:
  2151. .. rst-class:: classref-enumeration
  2152. enum **EnvironmentBG**:
  2153. .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
  2154. .. rst-class:: classref-enumeration-constant
  2155. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
  2156. Use the clear color as background.
  2157. .. _class_RenderingServer_constant_ENV_BG_COLOR:
  2158. .. rst-class:: classref-enumeration-constant
  2159. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
  2160. Use a specified color as the background.
  2161. .. _class_RenderingServer_constant_ENV_BG_SKY:
  2162. .. rst-class:: classref-enumeration-constant
  2163. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
  2164. Use a sky resource for the background.
  2165. .. _class_RenderingServer_constant_ENV_BG_CANVAS:
  2166. .. rst-class:: classref-enumeration-constant
  2167. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
  2168. Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
  2169. .. _class_RenderingServer_constant_ENV_BG_KEEP:
  2170. .. rst-class:: classref-enumeration-constant
  2171. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
  2172. Do not clear the background, use whatever was rendered last frame as the background.
  2173. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
  2174. .. rst-class:: classref-enumeration-constant
  2175. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
  2176. Displays a camera feed in the background.
  2177. .. _class_RenderingServer_constant_ENV_BG_MAX:
  2178. .. rst-class:: classref-enumeration-constant
  2179. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
  2180. Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
  2181. .. rst-class:: classref-item-separator
  2182. ----
  2183. .. _enum_RenderingServer_EnvironmentAmbientSource:
  2184. .. rst-class:: classref-enumeration
  2185. enum **EnvironmentAmbientSource**:
  2186. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
  2187. .. rst-class:: classref-enumeration-constant
  2188. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
  2189. Gather ambient light from whichever source is specified as the background.
  2190. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
  2191. .. rst-class:: classref-enumeration-constant
  2192. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
  2193. Disable ambient light.
  2194. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
  2195. .. rst-class:: classref-enumeration-constant
  2196. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
  2197. Specify a specific :ref:`Color<class_Color>` for ambient light.
  2198. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
  2199. .. rst-class:: classref-enumeration-constant
  2200. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
  2201. Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
  2202. .. rst-class:: classref-item-separator
  2203. ----
  2204. .. _enum_RenderingServer_EnvironmentReflectionSource:
  2205. .. rst-class:: classref-enumeration
  2206. enum **EnvironmentReflectionSource**:
  2207. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
  2208. .. rst-class:: classref-enumeration-constant
  2209. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
  2210. Use the background for reflections.
  2211. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
  2212. .. rst-class:: classref-enumeration-constant
  2213. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
  2214. Disable reflections.
  2215. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
  2216. .. rst-class:: classref-enumeration-constant
  2217. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
  2218. Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
  2219. .. rst-class:: classref-item-separator
  2220. ----
  2221. .. _enum_RenderingServer_EnvironmentGlowBlendMode:
  2222. .. rst-class:: classref-enumeration
  2223. enum **EnvironmentGlowBlendMode**:
  2224. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
  2225. .. rst-class:: classref-enumeration-constant
  2226. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
  2227. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  2228. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
  2229. .. rst-class:: classref-enumeration-constant
  2230. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
  2231. Screen glow blending mode. Increases brightness, used frequently with bloom.
  2232. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
  2233. .. rst-class:: classref-enumeration-constant
  2234. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
  2235. Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
  2236. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
  2237. .. rst-class:: classref-enumeration-constant
  2238. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
  2239. 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.
  2240. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
  2241. .. rst-class:: classref-enumeration-constant
  2242. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
  2243. Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
  2244. .. rst-class:: classref-item-separator
  2245. ----
  2246. .. _enum_RenderingServer_EnvironmentToneMapper:
  2247. .. rst-class:: classref-enumeration
  2248. enum **EnvironmentToneMapper**:
  2249. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
  2250. .. rst-class:: classref-enumeration-constant
  2251. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
  2252. Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
  2253. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
  2254. .. rst-class:: classref-enumeration-constant
  2255. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
  2256. Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: ``color = color / (1 + color)``. This avoids clipping bright highlights, but the resulting image can look a bit dull.
  2257. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
  2258. .. rst-class:: classref-enumeration-constant
  2259. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
  2260. 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>`.
  2261. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
  2262. .. rst-class:: classref-enumeration-constant
  2263. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
  2264. 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>`.
  2265. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
  2266. .. rst-class:: classref-item-separator
  2267. ----
  2268. .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
  2269. .. rst-class:: classref-enumeration
  2270. enum **EnvironmentSSRRoughnessQuality**:
  2271. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
  2272. .. rst-class:: classref-enumeration-constant
  2273. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
  2274. 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.
  2275. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
  2276. .. rst-class:: classref-enumeration-constant
  2277. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
  2278. Low quality of roughness filter for screen-space reflections.
  2279. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
  2280. .. rst-class:: classref-enumeration-constant
  2281. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
  2282. Medium quality of roughness filter for screen-space reflections.
  2283. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
  2284. .. rst-class:: classref-enumeration-constant
  2285. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
  2286. High quality of roughness filter for screen-space reflections. This is the slowest option.
  2287. .. rst-class:: classref-item-separator
  2288. ----
  2289. .. _enum_RenderingServer_EnvironmentSSAOQuality:
  2290. .. rst-class:: classref-enumeration
  2291. enum **EnvironmentSSAOQuality**:
  2292. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
  2293. .. rst-class:: classref-enumeration-constant
  2294. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
  2295. Lowest quality of screen-space ambient occlusion.
  2296. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
  2297. .. rst-class:: classref-enumeration-constant
  2298. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
  2299. Low quality screen-space ambient occlusion.
  2300. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
  2301. .. rst-class:: classref-enumeration-constant
  2302. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
  2303. Medium quality screen-space ambient occlusion.
  2304. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
  2305. .. rst-class:: classref-enumeration-constant
  2306. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
  2307. High quality screen-space ambient occlusion.
  2308. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
  2309. .. rst-class:: classref-enumeration-constant
  2310. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
  2311. Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2312. .. rst-class:: classref-item-separator
  2313. ----
  2314. .. _enum_RenderingServer_EnvironmentSSILQuality:
  2315. .. rst-class:: classref-enumeration
  2316. enum **EnvironmentSSILQuality**:
  2317. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
  2318. .. rst-class:: classref-enumeration-constant
  2319. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
  2320. Lowest quality of screen-space indirect lighting.
  2321. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
  2322. .. rst-class:: classref-enumeration-constant
  2323. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
  2324. Low quality screen-space indirect lighting.
  2325. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
  2326. .. rst-class:: classref-enumeration-constant
  2327. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
  2328. High quality screen-space indirect lighting.
  2329. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
  2330. .. rst-class:: classref-enumeration-constant
  2331. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
  2332. High quality screen-space indirect lighting.
  2333. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
  2334. .. rst-class:: classref-enumeration-constant
  2335. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
  2336. Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2337. .. rst-class:: classref-item-separator
  2338. ----
  2339. .. _enum_RenderingServer_EnvironmentSDFGIYScale:
  2340. .. rst-class:: classref-enumeration
  2341. enum **EnvironmentSDFGIYScale**:
  2342. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
  2343. .. rst-class:: classref-enumeration-constant
  2344. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
  2345. 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.
  2346. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
  2347. .. rst-class:: classref-enumeration-constant
  2348. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
  2349. Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
  2350. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
  2351. .. rst-class:: classref-enumeration-constant
  2352. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
  2353. 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.
  2354. .. rst-class:: classref-item-separator
  2355. ----
  2356. .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
  2357. .. rst-class:: classref-enumeration
  2358. enum **EnvironmentSDFGIRayCount**:
  2359. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
  2360. .. rst-class:: classref-enumeration-constant
  2361. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
  2362. Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
  2363. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
  2364. .. rst-class:: classref-enumeration-constant
  2365. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
  2366. Throw 8 rays per frame when converging SDFGI.
  2367. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
  2368. .. rst-class:: classref-enumeration-constant
  2369. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
  2370. Throw 16 rays per frame when converging SDFGI.
  2371. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
  2372. .. rst-class:: classref-enumeration-constant
  2373. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
  2374. Throw 32 rays per frame when converging SDFGI.
  2375. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
  2376. .. rst-class:: classref-enumeration-constant
  2377. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
  2378. Throw 64 rays per frame when converging SDFGI.
  2379. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
  2380. .. rst-class:: classref-enumeration-constant
  2381. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
  2382. Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
  2383. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
  2384. .. rst-class:: classref-enumeration-constant
  2385. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
  2386. Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
  2387. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
  2388. .. rst-class:: classref-enumeration-constant
  2389. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
  2390. Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
  2391. .. rst-class:: classref-item-separator
  2392. ----
  2393. .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
  2394. .. rst-class:: classref-enumeration
  2395. enum **EnvironmentSDFGIFramesToConverge**:
  2396. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
  2397. .. rst-class:: classref-enumeration-constant
  2398. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
  2399. Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
  2400. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
  2401. .. rst-class:: classref-enumeration-constant
  2402. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
  2403. Configure SDFGI to fully converge over 10 frames.
  2404. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
  2405. .. rst-class:: classref-enumeration-constant
  2406. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
  2407. Configure SDFGI to fully converge over 15 frames.
  2408. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
  2409. .. rst-class:: classref-enumeration-constant
  2410. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
  2411. Configure SDFGI to fully converge over 20 frames.
  2412. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
  2413. .. rst-class:: classref-enumeration-constant
  2414. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
  2415. Configure SDFGI to fully converge over 25 frames.
  2416. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
  2417. .. rst-class:: classref-enumeration-constant
  2418. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
  2419. Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
  2420. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
  2421. .. rst-class:: classref-enumeration-constant
  2422. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
  2423. Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
  2424. .. rst-class:: classref-item-separator
  2425. ----
  2426. .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
  2427. .. rst-class:: classref-enumeration
  2428. enum **EnvironmentSDFGIFramesToUpdateLight**:
  2429. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
  2430. .. rst-class:: classref-enumeration-constant
  2431. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
  2432. Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
  2433. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
  2434. .. rst-class:: classref-enumeration-constant
  2435. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
  2436. Update indirect light from dynamic lights in SDFGI over 2 frames.
  2437. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
  2438. .. rst-class:: classref-enumeration-constant
  2439. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
  2440. Update indirect light from dynamic lights in SDFGI over 4 frames.
  2441. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
  2442. .. rst-class:: classref-enumeration-constant
  2443. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
  2444. Update indirect light from dynamic lights in SDFGI over 8 frames.
  2445. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
  2446. .. rst-class:: classref-enumeration-constant
  2447. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
  2448. Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
  2449. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
  2450. .. rst-class:: classref-enumeration-constant
  2451. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
  2452. Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
  2453. .. rst-class:: classref-item-separator
  2454. ----
  2455. .. _enum_RenderingServer_SubSurfaceScatteringQuality:
  2456. .. rst-class:: classref-enumeration
  2457. enum **SubSurfaceScatteringQuality**:
  2458. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
  2459. .. rst-class:: classref-enumeration-constant
  2460. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
  2461. 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.
  2462. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
  2463. .. rst-class:: classref-enumeration-constant
  2464. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
  2465. Low subsurface scattering quality.
  2466. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
  2467. .. rst-class:: classref-enumeration-constant
  2468. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
  2469. Medium subsurface scattering quality.
  2470. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
  2471. .. rst-class:: classref-enumeration-constant
  2472. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
  2473. High subsurface scattering quality. This has the highest GPU requirements.
  2474. .. rst-class:: classref-item-separator
  2475. ----
  2476. .. _enum_RenderingServer_DOFBokehShape:
  2477. .. rst-class:: classref-enumeration
  2478. enum **DOFBokehShape**:
  2479. .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
  2480. .. rst-class:: classref-enumeration-constant
  2481. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
  2482. Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
  2483. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
  2484. .. rst-class:: classref-enumeration-constant
  2485. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
  2486. Calculates DOF blur using a hexagon shaped filter.
  2487. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
  2488. .. rst-class:: classref-enumeration-constant
  2489. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
  2490. 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).
  2491. .. rst-class:: classref-item-separator
  2492. ----
  2493. .. _enum_RenderingServer_DOFBlurQuality:
  2494. .. rst-class:: classref-enumeration
  2495. enum **DOFBlurQuality**:
  2496. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
  2497. .. rst-class:: classref-enumeration-constant
  2498. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
  2499. Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
  2500. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
  2501. .. rst-class:: classref-enumeration-constant
  2502. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
  2503. Low quality DOF blur.
  2504. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
  2505. .. rst-class:: classref-enumeration-constant
  2506. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
  2507. Medium quality DOF blur.
  2508. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
  2509. .. rst-class:: classref-enumeration-constant
  2510. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
  2511. Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
  2512. .. rst-class:: classref-item-separator
  2513. ----
  2514. .. _enum_RenderingServer_InstanceType:
  2515. .. rst-class:: classref-enumeration
  2516. enum **InstanceType**:
  2517. .. _class_RenderingServer_constant_INSTANCE_NONE:
  2518. .. rst-class:: classref-enumeration-constant
  2519. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
  2520. The instance does not have a type.
  2521. .. _class_RenderingServer_constant_INSTANCE_MESH:
  2522. .. rst-class:: classref-enumeration-constant
  2523. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
  2524. The instance is a mesh.
  2525. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
  2526. .. rst-class:: classref-enumeration-constant
  2527. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
  2528. The instance is a multimesh.
  2529. .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
  2530. .. rst-class:: classref-enumeration-constant
  2531. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
  2532. The instance is a particle emitter.
  2533. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
  2534. .. rst-class:: classref-enumeration-constant
  2535. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
  2536. The instance is a GPUParticles collision shape.
  2537. .. _class_RenderingServer_constant_INSTANCE_LIGHT:
  2538. .. rst-class:: classref-enumeration-constant
  2539. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
  2540. The instance is a light.
  2541. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
  2542. .. rst-class:: classref-enumeration-constant
  2543. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
  2544. The instance is a reflection probe.
  2545. .. _class_RenderingServer_constant_INSTANCE_DECAL:
  2546. .. rst-class:: classref-enumeration-constant
  2547. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
  2548. The instance is a decal.
  2549. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
  2550. .. rst-class:: classref-enumeration-constant
  2551. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
  2552. The instance is a VoxelGI.
  2553. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
  2554. .. rst-class:: classref-enumeration-constant
  2555. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
  2556. The instance is a lightmap.
  2557. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
  2558. .. rst-class:: classref-enumeration-constant
  2559. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
  2560. The instance is an occlusion culling occluder.
  2561. .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
  2562. .. rst-class:: classref-enumeration-constant
  2563. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
  2564. The instance is a visible on-screen notifier.
  2565. .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
  2566. .. rst-class:: classref-enumeration-constant
  2567. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
  2568. The instance is a fog volume.
  2569. .. _class_RenderingServer_constant_INSTANCE_MAX:
  2570. .. rst-class:: classref-enumeration-constant
  2571. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
  2572. Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
  2573. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
  2574. .. rst-class:: classref-enumeration-constant
  2575. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
  2576. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  2577. .. rst-class:: classref-item-separator
  2578. ----
  2579. .. _enum_RenderingServer_InstanceFlags:
  2580. .. rst-class:: classref-enumeration
  2581. enum **InstanceFlags**:
  2582. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
  2583. .. rst-class:: classref-enumeration-constant
  2584. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
  2585. Allows the instance to be used in baked lighting.
  2586. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
  2587. .. rst-class:: classref-enumeration-constant
  2588. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
  2589. Allows the instance to be used with dynamic global illumination.
  2590. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
  2591. .. rst-class:: classref-enumeration-constant
  2592. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
  2593. When set, manually requests to draw geometry on next frame.
  2594. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
  2595. .. rst-class:: classref-enumeration-constant
  2596. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
  2597. Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
  2598. .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
  2599. .. rst-class:: classref-enumeration-constant
  2600. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
  2601. Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
  2602. .. rst-class:: classref-item-separator
  2603. ----
  2604. .. _enum_RenderingServer_ShadowCastingSetting:
  2605. .. rst-class:: classref-enumeration
  2606. enum **ShadowCastingSetting**:
  2607. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
  2608. .. rst-class:: classref-enumeration-constant
  2609. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
  2610. Disable shadows from this instance.
  2611. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
  2612. .. rst-class:: classref-enumeration-constant
  2613. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
  2614. Cast shadows from this instance.
  2615. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
  2616. .. rst-class:: classref-enumeration-constant
  2617. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
  2618. Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
  2619. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
  2620. .. rst-class:: classref-enumeration-constant
  2621. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
  2622. Only render the shadows from the object. The object itself will not be drawn.
  2623. .. rst-class:: classref-item-separator
  2624. ----
  2625. .. _enum_RenderingServer_VisibilityRangeFadeMode:
  2626. .. rst-class:: classref-enumeration
  2627. enum **VisibilityRangeFadeMode**:
  2628. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
  2629. .. rst-class:: classref-enumeration-constant
  2630. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
  2631. Disable visibility range fading for the given instance.
  2632. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
  2633. .. rst-class:: classref-enumeration-constant
  2634. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
  2635. Fade-out the given instance when it approaches its visibility range limits.
  2636. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
  2637. .. rst-class:: classref-enumeration-constant
  2638. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
  2639. Fade-in the given instance's dependencies when reaching its visibility range limits.
  2640. .. rst-class:: classref-item-separator
  2641. ----
  2642. .. _enum_RenderingServer_BakeChannels:
  2643. .. rst-class:: classref-enumeration
  2644. enum **BakeChannels**:
  2645. .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
  2646. .. rst-class:: classref-enumeration-constant
  2647. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
  2648. 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.
  2649. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
  2650. .. rst-class:: classref-enumeration-constant
  2651. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
  2652. 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``.
  2653. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
  2654. .. rst-class:: classref-enumeration-constant
  2655. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
  2656. 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.
  2657. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
  2658. .. rst-class:: classref-enumeration-constant
  2659. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
  2660. 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.
  2661. .. rst-class:: classref-item-separator
  2662. ----
  2663. .. _enum_RenderingServer_CanvasTextureChannel:
  2664. .. rst-class:: classref-enumeration
  2665. enum **CanvasTextureChannel**:
  2666. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
  2667. .. rst-class:: classref-enumeration-constant
  2668. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
  2669. Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
  2670. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
  2671. .. rst-class:: classref-enumeration-constant
  2672. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
  2673. Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
  2674. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
  2675. .. rst-class:: classref-enumeration-constant
  2676. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
  2677. Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
  2678. .. rst-class:: classref-item-separator
  2679. ----
  2680. .. _enum_RenderingServer_NinePatchAxisMode:
  2681. .. rst-class:: classref-enumeration
  2682. enum **NinePatchAxisMode**:
  2683. .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
  2684. .. rst-class:: classref-enumeration-constant
  2685. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
  2686. The nine patch gets stretched where needed.
  2687. .. _class_RenderingServer_constant_NINE_PATCH_TILE:
  2688. .. rst-class:: classref-enumeration-constant
  2689. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
  2690. The nine patch gets filled with tiles where needed.
  2691. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
  2692. .. rst-class:: classref-enumeration-constant
  2693. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
  2694. The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  2695. .. rst-class:: classref-item-separator
  2696. ----
  2697. .. _enum_RenderingServer_CanvasItemTextureFilter:
  2698. .. rst-class:: classref-enumeration
  2699. enum **CanvasItemTextureFilter**:
  2700. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
  2701. .. rst-class:: classref-enumeration-constant
  2702. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
  2703. Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
  2704. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
  2705. .. rst-class:: classref-enumeration-constant
  2706. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
  2707. The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
  2708. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
  2709. .. rst-class:: classref-enumeration-constant
  2710. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
  2711. The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
  2712. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
  2713. .. rst-class:: classref-enumeration-constant
  2714. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
  2715. The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
  2716. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
  2717. .. rst-class:: classref-enumeration-constant
  2718. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
  2719. The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps.
  2720. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
  2721. .. rst-class:: classref-enumeration-constant
  2722. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
  2723. The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera.
  2724. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
  2725. .. rst-class:: classref-enumeration-constant
  2726. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
  2727. The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing.
  2728. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
  2729. .. rst-class:: classref-enumeration-constant
  2730. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
  2731. Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
  2732. .. rst-class:: classref-item-separator
  2733. ----
  2734. .. _enum_RenderingServer_CanvasItemTextureRepeat:
  2735. .. rst-class:: classref-enumeration
  2736. enum **CanvasItemTextureRepeat**:
  2737. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
  2738. .. rst-class:: classref-enumeration-constant
  2739. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
  2740. Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
  2741. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
  2742. .. rst-class:: classref-enumeration-constant
  2743. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
  2744. 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.
  2745. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
  2746. .. rst-class:: classref-enumeration-constant
  2747. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
  2748. 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.
  2749. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
  2750. .. rst-class:: classref-enumeration-constant
  2751. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
  2752. Flip the texture when repeating so that the edge lines up instead of abruptly changing.
  2753. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
  2754. .. rst-class:: classref-enumeration-constant
  2755. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
  2756. Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
  2757. .. rst-class:: classref-item-separator
  2758. ----
  2759. .. _enum_RenderingServer_CanvasGroupMode:
  2760. .. rst-class:: classref-enumeration
  2761. enum **CanvasGroupMode**:
  2762. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
  2763. .. rst-class:: classref-enumeration-constant
  2764. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
  2765. Child draws over parent and is not clipped.
  2766. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
  2767. .. rst-class:: classref-enumeration-constant
  2768. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
  2769. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
  2770. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
  2771. .. rst-class:: classref-enumeration-constant
  2772. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
  2773. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
  2774. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
  2775. .. rst-class:: classref-enumeration-constant
  2776. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
  2777. .. rst-class:: classref-item-separator
  2778. ----
  2779. .. _enum_RenderingServer_CanvasLightMode:
  2780. .. rst-class:: classref-enumeration
  2781. enum **CanvasLightMode**:
  2782. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
  2783. .. rst-class:: classref-enumeration-constant
  2784. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
  2785. 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
  2786. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
  2787. .. rst-class:: classref-enumeration-constant
  2788. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
  2789. 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
  2790. .. rst-class:: classref-item-separator
  2791. ----
  2792. .. _enum_RenderingServer_CanvasLightBlendMode:
  2793. .. rst-class:: classref-enumeration
  2794. enum **CanvasLightBlendMode**:
  2795. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
  2796. .. rst-class:: classref-enumeration-constant
  2797. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
  2798. Adds light color additive to the canvas.
  2799. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
  2800. .. rst-class:: classref-enumeration-constant
  2801. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
  2802. Adds light color subtractive to the canvas.
  2803. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
  2804. .. rst-class:: classref-enumeration-constant
  2805. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
  2806. The light adds color depending on transparency.
  2807. .. rst-class:: classref-item-separator
  2808. ----
  2809. .. _enum_RenderingServer_CanvasLightShadowFilter:
  2810. .. rst-class:: classref-enumeration
  2811. enum **CanvasLightShadowFilter**:
  2812. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
  2813. .. rst-class:: classref-enumeration-constant
  2814. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
  2815. Do not apply a filter to canvas light shadows.
  2816. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
  2817. .. rst-class:: classref-enumeration-constant
  2818. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
  2819. Use PCF5 filtering to filter canvas light shadows.
  2820. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
  2821. .. rst-class:: classref-enumeration-constant
  2822. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
  2823. Use PCF13 filtering to filter canvas light shadows.
  2824. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
  2825. .. rst-class:: classref-enumeration-constant
  2826. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
  2827. Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
  2828. .. rst-class:: classref-item-separator
  2829. ----
  2830. .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
  2831. .. rst-class:: classref-enumeration
  2832. enum **CanvasOccluderPolygonCullMode**:
  2833. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
  2834. .. rst-class:: classref-enumeration-constant
  2835. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
  2836. Culling of the canvas occluder is disabled.
  2837. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
  2838. .. rst-class:: classref-enumeration-constant
  2839. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
  2840. Culling of the canvas occluder is clockwise.
  2841. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
  2842. .. rst-class:: classref-enumeration-constant
  2843. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
  2844. Culling of the canvas occluder is counterclockwise.
  2845. .. rst-class:: classref-item-separator
  2846. ----
  2847. .. _enum_RenderingServer_GlobalShaderParameterType:
  2848. .. rst-class:: classref-enumeration
  2849. enum **GlobalShaderParameterType**:
  2850. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
  2851. .. rst-class:: classref-enumeration-constant
  2852. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
  2853. Boolean global shader parameter (``global uniform bool ...``).
  2854. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
  2855. .. rst-class:: classref-enumeration-constant
  2856. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
  2857. 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
  2858. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
  2859. .. rst-class:: classref-enumeration-constant
  2860. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
  2861. 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
  2862. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
  2863. .. rst-class:: classref-enumeration-constant
  2864. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
  2865. 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
  2866. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
  2867. .. rst-class:: classref-enumeration-constant
  2868. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
  2869. Integer global shader parameter (``global uniform int ...``).
  2870. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
  2871. .. rst-class:: classref-enumeration-constant
  2872. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
  2873. 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
  2874. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
  2875. .. rst-class:: classref-enumeration-constant
  2876. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
  2877. 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
  2878. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
  2879. .. rst-class:: classref-enumeration-constant
  2880. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
  2881. 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
  2882. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
  2883. .. rst-class:: classref-enumeration-constant
  2884. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
  2885. 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.
  2886. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
  2887. .. rst-class:: classref-enumeration-constant
  2888. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
  2889. Unsigned integer global shader parameter (``global uniform uint ...``).
  2890. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
  2891. .. rst-class:: classref-enumeration-constant
  2892. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
  2893. 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
  2894. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
  2895. .. rst-class:: classref-enumeration-constant
  2896. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
  2897. 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
  2898. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
  2899. .. rst-class:: classref-enumeration-constant
  2900. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
  2901. 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
  2902. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
  2903. .. rst-class:: classref-enumeration-constant
  2904. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
  2905. Single-precision floating-point global shader parameter (``global uniform float ...``).
  2906. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
  2907. .. rst-class:: classref-enumeration-constant
  2908. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
  2909. 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
  2910. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
  2911. .. rst-class:: classref-enumeration-constant
  2912. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
  2913. 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
  2914. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
  2915. .. rst-class:: classref-enumeration-constant
  2916. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
  2917. 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
  2918. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
  2919. .. rst-class:: classref-enumeration-constant
  2920. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
  2921. 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.
  2922. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
  2923. .. rst-class:: classref-enumeration-constant
  2924. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
  2925. 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.
  2926. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
  2927. .. rst-class:: classref-enumeration-constant
  2928. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
  2929. 2×2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
  2930. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
  2931. .. rst-class:: classref-enumeration-constant
  2932. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
  2933. 3×3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
  2934. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
  2935. .. rst-class:: classref-enumeration-constant
  2936. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
  2937. 4×4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
  2938. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
  2939. .. rst-class:: classref-enumeration-constant
  2940. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
  2941. 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
  2942. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
  2943. .. rst-class:: classref-enumeration-constant
  2944. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
  2945. 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
  2946. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
  2947. .. rst-class:: classref-enumeration-constant
  2948. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
  2949. 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
  2950. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
  2951. .. rst-class:: classref-enumeration-constant
  2952. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
  2953. 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
  2954. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
  2955. .. rst-class:: classref-enumeration-constant
  2956. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
  2957. 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
  2958. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
  2959. .. rst-class:: classref-enumeration-constant
  2960. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
  2961. Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
  2962. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
  2963. .. rst-class:: classref-enumeration-constant
  2964. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``28``
  2965. Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
  2966. .. rst-class:: classref-item-separator
  2967. ----
  2968. .. _enum_RenderingServer_RenderingInfo:
  2969. .. rst-class:: classref-enumeration
  2970. enum **RenderingInfo**:
  2971. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
  2972. .. rst-class:: classref-enumeration-constant
  2973. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
  2974. Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
  2975. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
  2976. .. rst-class:: classref-enumeration-constant
  2977. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
  2978. Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
  2979. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
  2980. .. rst-class:: classref-enumeration-constant
  2981. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
  2982. Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
  2983. .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
  2984. .. rst-class:: classref-enumeration-constant
  2985. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
  2986. Texture memory used (in bytes).
  2987. .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
  2988. .. rst-class:: classref-enumeration-constant
  2989. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
  2990. Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
  2991. .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
  2992. .. rst-class:: classref-enumeration-constant
  2993. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
  2994. Video memory used (in bytes). When using the Forward+ or mobile rendering backends, 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 GL Compatibility backend, 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>`.
  2995. .. rst-class:: classref-item-separator
  2996. ----
  2997. .. _enum_RenderingServer_Features:
  2998. .. rst-class:: classref-enumeration
  2999. enum **Features**:
  3000. .. _class_RenderingServer_constant_FEATURE_SHADERS:
  3001. .. rst-class:: classref-enumeration-constant
  3002. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
  3003. Hardware supports shaders. This enum is currently unused in Godot 3.x.
  3004. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
  3005. .. rst-class:: classref-enumeration-constant
  3006. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
  3007. Hardware supports multithreading. This enum is currently unused in Godot 3.x.
  3008. .. rst-class:: classref-section-separator
  3009. ----
  3010. .. rst-class:: classref-descriptions-group
  3011. Constants
  3012. ---------
  3013. .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
  3014. .. rst-class:: classref-constant
  3015. **NO_INDEX_ARRAY** = ``-1``
  3016. Marks an error that shows that the index array is empty.
  3017. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
  3018. .. rst-class:: classref-constant
  3019. **ARRAY_WEIGHTS_SIZE** = ``4``
  3020. Number of weights/bones per vertex.
  3021. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
  3022. .. rst-class:: classref-constant
  3023. **CANVAS_ITEM_Z_MIN** = ``-4096``
  3024. The minimum Z-layer for canvas items.
  3025. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
  3026. .. rst-class:: classref-constant
  3027. **CANVAS_ITEM_Z_MAX** = ``4096``
  3028. The maximum Z-layer for canvas items.
  3029. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
  3030. .. rst-class:: classref-constant
  3031. **MAX_GLOW_LEVELS** = ``7``
  3032. The maximum number of glow levels that can be used with the glow post-processing effect.
  3033. .. _class_RenderingServer_constant_MAX_CURSORS:
  3034. .. rst-class:: classref-constant
  3035. **MAX_CURSORS** = ``8``
  3036. *Deprecated.* This constant is unused internally.
  3037. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
  3038. .. rst-class:: classref-constant
  3039. **MAX_2D_DIRECTIONAL_LIGHTS** = ``8``
  3040. The maximum number of directional lights that can be rendered at a given time in 2D.
  3041. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
  3042. .. rst-class:: classref-constant
  3043. **MATERIAL_RENDER_PRIORITY_MIN** = ``-128``
  3044. The minimum renderpriority of all materials.
  3045. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
  3046. .. rst-class:: classref-constant
  3047. **MATERIAL_RENDER_PRIORITY_MAX** = ``127``
  3048. The maximum renderpriority of all materials.
  3049. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
  3050. .. rst-class:: classref-constant
  3051. **ARRAY_CUSTOM_COUNT** = ``4``
  3052. 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>`).
  3053. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
  3054. .. rst-class:: classref-constant
  3055. **PARTICLES_EMIT_FLAG_POSITION** = ``1``
  3056. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
  3057. .. rst-class:: classref-constant
  3058. **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2``
  3059. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
  3060. .. rst-class:: classref-constant
  3061. **PARTICLES_EMIT_FLAG_VELOCITY** = ``4``
  3062. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
  3063. .. rst-class:: classref-constant
  3064. **PARTICLES_EMIT_FLAG_COLOR** = ``8``
  3065. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
  3066. .. rst-class:: classref-constant
  3067. **PARTICLES_EMIT_FLAG_CUSTOM** = ``16``
  3068. .. rst-class:: classref-section-separator
  3069. ----
  3070. .. rst-class:: classref-descriptions-group
  3071. Property Descriptions
  3072. ---------------------
  3073. .. _class_RenderingServer_property_render_loop_enabled:
  3074. .. rst-class:: classref-property
  3075. :ref:`bool<class_bool>` **render_loop_enabled**
  3076. .. rst-class:: classref-property-setget
  3077. - void **set_render_loop_enabled** **(** :ref:`bool<class_bool>` value **)**
  3078. - :ref:`bool<class_bool>` **is_render_loop_enabled** **(** **)**
  3079. 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.
  3080. .. rst-class:: classref-section-separator
  3081. ----
  3082. .. rst-class:: classref-descriptions-group
  3083. Method Descriptions
  3084. -------------------
  3085. .. _class_RenderingServer_method_bake_render_uv2:
  3086. .. rst-class:: classref-method
  3087. :ref:`Image[]<class_Image>` **bake_render_uv2** **(** :ref:`RID<class_RID>` base, :ref:`RID[]<class_RID>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)**
  3088. 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>`.
  3089. .. rst-class:: classref-item-separator
  3090. ----
  3091. .. _class_RenderingServer_method_camera_attributes_create:
  3092. .. rst-class:: classref-method
  3093. :ref:`RID<class_RID>` **camera_attributes_create** **(** **)**
  3094. 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.
  3095. 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.
  3096. \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
  3097. .. rst-class:: classref-item-separator
  3098. ----
  3099. .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
  3100. .. rst-class:: classref-method
  3101. void **camera_attributes_set_auto_exposure** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_sensitivity, :ref:`float<class_float>` max_sensitivity, :ref:`float<class_float>` speed, :ref:`float<class_float>` scale **)**
  3102. 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>`.
  3103. .. rst-class:: classref-item-separator
  3104. ----
  3105. .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
  3106. .. rst-class:: classref-method
  3107. void **camera_attributes_set_dof_blur** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)**
  3108. 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>`.
  3109. .. rst-class:: classref-item-separator
  3110. ----
  3111. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
  3112. .. rst-class:: classref-method
  3113. void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)**
  3114. 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>`.
  3115. .. rst-class:: classref-item-separator
  3116. ----
  3117. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
  3118. .. rst-class:: classref-method
  3119. void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)**
  3120. 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.
  3121. .. rst-class:: classref-item-separator
  3122. ----
  3123. .. _class_RenderingServer_method_camera_attributes_set_exposure:
  3124. .. rst-class:: classref-method
  3125. void **camera_attributes_set_exposure** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` normalization **)**
  3126. 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.
  3127. The normalization factor can be calculated from exposure value (EV100) as follows:
  3128. ::
  3129. func get_exposure_normalization(float ev100):
  3130. return 1.0 / (pow(2.0, ev100) * 1.2)
  3131. The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
  3132. ::
  3133. func get_exposure(float aperture, float shutter_speed, float sensitivity):
  3134. return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity))
  3135. .. rst-class:: classref-item-separator
  3136. ----
  3137. .. _class_RenderingServer_method_camera_create:
  3138. .. rst-class:: classref-method
  3139. :ref:`RID<class_RID>` **camera_create** **(** **)**
  3140. 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.
  3141. 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.
  3142. \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
  3143. .. rst-class:: classref-item-separator
  3144. ----
  3145. .. _class_RenderingServer_method_camera_set_camera_attributes:
  3146. .. rst-class:: classref-method
  3147. void **camera_set_camera_attributes** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)**
  3148. Sets the camera_attributes created with :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` to the given camera.
  3149. .. rst-class:: classref-item-separator
  3150. ----
  3151. .. _class_RenderingServer_method_camera_set_cull_mask:
  3152. .. rst-class:: classref-method
  3153. void **camera_set_cull_mask** **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)**
  3154. 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>`.
  3155. .. rst-class:: classref-item-separator
  3156. ----
  3157. .. _class_RenderingServer_method_camera_set_environment:
  3158. .. rst-class:: classref-method
  3159. void **camera_set_environment** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)**
  3160. Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
  3161. .. rst-class:: classref-item-separator
  3162. ----
  3163. .. _class_RenderingServer_method_camera_set_frustum:
  3164. .. rst-class:: classref-method
  3165. void **camera_set_frustum** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3166. Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
  3167. .. rst-class:: classref-item-separator
  3168. ----
  3169. .. _class_RenderingServer_method_camera_set_orthogonal:
  3170. .. rst-class:: classref-method
  3171. void **camera_set_orthogonal** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3172. 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.
  3173. .. rst-class:: classref-item-separator
  3174. ----
  3175. .. _class_RenderingServer_method_camera_set_perspective:
  3176. .. rst-class:: classref-method
  3177. void **camera_set_perspective** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3178. Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
  3179. .. rst-class:: classref-item-separator
  3180. ----
  3181. .. _class_RenderingServer_method_camera_set_transform:
  3182. .. rst-class:: classref-method
  3183. void **camera_set_transform** **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)**
  3184. Sets :ref:`Transform3D<class_Transform3D>` of camera.
  3185. .. rst-class:: classref-item-separator
  3186. ----
  3187. .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
  3188. .. rst-class:: classref-method
  3189. void **camera_set_use_vertical_aspect** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)**
  3190. 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>`.
  3191. .. rst-class:: classref-item-separator
  3192. ----
  3193. .. _class_RenderingServer_method_canvas_create:
  3194. .. rst-class:: classref-method
  3195. :ref:`RID<class_RID>` **canvas_create** **(** **)**
  3196. 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.
  3197. 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.
  3198. Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
  3199. .. rst-class:: classref-item-separator
  3200. ----
  3201. .. _class_RenderingServer_method_canvas_item_add_animation_slice:
  3202. .. rst-class:: classref-method
  3203. void **canvas_item_add_animation_slice** **(** :ref:`RID<class_RID>` item, :ref:`float<class_float>` animation_length, :ref:`float<class_float>` slice_begin, :ref:`float<class_float>` slice_end, :ref:`float<class_float>` offset=0.0 **)**
  3204. 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.
  3205. .. rst-class:: classref-item-separator
  3206. ----
  3207. .. _class_RenderingServer_method_canvas_item_add_circle:
  3208. .. rst-class:: classref-method
  3209. void **canvas_item_add_circle** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
  3210. 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>`.
  3211. .. rst-class:: classref-item-separator
  3212. ----
  3213. .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
  3214. .. rst-class:: classref-method
  3215. void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)**
  3216. If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false.
  3217. .. rst-class:: classref-item-separator
  3218. ----
  3219. .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
  3220. .. rst-class:: classref-method
  3221. void **canvas_item_add_lcd_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate **)**
  3222. See also :ref:`CanvasItem.draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
  3223. .. rst-class:: classref-item-separator
  3224. ----
  3225. .. _class_RenderingServer_method_canvas_item_add_line:
  3226. .. rst-class:: classref-method
  3227. void **canvas_item_add_line** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)**
  3228. 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>`.
  3229. .. rst-class:: classref-item-separator
  3230. ----
  3231. .. _class_RenderingServer_method_canvas_item_add_mesh:
  3232. .. rst-class:: classref-method
  3233. void **canvas_item_add_mesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture=RID() **)**
  3234. 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>`.
  3235. .. rst-class:: classref-item-separator
  3236. ----
  3237. .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
  3238. .. rst-class:: classref-method
  3239. void **canvas_item_add_msdf_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0, :ref:`float<class_float>` scale=1.0 **)**
  3240. See also :ref:`CanvasItem.draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
  3241. .. rst-class:: classref-item-separator
  3242. ----
  3243. .. _class_RenderingServer_method_canvas_item_add_multiline:
  3244. .. rst-class:: classref-method
  3245. void **canvas_item_add_multiline** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0 **)**
  3246. 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>`.
  3247. .. rst-class:: classref-item-separator
  3248. ----
  3249. .. _class_RenderingServer_method_canvas_item_add_multimesh:
  3250. .. rst-class:: classref-method
  3251. void **canvas_item_add_multimesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture=RID() **)**
  3252. 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>`.
  3253. .. rst-class:: classref-item-separator
  3254. ----
  3255. .. _class_RenderingServer_method_canvas_item_add_nine_patch:
  3256. .. rst-class:: classref-method
  3257. void **canvas_item_add_nine_patch** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)**
  3258. Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3259. .. rst-class:: classref-item-separator
  3260. ----
  3261. .. _class_RenderingServer_method_canvas_item_add_particles:
  3262. .. rst-class:: classref-method
  3263. void **canvas_item_add_particles** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)**
  3264. Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3265. .. rst-class:: classref-item-separator
  3266. ----
  3267. .. _class_RenderingServer_method_canvas_item_add_polygon:
  3268. .. rst-class:: classref-method
  3269. void **canvas_item_add_polygon** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture=RID() **)**
  3270. 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>`.
  3271. .. rst-class:: classref-item-separator
  3272. ----
  3273. .. _class_RenderingServer_method_canvas_item_add_polyline:
  3274. .. rst-class:: classref-method
  3275. void **canvas_item_add_polyline** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)**
  3276. 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>`.
  3277. .. rst-class:: classref-item-separator
  3278. ----
  3279. .. _class_RenderingServer_method_canvas_item_add_primitive:
  3280. .. rst-class:: classref-method
  3281. void **canvas_item_add_primitive** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture **)**
  3282. 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>`.
  3283. .. rst-class:: classref-item-separator
  3284. ----
  3285. .. _class_RenderingServer_method_canvas_item_add_rect:
  3286. .. rst-class:: classref-method
  3287. void **canvas_item_add_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**
  3288. 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>`.
  3289. .. rst-class:: classref-item-separator
  3290. ----
  3291. .. _class_RenderingServer_method_canvas_item_add_set_transform:
  3292. .. rst-class:: classref-method
  3293. void **canvas_item_add_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
  3294. Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
  3295. .. rst-class:: classref-item-separator
  3296. ----
  3297. .. _class_RenderingServer_method_canvas_item_add_texture_rect:
  3298. .. rst-class:: classref-method
  3299. void **canvas_item_add_texture_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)**
  3300. 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>`.
  3301. .. rst-class:: classref-item-separator
  3302. ----
  3303. .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
  3304. .. rst-class:: classref-method
  3305. void **canvas_item_add_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)**
  3306. 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>`.
  3307. .. rst-class:: classref-item-separator
  3308. ----
  3309. .. _class_RenderingServer_method_canvas_item_add_triangle_array:
  3310. .. rst-class:: classref-method
  3311. void **canvas_item_add_triangle_array** **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture=RID(), :ref:`int<class_int>` count=-1 **)**
  3312. 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>`.
  3313. \ **Note:** ``count`` is unused and can be left unspecified.
  3314. .. rst-class:: classref-item-separator
  3315. ----
  3316. .. _class_RenderingServer_method_canvas_item_clear:
  3317. .. rst-class:: classref-method
  3318. void **canvas_item_clear** **(** :ref:`RID<class_RID>` item **)**
  3319. Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
  3320. .. rst-class:: classref-item-separator
  3321. ----
  3322. .. _class_RenderingServer_method_canvas_item_create:
  3323. .. rst-class:: classref-method
  3324. :ref:`RID<class_RID>` **canvas_item_create** **(** **)**
  3325. 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.
  3326. 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.
  3327. \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
  3328. .. rst-class:: classref-item-separator
  3329. ----
  3330. .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
  3331. .. rst-class:: classref-method
  3332. void **canvas_item_set_canvas_group_mode** **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)**
  3333. 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.
  3334. \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
  3335. .. rst-class:: classref-item-separator
  3336. ----
  3337. .. _class_RenderingServer_method_canvas_item_set_clip:
  3338. .. rst-class:: classref-method
  3339. void **canvas_item_set_clip** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)**
  3340. 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.
  3341. \ **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.
  3342. .. rst-class:: classref-item-separator
  3343. ----
  3344. .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
  3345. .. rst-class:: classref-method
  3346. void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)**
  3347. Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
  3348. .. rst-class:: classref-item-separator
  3349. ----
  3350. .. _class_RenderingServer_method_canvas_item_set_custom_rect:
  3351. .. rst-class:: classref-method
  3352. void **canvas_item_set_custom_rect** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
  3353. 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.
  3354. .. rst-class:: classref-item-separator
  3355. ----
  3356. .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
  3357. .. rst-class:: classref-method
  3358. void **canvas_item_set_default_texture_filter** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  3359. 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>`.
  3360. .. rst-class:: classref-item-separator
  3361. ----
  3362. .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
  3363. .. rst-class:: classref-method
  3364. void **canvas_item_set_default_texture_repeat** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  3365. 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>`.
  3366. .. rst-class:: classref-item-separator
  3367. ----
  3368. .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
  3369. .. rst-class:: classref-method
  3370. void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3371. 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>`__.
  3372. .. rst-class:: classref-item-separator
  3373. ----
  3374. .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
  3375. .. rst-class:: classref-method
  3376. void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3377. 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>`.
  3378. .. rst-class:: classref-item-separator
  3379. ----
  3380. .. _class_RenderingServer_method_canvas_item_set_draw_index:
  3381. .. rst-class:: classref-method
  3382. void **canvas_item_set_draw_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)**
  3383. Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
  3384. .. rst-class:: classref-item-separator
  3385. ----
  3386. .. _class_RenderingServer_method_canvas_item_set_light_mask:
  3387. .. rst-class:: classref-method
  3388. void **canvas_item_set_light_mask** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)**
  3389. Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
  3390. .. rst-class:: classref-item-separator
  3391. ----
  3392. .. _class_RenderingServer_method_canvas_item_set_material:
  3393. .. rst-class:: classref-method
  3394. void **canvas_item_set_material** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)**
  3395. Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
  3396. .. rst-class:: classref-item-separator
  3397. ----
  3398. .. _class_RenderingServer_method_canvas_item_set_modulate:
  3399. .. rst-class:: classref-method
  3400. void **canvas_item_set_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
  3401. 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>`.
  3402. .. rst-class:: classref-item-separator
  3403. ----
  3404. .. _class_RenderingServer_method_canvas_item_set_parent:
  3405. .. rst-class:: classref-method
  3406. void **canvas_item_set_parent** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)**
  3407. 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.
  3408. .. rst-class:: classref-item-separator
  3409. ----
  3410. .. _class_RenderingServer_method_canvas_item_set_self_modulate:
  3411. .. rst-class:: classref-method
  3412. void **canvas_item_set_self_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
  3413. 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>`.
  3414. .. rst-class:: classref-item-separator
  3415. ----
  3416. .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
  3417. .. rst-class:: classref-method
  3418. void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3419. 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>`.
  3420. .. rst-class:: classref-item-separator
  3421. ----
  3422. .. _class_RenderingServer_method_canvas_item_set_transform:
  3423. .. rst-class:: classref-method
  3424. void **canvas_item_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
  3425. 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>`.
  3426. .. rst-class:: classref-item-separator
  3427. ----
  3428. .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
  3429. .. rst-class:: classref-method
  3430. void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3431. Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
  3432. .. rst-class:: classref-item-separator
  3433. ----
  3434. .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
  3435. .. rst-class:: classref-method
  3436. void **canvas_item_set_visibility_layer** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` visibility_layer **)**
  3437. 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>`.
  3438. .. rst-class:: classref-item-separator
  3439. ----
  3440. .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
  3441. .. rst-class:: classref-method
  3442. void **canvas_item_set_visibility_notifier** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
  3443. 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.
  3444. This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
  3445. .. rst-class:: classref-item-separator
  3446. ----
  3447. .. _class_RenderingServer_method_canvas_item_set_visible:
  3448. .. rst-class:: classref-method
  3449. void **canvas_item_set_visible** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)**
  3450. Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
  3451. .. rst-class:: classref-item-separator
  3452. ----
  3453. .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
  3454. .. rst-class:: classref-method
  3455. void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3456. If this is enabled, the Z index of the parent will be added to the children's Z index.
  3457. .. rst-class:: classref-item-separator
  3458. ----
  3459. .. _class_RenderingServer_method_canvas_item_set_z_index:
  3460. .. rst-class:: classref-method
  3461. void **canvas_item_set_z_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)**
  3462. Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
  3463. .. rst-class:: classref-item-separator
  3464. ----
  3465. .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
  3466. .. rst-class:: classref-method
  3467. void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)**
  3468. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  3469. .. rst-class:: classref-item-separator
  3470. ----
  3471. .. _class_RenderingServer_method_canvas_light_create:
  3472. .. rst-class:: classref-method
  3473. :ref:`RID<class_RID>` **canvas_light_create** **(** **)**
  3474. 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.
  3475. 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.
  3476. \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
  3477. .. rst-class:: classref-item-separator
  3478. ----
  3479. .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
  3480. .. rst-class:: classref-method
  3481. void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)**
  3482. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  3483. .. rst-class:: classref-item-separator
  3484. ----
  3485. .. _class_RenderingServer_method_canvas_light_occluder_create:
  3486. .. rst-class:: classref-method
  3487. :ref:`RID<class_RID>` **canvas_light_occluder_create** **(** **)**
  3488. 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.
  3489. 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.
  3490. \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
  3491. .. rst-class:: classref-item-separator
  3492. ----
  3493. .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
  3494. .. rst-class:: classref-method
  3495. void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)**
  3496. .. container:: contribute
  3497. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3498. .. rst-class:: classref-item-separator
  3499. ----
  3500. .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
  3501. .. rst-class:: classref-method
  3502. void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)**
  3503. Enables or disables light occluder.
  3504. .. rst-class:: classref-item-separator
  3505. ----
  3506. .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
  3507. .. rst-class:: classref-method
  3508. void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)**
  3509. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3510. .. rst-class:: classref-item-separator
  3511. ----
  3512. .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
  3513. .. rst-class:: classref-method
  3514. void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)**
  3515. Sets a light occluder's polygon.
  3516. .. rst-class:: classref-item-separator
  3517. ----
  3518. .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
  3519. .. rst-class:: classref-method
  3520. void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)**
  3521. Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
  3522. .. rst-class:: classref-item-separator
  3523. ----
  3524. .. _class_RenderingServer_method_canvas_light_set_blend_mode:
  3525. .. rst-class:: classref-method
  3526. void **canvas_light_set_blend_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` mode **)**
  3527. 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>`.
  3528. .. rst-class:: classref-item-separator
  3529. ----
  3530. .. _class_RenderingServer_method_canvas_light_set_color:
  3531. .. rst-class:: classref-method
  3532. void **canvas_light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  3533. Sets the color for a light.
  3534. .. rst-class:: classref-item-separator
  3535. ----
  3536. .. _class_RenderingServer_method_canvas_light_set_enabled:
  3537. .. rst-class:: classref-method
  3538. void **canvas_light_set_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  3539. Enables or disables a canvas light.
  3540. .. rst-class:: classref-item-separator
  3541. ----
  3542. .. _class_RenderingServer_method_canvas_light_set_energy:
  3543. .. rst-class:: classref-method
  3544. void **canvas_light_set_energy** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)**
  3545. Sets a canvas light's energy.
  3546. .. rst-class:: classref-item-separator
  3547. ----
  3548. .. _class_RenderingServer_method_canvas_light_set_height:
  3549. .. rst-class:: classref-method
  3550. void **canvas_light_set_height** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)**
  3551. Sets a canvas light's height.
  3552. .. rst-class:: classref-item-separator
  3553. ----
  3554. .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
  3555. .. rst-class:: classref-method
  3556. void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  3557. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3558. .. rst-class:: classref-item-separator
  3559. ----
  3560. .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
  3561. .. rst-class:: classref-method
  3562. void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  3563. 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.
  3564. .. rst-class:: classref-item-separator
  3565. ----
  3566. .. _class_RenderingServer_method_canvas_light_set_layer_range:
  3567. .. rst-class:: classref-method
  3568. void **canvas_light_set_layer_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
  3569. The layer range that gets rendered with this light.
  3570. .. rst-class:: classref-item-separator
  3571. ----
  3572. .. _class_RenderingServer_method_canvas_light_set_mode:
  3573. .. rst-class:: classref-method
  3574. void **canvas_light_set_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)**
  3575. The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
  3576. .. rst-class:: classref-item-separator
  3577. ----
  3578. .. _class_RenderingServer_method_canvas_light_set_shadow_color:
  3579. .. rst-class:: classref-method
  3580. void **canvas_light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  3581. Sets the color of the canvas light's shadow.
  3582. .. rst-class:: classref-item-separator
  3583. ----
  3584. .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
  3585. .. rst-class:: classref-method
  3586. void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  3587. Enables or disables the canvas light's shadow.
  3588. .. rst-class:: classref-item-separator
  3589. ----
  3590. .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
  3591. .. rst-class:: classref-method
  3592. void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)**
  3593. Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
  3594. .. rst-class:: classref-item-separator
  3595. ----
  3596. .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
  3597. .. rst-class:: classref-method
  3598. void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)**
  3599. Smoothens the shadow. The lower, the smoother.
  3600. .. rst-class:: classref-item-separator
  3601. ----
  3602. .. _class_RenderingServer_method_canvas_light_set_texture:
  3603. .. rst-class:: classref-method
  3604. void **canvas_light_set_texture** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
  3605. Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
  3606. .. rst-class:: classref-item-separator
  3607. ----
  3608. .. _class_RenderingServer_method_canvas_light_set_texture_offset:
  3609. .. rst-class:: classref-method
  3610. void **canvas_light_set_texture_offset** **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)**
  3611. Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
  3612. .. rst-class:: classref-item-separator
  3613. ----
  3614. .. _class_RenderingServer_method_canvas_light_set_texture_scale:
  3615. .. rst-class:: classref-method
  3616. void **canvas_light_set_texture_scale** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)**
  3617. Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
  3618. .. rst-class:: classref-item-separator
  3619. ----
  3620. .. _class_RenderingServer_method_canvas_light_set_transform:
  3621. .. rst-class:: classref-method
  3622. void **canvas_light_set_transform** **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)**
  3623. Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
  3624. .. rst-class:: classref-item-separator
  3625. ----
  3626. .. _class_RenderingServer_method_canvas_light_set_z_range:
  3627. .. rst-class:: classref-method
  3628. void **canvas_light_set_z_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
  3629. 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>`.
  3630. .. rst-class:: classref-item-separator
  3631. ----
  3632. .. _class_RenderingServer_method_canvas_occluder_polygon_create:
  3633. .. rst-class:: classref-method
  3634. :ref:`RID<class_RID>` **canvas_occluder_polygon_create** **(** **)**
  3635. 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.
  3636. 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.
  3637. \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
  3638. .. rst-class:: classref-item-separator
  3639. ----
  3640. .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
  3641. .. rst-class:: classref-method
  3642. void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)**
  3643. Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
  3644. .. rst-class:: classref-item-separator
  3645. ----
  3646. .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
  3647. .. rst-class:: classref-method
  3648. void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)**
  3649. Sets the shape of the occluder polygon.
  3650. .. rst-class:: classref-item-separator
  3651. ----
  3652. .. _class_RenderingServer_method_canvas_set_disable_scale:
  3653. .. rst-class:: classref-method
  3654. void **canvas_set_disable_scale** **(** :ref:`bool<class_bool>` disable **)**
  3655. .. container:: contribute
  3656. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3657. .. rst-class:: classref-item-separator
  3658. ----
  3659. .. _class_RenderingServer_method_canvas_set_item_mirroring:
  3660. .. rst-class:: classref-method
  3661. void **canvas_set_item_mirroring** **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)**
  3662. A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_Vector2>`.
  3663. .. rst-class:: classref-item-separator
  3664. ----
  3665. .. _class_RenderingServer_method_canvas_set_modulate:
  3666. .. rst-class:: classref-method
  3667. void **canvas_set_modulate** **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)**
  3668. Modulates all colors in the given canvas.
  3669. .. rst-class:: classref-item-separator
  3670. ----
  3671. .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
  3672. .. rst-class:: classref-method
  3673. void **canvas_set_shadow_texture_size** **(** :ref:`int<class_int>` size **)**
  3674. 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.
  3675. .. rst-class:: classref-item-separator
  3676. ----
  3677. .. _class_RenderingServer_method_canvas_texture_create:
  3678. .. rst-class:: classref-method
  3679. :ref:`RID<class_RID>` **canvas_texture_create** **(** **)**
  3680. 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.
  3681. 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>`.
  3682. \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
  3683. .. rst-class:: classref-item-separator
  3684. ----
  3685. .. _class_RenderingServer_method_canvas_texture_set_channel:
  3686. .. rst-class:: classref-method
  3687. void **canvas_texture_set_channel** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)**
  3688. 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>`.
  3689. .. rst-class:: classref-item-separator
  3690. ----
  3691. .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
  3692. .. rst-class:: classref-method
  3693. void **canvas_texture_set_shading_parameters** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)**
  3694. 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>`.
  3695. .. rst-class:: classref-item-separator
  3696. ----
  3697. .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
  3698. .. rst-class:: classref-method
  3699. void **canvas_texture_set_texture_filter** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  3700. Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  3701. .. rst-class:: classref-item-separator
  3702. ----
  3703. .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
  3704. .. rst-class:: classref-method
  3705. void **canvas_texture_set_texture_repeat** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  3706. Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  3707. .. rst-class:: classref-item-separator
  3708. ----
  3709. .. _class_RenderingServer_method_create_local_rendering_device:
  3710. .. rst-class:: classref-method
  3711. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device** **(** **)** |const|
  3712. 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.
  3713. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  3714. .. rst-class:: classref-item-separator
  3715. ----
  3716. .. _class_RenderingServer_method_decal_create:
  3717. .. rst-class:: classref-method
  3718. :ref:`RID<class_RID>` **decal_create** **(** **)**
  3719. 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.
  3720. 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.
  3721. 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.
  3722. \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
  3723. .. rst-class:: classref-item-separator
  3724. ----
  3725. .. _class_RenderingServer_method_decal_set_albedo_mix:
  3726. .. rst-class:: classref-method
  3727. void **decal_set_albedo_mix** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)**
  3728. Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
  3729. .. rst-class:: classref-item-separator
  3730. ----
  3731. .. _class_RenderingServer_method_decal_set_cull_mask:
  3732. .. rst-class:: classref-method
  3733. void **decal_set_cull_mask** **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)**
  3734. Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
  3735. .. rst-class:: classref-item-separator
  3736. ----
  3737. .. _class_RenderingServer_method_decal_set_distance_fade:
  3738. .. rst-class:: classref-method
  3739. void **decal_set_distance_fade** **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)**
  3740. 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>`.
  3741. .. rst-class:: classref-item-separator
  3742. ----
  3743. .. _class_RenderingServer_method_decal_set_emission_energy:
  3744. .. rst-class:: classref-method
  3745. void **decal_set_emission_energy** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)**
  3746. Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
  3747. .. rst-class:: classref-item-separator
  3748. ----
  3749. .. _class_RenderingServer_method_decal_set_fade:
  3750. .. rst-class:: classref-method
  3751. void **decal_set_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)**
  3752. 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>`.
  3753. .. rst-class:: classref-item-separator
  3754. ----
  3755. .. _class_RenderingServer_method_decal_set_modulate:
  3756. .. rst-class:: classref-method
  3757. void **decal_set_modulate** **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)**
  3758. Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
  3759. .. rst-class:: classref-item-separator
  3760. ----
  3761. .. _class_RenderingServer_method_decal_set_normal_fade:
  3762. .. rst-class:: classref-method
  3763. void **decal_set_normal_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)**
  3764. Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
  3765. .. rst-class:: classref-item-separator
  3766. ----
  3767. .. _class_RenderingServer_method_decal_set_size:
  3768. .. rst-class:: classref-method
  3769. void **decal_set_size** **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)**
  3770. Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
  3771. .. rst-class:: classref-item-separator
  3772. ----
  3773. .. _class_RenderingServer_method_decal_set_texture:
  3774. .. rst-class:: classref-method
  3775. void **decal_set_texture** **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)**
  3776. Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture<class_Decal_method_set_texture>`.
  3777. .. rst-class:: classref-item-separator
  3778. ----
  3779. .. _class_RenderingServer_method_decals_set_filter:
  3780. .. rst-class:: classref-method
  3781. void **decals_set_filter** **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)**
  3782. Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
  3783. .. rst-class:: classref-item-separator
  3784. ----
  3785. .. _class_RenderingServer_method_directional_light_create:
  3786. .. rst-class:: classref-method
  3787. :ref:`RID<class_RID>` **directional_light_create** **(** **)**
  3788. 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.
  3789. 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.
  3790. 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.
  3791. \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
  3792. .. rst-class:: classref-item-separator
  3793. ----
  3794. .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
  3795. .. rst-class:: classref-method
  3796. void **directional_shadow_atlas_set_size** **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)**
  3797. 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.
  3798. .. rst-class:: classref-item-separator
  3799. ----
  3800. .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
  3801. .. rst-class:: classref-method
  3802. void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
  3803. 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.
  3804. .. rst-class:: classref-item-separator
  3805. ----
  3806. .. _class_RenderingServer_method_environment_bake_panorama:
  3807. .. rst-class:: classref-method
  3808. :ref:`Image<class_Image>` **environment_bake_panorama** **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
  3809. 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>`.
  3810. \ **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.
  3811. \ **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.
  3812. .. rst-class:: classref-item-separator
  3813. ----
  3814. .. _class_RenderingServer_method_environment_create:
  3815. .. rst-class:: classref-method
  3816. :ref:`RID<class_RID>` **environment_create** **(** **)**
  3817. 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.
  3818. 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.
  3819. \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
  3820. .. rst-class:: classref-item-separator
  3821. ----
  3822. .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
  3823. .. rst-class:: classref-method
  3824. void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool<class_bool>` enable **)**
  3825. 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>`.
  3826. .. rst-class:: classref-item-separator
  3827. ----
  3828. .. _class_RenderingServer_method_environment_set_adjustment:
  3829. .. rst-class:: classref-method
  3830. void **environment_set_adjustment** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)**
  3831. Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3832. .. rst-class:: classref-item-separator
  3833. ----
  3834. .. _class_RenderingServer_method_environment_set_ambient_light:
  3835. .. rst-class:: classref-method
  3836. void **environment_set_ambient_light** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)**
  3837. Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
  3838. .. rst-class:: classref-item-separator
  3839. ----
  3840. .. _class_RenderingServer_method_environment_set_background:
  3841. .. rst-class:: classref-method
  3842. void **environment_set_background** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)**
  3843. Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
  3844. .. rst-class:: classref-item-separator
  3845. ----
  3846. .. _class_RenderingServer_method_environment_set_bg_color:
  3847. .. rst-class:: classref-method
  3848. void **environment_set_bg_color** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)**
  3849. 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.
  3850. .. rst-class:: classref-item-separator
  3851. ----
  3852. .. _class_RenderingServer_method_environment_set_bg_energy:
  3853. .. rst-class:: classref-method
  3854. void **environment_set_bg_energy** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` exposure_value **)**
  3855. Sets the intensity of the background color.
  3856. .. rst-class:: classref-item-separator
  3857. ----
  3858. .. _class_RenderingServer_method_environment_set_canvas_max_layer:
  3859. .. rst-class:: classref-method
  3860. void **environment_set_canvas_max_layer** **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)**
  3861. Sets the maximum layer to use if using Canvas background mode.
  3862. .. rst-class:: classref-item-separator
  3863. ----
  3864. .. _class_RenderingServer_method_environment_set_fog:
  3865. .. rst-class:: classref-method
  3866. void **environment_set_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` 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 **)**
  3867. Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3868. .. rst-class:: classref-item-separator
  3869. ----
  3870. .. _class_RenderingServer_method_environment_set_glow:
  3871. .. rst-class:: classref-method
  3872. void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` 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:`RID<class_RID>` glow_map **)**
  3873. Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3874. .. rst-class:: classref-item-separator
  3875. ----
  3876. .. _class_RenderingServer_method_environment_set_sdfgi:
  3877. .. rst-class:: classref-method
  3878. void **environment_set_sdfgi** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)**
  3879. Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3880. .. rst-class:: classref-item-separator
  3881. ----
  3882. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
  3883. .. rst-class:: classref-method
  3884. void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)**
  3885. 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>`.
  3886. .. rst-class:: classref-item-separator
  3887. ----
  3888. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
  3889. .. rst-class:: classref-method
  3890. void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)**
  3891. 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>`.
  3892. .. rst-class:: classref-item-separator
  3893. ----
  3894. .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
  3895. .. rst-class:: classref-method
  3896. void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)**
  3897. 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>`.
  3898. .. rst-class:: classref-item-separator
  3899. ----
  3900. .. _class_RenderingServer_method_environment_set_sky:
  3901. .. rst-class:: classref-method
  3902. void **environment_set_sky** **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)**
  3903. 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>`.
  3904. .. rst-class:: classref-item-separator
  3905. ----
  3906. .. _class_RenderingServer_method_environment_set_sky_custom_fov:
  3907. .. rst-class:: classref-method
  3908. void **environment_set_sky_custom_fov** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)**
  3909. 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>`.
  3910. .. rst-class:: classref-item-separator
  3911. ----
  3912. .. _class_RenderingServer_method_environment_set_sky_orientation:
  3913. .. rst-class:: classref-method
  3914. void **environment_set_sky_orientation** **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)**
  3915. 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>`.
  3916. .. rst-class:: classref-item-separator
  3917. ----
  3918. .. _class_RenderingServer_method_environment_set_ssao:
  3919. .. rst-class:: classref-method
  3920. void **environment_set_ssao** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` 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 **)**
  3921. Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3922. .. rst-class:: classref-item-separator
  3923. ----
  3924. .. _class_RenderingServer_method_environment_set_ssao_quality:
  3925. .. rst-class:: classref-method
  3926. void **environment_set_ssao_quality** **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
  3927. Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3928. .. rst-class:: classref-item-separator
  3929. ----
  3930. .. _class_RenderingServer_method_environment_set_ssil_quality:
  3931. .. rst-class:: classref-method
  3932. void **environment_set_ssil_quality** **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
  3933. Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3934. .. rst-class:: classref-item-separator
  3935. ----
  3936. .. _class_RenderingServer_method_environment_set_ssr:
  3937. .. rst-class:: classref-method
  3938. void **environment_set_ssr** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)**
  3939. Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3940. .. rst-class:: classref-item-separator
  3941. ----
  3942. .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
  3943. .. rst-class:: classref-method
  3944. void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)**
  3945. .. container:: contribute
  3946. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3947. .. rst-class:: classref-item-separator
  3948. ----
  3949. .. _class_RenderingServer_method_environment_set_tonemap:
  3950. .. rst-class:: classref-method
  3951. void **environment_set_tonemap** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white **)**
  3952. Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3953. .. rst-class:: classref-item-separator
  3954. ----
  3955. .. _class_RenderingServer_method_environment_set_volumetric_fog:
  3956. .. rst-class:: classref-method
  3957. void **environment_set_volumetric_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` 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:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject, :ref:`float<class_float>` sky_affect **)**
  3958. Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3959. .. rst-class:: classref-item-separator
  3960. ----
  3961. .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
  3962. .. rst-class:: classref-method
  3963. void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool<class_bool>` active **)**
  3964. Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
  3965. .. rst-class:: classref-item-separator
  3966. ----
  3967. .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
  3968. .. rst-class:: classref-method
  3969. void **environment_set_volumetric_fog_volume_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)**
  3970. 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.
  3971. .. rst-class:: classref-item-separator
  3972. ----
  3973. .. _class_RenderingServer_method_fog_volume_create:
  3974. .. rst-class:: classref-method
  3975. :ref:`RID<class_RID>` **fog_volume_create** **(** **)**
  3976. 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.
  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:`FogVolume<class_FogVolume>`.
  3979. .. rst-class:: classref-item-separator
  3980. ----
  3981. .. _class_RenderingServer_method_fog_volume_set_material:
  3982. .. rst-class:: classref-method
  3983. void **fog_volume_set_material** **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)**
  3984. 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>`.
  3985. .. rst-class:: classref-item-separator
  3986. ----
  3987. .. _class_RenderingServer_method_fog_volume_set_shape:
  3988. .. rst-class:: classref-method
  3989. void **fog_volume_set_shape** **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)**
  3990. 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>`.
  3991. .. rst-class:: classref-item-separator
  3992. ----
  3993. .. _class_RenderingServer_method_fog_volume_set_size:
  3994. .. rst-class:: classref-method
  3995. void **fog_volume_set_size** **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)**
  3996. 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>`.
  3997. .. rst-class:: classref-item-separator
  3998. ----
  3999. .. _class_RenderingServer_method_force_draw:
  4000. .. rst-class:: classref-method
  4001. void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
  4002. Forces redrawing of all viewports at once.
  4003. .. rst-class:: classref-item-separator
  4004. ----
  4005. .. _class_RenderingServer_method_force_sync:
  4006. .. rst-class:: classref-method
  4007. void **force_sync** **(** **)**
  4008. 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.
  4009. .. rst-class:: classref-item-separator
  4010. ----
  4011. .. _class_RenderingServer_method_free_rid:
  4012. .. rst-class:: classref-method
  4013. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  4014. 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 RendeeringServer directly.
  4015. .. rst-class:: classref-item-separator
  4016. ----
  4017. .. _class_RenderingServer_method_get_default_clear_color:
  4018. .. rst-class:: classref-method
  4019. :ref:`Color<class_Color>` **get_default_clear_color** **(** **)**
  4020. 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>`.
  4021. .. rst-class:: classref-item-separator
  4022. ----
  4023. .. _class_RenderingServer_method_get_frame_setup_time_cpu:
  4024. .. rst-class:: classref-method
  4025. :ref:`float<class_float>` **get_frame_setup_time_cpu** **(** **)** |const|
  4026. 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>`.
  4027. .. rst-class:: classref-item-separator
  4028. ----
  4029. .. _class_RenderingServer_method_get_rendering_device:
  4030. .. rst-class:: classref-method
  4031. :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device** **(** **)** |const|
  4032. Returns the global RenderingDevice.
  4033. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  4034. .. rst-class:: classref-item-separator
  4035. ----
  4036. .. _class_RenderingServer_method_get_rendering_info:
  4037. .. rst-class:: classref-method
  4038. :ref:`int<class_int>` **get_rendering_info** **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)**
  4039. 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.
  4040. \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
  4041. \ **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:
  4042. ::
  4043. func _ready():
  4044. for _i in 2:
  4045. await get_tree().process_frame
  4046. print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
  4047. .. rst-class:: classref-item-separator
  4048. ----
  4049. .. _class_RenderingServer_method_get_shader_parameter_list:
  4050. .. rst-class:: classref-method
  4051. :ref:`Dictionary[]<class_Dictionary>` **get_shader_parameter_list** **(** :ref:`RID<class_RID>` shader **)** |const|
  4052. Returns the parameters of a shader.
  4053. .. rst-class:: classref-item-separator
  4054. ----
  4055. .. _class_RenderingServer_method_get_test_cube:
  4056. .. rst-class:: classref-method
  4057. :ref:`RID<class_RID>` **get_test_cube** **(** **)**
  4058. 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>`.
  4059. .. rst-class:: classref-item-separator
  4060. ----
  4061. .. _class_RenderingServer_method_get_test_texture:
  4062. .. rst-class:: classref-method
  4063. :ref:`RID<class_RID>` **get_test_texture** **(** **)**
  4064. 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>`.
  4065. Example of getting the test texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4066. ::
  4067. var texture_rid = RenderingServer.get_test_texture()
  4068. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4069. $Sprite2D.texture = texture
  4070. .. rst-class:: classref-item-separator
  4071. ----
  4072. .. _class_RenderingServer_method_get_video_adapter_api_version:
  4073. .. rst-class:: classref-method
  4074. :ref:`String<class_String>` **get_video_adapter_api_version** **(** **)** |const|
  4075. 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>`.
  4076. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4077. .. rst-class:: classref-item-separator
  4078. ----
  4079. .. _class_RenderingServer_method_get_video_adapter_name:
  4080. .. rst-class:: classref-method
  4081. :ref:`String<class_String>` **get_video_adapter_name** **(** **)** |const|
  4082. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
  4083. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4084. .. rst-class:: classref-item-separator
  4085. ----
  4086. .. _class_RenderingServer_method_get_video_adapter_type:
  4087. .. rst-class:: classref-method
  4088. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type** **(** **)** |const|
  4089. 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.
  4090. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns :ref:`RenderingDevice.DEVICE_TYPE_OTHER<class_RenderingDevice_constant_DEVICE_TYPE_OTHER>`.
  4091. .. rst-class:: classref-item-separator
  4092. ----
  4093. .. _class_RenderingServer_method_get_video_adapter_vendor:
  4094. .. rst-class:: classref-method
  4095. :ref:`String<class_String>` **get_video_adapter_vendor** **(** **)** |const|
  4096. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
  4097. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4098. .. rst-class:: classref-item-separator
  4099. ----
  4100. .. _class_RenderingServer_method_get_white_texture:
  4101. .. rst-class:: classref-method
  4102. :ref:`RID<class_RID>` **get_white_texture** **(** **)**
  4103. 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>`.
  4104. Example of getting the white texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4105. ::
  4106. var texture_rid = RenderingServer.get_white_texture()
  4107. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4108. $Sprite2D.texture = texture
  4109. .. rst-class:: classref-item-separator
  4110. ----
  4111. .. _class_RenderingServer_method_gi_set_use_half_resolution:
  4112. .. rst-class:: classref-method
  4113. void **gi_set_use_half_resolution** **(** :ref:`bool<class_bool>` half_resolution **)**
  4114. 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>`.
  4115. .. rst-class:: classref-item-separator
  4116. ----
  4117. .. _class_RenderingServer_method_global_shader_parameter_add:
  4118. .. rst-class:: classref-method
  4119. void **global_shader_parameter_add** **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` type, :ref:`Variant<class_Variant>` default_value **)**
  4120. Creates a new global shader uniform.
  4121. \ **Note:** Global shader parameter names are case-sensitive.
  4122. .. rst-class:: classref-item-separator
  4123. ----
  4124. .. _class_RenderingServer_method_global_shader_parameter_get:
  4125. .. rst-class:: classref-method
  4126. :ref:`Variant<class_Variant>` **global_shader_parameter_get** **(** :ref:`StringName<class_StringName>` name **)** |const|
  4127. Returns the value of the global shader uniform specified by ``name``.
  4128. \ **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.
  4129. .. rst-class:: classref-item-separator
  4130. ----
  4131. .. _class_RenderingServer_method_global_shader_parameter_get_list:
  4132. .. rst-class:: classref-method
  4133. :ref:`StringName[]<class_StringName>` **global_shader_parameter_get_list** **(** **)** |const|
  4134. Returns the list of global shader uniform names.
  4135. \ **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.
  4136. .. rst-class:: classref-item-separator
  4137. ----
  4138. .. _class_RenderingServer_method_global_shader_parameter_get_type:
  4139. .. rst-class:: classref-method
  4140. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **global_shader_parameter_get_type** **(** :ref:`StringName<class_StringName>` name **)** |const|
  4141. Returns the type associated to the global shader uniform specified by ``name``.
  4142. \ **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.
  4143. .. rst-class:: classref-item-separator
  4144. ----
  4145. .. _class_RenderingServer_method_global_shader_parameter_remove:
  4146. .. rst-class:: classref-method
  4147. void **global_shader_parameter_remove** **(** :ref:`StringName<class_StringName>` name **)**
  4148. Removes the global shader uniform specified by ``name``.
  4149. .. rst-class:: classref-item-separator
  4150. ----
  4151. .. _class_RenderingServer_method_global_shader_parameter_set:
  4152. .. rst-class:: classref-method
  4153. void **global_shader_parameter_set** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
  4154. Sets the global shader uniform ``name`` to ``value``.
  4155. .. rst-class:: classref-item-separator
  4156. ----
  4157. .. _class_RenderingServer_method_global_shader_parameter_set_override:
  4158. .. rst-class:: classref-method
  4159. void **global_shader_parameter_set_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
  4160. Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
  4161. .. rst-class:: classref-item-separator
  4162. ----
  4163. .. _class_RenderingServer_method_has_changed:
  4164. .. rst-class:: classref-method
  4165. :ref:`bool<class_bool>` **has_changed** **(** **)** |const|
  4166. 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.
  4167. .. rst-class:: classref-item-separator
  4168. ----
  4169. .. _class_RenderingServer_method_has_feature:
  4170. .. rst-class:: classref-method
  4171. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const|
  4172. Not yet implemented. Always returns ``false``.
  4173. .. rst-class:: classref-item-separator
  4174. ----
  4175. .. _class_RenderingServer_method_has_os_feature:
  4176. .. rst-class:: classref-method
  4177. :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_String>` feature **)** |const|
  4178. Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
  4179. .. rst-class:: classref-item-separator
  4180. ----
  4181. .. _class_RenderingServer_method_instance_attach_object_instance_id:
  4182. .. rst-class:: classref-method
  4183. void **instance_attach_object_instance_id** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)**
  4184. 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>`.
  4185. .. rst-class:: classref-item-separator
  4186. ----
  4187. .. _class_RenderingServer_method_instance_attach_skeleton:
  4188. .. rst-class:: classref-method
  4189. void **instance_attach_skeleton** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)**
  4190. Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
  4191. .. rst-class:: classref-item-separator
  4192. ----
  4193. .. _class_RenderingServer_method_instance_create:
  4194. .. rst-class:: classref-method
  4195. :ref:`RID<class_RID>` **instance_create** **(** **)**
  4196. 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.
  4197. 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.
  4198. 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>`.
  4199. \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
  4200. .. rst-class:: classref-item-separator
  4201. ----
  4202. .. _class_RenderingServer_method_instance_create2:
  4203. .. rst-class:: classref-method
  4204. :ref:`RID<class_RID>` **instance_create2** **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)**
  4205. 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.
  4206. 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.
  4207. .. rst-class:: classref-item-separator
  4208. ----
  4209. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
  4210. .. rst-class:: classref-method
  4211. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
  4212. 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>`.
  4213. \ **Note:** Per-instance shader parameter names are case-sensitive.
  4214. .. rst-class:: classref-item-separator
  4215. ----
  4216. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
  4217. .. rst-class:: classref-method
  4218. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
  4219. 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>`.
  4220. .. rst-class:: classref-item-separator
  4221. ----
  4222. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
  4223. .. rst-class:: classref-method
  4224. :ref:`Dictionary[]<class_Dictionary>` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID<class_RID>` instance **)** |const|
  4225. 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>`.
  4226. .. rst-class:: classref-item-separator
  4227. ----
  4228. .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
  4229. .. rst-class:: classref-method
  4230. void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)**
  4231. Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
  4232. .. rst-class:: classref-item-separator
  4233. ----
  4234. .. _class_RenderingServer_method_instance_geometry_set_flag:
  4235. .. rst-class:: classref-method
  4236. void **instance_geometry_set_flag** **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)**
  4237. Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
  4238. .. rst-class:: classref-item-separator
  4239. ----
  4240. .. _class_RenderingServer_method_instance_geometry_set_lightmap:
  4241. .. rst-class:: classref-method
  4242. void **instance_geometry_set_lightmap** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)**
  4243. 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.
  4244. .. rst-class:: classref-item-separator
  4245. ----
  4246. .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
  4247. .. rst-class:: classref-method
  4248. void **instance_geometry_set_lod_bias** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)**
  4249. 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>`.
  4250. .. rst-class:: classref-item-separator
  4251. ----
  4252. .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
  4253. .. rst-class:: classref-method
  4254. void **instance_geometry_set_material_overlay** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
  4255. 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>`.
  4256. .. rst-class:: classref-item-separator
  4257. ----
  4258. .. _class_RenderingServer_method_instance_geometry_set_material_override:
  4259. .. rst-class:: classref-method
  4260. void **instance_geometry_set_material_override** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
  4261. 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>`.
  4262. .. rst-class:: classref-item-separator
  4263. ----
  4264. .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
  4265. .. rst-class:: classref-method
  4266. void **instance_geometry_set_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
  4267. 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>`.
  4268. .. rst-class:: classref-item-separator
  4269. ----
  4270. .. _class_RenderingServer_method_instance_geometry_set_transparency:
  4271. .. rst-class:: classref-method
  4272. void **instance_geometry_set_transparency** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)**
  4273. Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
  4274. 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.
  4275. In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
  4276. \ **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.
  4277. .. rst-class:: classref-item-separator
  4278. ----
  4279. .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
  4280. .. rst-class:: classref-method
  4281. void **instance_geometry_set_visibility_range** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)**
  4282. 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.
  4283. .. rst-class:: classref-item-separator
  4284. ----
  4285. .. _class_RenderingServer_method_instance_set_base:
  4286. .. rst-class:: classref-method
  4287. void **instance_set_base** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)**
  4288. 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.
  4289. .. rst-class:: classref-item-separator
  4290. ----
  4291. .. _class_RenderingServer_method_instance_set_blend_shape_weight:
  4292. .. rst-class:: classref-method
  4293. void **instance_set_blend_shape_weight** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)**
  4294. Sets the weight for a given blend shape associated with this instance.
  4295. .. rst-class:: classref-item-separator
  4296. ----
  4297. .. _class_RenderingServer_method_instance_set_custom_aabb:
  4298. .. rst-class:: classref-method
  4299. void **instance_set_custom_aabb** **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)**
  4300. 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>`.
  4301. .. rst-class:: classref-item-separator
  4302. ----
  4303. .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
  4304. .. rst-class:: classref-method
  4305. void **instance_set_extra_visibility_margin** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)**
  4306. 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>`.
  4307. .. rst-class:: classref-item-separator
  4308. ----
  4309. .. _class_RenderingServer_method_instance_set_ignore_culling:
  4310. .. rst-class:: classref-method
  4311. void **instance_set_ignore_culling** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)**
  4312. 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.
  4313. .. rst-class:: classref-item-separator
  4314. ----
  4315. .. _class_RenderingServer_method_instance_set_layer_mask:
  4316. .. rst-class:: classref-method
  4317. void **instance_set_layer_mask** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)**
  4318. Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
  4319. .. rst-class:: classref-item-separator
  4320. ----
  4321. .. _class_RenderingServer_method_instance_set_pivot_data:
  4322. .. rst-class:: classref-method
  4323. void **instance_set_pivot_data** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` sorting_offset, :ref:`bool<class_bool>` use_aabb_center **)**
  4324. Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
  4325. .. rst-class:: classref-item-separator
  4326. ----
  4327. .. _class_RenderingServer_method_instance_set_scenario:
  4328. .. rst-class:: classref-method
  4329. void **instance_set_scenario** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)**
  4330. Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
  4331. .. rst-class:: classref-item-separator
  4332. ----
  4333. .. _class_RenderingServer_method_instance_set_surface_override_material:
  4334. .. rst-class:: classref-method
  4335. void **instance_set_surface_override_material** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
  4336. Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
  4337. .. rst-class:: classref-item-separator
  4338. ----
  4339. .. _class_RenderingServer_method_instance_set_transform:
  4340. .. rst-class:: classref-method
  4341. void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)**
  4342. Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform<class_Node3D_property_transform>`.
  4343. .. rst-class:: classref-item-separator
  4344. ----
  4345. .. _class_RenderingServer_method_instance_set_visibility_parent:
  4346. .. rst-class:: classref-method
  4347. void **instance_set_visibility_parent** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)**
  4348. Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
  4349. .. rst-class:: classref-item-separator
  4350. ----
  4351. .. _class_RenderingServer_method_instance_set_visible:
  4352. .. rst-class:: classref-method
  4353. void **instance_set_visible** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)**
  4354. Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
  4355. .. rst-class:: classref-item-separator
  4356. ----
  4357. .. _class_RenderingServer_method_instances_cull_aabb:
  4358. .. rst-class:: classref-method
  4359. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_aabb** **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4360. 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.
  4361. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4362. .. rst-class:: classref-item-separator
  4363. ----
  4364. .. _class_RenderingServer_method_instances_cull_convex:
  4365. .. rst-class:: classref-method
  4366. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_convex** **(** :ref:`Plane[]<class_Plane>` convex, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4367. 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.
  4368. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4369. .. rst-class:: classref-item-separator
  4370. ----
  4371. .. _class_RenderingServer_method_instances_cull_ray:
  4372. .. rst-class:: classref-method
  4373. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4374. 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.
  4375. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4376. .. rst-class:: classref-item-separator
  4377. ----
  4378. .. _class_RenderingServer_method_light_directional_set_blend_splits:
  4379. .. rst-class:: classref-method
  4380. void **light_directional_set_blend_splits** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
  4381. 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>`.
  4382. .. rst-class:: classref-item-separator
  4383. ----
  4384. .. _class_RenderingServer_method_light_directional_set_shadow_mode:
  4385. .. rst-class:: classref-method
  4386. void **light_directional_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)**
  4387. 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.
  4388. .. rst-class:: classref-item-separator
  4389. ----
  4390. .. _class_RenderingServer_method_light_directional_set_sky_mode:
  4391. .. rst-class:: classref-method
  4392. void **light_directional_set_sky_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` mode **)**
  4393. 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.
  4394. .. rst-class:: classref-item-separator
  4395. ----
  4396. .. _class_RenderingServer_method_light_omni_set_shadow_mode:
  4397. .. rst-class:: classref-method
  4398. void **light_omni_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)**
  4399. 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>`.
  4400. .. rst-class:: classref-item-separator
  4401. ----
  4402. .. _class_RenderingServer_method_light_projectors_set_filter:
  4403. .. rst-class:: classref-method
  4404. void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)**
  4405. Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
  4406. .. rst-class:: classref-item-separator
  4407. ----
  4408. .. _class_RenderingServer_method_light_set_bake_mode:
  4409. .. rst-class:: classref-method
  4410. void **light_set_bake_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)**
  4411. Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
  4412. .. rst-class:: classref-item-separator
  4413. ----
  4414. .. _class_RenderingServer_method_light_set_color:
  4415. .. rst-class:: classref-method
  4416. void **light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  4417. Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
  4418. .. rst-class:: classref-item-separator
  4419. ----
  4420. .. _class_RenderingServer_method_light_set_cull_mask:
  4421. .. rst-class:: classref-method
  4422. void **light_set_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  4423. 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>`.
  4424. .. rst-class:: classref-item-separator
  4425. ----
  4426. .. _class_RenderingServer_method_light_set_distance_fade:
  4427. .. rst-class:: classref-method
  4428. void **light_set_distance_fade** **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` shadow, :ref:`float<class_float>` length **)**
  4429. 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>`.
  4430. .. rst-class:: classref-item-separator
  4431. ----
  4432. .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
  4433. .. rst-class:: classref-method
  4434. void **light_set_max_sdfgi_cascade** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)**
  4435. 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.
  4436. .. rst-class:: classref-item-separator
  4437. ----
  4438. .. _class_RenderingServer_method_light_set_negative:
  4439. .. rst-class:: classref-method
  4440. void **light_set_negative** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
  4441. If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
  4442. .. rst-class:: classref-item-separator
  4443. ----
  4444. .. _class_RenderingServer_method_light_set_param:
  4445. .. rst-class:: classref-method
  4446. void **light_set_param** **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)**
  4447. 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>`.
  4448. .. rst-class:: classref-item-separator
  4449. ----
  4450. .. _class_RenderingServer_method_light_set_projector:
  4451. .. rst-class:: classref-method
  4452. void **light_set_projector** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
  4453. Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
  4454. .. rst-class:: classref-item-separator
  4455. ----
  4456. .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
  4457. .. rst-class:: classref-method
  4458. void **light_set_reverse_cull_face_mode** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  4459. 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>`.
  4460. .. rst-class:: classref-item-separator
  4461. ----
  4462. .. _class_RenderingServer_method_light_set_shadow:
  4463. .. rst-class:: classref-method
  4464. void **light_set_shadow** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  4465. If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
  4466. .. rst-class:: classref-item-separator
  4467. ----
  4468. .. _class_RenderingServer_method_lightmap_create:
  4469. .. rst-class:: classref-method
  4470. :ref:`RID<class_RID>` **lightmap_create** **(** **)**
  4471. 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.
  4472. 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.
  4473. \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
  4474. .. rst-class:: classref-item-separator
  4475. ----
  4476. .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
  4477. .. rst-class:: classref-method
  4478. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4479. .. container:: contribute
  4480. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4481. .. rst-class:: classref-item-separator
  4482. ----
  4483. .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
  4484. .. rst-class:: classref-method
  4485. :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4486. .. container:: contribute
  4487. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4488. .. rst-class:: classref-item-separator
  4489. ----
  4490. .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
  4491. .. rst-class:: classref-method
  4492. :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4493. .. container:: contribute
  4494. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4495. .. rst-class:: classref-item-separator
  4496. ----
  4497. .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
  4498. .. rst-class:: classref-method
  4499. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4500. .. container:: contribute
  4501. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4502. .. rst-class:: classref-item-separator
  4503. ----
  4504. .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
  4505. .. rst-class:: classref-method
  4506. void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` lightmap, :ref:`float<class_float>` baked_exposure **)**
  4507. 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>`.
  4508. .. rst-class:: classref-item-separator
  4509. ----
  4510. .. _class_RenderingServer_method_lightmap_set_probe_bounds:
  4511. .. rst-class:: classref-method
  4512. void **lightmap_set_probe_bounds** **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)**
  4513. .. container:: contribute
  4514. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4515. .. rst-class:: classref-item-separator
  4516. ----
  4517. .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
  4518. .. rst-class:: classref-method
  4519. void **lightmap_set_probe_capture_data** **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)**
  4520. .. container:: contribute
  4521. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4522. .. rst-class:: classref-item-separator
  4523. ----
  4524. .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
  4525. .. rst-class:: classref-method
  4526. void **lightmap_set_probe_capture_update_speed** **(** :ref:`float<class_float>` speed **)**
  4527. .. container:: contribute
  4528. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4529. .. rst-class:: classref-item-separator
  4530. ----
  4531. .. _class_RenderingServer_method_lightmap_set_probe_interior:
  4532. .. rst-class:: classref-method
  4533. void **lightmap_set_probe_interior** **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)**
  4534. .. container:: contribute
  4535. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4536. .. rst-class:: classref-item-separator
  4537. ----
  4538. .. _class_RenderingServer_method_lightmap_set_textures:
  4539. .. rst-class:: classref-method
  4540. void **lightmap_set_textures** **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)**
  4541. 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``.
  4542. .. rst-class:: classref-item-separator
  4543. ----
  4544. .. _class_RenderingServer_method_make_sphere_mesh:
  4545. .. rst-class:: classref-method
  4546. :ref:`RID<class_RID>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
  4547. 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>`.
  4548. .. rst-class:: classref-item-separator
  4549. ----
  4550. .. _class_RenderingServer_method_material_create:
  4551. .. rst-class:: classref-method
  4552. :ref:`RID<class_RID>` **material_create** **(** **)**
  4553. 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.
  4554. 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.
  4555. \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
  4556. .. rst-class:: classref-item-separator
  4557. ----
  4558. .. _class_RenderingServer_method_material_get_param:
  4559. .. rst-class:: classref-method
  4560. :ref:`Variant<class_Variant>` **material_get_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const|
  4561. Returns the value of a certain material's parameter.
  4562. .. rst-class:: classref-item-separator
  4563. ----
  4564. .. _class_RenderingServer_method_material_set_next_pass:
  4565. .. rst-class:: classref-method
  4566. void **material_set_next_pass** **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)**
  4567. Sets an object's next material.
  4568. .. rst-class:: classref-item-separator
  4569. ----
  4570. .. _class_RenderingServer_method_material_set_param:
  4571. .. rst-class:: classref-method
  4572. void **material_set_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
  4573. Sets a material's parameter.
  4574. .. rst-class:: classref-item-separator
  4575. ----
  4576. .. _class_RenderingServer_method_material_set_render_priority:
  4577. .. rst-class:: classref-method
  4578. void **material_set_render_priority** **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)**
  4579. Sets a material's render priority.
  4580. .. rst-class:: classref-item-separator
  4581. ----
  4582. .. _class_RenderingServer_method_material_set_shader:
  4583. .. rst-class:: classref-method
  4584. void **material_set_shader** **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)**
  4585. Sets a shader material's shader.
  4586. .. rst-class:: classref-item-separator
  4587. ----
  4588. .. _class_RenderingServer_method_mesh_add_surface:
  4589. .. rst-class:: classref-method
  4590. void **mesh_add_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)**
  4591. .. container:: contribute
  4592. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4593. .. rst-class:: classref-item-separator
  4594. ----
  4595. .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
  4596. .. rst-class:: classref-method
  4597. void **mesh_add_surface_from_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> compress_format=0 **)**
  4598. .. container:: contribute
  4599. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4600. .. rst-class:: classref-item-separator
  4601. ----
  4602. .. _class_RenderingServer_method_mesh_clear:
  4603. .. rst-class:: classref-method
  4604. void **mesh_clear** **(** :ref:`RID<class_RID>` mesh **)**
  4605. Removes all surfaces from a mesh.
  4606. .. rst-class:: classref-item-separator
  4607. ----
  4608. .. _class_RenderingServer_method_mesh_create:
  4609. .. rst-class:: classref-method
  4610. :ref:`RID<class_RID>` **mesh_create** **(** **)**
  4611. 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.
  4612. 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.
  4613. 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.
  4614. \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
  4615. .. rst-class:: classref-item-separator
  4616. ----
  4617. .. _class_RenderingServer_method_mesh_create_from_surfaces:
  4618. .. rst-class:: classref-method
  4619. :ref:`RID<class_RID>` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)**
  4620. .. container:: contribute
  4621. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4622. .. rst-class:: classref-item-separator
  4623. ----
  4624. .. _class_RenderingServer_method_mesh_get_blend_shape_count:
  4625. .. rst-class:: classref-method
  4626. :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4627. Returns a mesh's blend shape count.
  4628. .. rst-class:: classref-item-separator
  4629. ----
  4630. .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
  4631. .. rst-class:: classref-method
  4632. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4633. Returns a mesh's blend shape mode.
  4634. .. rst-class:: classref-item-separator
  4635. ----
  4636. .. _class_RenderingServer_method_mesh_get_custom_aabb:
  4637. .. rst-class:: classref-method
  4638. :ref:`AABB<class_AABB>` **mesh_get_custom_aabb** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4639. Returns a mesh's custom aabb.
  4640. .. rst-class:: classref-item-separator
  4641. ----
  4642. .. _class_RenderingServer_method_mesh_get_surface:
  4643. .. rst-class:: classref-method
  4644. :ref:`Dictionary<class_Dictionary>` **mesh_get_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)**
  4645. .. container:: contribute
  4646. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4647. .. rst-class:: classref-item-separator
  4648. ----
  4649. .. _class_RenderingServer_method_mesh_get_surface_count:
  4650. .. rst-class:: classref-method
  4651. :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4652. Returns a mesh's number of surfaces.
  4653. .. rst-class:: classref-item-separator
  4654. ----
  4655. .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
  4656. .. rst-class:: classref-method
  4657. void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)**
  4658. Sets a mesh's blend shape mode.
  4659. .. rst-class:: classref-item-separator
  4660. ----
  4661. .. _class_RenderingServer_method_mesh_set_custom_aabb:
  4662. .. rst-class:: classref-method
  4663. void **mesh_set_custom_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)**
  4664. Sets a mesh's custom aabb.
  4665. .. rst-class:: classref-item-separator
  4666. ----
  4667. .. _class_RenderingServer_method_mesh_set_shadow_mesh:
  4668. .. rst-class:: classref-method
  4669. void **mesh_set_shadow_mesh** **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)**
  4670. .. container:: contribute
  4671. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4672. .. rst-class:: classref-item-separator
  4673. ----
  4674. .. _class_RenderingServer_method_mesh_surface_get_arrays:
  4675. .. rst-class:: classref-method
  4676. :ref:`Array<class_Array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4677. Returns a mesh's surface's buffer arrays.
  4678. .. rst-class:: classref-item-separator
  4679. ----
  4680. .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
  4681. .. rst-class:: classref-method
  4682. :ref:`Array[]<class_Array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4683. Returns a mesh's surface's arrays for blend shapes.
  4684. .. rst-class:: classref-item-separator
  4685. ----
  4686. .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
  4687. .. rst-class:: classref-method
  4688. :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4689. .. container:: contribute
  4690. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4691. .. rst-class:: classref-item-separator
  4692. ----
  4693. .. _class_RenderingServer_method_mesh_surface_get_format_offset:
  4694. .. rst-class:: classref-method
  4695. :ref:`int<class_int>` **mesh_surface_get_format_offset** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const|
  4696. .. container:: contribute
  4697. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4698. .. rst-class:: classref-item-separator
  4699. ----
  4700. .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
  4701. .. rst-class:: classref-method
  4702. :ref:`int<class_int>` **mesh_surface_get_format_skin_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4703. .. container:: contribute
  4704. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4705. .. rst-class:: classref-item-separator
  4706. ----
  4707. .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
  4708. .. rst-class:: classref-method
  4709. :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4710. .. container:: contribute
  4711. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4712. .. rst-class:: classref-item-separator
  4713. ----
  4714. .. _class_RenderingServer_method_mesh_surface_get_material:
  4715. .. rst-class:: classref-method
  4716. :ref:`RID<class_RID>` **mesh_surface_get_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4717. Returns a mesh's surface's material.
  4718. .. rst-class:: classref-item-separator
  4719. ----
  4720. .. _class_RenderingServer_method_mesh_surface_set_material:
  4721. .. rst-class:: classref-method
  4722. void **mesh_surface_set_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
  4723. Sets a mesh's surface's material.
  4724. .. rst-class:: classref-item-separator
  4725. ----
  4726. .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
  4727. .. rst-class:: classref-method
  4728. void **mesh_surface_update_attribute_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4729. .. container:: contribute
  4730. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4731. .. rst-class:: classref-item-separator
  4732. ----
  4733. .. _class_RenderingServer_method_mesh_surface_update_skin_region:
  4734. .. rst-class:: classref-method
  4735. void **mesh_surface_update_skin_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4736. .. container:: contribute
  4737. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4738. .. rst-class:: classref-item-separator
  4739. ----
  4740. .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
  4741. .. rst-class:: classref-method
  4742. void **mesh_surface_update_vertex_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4743. .. container:: contribute
  4744. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4745. .. rst-class:: classref-item-separator
  4746. ----
  4747. .. _class_RenderingServer_method_multimesh_allocate_data:
  4748. .. rst-class:: classref-method
  4749. void **multimesh_allocate_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)**
  4750. .. container:: contribute
  4751. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4752. .. rst-class:: classref-item-separator
  4753. ----
  4754. .. _class_RenderingServer_method_multimesh_create:
  4755. .. rst-class:: classref-method
  4756. :ref:`RID<class_RID>` **multimesh_create** **(** **)**
  4757. 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.
  4758. 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.
  4759. 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.
  4760. \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
  4761. .. rst-class:: classref-item-separator
  4762. ----
  4763. .. _class_RenderingServer_method_multimesh_get_aabb:
  4764. .. rst-class:: classref-method
  4765. :ref:`AABB<class_AABB>` **multimesh_get_aabb** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4766. Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
  4767. .. rst-class:: classref-item-separator
  4768. ----
  4769. .. _class_RenderingServer_method_multimesh_get_buffer:
  4770. .. rst-class:: classref-method
  4771. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4772. Returns the MultiMesh data (such as instance transforms, colors, etc). See :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` for a description of the returned data.
  4773. \ **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.
  4774. .. rst-class:: classref-item-separator
  4775. ----
  4776. .. _class_RenderingServer_method_multimesh_get_instance_count:
  4777. .. rst-class:: classref-method
  4778. :ref:`int<class_int>` **multimesh_get_instance_count** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4779. Returns the number of instances allocated for this multimesh.
  4780. .. rst-class:: classref-item-separator
  4781. ----
  4782. .. _class_RenderingServer_method_multimesh_get_mesh:
  4783. .. rst-class:: classref-method
  4784. :ref:`RID<class_RID>` **multimesh_get_mesh** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4785. Returns the RID of the mesh that will be used in drawing this multimesh.
  4786. .. rst-class:: classref-item-separator
  4787. ----
  4788. .. _class_RenderingServer_method_multimesh_get_visible_instances:
  4789. .. rst-class:: classref-method
  4790. :ref:`int<class_int>` **multimesh_get_visible_instances** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4791. Returns the number of visible instances for this multimesh.
  4792. .. rst-class:: classref-item-separator
  4793. ----
  4794. .. _class_RenderingServer_method_multimesh_instance_get_color:
  4795. .. rst-class:: classref-method
  4796. :ref:`Color<class_Color>` **multimesh_instance_get_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4797. Returns the color by which the specified instance will be modulated.
  4798. .. rst-class:: classref-item-separator
  4799. ----
  4800. .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
  4801. .. rst-class:: classref-method
  4802. :ref:`Color<class_Color>` **multimesh_instance_get_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4803. Returns the custom data associated with the specified instance.
  4804. .. rst-class:: classref-item-separator
  4805. ----
  4806. .. _class_RenderingServer_method_multimesh_instance_get_transform:
  4807. .. rst-class:: classref-method
  4808. :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4809. Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
  4810. .. rst-class:: classref-item-separator
  4811. ----
  4812. .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
  4813. .. rst-class:: classref-method
  4814. :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4815. Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
  4816. .. rst-class:: classref-item-separator
  4817. ----
  4818. .. _class_RenderingServer_method_multimesh_instance_set_color:
  4819. .. rst-class:: classref-method
  4820. void **multimesh_instance_set_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)**
  4821. Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
  4822. .. rst-class:: classref-item-separator
  4823. ----
  4824. .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
  4825. .. rst-class:: classref-method
  4826. void **multimesh_instance_set_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)**
  4827. 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>`.
  4828. .. rst-class:: classref-item-separator
  4829. ----
  4830. .. _class_RenderingServer_method_multimesh_instance_set_transform:
  4831. .. rst-class:: classref-method
  4832. void **multimesh_instance_set_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)**
  4833. Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
  4834. .. rst-class:: classref-item-separator
  4835. ----
  4836. .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
  4837. .. rst-class:: classref-method
  4838. void **multimesh_instance_set_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)**
  4839. 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>`.
  4840. .. rst-class:: classref-item-separator
  4841. ----
  4842. .. _class_RenderingServer_method_multimesh_set_buffer:
  4843. .. rst-class:: classref-method
  4844. void **multimesh_set_buffer** **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)**
  4845. 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>`.
  4846. The per-instance data size and expected data order is:
  4847. ::
  4848. 2D:
  4849. - Position: 8 floats (8 floats for Transform2D)
  4850. - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
  4851. - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
  4852. - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
  4853. 3D:
  4854. - Position: 12 floats (12 floats for Transform3D)
  4855. - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
  4856. - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
  4857. - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
  4858. .. rst-class:: classref-item-separator
  4859. ----
  4860. .. _class_RenderingServer_method_multimesh_set_mesh:
  4861. .. rst-class:: classref-method
  4862. void **multimesh_set_mesh** **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)**
  4863. Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
  4864. .. rst-class:: classref-item-separator
  4865. ----
  4866. .. _class_RenderingServer_method_multimesh_set_visible_instances:
  4867. .. rst-class:: classref-method
  4868. void **multimesh_set_visible_instances** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)**
  4869. 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>`.
  4870. .. rst-class:: classref-item-separator
  4871. ----
  4872. .. _class_RenderingServer_method_occluder_create:
  4873. .. rst-class:: classref-method
  4874. :ref:`RID<class_RID>` **occluder_create** **(** **)**
  4875. 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.
  4876. 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.
  4877. \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
  4878. .. rst-class:: classref-item-separator
  4879. ----
  4880. .. _class_RenderingServer_method_occluder_set_mesh:
  4881. .. rst-class:: classref-method
  4882. void **occluder_set_mesh** **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
  4883. Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
  4884. .. rst-class:: classref-item-separator
  4885. ----
  4886. .. _class_RenderingServer_method_omni_light_create:
  4887. .. rst-class:: classref-method
  4888. :ref:`RID<class_RID>` **omni_light_create** **(** **)**
  4889. 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.
  4890. 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.
  4891. 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.
  4892. \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
  4893. .. rst-class:: classref-item-separator
  4894. ----
  4895. .. _class_RenderingServer_method_particles_collision_create:
  4896. .. rst-class:: classref-method
  4897. :ref:`RID<class_RID>` **particles_collision_create** **(** **)**
  4898. 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.
  4899. \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
  4900. .. rst-class:: classref-item-separator
  4901. ----
  4902. .. _class_RenderingServer_method_particles_collision_height_field_update:
  4903. .. rst-class:: classref-method
  4904. void **particles_collision_height_field_update** **(** :ref:`RID<class_RID>` particles_collision **)**
  4905. 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>`.
  4906. .. rst-class:: classref-item-separator
  4907. ----
  4908. .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
  4909. .. rst-class:: classref-method
  4910. void **particles_collision_set_attractor_attenuation** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)**
  4911. 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>`.
  4912. .. rst-class:: classref-item-separator
  4913. ----
  4914. .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
  4915. .. rst-class:: classref-method
  4916. void **particles_collision_set_attractor_directionality** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)**
  4917. 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>`.
  4918. .. rst-class:: classref-item-separator
  4919. ----
  4920. .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
  4921. .. rst-class:: classref-method
  4922. void **particles_collision_set_attractor_strength** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` strength **)**
  4923. 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>`.
  4924. .. rst-class:: classref-item-separator
  4925. ----
  4926. .. _class_RenderingServer_method_particles_collision_set_box_extents:
  4927. .. rst-class:: classref-method
  4928. void **particles_collision_set_box_extents** **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)**
  4929. 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.
  4930. .. rst-class:: classref-item-separator
  4931. ----
  4932. .. _class_RenderingServer_method_particles_collision_set_collision_type:
  4933. .. rst-class:: classref-method
  4934. void **particles_collision_set_collision_type** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)**
  4935. Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
  4936. .. rst-class:: classref-item-separator
  4937. ----
  4938. .. _class_RenderingServer_method_particles_collision_set_cull_mask:
  4939. .. rst-class:: classref-method
  4940. void **particles_collision_set_cull_mask** **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)**
  4941. 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.
  4942. .. rst-class:: classref-item-separator
  4943. ----
  4944. .. _class_RenderingServer_method_particles_collision_set_field_texture:
  4945. .. rst-class:: classref-method
  4946. void **particles_collision_set_field_texture** **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)**
  4947. 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.
  4948. .. rst-class:: classref-item-separator
  4949. ----
  4950. .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
  4951. .. rst-class:: classref-method
  4952. void **particles_collision_set_height_field_resolution** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)**
  4953. 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>`.
  4954. .. rst-class:: classref-item-separator
  4955. ----
  4956. .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
  4957. .. rst-class:: classref-method
  4958. void **particles_collision_set_sphere_radius** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)**
  4959. 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.
  4960. .. rst-class:: classref-item-separator
  4961. ----
  4962. .. _class_RenderingServer_method_particles_create:
  4963. .. rst-class:: classref-method
  4964. :ref:`RID<class_RID>` **particles_create** **(** **)**
  4965. 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.
  4966. 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.
  4967. 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.
  4968. \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
  4969. \ **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).
  4970. .. rst-class:: classref-item-separator
  4971. ----
  4972. .. _class_RenderingServer_method_particles_emit:
  4973. .. rst-class:: classref-method
  4974. void **particles_emit** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)**
  4975. Manually emits particles from the ``particles`` instance.
  4976. .. rst-class:: classref-item-separator
  4977. ----
  4978. .. _class_RenderingServer_method_particles_get_current_aabb:
  4979. .. rst-class:: classref-method
  4980. :ref:`AABB<class_AABB>` **particles_get_current_aabb** **(** :ref:`RID<class_RID>` particles **)**
  4981. Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
  4982. .. rst-class:: classref-item-separator
  4983. ----
  4984. .. _class_RenderingServer_method_particles_get_emitting:
  4985. .. rst-class:: classref-method
  4986. :ref:`bool<class_bool>` **particles_get_emitting** **(** :ref:`RID<class_RID>` particles **)**
  4987. Returns ``true`` if particles are currently set to emitting.
  4988. .. rst-class:: classref-item-separator
  4989. ----
  4990. .. _class_RenderingServer_method_particles_is_inactive:
  4991. .. rst-class:: classref-method
  4992. :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
  4993. Returns ``true`` if particles are not emitting and particles are set to inactive.
  4994. .. rst-class:: classref-item-separator
  4995. ----
  4996. .. _class_RenderingServer_method_particles_request_process:
  4997. .. rst-class:: classref-method
  4998. void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
  4999. 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>`.
  5000. .. rst-class:: classref-item-separator
  5001. ----
  5002. .. _class_RenderingServer_method_particles_restart:
  5003. .. rst-class:: classref-method
  5004. void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
  5005. Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
  5006. .. rst-class:: classref-item-separator
  5007. ----
  5008. .. _class_RenderingServer_method_particles_set_amount:
  5009. .. rst-class:: classref-method
  5010. void **particles_set_amount** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)**
  5011. Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
  5012. .. rst-class:: classref-item-separator
  5013. ----
  5014. .. _class_RenderingServer_method_particles_set_collision_base_size:
  5015. .. rst-class:: classref-method
  5016. void **particles_set_collision_base_size** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)**
  5017. .. container:: contribute
  5018. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5019. .. rst-class:: classref-item-separator
  5020. ----
  5021. .. _class_RenderingServer_method_particles_set_custom_aabb:
  5022. .. rst-class:: classref-method
  5023. void **particles_set_custom_aabb** **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)**
  5024. Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  5025. .. rst-class:: classref-item-separator
  5026. ----
  5027. .. _class_RenderingServer_method_particles_set_draw_order:
  5028. .. rst-class:: classref-method
  5029. void **particles_set_draw_order** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)**
  5030. 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>`.
  5031. .. rst-class:: classref-item-separator
  5032. ----
  5033. .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
  5034. .. rst-class:: classref-method
  5035. void **particles_set_draw_pass_mesh** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)**
  5036. 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>`.
  5037. .. rst-class:: classref-item-separator
  5038. ----
  5039. .. _class_RenderingServer_method_particles_set_draw_passes:
  5040. .. rst-class:: classref-method
  5041. void **particles_set_draw_passes** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)**
  5042. Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
  5043. .. rst-class:: classref-item-separator
  5044. ----
  5045. .. _class_RenderingServer_method_particles_set_emission_transform:
  5046. .. rst-class:: classref-method
  5047. void **particles_set_emission_transform** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)**
  5048. Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
  5049. .. rst-class:: classref-item-separator
  5050. ----
  5051. .. _class_RenderingServer_method_particles_set_emitting:
  5052. .. rst-class:: classref-method
  5053. void **particles_set_emitting** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)**
  5054. 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>`.
  5055. .. rst-class:: classref-item-separator
  5056. ----
  5057. .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
  5058. .. rst-class:: classref-method
  5059. void **particles_set_explosiveness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
  5060. Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
  5061. .. rst-class:: classref-item-separator
  5062. ----
  5063. .. _class_RenderingServer_method_particles_set_fixed_fps:
  5064. .. rst-class:: classref-method
  5065. void **particles_set_fixed_fps** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)**
  5066. Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
  5067. .. rst-class:: classref-item-separator
  5068. ----
  5069. .. _class_RenderingServer_method_particles_set_fractional_delta:
  5070. .. rst-class:: classref-method
  5071. void **particles_set_fractional_delta** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5072. If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
  5073. .. rst-class:: classref-item-separator
  5074. ----
  5075. .. _class_RenderingServer_method_particles_set_interpolate:
  5076. .. rst-class:: classref-method
  5077. void **particles_set_interpolate** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5078. .. container:: contribute
  5079. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5080. .. rst-class:: classref-item-separator
  5081. ----
  5082. .. _class_RenderingServer_method_particles_set_lifetime:
  5083. .. rst-class:: classref-method
  5084. void **particles_set_lifetime** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)**
  5085. Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
  5086. .. rst-class:: classref-item-separator
  5087. ----
  5088. .. _class_RenderingServer_method_particles_set_mode:
  5089. .. rst-class:: classref-method
  5090. void **particles_set_mode** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)**
  5091. Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
  5092. .. rst-class:: classref-item-separator
  5093. ----
  5094. .. _class_RenderingServer_method_particles_set_one_shot:
  5095. .. rst-class:: classref-method
  5096. void **particles_set_one_shot** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)**
  5097. If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
  5098. .. rst-class:: classref-item-separator
  5099. ----
  5100. .. _class_RenderingServer_method_particles_set_pre_process_time:
  5101. .. rst-class:: classref-method
  5102. void **particles_set_pre_process_time** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)**
  5103. 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>`.
  5104. .. rst-class:: classref-item-separator
  5105. ----
  5106. .. _class_RenderingServer_method_particles_set_process_material:
  5107. .. rst-class:: classref-method
  5108. void **particles_set_process_material** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)**
  5109. Sets the material for processing the particles.
  5110. \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
  5111. .. rst-class:: classref-item-separator
  5112. ----
  5113. .. _class_RenderingServer_method_particles_set_randomness_ratio:
  5114. .. rst-class:: classref-method
  5115. void **particles_set_randomness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
  5116. Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
  5117. .. rst-class:: classref-item-separator
  5118. ----
  5119. .. _class_RenderingServer_method_particles_set_speed_scale:
  5120. .. rst-class:: classref-method
  5121. void **particles_set_speed_scale** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)**
  5122. Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
  5123. .. rst-class:: classref-item-separator
  5124. ----
  5125. .. _class_RenderingServer_method_particles_set_subemitter:
  5126. .. rst-class:: classref-method
  5127. void **particles_set_subemitter** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)**
  5128. .. container:: contribute
  5129. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5130. .. rst-class:: classref-item-separator
  5131. ----
  5132. .. _class_RenderingServer_method_particles_set_trail_bind_poses:
  5133. .. rst-class:: classref-method
  5134. void **particles_set_trail_bind_poses** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)**
  5135. .. container:: contribute
  5136. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5137. .. rst-class:: classref-item-separator
  5138. ----
  5139. .. _class_RenderingServer_method_particles_set_trails:
  5140. .. rst-class:: classref-method
  5141. void **particles_set_trails** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)**
  5142. 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>`.
  5143. .. rst-class:: classref-item-separator
  5144. ----
  5145. .. _class_RenderingServer_method_particles_set_transform_align:
  5146. .. rst-class:: classref-method
  5147. void **particles_set_transform_align** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)**
  5148. .. container:: contribute
  5149. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5150. .. rst-class:: classref-item-separator
  5151. ----
  5152. .. _class_RenderingServer_method_particles_set_use_local_coordinates:
  5153. .. rst-class:: classref-method
  5154. void **particles_set_use_local_coordinates** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5155. If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
  5156. .. rst-class:: classref-item-separator
  5157. ----
  5158. .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
  5159. .. rst-class:: classref-method
  5160. void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
  5161. 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.
  5162. .. rst-class:: classref-item-separator
  5163. ----
  5164. .. _class_RenderingServer_method_reflection_probe_create:
  5165. .. rst-class:: classref-method
  5166. :ref:`RID<class_RID>` **reflection_probe_create** **(** **)**
  5167. 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.
  5168. 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.
  5169. 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.
  5170. \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
  5171. .. rst-class:: classref-item-separator
  5172. ----
  5173. .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
  5174. .. rst-class:: classref-method
  5175. void **reflection_probe_set_ambient_color** **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)**
  5176. Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
  5177. .. rst-class:: classref-item-separator
  5178. ----
  5179. .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
  5180. .. rst-class:: classref-method
  5181. void **reflection_probe_set_ambient_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
  5182. Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
  5183. .. rst-class:: classref-item-separator
  5184. ----
  5185. .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
  5186. .. rst-class:: classref-method
  5187. void **reflection_probe_set_ambient_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)**
  5188. Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
  5189. .. rst-class:: classref-item-separator
  5190. ----
  5191. .. _class_RenderingServer_method_reflection_probe_set_as_interior:
  5192. .. rst-class:: classref-method
  5193. void **reflection_probe_set_as_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5194. If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
  5195. .. rst-class:: classref-item-separator
  5196. ----
  5197. .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
  5198. .. rst-class:: classref-method
  5199. void **reflection_probe_set_cull_mask** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)**
  5200. Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
  5201. .. rst-class:: classref-item-separator
  5202. ----
  5203. .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
  5204. .. rst-class:: classref-method
  5205. void **reflection_probe_set_enable_box_projection** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5206. 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>`.
  5207. .. rst-class:: classref-item-separator
  5208. ----
  5209. .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
  5210. .. rst-class:: classref-method
  5211. void **reflection_probe_set_enable_shadows** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5212. 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>`.
  5213. .. rst-class:: classref-item-separator
  5214. ----
  5215. .. _class_RenderingServer_method_reflection_probe_set_intensity:
  5216. .. rst-class:: classref-method
  5217. void **reflection_probe_set_intensity** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)**
  5218. Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
  5219. .. rst-class:: classref-item-separator
  5220. ----
  5221. .. _class_RenderingServer_method_reflection_probe_set_max_distance:
  5222. .. rst-class:: classref-method
  5223. void **reflection_probe_set_max_distance** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)**
  5224. 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>`.
  5225. .. rst-class:: classref-item-separator
  5226. ----
  5227. .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
  5228. .. rst-class:: classref-method
  5229. void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)**
  5230. 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>`.
  5231. .. rst-class:: classref-item-separator
  5232. ----
  5233. .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
  5234. .. rst-class:: classref-method
  5235. void **reflection_probe_set_origin_offset** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)**
  5236. 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>`.
  5237. .. rst-class:: classref-item-separator
  5238. ----
  5239. .. _class_RenderingServer_method_reflection_probe_set_resolution:
  5240. .. rst-class:: classref-method
  5241. void **reflection_probe_set_resolution** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)**
  5242. 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).
  5243. .. rst-class:: classref-item-separator
  5244. ----
  5245. .. _class_RenderingServer_method_reflection_probe_set_size:
  5246. .. rst-class:: classref-method
  5247. void **reflection_probe_set_size** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)**
  5248. Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
  5249. .. rst-class:: classref-item-separator
  5250. ----
  5251. .. _class_RenderingServer_method_reflection_probe_set_update_mode:
  5252. .. rst-class:: classref-method
  5253. void **reflection_probe_set_update_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)**
  5254. Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
  5255. .. rst-class:: classref-item-separator
  5256. ----
  5257. .. _class_RenderingServer_method_request_frame_drawn_callback:
  5258. .. rst-class:: classref-method
  5259. void **request_frame_drawn_callback** **(** :ref:`Callable<class_Callable>` callable **)**
  5260. Schedules a callback to the given callable after a frame has been drawn.
  5261. .. rst-class:: classref-item-separator
  5262. ----
  5263. .. _class_RenderingServer_method_scenario_create:
  5264. .. rst-class:: classref-method
  5265. :ref:`RID<class_RID>` **scenario_create** **(** **)**
  5266. 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.
  5267. 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.
  5268. The scenario is the 3D world that all the visual instances exist in.
  5269. .. rst-class:: classref-item-separator
  5270. ----
  5271. .. _class_RenderingServer_method_scenario_set_camera_attributes:
  5272. .. rst-class:: classref-method
  5273. void **scenario_set_camera_attributes** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)**
  5274. Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
  5275. .. rst-class:: classref-item-separator
  5276. ----
  5277. .. _class_RenderingServer_method_scenario_set_environment:
  5278. .. rst-class:: classref-method
  5279. void **scenario_set_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
  5280. Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
  5281. .. rst-class:: classref-item-separator
  5282. ----
  5283. .. _class_RenderingServer_method_scenario_set_fallback_environment:
  5284. .. rst-class:: classref-method
  5285. void **scenario_set_fallback_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
  5286. 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.
  5287. .. rst-class:: classref-item-separator
  5288. ----
  5289. .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
  5290. .. rst-class:: classref-method
  5291. void **screen_space_roughness_limiter_set_active** **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)**
  5292. 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>`.
  5293. .. rst-class:: classref-item-separator
  5294. ----
  5295. .. _class_RenderingServer_method_set_boot_image:
  5296. .. rst-class:: classref-method
  5297. void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)**
  5298. 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.
  5299. .. rst-class:: classref-item-separator
  5300. ----
  5301. .. _class_RenderingServer_method_set_debug_generate_wireframes:
  5302. .. rst-class:: classref-method
  5303. void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
  5304. This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``.
  5305. .. rst-class:: classref-item-separator
  5306. ----
  5307. .. _class_RenderingServer_method_set_default_clear_color:
  5308. .. rst-class:: classref-method
  5309. void **set_default_clear_color** **(** :ref:`Color<class_Color>` color **)**
  5310. 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>`.
  5311. .. rst-class:: classref-item-separator
  5312. ----
  5313. .. _class_RenderingServer_method_shader_create:
  5314. .. rst-class:: classref-method
  5315. :ref:`RID<class_RID>` **shader_create** **(** **)**
  5316. 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.
  5317. 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.
  5318. \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
  5319. .. rst-class:: classref-item-separator
  5320. ----
  5321. .. _class_RenderingServer_method_shader_get_code:
  5322. .. rst-class:: classref-method
  5323. :ref:`String<class_String>` **shader_get_code** **(** :ref:`RID<class_RID>` shader **)** |const|
  5324. Returns a shader's source code as a string.
  5325. .. rst-class:: classref-item-separator
  5326. ----
  5327. .. _class_RenderingServer_method_shader_get_default_texture_parameter:
  5328. .. rst-class:: classref-method
  5329. :ref:`RID<class_RID>` **shader_get_default_texture_parameter** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` index=0 **)** |const|
  5330. Returns a default texture from a shader searched by name.
  5331. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5332. .. rst-class:: classref-item-separator
  5333. ----
  5334. .. _class_RenderingServer_method_shader_get_parameter_default:
  5335. .. rst-class:: classref-method
  5336. :ref:`Variant<class_Variant>` **shader_get_parameter_default** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name **)** |const|
  5337. Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
  5338. .. rst-class:: classref-item-separator
  5339. ----
  5340. .. _class_RenderingServer_method_shader_set_code:
  5341. .. rst-class:: classref-method
  5342. void **shader_set_code** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)**
  5343. Sets the shader's source code (which triggers recompilation after being changed).
  5344. .. rst-class:: classref-item-separator
  5345. ----
  5346. .. _class_RenderingServer_method_shader_set_default_texture_parameter:
  5347. .. rst-class:: classref-method
  5348. void **shader_set_default_texture_parameter** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)**
  5349. Sets a shader's default texture. Overwrites the texture given by name.
  5350. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5351. .. rst-class:: classref-item-separator
  5352. ----
  5353. .. _class_RenderingServer_method_shader_set_path_hint:
  5354. .. rst-class:: classref-method
  5355. void **shader_set_path_hint** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)**
  5356. 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>`.
  5357. .. rst-class:: classref-item-separator
  5358. ----
  5359. .. _class_RenderingServer_method_skeleton_allocate_data:
  5360. .. rst-class:: classref-method
  5361. void **skeleton_allocate_data** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)**
  5362. .. container:: contribute
  5363. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5364. .. rst-class:: classref-item-separator
  5365. ----
  5366. .. _class_RenderingServer_method_skeleton_bone_get_transform:
  5367. .. rst-class:: classref-method
  5368. :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
  5369. Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
  5370. .. rst-class:: classref-item-separator
  5371. ----
  5372. .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
  5373. .. rst-class:: classref-method
  5374. :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
  5375. Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
  5376. .. rst-class:: classref-item-separator
  5377. ----
  5378. .. _class_RenderingServer_method_skeleton_bone_set_transform:
  5379. .. rst-class:: classref-method
  5380. void **skeleton_bone_set_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)**
  5381. Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
  5382. .. rst-class:: classref-item-separator
  5383. ----
  5384. .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
  5385. .. rst-class:: classref-method
  5386. void **skeleton_bone_set_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)**
  5387. Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
  5388. .. rst-class:: classref-item-separator
  5389. ----
  5390. .. _class_RenderingServer_method_skeleton_create:
  5391. .. rst-class:: classref-method
  5392. :ref:`RID<class_RID>` **skeleton_create** **(** **)**
  5393. 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.
  5394. 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.
  5395. .. rst-class:: classref-item-separator
  5396. ----
  5397. .. _class_RenderingServer_method_skeleton_get_bone_count:
  5398. .. rst-class:: classref-method
  5399. :ref:`int<class_int>` **skeleton_get_bone_count** **(** :ref:`RID<class_RID>` skeleton **)** |const|
  5400. Returns the number of bones allocated for this skeleton.
  5401. .. rst-class:: classref-item-separator
  5402. ----
  5403. .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
  5404. .. rst-class:: classref-method
  5405. void **skeleton_set_base_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)**
  5406. .. container:: contribute
  5407. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5408. .. rst-class:: classref-item-separator
  5409. ----
  5410. .. _class_RenderingServer_method_sky_bake_panorama:
  5411. .. rst-class:: classref-method
  5412. :ref:`Image<class_Image>` **sky_bake_panorama** **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
  5413. 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>`.
  5414. \ **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.
  5415. \ **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.
  5416. .. rst-class:: classref-item-separator
  5417. ----
  5418. .. _class_RenderingServer_method_sky_create:
  5419. .. rst-class:: classref-method
  5420. :ref:`RID<class_RID>` **sky_create** **(** **)**
  5421. 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.
  5422. 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.
  5423. .. rst-class:: classref-item-separator
  5424. ----
  5425. .. _class_RenderingServer_method_sky_set_material:
  5426. .. rst-class:: classref-method
  5427. void **sky_set_material** **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)**
  5428. Sets the material that the sky uses to render the background, ambient and reflection maps.
  5429. .. rst-class:: classref-item-separator
  5430. ----
  5431. .. _class_RenderingServer_method_sky_set_mode:
  5432. .. rst-class:: classref-method
  5433. void **sky_set_mode** **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)**
  5434. Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
  5435. .. rst-class:: classref-item-separator
  5436. ----
  5437. .. _class_RenderingServer_method_sky_set_radiance_size:
  5438. .. rst-class:: classref-method
  5439. void **sky_set_radiance_size** **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)**
  5440. 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>`.
  5441. .. rst-class:: classref-item-separator
  5442. ----
  5443. .. _class_RenderingServer_method_spot_light_create:
  5444. .. rst-class:: classref-method
  5445. :ref:`RID<class_RID>` **spot_light_create** **(** **)**
  5446. 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.
  5447. 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.
  5448. 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.
  5449. .. rst-class:: classref-item-separator
  5450. ----
  5451. .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
  5452. .. rst-class:: classref-method
  5453. void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)**
  5454. 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.
  5455. .. rst-class:: classref-item-separator
  5456. ----
  5457. .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
  5458. .. rst-class:: classref-method
  5459. void **sub_surface_scattering_set_scale** **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)**
  5460. 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.
  5461. .. rst-class:: classref-item-separator
  5462. ----
  5463. .. _class_RenderingServer_method_texture_2d_create:
  5464. .. rst-class:: classref-method
  5465. :ref:`RID<class_RID>` **texture_2d_create** **(** :ref:`Image<class_Image>` image **)**
  5466. 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.
  5467. 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.
  5468. \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
  5469. \ **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.
  5470. .. rst-class:: classref-item-separator
  5471. ----
  5472. .. _class_RenderingServer_method_texture_2d_get:
  5473. .. rst-class:: classref-method
  5474. :ref:`Image<class_Image>` **texture_2d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
  5475. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
  5476. Example of getting the test texture from :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  5477. ::
  5478. var texture_rid = RenderingServer.get_test_texture()
  5479. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  5480. $Sprite2D.texture = texture
  5481. .. rst-class:: classref-item-separator
  5482. ----
  5483. .. _class_RenderingServer_method_texture_2d_layer_get:
  5484. .. rst-class:: classref-method
  5485. :ref:`Image<class_Image>` **texture_2d_layer_get** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const|
  5486. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
  5487. .. rst-class:: classref-item-separator
  5488. ----
  5489. .. _class_RenderingServer_method_texture_2d_layered_create:
  5490. .. rst-class:: classref-method
  5491. :ref:`RID<class_RID>` **texture_2d_layered_create** **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
  5492. 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.
  5493. 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.
  5494. \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
  5495. .. rst-class:: classref-item-separator
  5496. ----
  5497. .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
  5498. .. rst-class:: classref-method
  5499. :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
  5500. 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>`.
  5501. \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
  5502. .. rst-class:: classref-item-separator
  5503. ----
  5504. .. _class_RenderingServer_method_texture_2d_placeholder_create:
  5505. .. rst-class:: classref-method
  5506. :ref:`RID<class_RID>` **texture_2d_placeholder_create** **(** **)**
  5507. 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>`\
  5508. 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.
  5509. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
  5510. .. rst-class:: classref-item-separator
  5511. ----
  5512. .. _class_RenderingServer_method_texture_2d_update:
  5513. .. rst-class:: classref-method
  5514. void **texture_2d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**
  5515. 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>`).
  5516. \ **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.
  5517. .. rst-class:: classref-item-separator
  5518. ----
  5519. .. _class_RenderingServer_method_texture_3d_create:
  5520. .. rst-class:: classref-method
  5521. :ref:`RID<class_RID>` **texture_3d_create** **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)**
  5522. **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
  5523. .. rst-class:: classref-item-separator
  5524. ----
  5525. .. _class_RenderingServer_method_texture_3d_get:
  5526. .. rst-class:: classref-method
  5527. :ref:`Image[]<class_Image>` **texture_3d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
  5528. Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
  5529. .. rst-class:: classref-item-separator
  5530. ----
  5531. .. _class_RenderingServer_method_texture_3d_placeholder_create:
  5532. .. rst-class:: classref-method
  5533. :ref:`RID<class_RID>` **texture_3d_placeholder_create** **(** **)**
  5534. 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.
  5535. 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.
  5536. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
  5537. .. rst-class:: classref-item-separator
  5538. ----
  5539. .. _class_RenderingServer_method_texture_3d_update:
  5540. .. rst-class:: classref-method
  5541. void **texture_3d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)**
  5542. 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.
  5543. \ **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.
  5544. .. rst-class:: classref-item-separator
  5545. ----
  5546. .. _class_RenderingServer_method_texture_get_native_handle:
  5547. .. rst-class:: classref-method
  5548. :ref:`int<class_int>` **texture_get_native_handle** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
  5549. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  5550. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  5551. .. rst-class:: classref-item-separator
  5552. ----
  5553. .. _class_RenderingServer_method_texture_get_path:
  5554. .. rst-class:: classref-method
  5555. :ref:`String<class_String>` **texture_get_path** **(** :ref:`RID<class_RID>` texture **)** |const|
  5556. .. container:: contribute
  5557. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5558. .. rst-class:: classref-item-separator
  5559. ----
  5560. .. _class_RenderingServer_method_texture_get_rd_texture:
  5561. .. rst-class:: classref-method
  5562. :ref:`RID<class_RID>` **texture_get_rd_texture** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
  5563. Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
  5564. .. rst-class:: classref-item-separator
  5565. ----
  5566. .. _class_RenderingServer_method_texture_proxy_create:
  5567. .. rst-class:: classref-method
  5568. :ref:`RID<class_RID>` **texture_proxy_create** **(** :ref:`RID<class_RID>` base **)**
  5569. *Deprecated.* ProxyTexture was removed in Godot 4, so this method does nothing when called and always returns a null :ref:`RID<class_RID>`.
  5570. .. rst-class:: classref-item-separator
  5571. ----
  5572. .. _class_RenderingServer_method_texture_proxy_update:
  5573. .. rst-class:: classref-method
  5574. void **texture_proxy_update** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)**
  5575. *Deprecated.* ProxyTexture was removed in Godot 4, so this method cannot be used anymore.
  5576. .. rst-class:: classref-item-separator
  5577. ----
  5578. .. _class_RenderingServer_method_texture_replace:
  5579. .. rst-class:: classref-method
  5580. void **texture_replace** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)**
  5581. Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
  5582. .. rst-class:: classref-item-separator
  5583. ----
  5584. .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
  5585. .. rst-class:: classref-method
  5586. void **texture_set_force_redraw_if_visible** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)**
  5587. .. container:: contribute
  5588. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5589. .. rst-class:: classref-item-separator
  5590. ----
  5591. .. _class_RenderingServer_method_texture_set_path:
  5592. .. rst-class:: classref-method
  5593. void **texture_set_path** **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)**
  5594. .. container:: contribute
  5595. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5596. .. rst-class:: classref-item-separator
  5597. ----
  5598. .. _class_RenderingServer_method_texture_set_size_override:
  5599. .. rst-class:: classref-method
  5600. void **texture_set_size_override** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  5601. .. container:: contribute
  5602. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5603. .. rst-class:: classref-item-separator
  5604. ----
  5605. .. _class_RenderingServer_method_viewport_attach_camera:
  5606. .. rst-class:: classref-method
  5607. void **viewport_attach_camera** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)**
  5608. Sets a viewport's camera.
  5609. .. rst-class:: classref-item-separator
  5610. ----
  5611. .. _class_RenderingServer_method_viewport_attach_canvas:
  5612. .. rst-class:: classref-method
  5613. void **viewport_attach_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
  5614. Sets a viewport's canvas.
  5615. .. rst-class:: classref-item-separator
  5616. ----
  5617. .. _class_RenderingServer_method_viewport_attach_to_screen:
  5618. .. rst-class:: classref-method
  5619. void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)**
  5620. 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.
  5621. For example, you can set the root viewport to not render at all with the following code:
  5622. FIXME: The method seems to be non-existent.
  5623. .. tabs::
  5624. .. code-tab:: gdscript
  5625. func _ready():
  5626. get_viewport().set_attach_to_screen_rect(Rect2())
  5627. $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
  5628. 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>`.
  5629. .. rst-class:: classref-item-separator
  5630. ----
  5631. .. _class_RenderingServer_method_viewport_create:
  5632. .. rst-class:: classref-method
  5633. :ref:`RID<class_RID>` **viewport_create** **(** **)**
  5634. 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.
  5635. 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.
  5636. \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
  5637. .. rst-class:: classref-item-separator
  5638. ----
  5639. .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
  5640. .. rst-class:: classref-method
  5641. :ref:`float<class_float>` **viewport_get_measured_render_time_cpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5642. 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>`.
  5643. \ **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``.
  5644. .. rst-class:: classref-item-separator
  5645. ----
  5646. .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
  5647. .. rst-class:: classref-method
  5648. :ref:`float<class_float>` **viewport_get_measured_render_time_gpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5649. 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_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`.
  5650. \ **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``.
  5651. \ **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.
  5652. .. rst-class:: classref-item-separator
  5653. ----
  5654. .. _class_RenderingServer_method_viewport_get_render_info:
  5655. .. rst-class:: classref-method
  5656. :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)**
  5657. 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.
  5658. See also :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
  5659. \ **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:
  5660. ::
  5661. func _ready():
  5662. for _i in 2:
  5663. await get_tree().process_frame
  5664. print(
  5665. RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
  5666. RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  5667. RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
  5668. )
  5669. .. rst-class:: classref-item-separator
  5670. ----
  5671. .. _class_RenderingServer_method_viewport_get_render_target:
  5672. .. rst-class:: classref-method
  5673. :ref:`RID<class_RID>` **viewport_get_render_target** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5674. Returns the render target for the viewport.
  5675. .. rst-class:: classref-item-separator
  5676. ----
  5677. .. _class_RenderingServer_method_viewport_get_texture:
  5678. .. rst-class:: classref-method
  5679. :ref:`RID<class_RID>` **viewport_get_texture** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5680. Returns the viewport's last rendered frame.
  5681. .. rst-class:: classref-item-separator
  5682. ----
  5683. .. _class_RenderingServer_method_viewport_remove_canvas:
  5684. .. rst-class:: classref-method
  5685. void **viewport_remove_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
  5686. Detaches a viewport from a canvas and vice versa.
  5687. .. rst-class:: classref-item-separator
  5688. ----
  5689. .. _class_RenderingServer_method_viewport_set_active:
  5690. .. rst-class:: classref-method
  5691. void **viewport_set_active** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)**
  5692. If ``true``, sets the viewport active, else sets it inactive.
  5693. .. rst-class:: classref-item-separator
  5694. ----
  5695. .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
  5696. .. rst-class:: classref-method
  5697. void **viewport_set_canvas_cull_mask** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` canvas_cull_mask **)**
  5698. 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>`.
  5699. .. rst-class:: classref-item-separator
  5700. ----
  5701. .. _class_RenderingServer_method_viewport_set_canvas_stacking:
  5702. .. rst-class:: classref-method
  5703. void **viewport_set_canvas_stacking** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)**
  5704. Sets the stacking order for a viewport's canvas.
  5705. \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
  5706. .. rst-class:: classref-item-separator
  5707. ----
  5708. .. _class_RenderingServer_method_viewport_set_canvas_transform:
  5709. .. rst-class:: classref-method
  5710. void **viewport_set_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)**
  5711. Sets the transformation of a viewport's canvas.
  5712. .. rst-class:: classref-item-separator
  5713. ----
  5714. .. _class_RenderingServer_method_viewport_set_clear_mode:
  5715. .. rst-class:: classref-method
  5716. void **viewport_set_clear_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)**
  5717. Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
  5718. .. rst-class:: classref-item-separator
  5719. ----
  5720. .. _class_RenderingServer_method_viewport_set_debug_draw:
  5721. .. rst-class:: classref-method
  5722. void **viewport_set_debug_draw** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)**
  5723. Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
  5724. .. rst-class:: classref-item-separator
  5725. ----
  5726. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
  5727. .. rst-class:: classref-method
  5728. void **viewport_set_default_canvas_item_texture_filter** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  5729. Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` for options.
  5730. .. rst-class:: classref-item-separator
  5731. ----
  5732. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
  5733. .. rst-class:: classref-method
  5734. void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  5735. Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` for options.
  5736. .. rst-class:: classref-item-separator
  5737. ----
  5738. .. _class_RenderingServer_method_viewport_set_disable_2d:
  5739. .. rst-class:: classref-method
  5740. void **viewport_set_disable_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
  5741. If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
  5742. .. rst-class:: classref-item-separator
  5743. ----
  5744. .. _class_RenderingServer_method_viewport_set_disable_3d:
  5745. .. rst-class:: classref-method
  5746. void **viewport_set_disable_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
  5747. If ``true``, the viewport's 3D elements are not rendered.
  5748. .. rst-class:: classref-item-separator
  5749. ----
  5750. .. _class_RenderingServer_method_viewport_set_environment_mode:
  5751. .. rst-class:: classref-method
  5752. void **viewport_set_environment_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)**
  5753. 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>`.
  5754. .. rst-class:: classref-item-separator
  5755. ----
  5756. .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
  5757. .. rst-class:: classref-method
  5758. void **viewport_set_fsr_sharpness** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)**
  5759. 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.
  5760. .. rst-class:: classref-item-separator
  5761. ----
  5762. .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
  5763. .. rst-class:: classref-method
  5764. void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)**
  5765. Sets the viewport's global transformation matrix.
  5766. .. rst-class:: classref-item-separator
  5767. ----
  5768. .. _class_RenderingServer_method_viewport_set_measure_render_time:
  5769. .. rst-class:: classref-method
  5770. void **viewport_set_measure_render_time** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5771. 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``.
  5772. .. rst-class:: classref-item-separator
  5773. ----
  5774. .. _class_RenderingServer_method_viewport_set_msaa_2d:
  5775. .. rst-class:: classref-method
  5776. void **viewport_set_msaa_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
  5777. Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  5778. .. rst-class:: classref-item-separator
  5779. ----
  5780. .. _class_RenderingServer_method_viewport_set_msaa_3d:
  5781. .. rst-class:: classref-method
  5782. void **viewport_set_msaa_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
  5783. Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  5784. .. rst-class:: classref-item-separator
  5785. ----
  5786. .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
  5787. .. rst-class:: classref-method
  5788. void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)**
  5789. 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.
  5790. .. rst-class:: classref-item-separator
  5791. ----
  5792. .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
  5793. .. rst-class:: classref-method
  5794. void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int<class_int>` rays_per_thread **)**
  5795. 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.
  5796. .. rst-class:: classref-item-separator
  5797. ----
  5798. .. _class_RenderingServer_method_viewport_set_parent_viewport:
  5799. .. rst-class:: classref-method
  5800. void **viewport_set_parent_viewport** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)**
  5801. Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
  5802. .. rst-class:: classref-item-separator
  5803. ----
  5804. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
  5805. .. rst-class:: classref-method
  5806. void **viewport_set_positional_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
  5807. 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>`.
  5808. .. rst-class:: classref-item-separator
  5809. ----
  5810. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
  5811. .. rst-class:: classref-method
  5812. void **viewport_set_positional_shadow_atlas_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)**
  5813. 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.
  5814. \ **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).
  5815. .. rst-class:: classref-item-separator
  5816. ----
  5817. .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
  5818. .. rst-class:: classref-method
  5819. void **viewport_set_render_direct_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5820. 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.
  5821. .. rst-class:: classref-item-separator
  5822. ----
  5823. .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
  5824. .. rst-class:: classref-method
  5825. void **viewport_set_scaling_3d_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)**
  5826. 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.
  5827. .. rst-class:: classref-item-separator
  5828. ----
  5829. .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
  5830. .. rst-class:: classref-method
  5831. void **viewport_set_scaling_3d_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)**
  5832. 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.
  5833. 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.
  5834. .. rst-class:: classref-item-separator
  5835. ----
  5836. .. _class_RenderingServer_method_viewport_set_scenario:
  5837. .. rst-class:: classref-method
  5838. void **viewport_set_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)**
  5839. Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
  5840. .. rst-class:: classref-item-separator
  5841. ----
  5842. .. _class_RenderingServer_method_viewport_set_screen_space_aa:
  5843. .. rst-class:: classref-method
  5844. void **viewport_set_screen_space_aa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)**
  5845. Sets the viewport's screen-space antialiasing mode.
  5846. .. rst-class:: classref-item-separator
  5847. ----
  5848. .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
  5849. .. rst-class:: classref-method
  5850. void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)**
  5851. 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.
  5852. .. rst-class:: classref-item-separator
  5853. ----
  5854. .. _class_RenderingServer_method_viewport_set_size:
  5855. .. rst-class:: classref-method
  5856. void **viewport_set_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  5857. Sets the viewport's width and height in pixels.
  5858. .. rst-class:: classref-item-separator
  5859. ----
  5860. .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
  5861. .. rst-class:: classref-method
  5862. void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5863. 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>`.
  5864. .. rst-class:: classref-item-separator
  5865. ----
  5866. .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
  5867. .. rst-class:: classref-method
  5868. void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5869. 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>`.
  5870. .. rst-class:: classref-item-separator
  5871. ----
  5872. .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
  5873. .. rst-class:: classref-method
  5874. void **viewport_set_texture_mipmap_bias** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)**
  5875. 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.
  5876. \ **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``.
  5877. .. rst-class:: classref-item-separator
  5878. ----
  5879. .. _class_RenderingServer_method_viewport_set_transparent_background:
  5880. .. rst-class:: classref-method
  5881. void **viewport_set_transparent_background** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5882. If ``true``, the viewport renders its background as transparent.
  5883. .. rst-class:: classref-item-separator
  5884. ----
  5885. .. _class_RenderingServer_method_viewport_set_update_mode:
  5886. .. rst-class:: classref-method
  5887. void **viewport_set_update_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)**
  5888. Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  5889. .. rst-class:: classref-item-separator
  5890. ----
  5891. .. _class_RenderingServer_method_viewport_set_use_debanding:
  5892. .. rst-class:: classref-method
  5893. void **viewport_set_use_debanding** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5894. 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>`.
  5895. .. rst-class:: classref-item-separator
  5896. ----
  5897. .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
  5898. .. rst-class:: classref-method
  5899. void **viewport_set_use_occlusion_culling** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5900. 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>`.
  5901. .. rst-class:: classref-item-separator
  5902. ----
  5903. .. _class_RenderingServer_method_viewport_set_use_taa:
  5904. .. rst-class:: classref-method
  5905. void **viewport_set_use_taa** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5906. If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>`.
  5907. .. rst-class:: classref-item-separator
  5908. ----
  5909. .. _class_RenderingServer_method_viewport_set_use_xr:
  5910. .. rst-class:: classref-method
  5911. void **viewport_set_use_xr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)**
  5912. If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
  5913. .. rst-class:: classref-item-separator
  5914. ----
  5915. .. _class_RenderingServer_method_viewport_set_vrs_mode:
  5916. .. rst-class:: classref-method
  5917. void **viewport_set_vrs_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)**
  5918. 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>`.
  5919. .. rst-class:: classref-item-separator
  5920. ----
  5921. .. _class_RenderingServer_method_viewport_set_vrs_texture:
  5922. .. rst-class:: classref-method
  5923. void **viewport_set_vrs_texture** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)**
  5924. 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>`.
  5925. .. rst-class:: classref-item-separator
  5926. ----
  5927. .. _class_RenderingServer_method_visibility_notifier_create:
  5928. .. rst-class:: classref-method
  5929. :ref:`RID<class_RID>` **visibility_notifier_create** **(** **)**
  5930. 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.
  5931. 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.
  5932. 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.
  5933. \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
  5934. .. rst-class:: classref-item-separator
  5935. ----
  5936. .. _class_RenderingServer_method_visibility_notifier_set_aabb:
  5937. .. rst-class:: classref-method
  5938. void **visibility_notifier_set_aabb** **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)**
  5939. .. container:: contribute
  5940. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5941. .. rst-class:: classref-item-separator
  5942. ----
  5943. .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
  5944. .. rst-class:: classref-method
  5945. void **visibility_notifier_set_callbacks** **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
  5946. .. container:: contribute
  5947. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5948. .. rst-class:: classref-item-separator
  5949. ----
  5950. .. _class_RenderingServer_method_voxel_gi_allocate_data:
  5951. .. rst-class:: classref-method
  5952. void **voxel_gi_allocate_data** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)**
  5953. .. container:: contribute
  5954. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5955. .. rst-class:: classref-item-separator
  5956. ----
  5957. .. _class_RenderingServer_method_voxel_gi_create:
  5958. .. rst-class:: classref-method
  5959. :ref:`RID<class_RID>` **voxel_gi_create** **(** **)**
  5960. 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.
  5961. 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.
  5962. \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
  5963. .. rst-class:: classref-item-separator
  5964. ----
  5965. .. _class_RenderingServer_method_voxel_gi_get_data_cells:
  5966. .. rst-class:: classref-method
  5967. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  5968. .. container:: contribute
  5969. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5970. .. rst-class:: classref-item-separator
  5971. ----
  5972. .. _class_RenderingServer_method_voxel_gi_get_distance_field:
  5973. .. rst-class:: classref-method
  5974. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  5975. .. container:: contribute
  5976. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5977. .. rst-class:: classref-item-separator
  5978. ----
  5979. .. _class_RenderingServer_method_voxel_gi_get_level_counts:
  5980. .. rst-class:: classref-method
  5981. :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  5982. .. container:: contribute
  5983. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5984. .. rst-class:: classref-item-separator
  5985. ----
  5986. .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
  5987. .. rst-class:: classref-method
  5988. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  5989. .. container:: contribute
  5990. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5991. .. rst-class:: classref-item-separator
  5992. ----
  5993. .. _class_RenderingServer_method_voxel_gi_get_octree_size:
  5994. .. rst-class:: classref-method
  5995. :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  5996. .. container:: contribute
  5997. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5998. .. rst-class:: classref-item-separator
  5999. ----
  6000. .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
  6001. .. rst-class:: classref-method
  6002. :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6003. .. container:: contribute
  6004. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6005. .. rst-class:: classref-item-separator
  6006. ----
  6007. .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
  6008. .. rst-class:: classref-method
  6009. void **voxel_gi_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` baked_exposure **)**
  6010. 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>`.
  6011. .. rst-class:: classref-item-separator
  6012. ----
  6013. .. _class_RenderingServer_method_voxel_gi_set_bias:
  6014. .. rst-class:: classref-method
  6015. void **voxel_gi_set_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
  6016. Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6017. .. rst-class:: classref-item-separator
  6018. ----
  6019. .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
  6020. .. rst-class:: classref-method
  6021. void **voxel_gi_set_dynamic_range** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)**
  6022. Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6023. .. rst-class:: classref-item-separator
  6024. ----
  6025. .. _class_RenderingServer_method_voxel_gi_set_energy:
  6026. .. rst-class:: classref-method
  6027. void **voxel_gi_set_energy** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)**
  6028. Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6029. .. rst-class:: classref-item-separator
  6030. ----
  6031. .. _class_RenderingServer_method_voxel_gi_set_interior:
  6032. .. rst-class:: classref-method
  6033. void **voxel_gi_set_interior** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
  6034. Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6035. .. rst-class:: classref-item-separator
  6036. ----
  6037. .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
  6038. .. rst-class:: classref-method
  6039. void **voxel_gi_set_normal_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
  6040. Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6041. .. rst-class:: classref-item-separator
  6042. ----
  6043. .. _class_RenderingServer_method_voxel_gi_set_propagation:
  6044. .. rst-class:: classref-method
  6045. void **voxel_gi_set_propagation** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)**
  6046. Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6047. .. rst-class:: classref-item-separator
  6048. ----
  6049. .. _class_RenderingServer_method_voxel_gi_set_quality:
  6050. .. rst-class:: classref-method
  6051. void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)**
  6052. 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.
  6053. .. rst-class:: classref-item-separator
  6054. ----
  6055. .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
  6056. .. rst-class:: classref-method
  6057. void **voxel_gi_set_use_two_bounces** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
  6058. 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>`.
  6059. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  6060. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  6061. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  6062. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  6063. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  6064. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  6065. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`