class_renderingserver.rst 1.2 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147
  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.3/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/RenderingServer.xml.
  6. .. _class_RenderingServer:
  7. RenderingServer
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Server for anything visible.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. The rendering server is the API backend for everything visible. The whole scene system mounts on it to display. The rendering server is completely opaque: the internals are entirely implementation-specific and cannot be accessed.
  15. The rendering server can be used to bypass the scene/:ref:`Node<class_Node>` system entirely. This can improve performance in cases where the scene system is the bottleneck, but won't improve performance otherwise (for instance, if the GPU is already fully utilized).
  16. Resources are created using the ``*_create`` functions. These functions return :ref:`RID<class_RID>`\ s which are not references to the objects themselves, but opaque *pointers* towards these objects.
  17. All objects are drawn to a viewport. You can use the :ref:`Viewport<class_Viewport>` attached to the :ref:`SceneTree<class_SceneTree>` or you can create one yourself with :ref:`viewport_create<class_RenderingServer_method_viewport_create>`. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` or :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`.
  18. \ **Scenarios:** In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any :ref:`Node3D<class_Node3D>` node with :ref:`Node3D.get_world_3d<class_Node3D_method_get_world_3d>`. Otherwise, a scenario can be created with :ref:`scenario_create<class_RenderingServer_method_scenario_create>`.
  19. Similarly, in 2D, a canvas is needed to draw all canvas items.
  20. \ **3D:** In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`. The instance must also be attached to the scenario using :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` in order to be visible. RenderingServer methods that don't have a prefix are usually 3D-specific (but not always).
  21. \ **2D:** In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas. 2D-specific RenderingServer methods generally start with ``canvas_*``.
  22. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **RenderingServer** will return dummy values in this case.
  23. .. rst-class:: classref-introduction-group
  24. Tutorials
  25. ---------
  26. - :doc:`Optimization using Servers <../tutorials/performance/using_servers>`
  27. .. rst-class:: classref-reftable-group
  28. Properties
  29. ----------
  30. .. table::
  31. :widths: auto
  32. +-------------------------+--------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_RenderingServer_property_render_loop_enabled>` |
  34. +-------------------------+--------------------------------------------------------------------------------+
  35. .. rst-class:: classref-reftable-group
  36. Methods
  37. -------
  38. .. table::
  39. :widths: auto
  40. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`\ (\ base\: :ref:`RID<class_RID>`, material_overrides\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], image_size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  42. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`call_on_render_thread<class_RenderingServer_method_call_on_render_thread>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  44. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>`\ (\ ) |
  46. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | |void| | :ref:`camera_attributes_set_auto_exposure<class_RenderingServer_method_camera_attributes_set_auto_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, min_sensitivity\: :ref:`float<class_float>`, max_sensitivity\: :ref:`float<class_float>`, speed\: :ref:`float<class_float>`, scale\: :ref:`float<class_float>`\ ) |
  48. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | |void| | :ref:`camera_attributes_set_dof_blur<class_RenderingServer_method_camera_attributes_set_dof_blur>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, far_enable\: :ref:`bool<class_bool>`, far_distance\: :ref:`float<class_float>`, far_transition\: :ref:`float<class_float>`, near_enable\: :ref:`bool<class_bool>`, near_distance\: :ref:`float<class_float>`, near_transition\: :ref:`float<class_float>`, amount\: :ref:`float<class_float>`\ ) |
  50. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`camera_attributes_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>`\ (\ shape\: :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`\ ) |
  52. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`camera_attributes_set_dof_blur_quality<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>`\ (\ quality\: :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`, use_jitter\: :ref:`bool<class_bool>`\ ) |
  54. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, normalization\: :ref:`float<class_float>`\ ) |
  56. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>`\ (\ ) |
  58. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`camera_set_camera_attributes<class_RenderingServer_method_camera_set_camera_attributes>`\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  60. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`camera_set_compositor<class_RenderingServer_method_camera_set_compositor>`\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  62. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>`\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  64. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>`\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) |
  66. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, offset\: :ref:`Vector2<class_Vector2>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  68. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  70. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>`\ (\ camera\: :ref:`RID<class_RID>`, fovy_degrees\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  72. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>`\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  74. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>`\ (\ camera\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  76. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>`\ (\ ) |
  78. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`canvas_item_add_animation_slice<class_RenderingServer_method_canvas_item_add_animation_slice>`\ (\ item\: :ref:`RID<class_RID>`, animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) |
  80. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>`\ (\ item\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  82. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>`\ (\ item\: :ref:`RID<class_RID>`, ignore\: :ref:`bool<class_bool>`\ ) |
  84. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`canvas_item_add_lcd_texture_rect_region<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>`\ ) |
  86. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>`\ (\ item\: :ref:`RID<class_RID>`, from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  88. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  90. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline_size\: :ref:`int<class_int>` = 0, px_range\: :ref:`float<class_float>` = 1.0, scale\: :ref:`float<class_float>` = 1.0\ ) |
  92. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`canvas_item_add_multiline<class_RenderingServer_method_canvas_item_add_multiline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  94. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>` = RID()\ ) |
  96. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, source\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, topleft\: :ref:`Vector2<class_Vector2>`, bottomright\: :ref:`Vector2<class_Vector2>`, x_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, y_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, draw_center\: :ref:`bool<class_bool>` = true, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |
  98. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>`\ (\ item\: :ref:`RID<class_RID>`, particles\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  100. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | |void| | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  102. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | |void| | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  104. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | |void| | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`RID<class_RID>`\ ) |
  106. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | |void| | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  108. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | |void| | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  110. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | |void| | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, tile\: :ref:`bool<class_bool>` = false, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) |
  112. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | |void| | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) |
  114. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | |void| | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`\ (\ item\: :ref:`RID<class_RID>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), bones\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array<class_PackedFloat32Array>` = PackedFloat32Array(), texture\: :ref:`RID<class_RID>` = RID(), count\: :ref:`int<class_int>` = -1\ ) |
  116. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | |void| | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  118. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>`\ (\ ) |
  120. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | |void| | :ref:`canvas_item_reset_physics_interpolation<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  122. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | |void| | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>`\ (\ item\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>`, clear_margin\: :ref:`float<class_float>` = 5.0, fit_empty\: :ref:`bool<class_bool>` = false, fit_margin\: :ref:`float<class_float>` = 0.0, blur_mipmaps\: :ref:`bool<class_bool>` = false\ ) |
  124. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | |void| | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>`\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) |
  126. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | |void| | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>`\ ) |
  128. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | |void| | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>`\ (\ item\: :ref:`RID<class_RID>`, use_custom_rect\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) |
  130. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | |void| | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>`\ (\ item\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  132. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | |void| | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  134. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | |void| | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  136. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | |void| | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  138. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | |void| | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>`\ (\ item\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  140. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | |void| | :ref:`canvas_item_set_interpolated<class_RenderingServer_method_canvas_item_set_interpolated>`\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  142. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | |void| | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>`\ (\ item\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  144. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | |void| | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>`\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  146. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | |void| | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  148. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | |void| | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>`\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  150. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | |void| | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  152. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | |void| | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  154. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | |void| | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  156. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | |void| | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  158. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | |void| | :ref:`canvas_item_set_visibility_layer<class_RenderingServer_method_canvas_item_set_visibility_layer>`\ (\ item\: :ref:`RID<class_RID>`, visibility_layer\: :ref:`int<class_int>`\ ) |
  160. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | |void| | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>`\ (\ item\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, area\: :ref:`Rect2<class_Rect2>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) |
  162. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | |void| | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>`\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  164. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  166. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>`\ (\ item\: :ref:`RID<class_RID>`, z_index\: :ref:`int<class_int>`\ ) |
  168. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`canvas_item_transform_physics_interpolation<class_RenderingServer_method_canvas_item_transform_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  170. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>`\ (\ light\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  172. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>`\ (\ ) |
  174. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>`\ (\ occluder\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  176. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>`\ (\ ) |
  178. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`canvas_light_occluder_reset_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`\ ) |
  180. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>`\ (\ occluder\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  182. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |void| | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>`\ (\ occluder\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  184. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`canvas_light_occluder_set_interpolated<class_RenderingServer_method_canvas_light_occluder_set_interpolated>`\ (\ occluder\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  186. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>`\ (\ occluder\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  188. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>`\ (\ occluder\: :ref:`RID<class_RID>`, polygon\: :ref:`RID<class_RID>`\ ) |
  190. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  192. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`canvas_light_occluder_transform_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  194. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`canvas_light_reset_physics_interpolation<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`\ ) |
  196. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`canvas_light_set_blend_mode<class_RenderingServer_method_canvas_light_set_blend_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>`\ ) |
  198. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  200. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  202. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |void| | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>`\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  204. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |void| | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>`\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) |
  206. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`canvas_light_set_interpolated<class_RenderingServer_method_canvas_light_set_interpolated>`\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  208. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  210. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  212. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>`\ (\ light\: :ref:`RID<class_RID>`, min_layer\: :ref:`int<class_int>`, max_layer\: :ref:`int<class_int>`\ ) |
  214. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) |
  216. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  218. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |void| | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  220. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>`\ (\ light\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>`\ ) |
  222. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>`\ (\ light\: :ref:`RID<class_RID>`, smooth\: :ref:`float<class_float>`\ ) |
  224. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  226. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>`\ (\ light\: :ref:`RID<class_RID>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
  228. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>`\ (\ light\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  230. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  232. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>`\ (\ light\: :ref:`RID<class_RID>`, min_z\: :ref:`int<class_int>`, max_z\: :ref:`int<class_int>`\ ) |
  234. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`canvas_light_transform_physics_interpolation<class_RenderingServer_method_canvas_light_transform_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  236. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>`\ (\ ) |
  238. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |void| | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>`\ ) |
  240. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, shape\: :ref:`PackedVector2Array<class_PackedVector2Array>`, closed\: :ref:`bool<class_bool>`\ ) |
  242. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>`\ (\ disable\: :ref:`bool<class_bool>`\ ) |
  244. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>`\ (\ canvas\: :ref:`RID<class_RID>`, item\: :ref:`RID<class_RID>`, mirroring\: :ref:`Vector2<class_Vector2>`\ ) |
  246. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`canvas_set_item_repeat<class_RenderingServer_method_canvas_set_item_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat_size\: :ref:`Vector2<class_Vector2>`, repeat_times\: :ref:`int<class_int>`\ ) |
  248. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>`\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  250. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>`\ (\ size\: :ref:`int<class_int>`\ ) |
  252. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>`\ (\ ) |
  254. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |void| | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, channel\: :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>`, texture\: :ref:`RID<class_RID>`\ ) |
  256. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, base_color\: :ref:`Color<class_Color>`, shininess\: :ref:`float<class_float>`\ ) |
  258. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  260. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  262. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | :ref:`RID<class_RID>` | :ref:`compositor_create<class_RenderingServer_method_compositor_create>`\ (\ ) |
  264. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`RID<class_RID>` | :ref:`compositor_effect_create<class_RenderingServer_method_compositor_effect_create>`\ (\ ) |
  266. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |void| | :ref:`compositor_effect_set_callback<class_RenderingServer_method_compositor_effect_set_callback>`\ (\ effect\: :ref:`RID<class_RID>`, callback_type\: :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  268. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`compositor_effect_set_enabled<class_RenderingServer_method_compositor_effect_set_enabled>`\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  270. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | |void| | :ref:`compositor_effect_set_flag<class_RenderingServer_method_compositor_effect_set_flag>`\ (\ effect\: :ref:`RID<class_RID>`, flag\: :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>`, set\: :ref:`bool<class_bool>`\ ) |
  272. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | |void| | :ref:`compositor_set_compositor_effects<class_RenderingServer_method_compositor_set_compositor_effects>`\ (\ compositor\: :ref:`RID<class_RID>`, effects\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ ) |
  274. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>`\ (\ ) |const| |
  276. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | :ref:`Rect2<class_Rect2>` | :ref:`debug_canvas_item_get_rect<class_RenderingServer_method_debug_canvas_item_get_rect>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  278. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>`\ (\ ) |
  280. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | |void| | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>`\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) |
  282. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |void| | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>`\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  284. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | |void| | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  286. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | |void| | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>`\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  288. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | |void| | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>`\ (\ decal\: :ref:`RID<class_RID>`, above\: :ref:`float<class_float>`, below\: :ref:`float<class_float>`\ ) |
  290. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | |void| | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>`\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  292. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | |void| | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>`\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) |
  294. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | |void| | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>`\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  296. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | |void| | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>`\ (\ decal\: :ref:`RID<class_RID>`, type\: :ref:`DecalTexture<enum_RenderingServer_DecalTexture>`, texture\: :ref:`RID<class_RID>`\ ) |
  298. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | |void| | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>`\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) |
  300. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>`\ (\ ) |
  302. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | |void| | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>`\ (\ size\: :ref:`int<class_int>`, is_16bits\: :ref:`bool<class_bool>`\ ) |
  304. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | |void| | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  306. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>`\ (\ environment\: :ref:`RID<class_RID>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  308. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>`\ (\ ) |
  310. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | |void| | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  312. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | |void| | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`, use_1d_color_correction\: :ref:`bool<class_bool>`, color_correction\: :ref:`RID<class_RID>`\ ) |
  314. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | |void| | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contibution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) |
  316. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | |void| | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>`\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) |
  318. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | |void| | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  320. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |void| | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>`\ (\ env\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, exposure_value\: :ref:`float<class_float>`\ ) |
  322. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |void| | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>`\ (\ env\: :ref:`RID<class_RID>`, max_layer\: :ref:`int<class_int>`\ ) |
  324. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, light_color\: :ref:`Color<class_Color>`, light_energy\: :ref:`float<class_float>`, sun_scatter\: :ref:`float<class_float>`, density\: :ref:`float<class_float>`, height\: :ref:`float<class_float>`, height_density\: :ref:`float<class_float>`, aerial_perspective\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`, fog_mode\: :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` = 0\ ) |
  326. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`environment_set_glow<class_RenderingServer_method_environment_set_glow>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, levels\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, intensity\: :ref:`float<class_float>`, strength\: :ref:`float<class_float>`, mix\: :ref:`float<class_float>`, bloom_threshold\: :ref:`float<class_float>`, blend_mode\: :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>`, hdr_bleed_threshold\: :ref:`float<class_float>`, hdr_bleed_scale\: :ref:`float<class_float>`, hdr_luminance_cap\: :ref:`float<class_float>`, glow_map_strength\: :ref:`float<class_float>`, glow_map\: :ref:`RID<class_RID>`\ ) |
  328. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |void| | :ref:`environment_set_sdfgi<class_RenderingServer_method_environment_set_sdfgi>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, cascades\: :ref:`int<class_int>`, min_cell_size\: :ref:`float<class_float>`, y_scale\: :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>`, use_occlusion\: :ref:`bool<class_bool>`, bounce_feedback\: :ref:`float<class_float>`, read_sky\: :ref:`bool<class_bool>`, energy\: :ref:`float<class_float>`, normal_bias\: :ref:`float<class_float>`, probe_bias\: :ref:`float<class_float>`\ ) |
  330. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |void| | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) |
  332. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`environment_set_sdfgi_frames_to_update_light<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`\ ) |
  334. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |void| | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>`\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) |
  336. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |void| | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>`\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) |
  338. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |void| | :ref:`environment_set_sky_custom_fov<class_RenderingServer_method_environment_set_sky_custom_fov>`\ (\ env\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  340. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |void| | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>`\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) |
  342. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |void| | :ref:`environment_set_ssao<class_RenderingServer_method_environment_set_ssao>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, radius\: :ref:`float<class_float>`, intensity\: :ref:`float<class_float>`, power\: :ref:`float<class_float>`, detail\: :ref:`float<class_float>`, horizon\: :ref:`float<class_float>`, sharpness\: :ref:`float<class_float>`, light_affect\: :ref:`float<class_float>`, ao_channel_affect\: :ref:`float<class_float>`\ ) |
  344. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |void| | :ref:`environment_set_ssao_quality<class_RenderingServer_method_environment_set_ssao_quality>`\ (\ quality\: :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) |
  346. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |void| | :ref:`environment_set_ssil_quality<class_RenderingServer_method_environment_set_ssil_quality>`\ (\ quality\: :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) |
  348. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | |void| | :ref:`environment_set_ssr<class_RenderingServer_method_environment_set_ssr>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, max_steps\: :ref:`int<class_int>`, fade_in\: :ref:`float<class_float>`, fade_out\: :ref:`float<class_float>`, depth_tolerance\: :ref:`float<class_float>`\ ) |
  350. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | |void| | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>`\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) |
  352. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | |void| | :ref:`environment_set_tonemap<class_RenderingServer_method_environment_set_tonemap>`\ (\ env\: :ref:`RID<class_RID>`, tone_mapper\: :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>`, exposure\: :ref:`float<class_float>`, white\: :ref:`float<class_float>`\ ) |
  354. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | |void| | :ref:`environment_set_volumetric_fog<class_RenderingServer_method_environment_set_volumetric_fog>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, density\: :ref:`float<class_float>`, albedo\: :ref:`Color<class_Color>`, emission\: :ref:`Color<class_Color>`, emission_energy\: :ref:`float<class_float>`, anisotropy\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`, p_detail_spread\: :ref:`float<class_float>`, gi_inject\: :ref:`float<class_float>`, temporal_reprojection\: :ref:`bool<class_bool>`, temporal_reprojection_amount\: :ref:`float<class_float>`, ambient_inject\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`\ ) |
  356. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |void| | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  358. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |void| | :ref:`environment_set_volumetric_fog_volume_size<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>`\ (\ size\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`\ ) |
  360. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>`\ (\ ) |
  362. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | |void| | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>`\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  364. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | |void| | :ref:`fog_volume_set_shape<class_RenderingServer_method_fog_volume_set_shape>`\ (\ fog_volume\: :ref:`RID<class_RID>`, shape\: :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>`\ ) |
  366. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | |void| | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>`\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  368. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | |void| | :ref:`force_draw<class_RenderingServer_method_force_draw>`\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) |
  370. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | |void| | :ref:`force_sync<class_RenderingServer_method_force_sync>`\ (\ ) |
  372. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | |void| | :ref:`free_rid<class_RenderingServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  374. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>`\ (\ ) |
  376. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>`\ (\ ) |const| |
  378. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>`\ (\ ) |const| |
  380. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) |
  382. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_shader_parameter_list<class_RenderingServer_method_get_shader_parameter_list>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| |
  384. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>`\ (\ ) |
  386. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>`\ (\ ) |
  388. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>`\ (\ ) |const| |
  390. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>`\ (\ ) |const| |
  392. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>`\ (\ ) |const| |
  394. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>`\ (\ ) |const| |
  396. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>`\ (\ ) |
  398. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | |void| | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>`\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) |
  400. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | |void| | :ref:`global_shader_parameter_add<class_RenderingServer_method_global_shader_parameter_add>`\ (\ name\: :ref:`StringName<class_StringName>`, type\: :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>`, default_value\: :ref:`Variant<class_Variant>`\ ) |
  402. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  404. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>`\ (\ ) |const| |
  406. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` | :ref:`global_shader_parameter_get_type<class_RenderingServer_method_global_shader_parameter_get_type>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  408. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | |void| | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
  410. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | |void| | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  412. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | |void| | :ref:`global_shader_parameter_set_override<class_RenderingServer_method_global_shader_parameter_set_override>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  414. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>`\ (\ ) |const| |
  416. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>`\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| |
  418. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>`\ (\ feature\: :ref:`String<class_String>`\ ) |const| |
  420. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | |void| | :ref:`instance_attach_object_instance_id<class_RenderingServer_method_instance_attach_object_instance_id>`\ (\ instance\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  422. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | |void| | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>`\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) |
  424. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>`\ (\ ) |
  426. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>`\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  428. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter<class_RenderingServer_method_instance_geometry_get_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  430. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter_default_value<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  432. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`instance_geometry_get_shader_parameter_list<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| |
  434. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | |void| | :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`\ (\ instance\: :ref:`RID<class_RID>`, shadow_casting_setting\: :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`\ ) |
  436. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | |void| | :ref:`instance_geometry_set_flag<class_RenderingServer_method_instance_geometry_set_flag>`\ (\ instance\: :ref:`RID<class_RID>`, flag\: :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`, enabled\: :ref:`bool<class_bool>`\ ) |
  438. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | |void| | :ref:`instance_geometry_set_lightmap<class_RenderingServer_method_instance_geometry_set_lightmap>`\ (\ instance\: :ref:`RID<class_RID>`, lightmap\: :ref:`RID<class_RID>`, lightmap_uv_scale\: :ref:`Rect2<class_Rect2>`, lightmap_slice\: :ref:`int<class_int>`\ ) |
  440. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | |void| | :ref:`instance_geometry_set_lod_bias<class_RenderingServer_method_instance_geometry_set_lod_bias>`\ (\ instance\: :ref:`RID<class_RID>`, lod_bias\: :ref:`float<class_float>`\ ) |
  442. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | |void| | :ref:`instance_geometry_set_material_overlay<class_RenderingServer_method_instance_geometry_set_material_overlay>`\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  444. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | |void| | :ref:`instance_geometry_set_material_override<class_RenderingServer_method_instance_geometry_set_material_override>`\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  446. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | |void| | :ref:`instance_geometry_set_shader_parameter<class_RenderingServer_method_instance_geometry_set_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  448. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | |void| | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>`\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) |
  450. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | |void| | :ref:`instance_geometry_set_visibility_range<class_RenderingServer_method_instance_geometry_set_visibility_range>`\ (\ instance\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`, min_margin\: :ref:`float<class_float>`, max_margin\: :ref:`float<class_float>`, fade_mode\: :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>`\ ) |
  452. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | |void| | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) |
  454. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | |void| | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>`\ (\ instance\: :ref:`RID<class_RID>`, shape\: :ref:`int<class_int>`, weight\: :ref:`float<class_float>`\ ) |
  456. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | |void| | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>`\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  458. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | |void| | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>`\ (\ instance\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  460. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | |void| | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>`\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  462. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | |void| | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>`\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  464. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | |void| | :ref:`instance_set_pivot_data<class_RenderingServer_method_instance_set_pivot_data>`\ (\ instance\: :ref:`RID<class_RID>`, sorting_offset\: :ref:`float<class_float>`, use_aabb_center\: :ref:`bool<class_bool>`\ ) |
  466. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | |void| | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>`\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  468. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | |void| | :ref:`instance_set_surface_override_material<class_RenderingServer_method_instance_set_surface_override_material>`\ (\ instance\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) |
  470. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | |void| | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>`\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  472. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | |void| | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>`\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  474. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | |void| | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>`\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  476. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`\ (\ aabb\: :ref:`AABB<class_AABB>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  478. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`\ (\ convex\: :ref:`Array<class_Array>`\[:ref:`Plane<class_Plane>`\], scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  480. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  482. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | :ref:`bool<class_bool>` | :ref:`is_on_render_thread<class_RenderingServer_method_is_on_render_thread>`\ (\ ) |
  484. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | |void| | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  486. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | |void| | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>`\ ) |
  488. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | |void| | :ref:`light_directional_set_sky_mode<class_RenderingServer_method_light_directional_set_sky_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>`\ ) |
  490. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | |void| | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>`\ ) |
  492. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | |void| | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>`\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) |
  494. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | |void| | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>`\ (\ light\: :ref:`RID<class_RID>`, bake_mode\: :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>`\ ) |
  496. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | |void| | :ref:`light_set_color<class_RenderingServer_method_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  498. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. | |void| | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  500. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  501. | |void| | :ref:`light_set_distance_fade<class_RenderingServer_method_light_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, shadow\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  502. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  503. | |void| | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>`\ (\ light\: :ref:`RID<class_RID>`, cascade\: :ref:`int<class_int>`\ ) |
  504. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  505. | |void| | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  506. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  507. | |void| | :ref:`light_set_param<class_RenderingServer_method_light_set_param>`\ (\ light\: :ref:`RID<class_RID>`, param\: :ref:`LightParam<enum_RenderingServer_LightParam>`, value\: :ref:`float<class_float>`\ ) |
  508. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  509. | |void| | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  510. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  511. | |void| | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  512. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  513. | |void| | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  514. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  515. | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>`\ (\ ) |
  516. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  517. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  518. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  519. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  520. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  521. | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  522. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  523. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  524. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  525. | |void| | :ref:`lightmap_set_baked_exposure_normalization<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>`\ (\ lightmap\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) |
  526. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  527. | |void| | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>`\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) |
  528. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  529. | |void| | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>`\ (\ lightmap\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector3Array<class_PackedVector3Array>`, point_sh\: :ref:`PackedColorArray<class_PackedColorArray>`, tetrahedra\: :ref:`PackedInt32Array<class_PackedInt32Array>`, bsp_tree\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  530. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  531. | |void| | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`\ (\ speed\: :ref:`float<class_float>`\ ) |
  532. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  533. | |void| | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>`\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) |
  534. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  535. | |void| | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>`\ (\ lightmap\: :ref:`RID<class_RID>`, light\: :ref:`RID<class_RID>`, uses_sh\: :ref:`bool<class_bool>`\ ) |
  536. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  537. | :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>`\ (\ latitudes\: :ref:`int<class_int>`, longitudes\: :ref:`int<class_int>`, radius\: :ref:`float<class_float>`\ ) |
  538. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  539. | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>`\ (\ ) |
  540. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  541. | :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  542. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  543. | |void| | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>`\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) |
  544. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  545. | |void| | :ref:`material_set_param<class_RenderingServer_method_material_set_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  546. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  547. | |void| | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>`\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  548. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  549. | |void| | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>`\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) |
  550. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  551. | |void| | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) |
  552. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  553. | |void| | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, primitive\: :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>` = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\] = 0\ ) |
  554. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  555. | |void| | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |
  556. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  557. | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>`\ (\ ) |
  558. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  559. | :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>`\ (\ surfaces\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], blend_shape_count\: :ref:`int<class_int>` = 0\ ) |
  560. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  561. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  562. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  563. | :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  564. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  565. | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  566. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  567. | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |
  568. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  569. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  570. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  571. | |void| | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`, mode\: :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>`\ ) |
  572. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  573. | |void| | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  574. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  575. | |void| | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>`\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) |
  576. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  577. | :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  578. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  579. | :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  580. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  581. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  582. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  583. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_normal_tangent_stride<class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  584. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  585. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_RenderingServer_method_mesh_surface_get_format_offset>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`, array_index\: :ref:`int<class_int>`\ ) |const| |
  586. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  587. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_skin_stride<class_RenderingServer_method_mesh_surface_get_format_skin_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  588. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  589. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_vertex_stride<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  590. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  591. | :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_RenderingServer_method_mesh_surface_get_material>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  592. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  593. | |void| | :ref:`mesh_surface_set_material<class_RenderingServer_method_mesh_surface_set_material>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) |
  594. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  595. | |void| | :ref:`mesh_surface_update_attribute_region<class_RenderingServer_method_mesh_surface_update_attribute_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  596. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  597. | |void| | :ref:`mesh_surface_update_skin_region<class_RenderingServer_method_mesh_surface_update_skin_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  598. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  599. | |void| | :ref:`mesh_surface_update_vertex_region<class_RenderingServer_method_mesh_surface_update_vertex_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  600. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  601. | |void| | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false\ ) |
  602. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  603. | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>`\ (\ ) |
  604. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  605. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  606. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  607. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  608. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  609. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_custom_aabb<class_RenderingServer_method_multimesh_get_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  610. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  611. | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  612. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  613. | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  614. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  615. | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  616. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  617. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_RenderingServer_method_multimesh_instance_get_color>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  618. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  619. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_RenderingServer_method_multimesh_instance_get_custom_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  620. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  621. | :ref:`Transform3D<class_Transform3D>` | :ref:`multimesh_instance_get_transform<class_RenderingServer_method_multimesh_instance_get_transform>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  622. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  623. | :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_RenderingServer_method_multimesh_instance_get_transform_2d>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  624. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  625. | |void| | :ref:`multimesh_instance_set_color<class_RenderingServer_method_multimesh_instance_set_color>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |
  626. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  627. | |void| | :ref:`multimesh_instance_set_custom_data<class_RenderingServer_method_multimesh_instance_set_custom_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, custom_data\: :ref:`Color<class_Color>`\ ) |
  628. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  629. | |void| | :ref:`multimesh_instance_set_transform<class_RenderingServer_method_multimesh_instance_set_transform>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  630. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  631. | |void| | :ref:`multimesh_instance_set_transform_2d<class_RenderingServer_method_multimesh_instance_set_transform_2d>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  632. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  633. | |void| | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  634. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  635. | |void| | :ref:`multimesh_set_custom_aabb<class_RenderingServer_method_multimesh_set_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  636. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  637. | |void| | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  638. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  639. | |void| | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) |
  640. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  641. | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>`\ (\ ) |
  642. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  643. | |void| | :ref:`occluder_set_mesh<class_RenderingServer_method_occluder_set_mesh>`\ (\ occluder\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  644. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  645. | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>`\ (\ ) |
  646. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  647. | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>`\ (\ ) |
  648. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  649. | |void| | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>`\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) |
  650. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  651. | |void| | :ref:`particles_collision_set_attractor_attenuation<class_RenderingServer_method_particles_collision_set_attractor_attenuation>`\ (\ particles_collision\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`\ ) |
  652. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  653. | |void| | :ref:`particles_collision_set_attractor_directionality<class_RenderingServer_method_particles_collision_set_attractor_directionality>`\ (\ particles_collision\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) |
  654. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  655. | |void| | :ref:`particles_collision_set_attractor_strength<class_RenderingServer_method_particles_collision_set_attractor_strength>`\ (\ particles_collision\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  656. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  657. | |void| | :ref:`particles_collision_set_box_extents<class_RenderingServer_method_particles_collision_set_box_extents>`\ (\ particles_collision\: :ref:`RID<class_RID>`, extents\: :ref:`Vector3<class_Vector3>`\ ) |
  658. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  659. | |void| | :ref:`particles_collision_set_collision_type<class_RenderingServer_method_particles_collision_set_collision_type>`\ (\ particles_collision\: :ref:`RID<class_RID>`, type\: :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>`\ ) |
  660. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  661. | |void| | :ref:`particles_collision_set_cull_mask<class_RenderingServer_method_particles_collision_set_cull_mask>`\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  662. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  663. | |void| | :ref:`particles_collision_set_field_texture<class_RenderingServer_method_particles_collision_set_field_texture>`\ (\ particles_collision\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  664. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  665. | |void| | :ref:`particles_collision_set_height_field_resolution<class_RenderingServer_method_particles_collision_set_height_field_resolution>`\ (\ particles_collision\: :ref:`RID<class_RID>`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`\ ) |
  666. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  667. | |void| | :ref:`particles_collision_set_sphere_radius<class_RenderingServer_method_particles_collision_set_sphere_radius>`\ (\ particles_collision\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) |
  668. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  669. | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>`\ (\ ) |
  670. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  671. | |void| | :ref:`particles_emit<class_RenderingServer_method_particles_emit>`\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, emit_flags\: :ref:`int<class_int>`\ ) |
  672. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  673. | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  674. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  675. | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  676. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  677. | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  678. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  679. | |void| | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  680. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  681. | |void| | :ref:`particles_restart<class_RenderingServer_method_particles_restart>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  682. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  683. | |void| | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>`\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) |
  684. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  685. | |void| | :ref:`particles_set_amount_ratio<class_RenderingServer_method_particles_set_amount_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  686. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  687. | |void| | :ref:`particles_set_collision_base_size<class_RenderingServer_method_particles_set_collision_base_size>`\ (\ particles\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`\ ) |
  688. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  689. | |void| | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>`\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  690. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  691. | |void| | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>`\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) |
  692. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  693. | |void| | :ref:`particles_set_draw_pass_mesh<class_RenderingServer_method_particles_set_draw_pass_mesh>`\ (\ particles\: :ref:`RID<class_RID>`, pass\: :ref:`int<class_int>`, mesh\: :ref:`RID<class_RID>`\ ) |
  694. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  695. | |void| | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>`\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  696. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  697. | |void| | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>`\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  698. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  699. | |void| | :ref:`particles_set_emitter_velocity<class_RenderingServer_method_particles_set_emitter_velocity>`\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  700. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  701. | |void| | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>`\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) |
  702. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  703. | |void| | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  704. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  705. | |void| | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>`\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) |
  706. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  707. | |void| | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  708. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  709. | |void| | :ref:`particles_set_interp_to_end<class_RenderingServer_method_particles_set_interp_to_end>`\ (\ particles\: :ref:`RID<class_RID>`, factor\: :ref:`float<class_float>`\ ) |
  710. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  711. | |void| | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  712. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  713. | |void| | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>`\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) |
  714. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  715. | |void| | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>`\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) |
  716. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  717. | |void| | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>`\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) |
  718. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  719. | |void| | :ref:`particles_set_pre_process_time<class_RenderingServer_method_particles_set_pre_process_time>`\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) |
  720. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  721. | |void| | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>`\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  722. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  723. | |void| | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  724. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  725. | |void| | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>`\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  726. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  727. | |void| | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>`\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) |
  728. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  729. | |void| | :ref:`particles_set_trail_bind_poses<class_RenderingServer_method_particles_set_trail_bind_poses>`\ (\ particles\: :ref:`RID<class_RID>`, bind_poses\: :ref:`Array<class_Array>`\[:ref:`Transform3D<class_Transform3D>`\]\ ) |
  730. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  731. | |void| | :ref:`particles_set_trails<class_RenderingServer_method_particles_set_trails>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, length_sec\: :ref:`float<class_float>`\ ) |
  732. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  733. | |void| | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>`\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) |
  734. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  735. | |void| | :ref:`particles_set_use_local_coordinates<class_RenderingServer_method_particles_set_use_local_coordinates>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  736. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  737. | |void| | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  738. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  739. | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>`\ (\ ) |
  740. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  741. | |void| | :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>`\ (\ probe\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  742. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  743. | |void| | :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>`\ (\ probe\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  744. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  745. | |void| | :ref:`reflection_probe_set_ambient_mode<class_RenderingServer_method_reflection_probe_set_ambient_mode>`\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>`\ ) |
  746. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  747. | |void| | :ref:`reflection_probe_set_as_interior<class_RenderingServer_method_reflection_probe_set_as_interior>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  748. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  749. | |void| | :ref:`reflection_probe_set_cull_mask<class_RenderingServer_method_reflection_probe_set_cull_mask>`\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  750. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  751. | |void| | :ref:`reflection_probe_set_enable_box_projection<class_RenderingServer_method_reflection_probe_set_enable_box_projection>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  752. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  753. | |void| | :ref:`reflection_probe_set_enable_shadows<class_RenderingServer_method_reflection_probe_set_enable_shadows>`\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  754. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  755. | |void| | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>`\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) |
  756. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  757. | |void| | :ref:`reflection_probe_set_max_distance<class_RenderingServer_method_reflection_probe_set_max_distance>`\ (\ probe\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) |
  758. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  759. | |void| | :ref:`reflection_probe_set_mesh_lod_threshold<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>`\ (\ probe\: :ref:`RID<class_RID>`, pixels\: :ref:`float<class_float>`\ ) |
  760. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  761. | |void| | :ref:`reflection_probe_set_origin_offset<class_RenderingServer_method_reflection_probe_set_origin_offset>`\ (\ probe\: :ref:`RID<class_RID>`, offset\: :ref:`Vector3<class_Vector3>`\ ) |
  762. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  763. | |void| | :ref:`reflection_probe_set_reflection_mask<class_RenderingServer_method_reflection_probe_set_reflection_mask>`\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  764. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  765. | |void| | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>`\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) |
  766. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  767. | |void| | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>`\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  768. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  769. | |void| | :ref:`reflection_probe_set_update_mode<class_RenderingServer_method_reflection_probe_set_update_mode>`\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>`\ ) |
  770. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  771. | |void| | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  772. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  773. | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>`\ (\ ) |
  774. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  775. | |void| | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>`\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  776. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  777. | |void| | :ref:`scenario_set_compositor<class_RenderingServer_method_scenario_set_compositor>`\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  778. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  779. | |void| | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  780. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  781. | |void| | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  782. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  783. | |void| | :ref:`screen_space_roughness_limiter_set_active<class_RenderingServer_method_screen_space_roughness_limiter_set_active>`\ (\ enable\: :ref:`bool<class_bool>`, amount\: :ref:`float<class_float>`, limit\: :ref:`float<class_float>`\ ) |
  784. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  785. | |void| | :ref:`set_boot_image<class_RenderingServer_method_set_boot_image>`\ (\ image\: :ref:`Image<class_Image>`, color\: :ref:`Color<class_Color>`, scale\: :ref:`bool<class_bool>`, use_filter\: :ref:`bool<class_bool>` = true\ ) |
  786. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  787. | |void| | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>`\ (\ generate\: :ref:`bool<class_bool>`\ ) |
  788. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  789. | |void| | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
  790. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  791. | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>`\ (\ ) |
  792. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  793. | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| |
  794. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  795. | :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_parameter<class_RenderingServer_method_shader_get_default_texture_parameter>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, index\: :ref:`int<class_int>` = 0\ ) |const| |
  796. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  797. | :ref:`Variant<class_Variant>` | :ref:`shader_get_parameter_default<class_RenderingServer_method_shader_get_parameter_default>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`\ ) |const| |
  798. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  799. | |void| | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>`\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) |
  800. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  801. | |void| | :ref:`shader_set_default_texture_parameter<class_RenderingServer_method_shader_set_default_texture_parameter>`\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, texture\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>` = 0\ ) |
  802. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  803. | |void| | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>`\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  804. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  805. | |void| | :ref:`skeleton_allocate_data<class_RenderingServer_method_skeleton_allocate_data>`\ (\ skeleton\: :ref:`RID<class_RID>`, bones\: :ref:`int<class_int>`, is_2d_skeleton\: :ref:`bool<class_bool>` = false\ ) |
  806. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  807. | :ref:`Transform3D<class_Transform3D>` | :ref:`skeleton_bone_get_transform<class_RenderingServer_method_skeleton_bone_get_transform>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| |
  808. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  809. | :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_RenderingServer_method_skeleton_bone_get_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| |
  810. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  811. | |void| | :ref:`skeleton_bone_set_transform<class_RenderingServer_method_skeleton_bone_set_transform>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  812. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  813. | |void| | :ref:`skeleton_bone_set_transform_2d<class_RenderingServer_method_skeleton_bone_set_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  814. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  815. | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>`\ (\ ) |
  816. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  817. | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>`\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| |
  818. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  819. | |void| | :ref:`skeleton_set_base_transform_2d<class_RenderingServer_method_skeleton_set_base_transform_2d>`\ (\ skeleton\: :ref:`RID<class_RID>`, base_transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  820. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  821. | :ref:`Image<class_Image>` | :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>`\ (\ sky\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  822. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  823. | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>`\ (\ ) |
  824. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  825. | |void| | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>`\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  826. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  827. | |void| | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>`\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) |
  828. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  829. | |void| | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>`\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) |
  830. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  831. | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>`\ (\ ) |
  832. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  833. | |void| | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>`\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) |
  834. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  835. | |void| | :ref:`sub_surface_scattering_set_scale<class_RenderingServer_method_sub_surface_scattering_set_scale>`\ (\ scale\: :ref:`float<class_float>`, depth_scale\: :ref:`float<class_float>`\ ) |
  836. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  837. | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
  838. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  839. | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  840. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  841. | :ref:`Image<class_Image>` | :ref:`texture_2d_layer_get<class_RenderingServer_method_texture_2d_layer_get>`\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |const| |
  842. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  843. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_create<class_RenderingServer_method_texture_2d_layered_create>`\ (\ layers\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\], layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) |
  844. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  845. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>`\ (\ layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) |
  846. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  847. | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>`\ (\ ) |
  848. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  849. | |void| | :ref:`texture_2d_update<class_RenderingServer_method_texture_2d_update>`\ (\ texture\: :ref:`RID<class_RID>`, image\: :ref:`Image<class_Image>`, layer\: :ref:`int<class_int>`\ ) |
  850. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  851. | :ref:`RID<class_RID>` | :ref:`texture_3d_create<class_RenderingServer_method_texture_3d_create>`\ (\ format\: :ref:`Format<enum_Image_Format>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, mipmaps\: :ref:`bool<class_bool>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) |
  852. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  853. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  854. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  855. | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>`\ (\ ) |
  856. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  857. | |void| | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>`\ (\ texture\: :ref:`RID<class_RID>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) |
  858. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  859. | :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_RenderingServer_method_texture_get_format>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  860. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  861. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingServer_method_texture_get_native_handle>`\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| |
  862. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  863. | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  864. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  865. | :ref:`RID<class_RID>` | :ref:`texture_get_rd_texture<class_RenderingServer_method_texture_get_rd_texture>`\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| |
  866. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  867. | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>`\ (\ base\: :ref:`RID<class_RID>`\ ) |
  868. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  869. | |void| | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>`\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) |
  870. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  871. | :ref:`RID<class_RID>` | :ref:`texture_rd_create<class_RenderingServer_method_texture_rd_create>`\ (\ rd_texture\: :ref:`RID<class_RID>`, layer_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) |
  872. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  873. | |void| | :ref:`texture_replace<class_RenderingServer_method_texture_replace>`\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) |
  874. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  875. | |void| | :ref:`texture_set_force_redraw_if_visible<class_RenderingServer_method_texture_set_force_redraw_if_visible>`\ (\ texture\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  876. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  877. | |void| | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>`\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  878. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  879. | |void| | :ref:`texture_set_size_override<class_RenderingServer_method_texture_set_size_override>`\ (\ texture\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
  880. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  881. | |void| | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>`\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) |
  882. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  883. | |void| | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  884. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  885. | |void| | :ref:`viewport_attach_to_screen<class_RenderingServer_method_viewport_attach_to_screen>`\ (\ viewport\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), screen\: :ref:`int<class_int>` = 0\ ) |
  886. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  887. | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>`\ (\ ) |
  888. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  889. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  890. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  891. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  892. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  893. | :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>`\ (\ viewport\: :ref:`RID<class_RID>`, type\: :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>`, info\: :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>`\ ) |
  894. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  895. | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  896. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  897. | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  898. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  899. | :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` | :ref:`viewport_get_update_mode<class_RenderingServer_method_viewport_get_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  900. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  901. | |void| | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  902. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  903. | |void| | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>`\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  904. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  905. | |void| | :ref:`viewport_set_canvas_cull_mask<class_RenderingServer_method_viewport_set_canvas_cull_mask>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas_cull_mask\: :ref:`int<class_int>`\ ) |
  906. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  907. | |void| | :ref:`viewport_set_canvas_stacking<class_RenderingServer_method_viewport_set_canvas_stacking>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, sublayer\: :ref:`int<class_int>`\ ) |
  908. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  909. | |void| | :ref:`viewport_set_canvas_transform<class_RenderingServer_method_viewport_set_canvas_transform>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, offset\: :ref:`Transform2D<class_Transform2D>`\ ) |
  910. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  911. | |void| | :ref:`viewport_set_clear_mode<class_RenderingServer_method_viewport_set_clear_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, clear_mode\: :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>`\ ) |
  912. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  913. | |void| | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>`\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) |
  914. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  915. | |void| | :ref:`viewport_set_default_canvas_item_texture_filter<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>`\ (\ viewport\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  916. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  917. | |void| | :ref:`viewport_set_default_canvas_item_texture_repeat<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>`\ (\ viewport\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  918. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  919. | |void| | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  920. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  921. | |void| | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  922. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  923. | |void| | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) |
  924. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  925. | |void| | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>`\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) |
  926. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  927. | |void| | :ref:`viewport_set_global_canvas_transform<class_RenderingServer_method_viewport_set_global_canvas_transform>`\ (\ viewport\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  928. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  929. | |void| | :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  930. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  931. | |void| | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  932. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  933. | |void| | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  934. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  935. | |void| | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) |
  936. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  937. | |void| | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) |
  938. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  939. | |void| | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>`\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) |
  940. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  941. | |void| | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>`\ (\ viewport\: :ref:`RID<class_RID>`, quadrant\: :ref:`int<class_int>`, subdivision\: :ref:`int<class_int>`\ ) |
  942. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  943. | |void| | :ref:`viewport_set_positional_shadow_atlas_size<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>`\ (\ viewport\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, use_16_bits\: :ref:`bool<class_bool>` = false\ ) |
  944. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  945. | |void| | :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  946. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  947. | |void| | :ref:`viewport_set_scaling_3d_mode<class_RenderingServer_method_viewport_set_scaling_3d_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, scaling_3d_mode\: :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>`\ ) |
  948. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  949. | |void| | :ref:`viewport_set_scaling_3d_scale<class_RenderingServer_method_viewport_set_scaling_3d_scale>`\ (\ viewport\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  950. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  951. | |void| | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>`\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  952. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  953. | |void| | :ref:`viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>`\ ) |
  954. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  955. | |void| | :ref:`viewport_set_sdf_oversize_and_scale<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>`\ (\ viewport\: :ref:`RID<class_RID>`, oversize\: :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>`, scale\: :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>`\ ) |
  956. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  957. | |void| | :ref:`viewport_set_size<class_RenderingServer_method_viewport_set_size>`\ (\ viewport\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
  958. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  959. | |void| | :ref:`viewport_set_snap_2d_transforms_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  960. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  961. | |void| | :ref:`viewport_set_snap_2d_vertices_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  962. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  963. | |void| | :ref:`viewport_set_texture_mipmap_bias<class_RenderingServer_method_viewport_set_texture_mipmap_bias>`\ (\ viewport\: :ref:`RID<class_RID>`, mipmap_bias\: :ref:`float<class_float>`\ ) |
  964. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  965. | |void| | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  966. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  967. | |void| | :ref:`viewport_set_update_mode<class_RenderingServer_method_viewport_set_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, update_mode\: :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>`\ ) |
  968. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  969. | |void| | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  970. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  971. | |void| | :ref:`viewport_set_use_hdr_2d<class_RenderingServer_method_viewport_set_use_hdr_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  972. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  973. | |void| | :ref:`viewport_set_use_occlusion_culling<class_RenderingServer_method_viewport_set_use_occlusion_culling>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  974. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  975. | |void| | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  976. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  977. | |void| | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>`\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) |
  978. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  979. | |void| | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) |
  980. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  981. | |void| | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>`\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  982. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  983. | |void| | :ref:`viewport_set_vrs_update_mode<class_RenderingServer_method_viewport_set_vrs_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>`\ ) |
  984. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  985. | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>`\ (\ ) |
  986. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  987. | |void| | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>`\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  988. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  989. | |void| | :ref:`visibility_notifier_set_callbacks<class_RenderingServer_method_visibility_notifier_set_callbacks>`\ (\ notifier\: :ref:`RID<class_RID>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) |
  990. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  991. | |void| | :ref:`voxel_gi_allocate_data<class_RenderingServer_method_voxel_gi_allocate_data>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, to_cell_xform\: :ref:`Transform3D<class_Transform3D>`, aabb\: :ref:`AABB<class_AABB>`, octree_size\: :ref:`Vector3i<class_Vector3i>`, octree_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, data_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, distance_field\: :ref:`PackedByteArray<class_PackedByteArray>`, level_counts\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  992. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  993. | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>`\ (\ ) |
  994. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  995. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_data_cells<class_RenderingServer_method_voxel_gi_get_data_cells>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  996. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  997. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_distance_field<class_RenderingServer_method_voxel_gi_get_distance_field>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  998. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  999. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`voxel_gi_get_level_counts<class_RenderingServer_method_voxel_gi_get_level_counts>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1000. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1001. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_octree_cells<class_RenderingServer_method_voxel_gi_get_octree_cells>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1002. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1003. | :ref:`Vector3i<class_Vector3i>` | :ref:`voxel_gi_get_octree_size<class_RenderingServer_method_voxel_gi_get_octree_size>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1004. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1005. | :ref:`Transform3D<class_Transform3D>` | :ref:`voxel_gi_get_to_cell_xform<class_RenderingServer_method_voxel_gi_get_to_cell_xform>`\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| |
  1006. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1007. | |void| | :ref:`voxel_gi_set_baked_exposure_normalization<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) |
  1008. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1009. | |void| | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) |
  1010. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1011. | |void| | :ref:`voxel_gi_set_dynamic_range<class_RenderingServer_method_voxel_gi_set_dynamic_range>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, range\: :ref:`float<class_float>`\ ) |
  1012. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1013. | |void| | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  1014. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1015. | |void| | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1016. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1017. | |void| | :ref:`voxel_gi_set_normal_bias<class_RenderingServer_method_voxel_gi_set_normal_bias>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) |
  1018. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1019. | |void| | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) |
  1020. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1021. | |void| | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>`\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) |
  1022. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1023. | |void| | :ref:`voxel_gi_set_use_two_bounces<class_RenderingServer_method_voxel_gi_set_use_two_bounces>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1024. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1025. .. rst-class:: classref-section-separator
  1026. ----
  1027. .. rst-class:: classref-descriptions-group
  1028. Signals
  1029. -------
  1030. .. _class_RenderingServer_signal_frame_post_draw:
  1031. .. rst-class:: classref-signal
  1032. **frame_post_draw**\ (\ ) :ref:`🔗<class_RenderingServer_signal_frame_post_draw>`
  1033. Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
  1034. .. rst-class:: classref-item-separator
  1035. ----
  1036. .. _class_RenderingServer_signal_frame_pre_draw:
  1037. .. rst-class:: classref-signal
  1038. **frame_pre_draw**\ (\ ) :ref:`🔗<class_RenderingServer_signal_frame_pre_draw>`
  1039. Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
  1040. .. rst-class:: classref-section-separator
  1041. ----
  1042. .. rst-class:: classref-descriptions-group
  1043. Enumerations
  1044. ------------
  1045. .. _enum_RenderingServer_TextureLayeredType:
  1046. .. rst-class:: classref-enumeration
  1047. enum **TextureLayeredType**: :ref:`🔗<enum_RenderingServer_TextureLayeredType>`
  1048. .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
  1049. .. rst-class:: classref-enumeration-constant
  1050. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
  1051. Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
  1052. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
  1053. .. rst-class:: classref-enumeration-constant
  1054. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
  1055. Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
  1056. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
  1057. .. rst-class:: classref-enumeration-constant
  1058. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
  1059. Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
  1060. .. rst-class:: classref-item-separator
  1061. ----
  1062. .. _enum_RenderingServer_CubeMapLayer:
  1063. .. rst-class:: classref-enumeration
  1064. enum **CubeMapLayer**: :ref:`🔗<enum_RenderingServer_CubeMapLayer>`
  1065. .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
  1066. .. rst-class:: classref-enumeration-constant
  1067. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
  1068. Left face of a :ref:`Cubemap<class_Cubemap>`.
  1069. .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
  1070. .. rst-class:: classref-enumeration-constant
  1071. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
  1072. Right face of a :ref:`Cubemap<class_Cubemap>`.
  1073. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
  1074. .. rst-class:: classref-enumeration-constant
  1075. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
  1076. Bottom face of a :ref:`Cubemap<class_Cubemap>`.
  1077. .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
  1078. .. rst-class:: classref-enumeration-constant
  1079. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
  1080. Top face of a :ref:`Cubemap<class_Cubemap>`.
  1081. .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
  1082. .. rst-class:: classref-enumeration-constant
  1083. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
  1084. Front face of a :ref:`Cubemap<class_Cubemap>`.
  1085. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
  1086. .. rst-class:: classref-enumeration-constant
  1087. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
  1088. Back face of a :ref:`Cubemap<class_Cubemap>`.
  1089. .. rst-class:: classref-item-separator
  1090. ----
  1091. .. _enum_RenderingServer_ShaderMode:
  1092. .. rst-class:: classref-enumeration
  1093. enum **ShaderMode**: :ref:`🔗<enum_RenderingServer_ShaderMode>`
  1094. .. _class_RenderingServer_constant_SHADER_SPATIAL:
  1095. .. rst-class:: classref-enumeration-constant
  1096. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
  1097. Shader is a 3D shader.
  1098. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
  1099. .. rst-class:: classref-enumeration-constant
  1100. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
  1101. Shader is a 2D shader.
  1102. .. _class_RenderingServer_constant_SHADER_PARTICLES:
  1103. .. rst-class:: classref-enumeration-constant
  1104. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
  1105. Shader is a particle shader (can be used in both 2D and 3D).
  1106. .. _class_RenderingServer_constant_SHADER_SKY:
  1107. .. rst-class:: classref-enumeration-constant
  1108. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
  1109. Shader is a 3D sky shader.
  1110. .. _class_RenderingServer_constant_SHADER_FOG:
  1111. .. rst-class:: classref-enumeration-constant
  1112. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
  1113. Shader is a 3D fog shader.
  1114. .. _class_RenderingServer_constant_SHADER_MAX:
  1115. .. rst-class:: classref-enumeration-constant
  1116. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
  1117. Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _enum_RenderingServer_ArrayType:
  1121. .. rst-class:: classref-enumeration
  1122. enum **ArrayType**: :ref:`🔗<enum_RenderingServer_ArrayType>`
  1123. .. _class_RenderingServer_constant_ARRAY_VERTEX:
  1124. .. rst-class:: classref-enumeration-constant
  1125. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
  1126. Array is a vertex position array.
  1127. .. _class_RenderingServer_constant_ARRAY_NORMAL:
  1128. .. rst-class:: classref-enumeration-constant
  1129. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
  1130. Array is a normal array.
  1131. .. _class_RenderingServer_constant_ARRAY_TANGENT:
  1132. .. rst-class:: classref-enumeration-constant
  1133. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
  1134. Array is a tangent array.
  1135. .. _class_RenderingServer_constant_ARRAY_COLOR:
  1136. .. rst-class:: classref-enumeration-constant
  1137. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
  1138. Array is a vertex color array.
  1139. .. _class_RenderingServer_constant_ARRAY_TEX_UV:
  1140. .. rst-class:: classref-enumeration-constant
  1141. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
  1142. Array is a UV coordinates array.
  1143. .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
  1144. .. rst-class:: classref-enumeration-constant
  1145. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
  1146. Array is a UV coordinates array for the second set of UV coordinates.
  1147. .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
  1148. .. rst-class:: classref-enumeration-constant
  1149. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
  1150. Array is a custom data array for the first set of custom data.
  1151. .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
  1152. .. rst-class:: classref-enumeration-constant
  1153. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
  1154. Array is a custom data array for the second set of custom data.
  1155. .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
  1156. .. rst-class:: classref-enumeration-constant
  1157. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
  1158. Array is a custom data array for the third set of custom data.
  1159. .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
  1160. .. rst-class:: classref-enumeration-constant
  1161. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
  1162. Array is a custom data array for the fourth set of custom data.
  1163. .. _class_RenderingServer_constant_ARRAY_BONES:
  1164. .. rst-class:: classref-enumeration-constant
  1165. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
  1166. Array contains bone information.
  1167. .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
  1168. .. rst-class:: classref-enumeration-constant
  1169. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
  1170. Array is weight information.
  1171. .. _class_RenderingServer_constant_ARRAY_INDEX:
  1172. .. rst-class:: classref-enumeration-constant
  1173. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
  1174. Array is an index array.
  1175. .. _class_RenderingServer_constant_ARRAY_MAX:
  1176. .. rst-class:: classref-enumeration-constant
  1177. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
  1178. Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
  1179. .. rst-class:: classref-item-separator
  1180. ----
  1181. .. _enum_RenderingServer_ArrayCustomFormat:
  1182. .. rst-class:: classref-enumeration
  1183. enum **ArrayCustomFormat**: :ref:`🔗<enum_RenderingServer_ArrayCustomFormat>`
  1184. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
  1185. .. rst-class:: classref-enumeration-constant
  1186. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
  1187. 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.
  1188. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
  1189. .. rst-class:: classref-enumeration-constant
  1190. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
  1191. 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.
  1192. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
  1193. .. rst-class:: classref-enumeration-constant
  1194. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
  1195. Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
  1196. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
  1197. .. rst-class:: classref-enumeration-constant
  1198. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
  1199. Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
  1200. .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
  1201. .. rst-class:: classref-enumeration-constant
  1202. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
  1203. Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
  1204. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
  1205. .. rst-class:: classref-enumeration-constant
  1206. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
  1207. Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
  1208. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
  1209. .. rst-class:: classref-enumeration-constant
  1210. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
  1211. Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
  1212. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
  1213. .. rst-class:: classref-enumeration-constant
  1214. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
  1215. Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
  1216. .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
  1217. .. rst-class:: classref-enumeration-constant
  1218. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
  1219. Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
  1220. .. rst-class:: classref-item-separator
  1221. ----
  1222. .. _enum_RenderingServer_ArrayFormat:
  1223. .. rst-class:: classref-enumeration
  1224. flags **ArrayFormat**: :ref:`🔗<enum_RenderingServer_ArrayFormat>`
  1225. .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
  1226. .. rst-class:: classref-enumeration-constant
  1227. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
  1228. Flag used to mark a vertex position array.
  1229. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
  1230. .. rst-class:: classref-enumeration-constant
  1231. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
  1232. Flag used to mark a normal array.
  1233. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
  1234. .. rst-class:: classref-enumeration-constant
  1235. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
  1236. Flag used to mark a tangent array.
  1237. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
  1238. .. rst-class:: classref-enumeration-constant
  1239. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
  1240. Flag used to mark a vertex color array.
  1241. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
  1242. .. rst-class:: classref-enumeration-constant
  1243. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
  1244. Flag used to mark a UV coordinates array.
  1245. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
  1246. .. rst-class:: classref-enumeration-constant
  1247. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
  1248. Flag used to mark a UV coordinates array for the second UV coordinates.
  1249. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
  1250. .. rst-class:: classref-enumeration-constant
  1251. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
  1252. Flag used to mark an array of custom per-vertex data for the first set of custom data.
  1253. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
  1254. .. rst-class:: classref-enumeration-constant
  1255. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
  1256. Flag used to mark an array of custom per-vertex data for the second set of custom data.
  1257. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
  1258. .. rst-class:: classref-enumeration-constant
  1259. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
  1260. Flag used to mark an array of custom per-vertex data for the third set of custom data.
  1261. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
  1262. .. rst-class:: classref-enumeration-constant
  1263. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
  1264. Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
  1265. .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
  1266. .. rst-class:: classref-enumeration-constant
  1267. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
  1268. Flag used to mark a bone information array.
  1269. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
  1270. .. rst-class:: classref-enumeration-constant
  1271. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
  1272. Flag used to mark a weights array.
  1273. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
  1274. .. rst-class:: classref-enumeration-constant
  1275. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
  1276. Flag used to mark an index array.
  1277. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
  1278. .. rst-class:: classref-enumeration-constant
  1279. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
  1280. .. container:: contribute
  1281. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1282. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
  1283. .. rst-class:: classref-enumeration-constant
  1284. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
  1285. .. container:: contribute
  1286. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1287. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
  1288. .. rst-class:: classref-enumeration-constant
  1289. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
  1290. .. container:: contribute
  1291. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1292. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
  1293. .. rst-class:: classref-enumeration-constant
  1294. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
  1295. .. container:: contribute
  1296. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1297. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
  1298. .. rst-class:: classref-enumeration-constant
  1299. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
  1300. .. container:: contribute
  1301. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1302. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
  1303. .. rst-class:: classref-enumeration-constant
  1304. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
  1305. .. container:: contribute
  1306. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1307. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
  1308. .. rst-class:: classref-enumeration-constant
  1309. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
  1310. .. container:: contribute
  1311. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1312. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
  1313. .. rst-class:: classref-enumeration-constant
  1314. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
  1315. .. container:: contribute
  1316. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1317. .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
  1318. .. rst-class:: classref-enumeration-constant
  1319. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
  1320. .. container:: contribute
  1321. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1322. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
  1323. .. rst-class:: classref-enumeration-constant
  1324. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
  1325. Flag used to mark that the array contains 2D vertices.
  1326. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
  1327. .. rst-class:: classref-enumeration-constant
  1328. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
  1329. .. container:: contribute
  1330. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1331. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
  1332. .. rst-class:: classref-enumeration-constant
  1333. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
  1334. Flag used to mark that the array uses 8 bone weights instead of 4.
  1335. .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
  1336. .. rst-class:: classref-enumeration-constant
  1337. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
  1338. Flag used to mark that the mesh does not have a vertex array and instead will infer vertex positions in the shader using indices and other information.
  1339. .. _class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES:
  1340. .. rst-class:: classref-enumeration-constant
  1341. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912``
  1342. Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can.
  1343. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE:
  1344. .. rst-class:: classref-enumeration-constant
  1345. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_BASE** = ``35``
  1346. Flag used to mark the start of the bits used to store the mesh version.
  1347. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT:
  1348. .. rst-class:: classref-enumeration-constant
  1349. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_SHIFT** = ``35``
  1350. Flag used to shift a mesh format int to bring the version into the lowest digits.
  1351. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1:
  1352. .. rst-class:: classref-enumeration-constant
  1353. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_1** = ``0``
  1354. Flag used to record the format used by prior mesh versions before the introduction of a version.
  1355. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2:
  1356. .. rst-class:: classref-enumeration-constant
  1357. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_2** = ``34359738368``
  1358. Flag used to record the second iteration of the mesh version flag. The primary difference between this and :ref:`ARRAY_FLAG_FORMAT_VERSION_1<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1>` is that this version supports :ref:`ARRAY_FLAG_COMPRESS_ATTRIBUTES<class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES>` and in this version vertex positions are de-interleaved from normals and tangents.
  1359. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_CURRENT_VERSION:
  1360. .. rst-class:: classref-enumeration-constant
  1361. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_CURRENT_VERSION** = ``34359738368``
  1362. Flag used to record the current version that the engine expects. Currently this is the same as :ref:`ARRAY_FLAG_FORMAT_VERSION_2<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2>`.
  1363. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_MASK:
  1364. .. rst-class:: classref-enumeration-constant
  1365. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_MASK** = ``255``
  1366. Flag used to isolate the bits used for mesh version after using :ref:`ARRAY_FLAG_FORMAT_VERSION_SHIFT<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT>` to shift them into place.
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _enum_RenderingServer_PrimitiveType:
  1370. .. rst-class:: classref-enumeration
  1371. enum **PrimitiveType**: :ref:`🔗<enum_RenderingServer_PrimitiveType>`
  1372. .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
  1373. .. rst-class:: classref-enumeration-constant
  1374. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
  1375. Primitive to draw consists of points.
  1376. .. _class_RenderingServer_constant_PRIMITIVE_LINES:
  1377. .. rst-class:: classref-enumeration-constant
  1378. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
  1379. Primitive to draw consists of lines.
  1380. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
  1381. .. rst-class:: classref-enumeration-constant
  1382. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
  1383. Primitive to draw consists of a line strip from start to end.
  1384. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
  1385. .. rst-class:: classref-enumeration-constant
  1386. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
  1387. Primitive to draw consists of triangles.
  1388. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
  1389. .. rst-class:: classref-enumeration-constant
  1390. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
  1391. Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  1392. .. _class_RenderingServer_constant_PRIMITIVE_MAX:
  1393. .. rst-class:: classref-enumeration-constant
  1394. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
  1395. Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
  1396. .. rst-class:: classref-item-separator
  1397. ----
  1398. .. _enum_RenderingServer_BlendShapeMode:
  1399. .. rst-class:: classref-enumeration
  1400. enum **BlendShapeMode**: :ref:`🔗<enum_RenderingServer_BlendShapeMode>`
  1401. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
  1402. .. rst-class:: classref-enumeration-constant
  1403. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
  1404. Blend shapes are normalized.
  1405. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
  1406. .. rst-class:: classref-enumeration-constant
  1407. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
  1408. Blend shapes are relative to base weight.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _enum_RenderingServer_MultimeshTransformFormat:
  1412. .. rst-class:: classref-enumeration
  1413. enum **MultimeshTransformFormat**: :ref:`🔗<enum_RenderingServer_MultimeshTransformFormat>`
  1414. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
  1417. Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
  1418. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
  1421. Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
  1422. .. rst-class:: classref-item-separator
  1423. ----
  1424. .. _enum_RenderingServer_LightProjectorFilter:
  1425. .. rst-class:: classref-enumeration
  1426. enum **LightProjectorFilter**: :ref:`🔗<enum_RenderingServer_LightProjectorFilter>`
  1427. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
  1428. .. rst-class:: classref-enumeration-constant
  1429. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
  1430. 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.
  1431. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
  1432. .. rst-class:: classref-enumeration-constant
  1433. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
  1434. 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.
  1435. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
  1436. .. rst-class:: classref-enumeration-constant
  1437. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
  1438. 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.
  1439. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
  1440. .. rst-class:: classref-enumeration-constant
  1441. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
  1442. 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.
  1443. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1444. .. rst-class:: classref-enumeration-constant
  1445. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1446. 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>`.
  1447. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1448. .. rst-class:: classref-enumeration-constant
  1449. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1450. 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>`.
  1451. .. rst-class:: classref-item-separator
  1452. ----
  1453. .. _enum_RenderingServer_LightType:
  1454. .. rst-class:: classref-enumeration
  1455. enum **LightType**: :ref:`🔗<enum_RenderingServer_LightType>`
  1456. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
  1457. .. rst-class:: classref-enumeration-constant
  1458. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
  1459. Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
  1460. .. _class_RenderingServer_constant_LIGHT_OMNI:
  1461. .. rst-class:: classref-enumeration-constant
  1462. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
  1463. Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
  1464. .. _class_RenderingServer_constant_LIGHT_SPOT:
  1465. .. rst-class:: classref-enumeration-constant
  1466. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
  1467. Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
  1468. .. rst-class:: classref-item-separator
  1469. ----
  1470. .. _enum_RenderingServer_LightParam:
  1471. .. rst-class:: classref-enumeration
  1472. enum **LightParam**: :ref:`🔗<enum_RenderingServer_LightParam>`
  1473. .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
  1474. .. rst-class:: classref-enumeration-constant
  1475. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
  1476. The light's energy multiplier.
  1477. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
  1478. .. rst-class:: classref-enumeration-constant
  1479. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
  1480. 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>`).
  1481. .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
  1482. .. rst-class:: classref-enumeration-constant
  1483. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
  1484. 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>`).
  1485. .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
  1486. .. rst-class:: classref-enumeration-constant
  1487. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
  1488. The light's influence on specularity.
  1489. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
  1490. .. rst-class:: classref-enumeration-constant
  1491. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
  1492. The light's range.
  1493. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
  1494. .. rst-class:: classref-enumeration-constant
  1495. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
  1496. The size of the light when using spot light or omni light. The angular size of the light when using directional light.
  1497. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
  1498. .. rst-class:: classref-enumeration-constant
  1499. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
  1500. The light's attenuation.
  1501. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
  1502. .. rst-class:: classref-enumeration-constant
  1503. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
  1504. The spotlight's angle.
  1505. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
  1506. .. rst-class:: classref-enumeration-constant
  1507. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
  1508. The spotlight's attenuation.
  1509. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
  1510. .. rst-class:: classref-enumeration-constant
  1511. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
  1512. 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).
  1513. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
  1514. .. rst-class:: classref-enumeration-constant
  1515. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
  1516. Proportion of shadow atlas occupied by the first split.
  1517. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
  1518. .. rst-class:: classref-enumeration-constant
  1519. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
  1520. Proportion of shadow atlas occupied by the second split.
  1521. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
  1522. .. rst-class:: classref-enumeration-constant
  1523. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
  1524. Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
  1525. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
  1526. .. rst-class:: classref-enumeration-constant
  1527. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
  1528. Proportion of shadow max distance where the shadow will start to fade out.
  1529. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
  1530. .. rst-class:: classref-enumeration-constant
  1531. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
  1532. Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
  1533. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
  1534. .. rst-class:: classref-enumeration-constant
  1535. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
  1536. Bias the shadow lookup to fix self-shadowing artifacts.
  1537. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
  1538. .. rst-class:: classref-enumeration-constant
  1539. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
  1540. 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.
  1541. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
  1542. .. rst-class:: classref-enumeration-constant
  1543. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
  1544. 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.
  1545. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
  1546. .. rst-class:: classref-enumeration-constant
  1547. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
  1548. 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.
  1549. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
  1550. .. rst-class:: classref-enumeration-constant
  1551. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
  1552. .. container:: contribute
  1553. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1554. .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
  1555. .. rst-class:: classref-enumeration-constant
  1556. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
  1557. 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``.
  1558. .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
  1559. .. rst-class:: classref-enumeration-constant
  1560. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
  1561. Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
  1562. .. rst-class:: classref-item-separator
  1563. ----
  1564. .. _enum_RenderingServer_LightBakeMode:
  1565. .. rst-class:: classref-enumeration
  1566. enum **LightBakeMode**: :ref:`🔗<enum_RenderingServer_LightBakeMode>`
  1567. .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
  1568. .. rst-class:: classref-enumeration-constant
  1569. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
  1570. 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.
  1571. .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
  1572. .. rst-class:: classref-enumeration-constant
  1573. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
  1574. 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.
  1575. .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
  1576. .. rst-class:: classref-enumeration-constant
  1577. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
  1578. 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>`.
  1579. .. rst-class:: classref-item-separator
  1580. ----
  1581. .. _enum_RenderingServer_LightOmniShadowMode:
  1582. .. rst-class:: classref-enumeration
  1583. enum **LightOmniShadowMode**: :ref:`🔗<enum_RenderingServer_LightOmniShadowMode>`
  1584. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
  1585. .. rst-class:: classref-enumeration-constant
  1586. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
  1587. Use a dual paraboloid shadow map for omni lights.
  1588. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
  1589. .. rst-class:: classref-enumeration-constant
  1590. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
  1591. Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
  1592. .. rst-class:: classref-item-separator
  1593. ----
  1594. .. _enum_RenderingServer_LightDirectionalShadowMode:
  1595. .. rst-class:: classref-enumeration
  1596. enum **LightDirectionalShadowMode**: :ref:`🔗<enum_RenderingServer_LightDirectionalShadowMode>`
  1597. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
  1598. .. rst-class:: classref-enumeration-constant
  1599. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
  1600. Use orthogonal shadow projection for directional light.
  1601. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
  1602. .. rst-class:: classref-enumeration-constant
  1603. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
  1604. Use 2 splits for shadow projection when using directional light.
  1605. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
  1606. .. rst-class:: classref-enumeration-constant
  1607. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
  1608. Use 4 splits for shadow projection when using directional light.
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _enum_RenderingServer_LightDirectionalSkyMode:
  1612. .. rst-class:: classref-enumeration
  1613. enum **LightDirectionalSkyMode**: :ref:`🔗<enum_RenderingServer_LightDirectionalSkyMode>`
  1614. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
  1615. .. rst-class:: classref-enumeration-constant
  1616. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
  1617. Use DirectionalLight3D in both sky rendering and scene lighting.
  1618. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
  1619. .. rst-class:: classref-enumeration-constant
  1620. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
  1621. Only use DirectionalLight3D in scene lighting.
  1622. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
  1623. .. rst-class:: classref-enumeration-constant
  1624. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
  1625. Only use DirectionalLight3D in sky rendering.
  1626. .. rst-class:: classref-item-separator
  1627. ----
  1628. .. _enum_RenderingServer_ShadowQuality:
  1629. .. rst-class:: classref-enumeration
  1630. enum **ShadowQuality**: :ref:`🔗<enum_RenderingServer_ShadowQuality>`
  1631. .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
  1632. .. rst-class:: classref-enumeration-constant
  1633. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
  1634. 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``.
  1635. \ **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.
  1636. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
  1637. .. rst-class:: classref-enumeration-constant
  1638. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
  1639. 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``).
  1640. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
  1641. .. rst-class:: classref-enumeration-constant
  1642. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
  1643. Low shadow filtering quality (fast).
  1644. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
  1645. .. rst-class:: classref-enumeration-constant
  1646. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
  1647. Medium low shadow filtering quality (average).
  1648. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
  1649. .. rst-class:: classref-enumeration-constant
  1650. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
  1651. 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``).
  1652. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
  1653. .. rst-class:: classref-enumeration-constant
  1654. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
  1655. 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``).
  1656. .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
  1657. .. rst-class:: classref-enumeration-constant
  1658. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
  1659. Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _enum_RenderingServer_ReflectionProbeUpdateMode:
  1663. .. rst-class:: classref-enumeration
  1664. enum **ReflectionProbeUpdateMode**: :ref:`🔗<enum_RenderingServer_ReflectionProbeUpdateMode>`
  1665. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
  1666. .. rst-class:: classref-enumeration-constant
  1667. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
  1668. Reflection probe will update reflections once and then stop.
  1669. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
  1670. .. rst-class:: classref-enumeration-constant
  1671. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
  1672. Reflection probe will update each frame. This mode is necessary to capture moving objects.
  1673. .. rst-class:: classref-item-separator
  1674. ----
  1675. .. _enum_RenderingServer_ReflectionProbeAmbientMode:
  1676. .. rst-class:: classref-enumeration
  1677. enum **ReflectionProbeAmbientMode**: :ref:`🔗<enum_RenderingServer_ReflectionProbeAmbientMode>`
  1678. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
  1679. .. rst-class:: classref-enumeration-constant
  1680. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
  1681. Do not apply any ambient lighting inside the reflection probe's box defined by its size.
  1682. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
  1683. .. rst-class:: classref-enumeration-constant
  1684. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
  1685. Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
  1686. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
  1687. .. rst-class:: classref-enumeration-constant
  1688. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
  1689. 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>`.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _enum_RenderingServer_DecalTexture:
  1693. .. rst-class:: classref-enumeration
  1694. enum **DecalTexture**: :ref:`🔗<enum_RenderingServer_DecalTexture>`
  1695. .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
  1696. .. rst-class:: classref-enumeration-constant
  1697. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
  1698. Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
  1699. .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
  1700. .. rst-class:: classref-enumeration-constant
  1701. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
  1702. Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
  1703. .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
  1704. .. rst-class:: classref-enumeration-constant
  1705. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
  1706. Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
  1707. .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
  1708. .. rst-class:: classref-enumeration-constant
  1709. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
  1710. Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
  1711. .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
  1712. .. rst-class:: classref-enumeration-constant
  1713. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
  1714. Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _enum_RenderingServer_DecalFilter:
  1718. .. rst-class:: classref-enumeration
  1719. enum **DecalFilter**: :ref:`🔗<enum_RenderingServer_DecalFilter>`
  1720. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
  1721. .. rst-class:: classref-enumeration-constant
  1722. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
  1723. 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.
  1724. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
  1725. .. rst-class:: classref-enumeration-constant
  1726. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
  1727. 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.
  1728. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
  1729. .. rst-class:: classref-enumeration-constant
  1730. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
  1731. 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.
  1732. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
  1733. .. rst-class:: classref-enumeration-constant
  1734. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
  1735. 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.
  1736. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1737. .. rst-class:: classref-enumeration-constant
  1738. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1739. 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>`.
  1740. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1741. .. rst-class:: classref-enumeration-constant
  1742. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1743. 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>`.
  1744. .. rst-class:: classref-item-separator
  1745. ----
  1746. .. _enum_RenderingServer_VoxelGIQuality:
  1747. .. rst-class:: classref-enumeration
  1748. enum **VoxelGIQuality**: :ref:`🔗<enum_RenderingServer_VoxelGIQuality>`
  1749. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
  1750. .. rst-class:: classref-enumeration-constant
  1751. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
  1752. Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
  1753. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
  1754. .. rst-class:: classref-enumeration-constant
  1755. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
  1756. High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
  1757. .. rst-class:: classref-item-separator
  1758. ----
  1759. .. _enum_RenderingServer_ParticlesMode:
  1760. .. rst-class:: classref-enumeration
  1761. enum **ParticlesMode**: :ref:`🔗<enum_RenderingServer_ParticlesMode>`
  1762. .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
  1763. .. rst-class:: classref-enumeration-constant
  1764. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
  1765. 2D particles.
  1766. .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
  1767. .. rst-class:: classref-enumeration-constant
  1768. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
  1769. 3D particles.
  1770. .. rst-class:: classref-item-separator
  1771. ----
  1772. .. _enum_RenderingServer_ParticlesTransformAlign:
  1773. .. rst-class:: classref-enumeration
  1774. enum **ParticlesTransformAlign**: :ref:`🔗<enum_RenderingServer_ParticlesTransformAlign>`
  1775. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
  1776. .. rst-class:: classref-enumeration-constant
  1777. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
  1778. .. container:: contribute
  1779. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1780. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
  1781. .. rst-class:: classref-enumeration-constant
  1782. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
  1783. .. container:: contribute
  1784. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1785. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
  1786. .. rst-class:: classref-enumeration-constant
  1787. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
  1788. .. container:: contribute
  1789. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1790. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
  1791. .. rst-class:: classref-enumeration-constant
  1792. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
  1793. .. container:: contribute
  1794. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _enum_RenderingServer_ParticlesDrawOrder:
  1798. .. rst-class:: classref-enumeration
  1799. enum **ParticlesDrawOrder**: :ref:`🔗<enum_RenderingServer_ParticlesDrawOrder>`
  1800. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
  1801. .. rst-class:: classref-enumeration-constant
  1802. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
  1803. Draw particles in the order that they appear in the particles array.
  1804. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
  1805. .. rst-class:: classref-enumeration-constant
  1806. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
  1807. Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front.
  1808. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
  1809. .. rst-class:: classref-enumeration-constant
  1810. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
  1811. Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front.
  1812. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
  1813. .. rst-class:: classref-enumeration-constant
  1814. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
  1815. Sort particles based on their distance to the camera.
  1816. .. rst-class:: classref-item-separator
  1817. ----
  1818. .. _enum_RenderingServer_ParticlesCollisionType:
  1819. .. rst-class:: classref-enumeration
  1820. enum **ParticlesCollisionType**: :ref:`🔗<enum_RenderingServer_ParticlesCollisionType>`
  1821. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1822. .. rst-class:: classref-enumeration-constant
  1823. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
  1824. .. container:: contribute
  1825. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1826. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
  1827. .. rst-class:: classref-enumeration-constant
  1828. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
  1829. .. container:: contribute
  1830. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1831. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
  1832. .. rst-class:: classref-enumeration-constant
  1833. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
  1834. .. container:: contribute
  1835. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1836. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
  1837. .. rst-class:: classref-enumeration-constant
  1838. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
  1839. .. container:: contribute
  1840. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1841. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
  1842. .. rst-class:: classref-enumeration-constant
  1843. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
  1844. .. container:: contribute
  1845. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1846. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
  1847. .. rst-class:: classref-enumeration-constant
  1848. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
  1849. .. container:: contribute
  1850. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1851. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
  1852. .. rst-class:: classref-enumeration-constant
  1853. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
  1854. .. container:: contribute
  1855. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1856. .. rst-class:: classref-item-separator
  1857. ----
  1858. .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
  1859. .. rst-class:: classref-enumeration
  1860. enum **ParticlesCollisionHeightfieldResolution**: :ref:`🔗<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`
  1861. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
  1862. .. rst-class:: classref-enumeration-constant
  1863. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
  1864. .. container:: contribute
  1865. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1866. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
  1867. .. rst-class:: classref-enumeration-constant
  1868. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
  1869. .. container:: contribute
  1870. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1871. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
  1872. .. rst-class:: classref-enumeration-constant
  1873. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
  1874. .. container:: contribute
  1875. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1876. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
  1877. .. rst-class:: classref-enumeration-constant
  1878. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
  1879. .. container:: contribute
  1880. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1881. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
  1882. .. rst-class:: classref-enumeration-constant
  1883. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
  1884. .. container:: contribute
  1885. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1886. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
  1887. .. rst-class:: classref-enumeration-constant
  1888. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
  1889. .. container:: contribute
  1890. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1891. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
  1892. .. rst-class:: classref-enumeration-constant
  1893. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
  1894. Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
  1895. .. rst-class:: classref-item-separator
  1896. ----
  1897. .. _enum_RenderingServer_FogVolumeShape:
  1898. .. rst-class:: classref-enumeration
  1899. enum **FogVolumeShape**: :ref:`🔗<enum_RenderingServer_FogVolumeShape>`
  1900. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
  1901. .. rst-class:: classref-enumeration-constant
  1902. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
  1903. :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
  1904. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
  1905. .. rst-class:: classref-enumeration-constant
  1906. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
  1907. :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).
  1908. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
  1909. .. rst-class:: classref-enumeration-constant
  1910. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
  1911. :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).
  1912. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
  1913. .. rst-class:: classref-enumeration-constant
  1914. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
  1915. :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
  1916. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
  1917. .. rst-class:: classref-enumeration-constant
  1918. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
  1919. :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
  1920. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
  1921. .. rst-class:: classref-enumeration-constant
  1922. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
  1923. Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
  1924. .. rst-class:: classref-item-separator
  1925. ----
  1926. .. _enum_RenderingServer_ViewportScaling3DMode:
  1927. .. rst-class:: classref-enumeration
  1928. enum **ViewportScaling3DMode**: :ref:`🔗<enum_RenderingServer_ViewportScaling3DMode>`
  1929. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
  1930. .. rst-class:: classref-enumeration-constant
  1931. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
  1932. 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.
  1933. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
  1934. .. rst-class:: classref-enumeration-constant
  1935. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
  1936. 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.
  1937. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2:
  1938. .. rst-class:: classref-enumeration-constant
  1939. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2``
  1940. Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution.
  1941. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
  1942. .. rst-class:: classref-enumeration-constant
  1943. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``3``
  1944. Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
  1945. .. rst-class:: classref-item-separator
  1946. ----
  1947. .. _enum_RenderingServer_ViewportUpdateMode:
  1948. .. rst-class:: classref-enumeration
  1949. enum **ViewportUpdateMode**: :ref:`🔗<enum_RenderingServer_ViewportUpdateMode>`
  1950. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
  1951. .. rst-class:: classref-enumeration-constant
  1952. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
  1953. Do not update the viewport's render target.
  1954. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
  1955. .. rst-class:: classref-enumeration-constant
  1956. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
  1957. Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
  1958. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
  1959. .. rst-class:: classref-enumeration-constant
  1960. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
  1961. Update the viewport's render target only when it is visible. This is the default value.
  1962. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
  1963. .. rst-class:: classref-enumeration-constant
  1964. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
  1965. Update the viewport's render target only when its parent is visible.
  1966. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
  1967. .. rst-class:: classref-enumeration-constant
  1968. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
  1969. Always update the viewport's render target.
  1970. .. rst-class:: classref-item-separator
  1971. ----
  1972. .. _enum_RenderingServer_ViewportClearMode:
  1973. .. rst-class:: classref-enumeration
  1974. enum **ViewportClearMode**: :ref:`🔗<enum_RenderingServer_ViewportClearMode>`
  1975. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
  1976. .. rst-class:: classref-enumeration-constant
  1977. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
  1978. Always clear the viewport's render target before drawing.
  1979. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
  1980. .. rst-class:: classref-enumeration-constant
  1981. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
  1982. Never clear the viewport's render target.
  1983. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
  1984. .. rst-class:: classref-enumeration-constant
  1985. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
  1986. Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
  1987. .. rst-class:: classref-item-separator
  1988. ----
  1989. .. _enum_RenderingServer_ViewportEnvironmentMode:
  1990. .. rst-class:: classref-enumeration
  1991. enum **ViewportEnvironmentMode**: :ref:`🔗<enum_RenderingServer_ViewportEnvironmentMode>`
  1992. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
  1993. .. rst-class:: classref-enumeration-constant
  1994. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
  1995. Disable rendering of 3D environment over 2D canvas.
  1996. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
  1997. .. rst-class:: classref-enumeration-constant
  1998. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
  1999. Enable rendering of 3D environment over 2D canvas.
  2000. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
  2001. .. rst-class:: classref-enumeration-constant
  2002. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
  2003. 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>`.
  2004. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
  2005. .. rst-class:: classref-enumeration-constant
  2006. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
  2007. Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
  2008. .. rst-class:: classref-item-separator
  2009. ----
  2010. .. _enum_RenderingServer_ViewportSDFOversize:
  2011. .. rst-class:: classref-enumeration
  2012. enum **ViewportSDFOversize**: :ref:`🔗<enum_RenderingServer_ViewportSDFOversize>`
  2013. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
  2014. .. rst-class:: classref-enumeration-constant
  2015. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
  2016. 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.
  2017. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
  2018. .. rst-class:: classref-enumeration-constant
  2019. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
  2020. 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2021. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
  2022. .. rst-class:: classref-enumeration-constant
  2023. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
  2024. 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2025. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
  2026. .. rst-class:: classref-enumeration-constant
  2027. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
  2028. 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.
  2029. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
  2030. .. rst-class:: classref-enumeration-constant
  2031. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
  2032. Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
  2033. .. rst-class:: classref-item-separator
  2034. ----
  2035. .. _enum_RenderingServer_ViewportSDFScale:
  2036. .. rst-class:: classref-enumeration
  2037. enum **ViewportSDFScale**: :ref:`🔗<enum_RenderingServer_ViewportSDFScale>`
  2038. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
  2039. .. rst-class:: classref-enumeration-constant
  2040. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
  2041. Full resolution 2D signed distance field scale. This has the highest GPU requirements.
  2042. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
  2043. .. rst-class:: classref-enumeration-constant
  2044. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
  2045. Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
  2046. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
  2047. .. rst-class:: classref-enumeration-constant
  2048. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
  2049. Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
  2050. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
  2051. .. rst-class:: classref-enumeration-constant
  2052. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
  2053. Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
  2054. .. rst-class:: classref-item-separator
  2055. ----
  2056. .. _enum_RenderingServer_ViewportMSAA:
  2057. .. rst-class:: classref-enumeration
  2058. enum **ViewportMSAA**: :ref:`🔗<enum_RenderingServer_ViewportMSAA>`
  2059. .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
  2060. .. rst-class:: classref-enumeration-constant
  2061. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
  2062. Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
  2063. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
  2064. .. rst-class:: classref-enumeration-constant
  2065. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
  2066. Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
  2067. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
  2068. .. rst-class:: classref-enumeration-constant
  2069. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
  2070. Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
  2071. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
  2072. .. rst-class:: classref-enumeration-constant
  2073. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
  2074. 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.
  2075. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
  2076. .. rst-class:: classref-enumeration-constant
  2077. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
  2078. Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
  2079. .. rst-class:: classref-item-separator
  2080. ----
  2081. .. _enum_RenderingServer_ViewportScreenSpaceAA:
  2082. .. rst-class:: classref-enumeration
  2083. enum **ViewportScreenSpaceAA**: :ref:`🔗<enum_RenderingServer_ViewportScreenSpaceAA>`
  2084. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
  2085. .. rst-class:: classref-enumeration-constant
  2086. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
  2087. Do not perform any antialiasing in the full screen post-process.
  2088. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
  2089. .. rst-class:: classref-enumeration-constant
  2090. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
  2091. 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.
  2092. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
  2093. .. rst-class:: classref-enumeration-constant
  2094. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2``
  2095. Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
  2096. .. rst-class:: classref-item-separator
  2097. ----
  2098. .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
  2099. .. rst-class:: classref-enumeration
  2100. enum **ViewportOcclusionCullingBuildQuality**: :ref:`🔗<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`
  2101. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
  2102. .. rst-class:: classref-enumeration-constant
  2103. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
  2104. Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
  2105. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
  2106. .. rst-class:: classref-enumeration-constant
  2107. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
  2108. Medium occlusion culling BVH build quality (as defined by Embree).
  2109. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
  2110. .. rst-class:: classref-enumeration-constant
  2111. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
  2112. High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
  2113. .. rst-class:: classref-item-separator
  2114. ----
  2115. .. _enum_RenderingServer_ViewportRenderInfo:
  2116. .. rst-class:: classref-enumeration
  2117. enum **ViewportRenderInfo**: :ref:`🔗<enum_RenderingServer_ViewportRenderInfo>`
  2118. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
  2119. .. rst-class:: classref-enumeration-constant
  2120. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
  2121. Number of objects drawn in a single frame.
  2122. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
  2123. .. rst-class:: classref-enumeration-constant
  2124. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
  2125. Number of points, lines, or triangles drawn in a single frame.
  2126. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
  2127. .. rst-class:: classref-enumeration-constant
  2128. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
  2129. Number of draw calls during this frame.
  2130. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
  2131. .. rst-class:: classref-enumeration-constant
  2132. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
  2133. Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
  2134. .. rst-class:: classref-item-separator
  2135. ----
  2136. .. _enum_RenderingServer_ViewportRenderInfoType:
  2137. .. rst-class:: classref-enumeration
  2138. enum **ViewportRenderInfoType**: :ref:`🔗<enum_RenderingServer_ViewportRenderInfoType>`
  2139. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
  2140. .. rst-class:: classref-enumeration-constant
  2141. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
  2142. Visible render pass (excluding shadows).
  2143. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
  2144. .. rst-class:: classref-enumeration-constant
  2145. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
  2146. 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.
  2147. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_CANVAS:
  2148. .. rst-class:: classref-enumeration-constant
  2149. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_CANVAS** = ``2``
  2150. Canvas item rendering. This includes all 2D rendering.
  2151. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
  2152. .. rst-class:: classref-enumeration-constant
  2153. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``3``
  2154. Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
  2155. .. rst-class:: classref-item-separator
  2156. ----
  2157. .. _enum_RenderingServer_ViewportDebugDraw:
  2158. .. rst-class:: classref-enumeration
  2159. enum **ViewportDebugDraw**: :ref:`🔗<enum_RenderingServer_ViewportDebugDraw>`
  2160. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
  2161. .. rst-class:: classref-enumeration-constant
  2162. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
  2163. Debug draw is disabled. Default setting.
  2164. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
  2165. .. rst-class:: classref-enumeration-constant
  2166. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
  2167. Objects are displayed without light information.
  2168. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
  2169. .. rst-class:: classref-enumeration-constant
  2170. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
  2171. Objects are displayed with only light information.
  2172. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
  2173. .. rst-class:: classref-enumeration-constant
  2174. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
  2175. 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.
  2176. \ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
  2177. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
  2178. .. rst-class:: classref-enumeration-constant
  2179. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
  2180. Debug draw draws objects in wireframe.
  2181. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
  2182. .. rst-class:: classref-enumeration-constant
  2183. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
  2184. Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
  2185. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
  2186. .. rst-class:: classref-enumeration-constant
  2187. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
  2188. Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2189. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
  2190. .. rst-class:: classref-enumeration-constant
  2191. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
  2192. Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2193. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
  2194. .. rst-class:: classref-enumeration-constant
  2195. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
  2196. Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2197. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
  2198. .. rst-class:: classref-enumeration-constant
  2199. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
  2200. 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>`.
  2201. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
  2202. .. rst-class:: classref-enumeration-constant
  2203. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
  2204. Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2205. The slice of the camera frustum related to the shadow map cascade is superimposed to visualize coverage. The color of each slice matches the colors used for :ref:`VIEWPORT_DEBUG_DRAW_PSSM_SPLITS<class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS>`. When shadow cascades are blended the overlap is taken into account when drawing the frustum slices.
  2206. The last cascade shows all frustum slices to illustrate the coverage of all slices.
  2207. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
  2208. .. rst-class:: classref-enumeration-constant
  2209. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
  2210. Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
  2211. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
  2212. .. rst-class:: classref-enumeration-constant
  2213. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
  2214. 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>`.
  2215. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
  2216. .. rst-class:: classref-enumeration-constant
  2217. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
  2218. 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>`.
  2219. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
  2220. .. rst-class:: classref-enumeration-constant
  2221. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
  2222. 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.
  2223. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
  2224. .. rst-class:: classref-enumeration-constant
  2225. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
  2226. Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
  2227. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
  2228. .. rst-class:: classref-enumeration-constant
  2229. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
  2230. Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
  2231. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
  2232. .. rst-class:: classref-enumeration-constant
  2233. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
  2234. Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
  2235. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
  2236. .. rst-class:: classref-enumeration-constant
  2237. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
  2238. Draws the global illumination buffer (:ref:`VoxelGI<class_VoxelGI>` or SDFGI).
  2239. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
  2240. .. rst-class:: classref-enumeration-constant
  2241. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
  2242. Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
  2243. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
  2244. .. rst-class:: classref-enumeration-constant
  2245. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
  2246. 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.
  2247. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
  2248. .. rst-class:: classref-enumeration-constant
  2249. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
  2250. 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.
  2251. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
  2252. .. rst-class:: classref-enumeration-constant
  2253. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
  2254. 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.
  2255. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
  2256. .. rst-class:: classref-enumeration-constant
  2257. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
  2258. 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.
  2259. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
  2260. .. rst-class:: classref-enumeration-constant
  2261. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
  2262. 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.
  2263. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
  2264. .. rst-class:: classref-enumeration-constant
  2265. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
  2266. Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
  2267. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER:
  2268. .. rst-class:: classref-enumeration-constant
  2269. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26``
  2270. Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
  2271. .. rst-class:: classref-item-separator
  2272. ----
  2273. .. _enum_RenderingServer_ViewportVRSMode:
  2274. .. rst-class:: classref-enumeration
  2275. enum **ViewportVRSMode**: :ref:`🔗<enum_RenderingServer_ViewportVRSMode>`
  2276. .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
  2277. .. rst-class:: classref-enumeration-constant
  2278. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
  2279. Variable rate shading is disabled.
  2280. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
  2281. .. rst-class:: classref-enumeration-constant
  2282. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
  2283. Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
  2284. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
  2285. .. rst-class:: classref-enumeration-constant
  2286. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
  2287. Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`. Note that this may override the update mode.
  2288. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
  2289. .. rst-class:: classref-enumeration-constant
  2290. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
  2291. Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
  2292. .. rst-class:: classref-item-separator
  2293. ----
  2294. .. _enum_RenderingServer_ViewportVRSUpdateMode:
  2295. .. rst-class:: classref-enumeration
  2296. enum **ViewportVRSUpdateMode**: :ref:`🔗<enum_RenderingServer_ViewportVRSUpdateMode>`
  2297. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED:
  2298. .. rst-class:: classref-enumeration-constant
  2299. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_DISABLED** = ``0``
  2300. The input texture for variable rate shading will not be processed.
  2301. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE:
  2302. .. rst-class:: classref-enumeration-constant
  2303. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ONCE** = ``1``
  2304. The input texture for variable rate shading will be processed once.
  2305. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ALWAYS:
  2306. .. rst-class:: classref-enumeration-constant
  2307. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ALWAYS** = ``2``
  2308. The input texture for variable rate shading will be processed each frame.
  2309. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_MAX:
  2310. .. rst-class:: classref-enumeration-constant
  2311. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_MAX** = ``3``
  2312. Represents the size of the :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` enum.
  2313. .. rst-class:: classref-item-separator
  2314. ----
  2315. .. _enum_RenderingServer_SkyMode:
  2316. .. rst-class:: classref-enumeration
  2317. enum **SkyMode**: :ref:`🔗<enum_RenderingServer_SkyMode>`
  2318. .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
  2319. .. rst-class:: classref-enumeration-constant
  2320. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
  2321. 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>`.
  2322. .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
  2323. .. rst-class:: classref-enumeration-constant
  2324. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
  2325. 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>`.
  2326. .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
  2327. .. rst-class:: classref-enumeration-constant
  2328. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
  2329. 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.
  2330. .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
  2331. .. rst-class:: classref-enumeration-constant
  2332. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
  2333. 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>`.
  2334. \ **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.
  2335. .. rst-class:: classref-item-separator
  2336. ----
  2337. .. _enum_RenderingServer_CompositorEffectFlags:
  2338. .. rst-class:: classref-enumeration
  2339. enum **CompositorEffectFlags**: :ref:`🔗<enum_RenderingServer_CompositorEffectFlags>`
  2340. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR:
  2341. .. rst-class:: classref-enumeration-constant
  2342. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR** = ``1``
  2343. The rendering effect requires the color buffer to be resolved if MSAA is enabled.
  2344. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH:
  2345. .. rst-class:: classref-enumeration-constant
  2346. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH** = ``2``
  2347. The rendering effect requires the depth buffer to be resolved if MSAA is enabled.
  2348. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS:
  2349. .. rst-class:: classref-enumeration-constant
  2350. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS** = ``4``
  2351. The rendering effect requires motion vectors to be produced.
  2352. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS:
  2353. .. rst-class:: classref-enumeration-constant
  2354. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS** = ``8``
  2355. The rendering effect requires normals and roughness g-buffer to be produced (Forward+ only).
  2356. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR:
  2357. .. rst-class:: classref-enumeration-constant
  2358. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR** = ``16``
  2359. The rendering effect requires specular data to be separated out (Forward+ only).
  2360. .. rst-class:: classref-item-separator
  2361. ----
  2362. .. _enum_RenderingServer_CompositorEffectCallbackType:
  2363. .. rst-class:: classref-enumeration
  2364. enum **CompositorEffectCallbackType**: :ref:`🔗<enum_RenderingServer_CompositorEffectCallbackType>`
  2365. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE:
  2366. .. rst-class:: classref-enumeration-constant
  2367. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0``
  2368. The callback is called before our opaque rendering pass, but after depth prepass (if applicable).
  2369. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE:
  2370. .. rst-class:: classref-enumeration-constant
  2371. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1``
  2372. The callback is called after our opaque rendering pass, but before our sky is rendered.
  2373. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY:
  2374. .. rst-class:: classref-enumeration-constant
  2375. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY** = ``2``
  2376. The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections).
  2377. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT:
  2378. .. rst-class:: classref-enumeration-constant
  2379. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3``
  2380. The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.
  2381. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT:
  2382. .. rst-class:: classref-enumeration-constant
  2383. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4``
  2384. The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target.
  2385. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY:
  2386. .. rst-class:: classref-enumeration-constant
  2387. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY** = ``-1``
  2388. .. container:: contribute
  2389. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2390. .. rst-class:: classref-item-separator
  2391. ----
  2392. .. _enum_RenderingServer_EnvironmentBG:
  2393. .. rst-class:: classref-enumeration
  2394. enum **EnvironmentBG**: :ref:`🔗<enum_RenderingServer_EnvironmentBG>`
  2395. .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
  2396. .. rst-class:: classref-enumeration-constant
  2397. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
  2398. Use the clear color as background.
  2399. .. _class_RenderingServer_constant_ENV_BG_COLOR:
  2400. .. rst-class:: classref-enumeration-constant
  2401. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
  2402. Use a specified color as the background.
  2403. .. _class_RenderingServer_constant_ENV_BG_SKY:
  2404. .. rst-class:: classref-enumeration-constant
  2405. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
  2406. Use a sky resource for the background.
  2407. .. _class_RenderingServer_constant_ENV_BG_CANVAS:
  2408. .. rst-class:: classref-enumeration-constant
  2409. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
  2410. Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
  2411. .. _class_RenderingServer_constant_ENV_BG_KEEP:
  2412. .. rst-class:: classref-enumeration-constant
  2413. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
  2414. Do not clear the background, use whatever was rendered last frame as the background.
  2415. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
  2416. .. rst-class:: classref-enumeration-constant
  2417. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
  2418. Displays a camera feed in the background.
  2419. .. _class_RenderingServer_constant_ENV_BG_MAX:
  2420. .. rst-class:: classref-enumeration-constant
  2421. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
  2422. Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
  2423. .. rst-class:: classref-item-separator
  2424. ----
  2425. .. _enum_RenderingServer_EnvironmentAmbientSource:
  2426. .. rst-class:: classref-enumeration
  2427. enum **EnvironmentAmbientSource**: :ref:`🔗<enum_RenderingServer_EnvironmentAmbientSource>`
  2428. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
  2429. .. rst-class:: classref-enumeration-constant
  2430. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
  2431. Gather ambient light from whichever source is specified as the background.
  2432. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
  2433. .. rst-class:: classref-enumeration-constant
  2434. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
  2435. Disable ambient light.
  2436. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
  2437. .. rst-class:: classref-enumeration-constant
  2438. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
  2439. Specify a specific :ref:`Color<class_Color>` for ambient light.
  2440. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
  2441. .. rst-class:: classref-enumeration-constant
  2442. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
  2443. Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
  2444. .. rst-class:: classref-item-separator
  2445. ----
  2446. .. _enum_RenderingServer_EnvironmentReflectionSource:
  2447. .. rst-class:: classref-enumeration
  2448. enum **EnvironmentReflectionSource**: :ref:`🔗<enum_RenderingServer_EnvironmentReflectionSource>`
  2449. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
  2450. .. rst-class:: classref-enumeration-constant
  2451. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
  2452. Use the background for reflections.
  2453. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
  2454. .. rst-class:: classref-enumeration-constant
  2455. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
  2456. Disable reflections.
  2457. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
  2458. .. rst-class:: classref-enumeration-constant
  2459. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
  2460. Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
  2461. .. rst-class:: classref-item-separator
  2462. ----
  2463. .. _enum_RenderingServer_EnvironmentGlowBlendMode:
  2464. .. rst-class:: classref-enumeration
  2465. enum **EnvironmentGlowBlendMode**: :ref:`🔗<enum_RenderingServer_EnvironmentGlowBlendMode>`
  2466. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
  2467. .. rst-class:: classref-enumeration-constant
  2468. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
  2469. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  2470. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
  2471. .. rst-class:: classref-enumeration-constant
  2472. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
  2473. Screen glow blending mode. Increases brightness, used frequently with bloom.
  2474. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
  2475. .. rst-class:: classref-enumeration-constant
  2476. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
  2477. Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
  2478. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
  2479. .. rst-class:: classref-enumeration-constant
  2480. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
  2481. 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.
  2482. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
  2483. .. rst-class:: classref-enumeration-constant
  2484. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
  2485. Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
  2486. .. rst-class:: classref-item-separator
  2487. ----
  2488. .. _enum_RenderingServer_EnvironmentFogMode:
  2489. .. rst-class:: classref-enumeration
  2490. enum **EnvironmentFogMode**: :ref:`🔗<enum_RenderingServer_EnvironmentFogMode>`
  2491. .. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL:
  2492. .. rst-class:: classref-enumeration-constant
  2493. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_EXPONENTIAL** = ``0``
  2494. Use a physically-based fog model defined primarily by fog density.
  2495. .. _class_RenderingServer_constant_ENV_FOG_MODE_DEPTH:
  2496. .. rst-class:: classref-enumeration-constant
  2497. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_DEPTH** = ``1``
  2498. Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control.
  2499. .. rst-class:: classref-item-separator
  2500. ----
  2501. .. _enum_RenderingServer_EnvironmentToneMapper:
  2502. .. rst-class:: classref-enumeration
  2503. enum **EnvironmentToneMapper**: :ref:`🔗<enum_RenderingServer_EnvironmentToneMapper>`
  2504. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
  2505. .. rst-class:: classref-enumeration-constant
  2506. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
  2507. Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
  2508. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
  2509. .. rst-class:: classref-enumeration-constant
  2510. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
  2511. 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.
  2512. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
  2513. .. rst-class:: classref-enumeration-constant
  2514. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
  2515. 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>`.
  2516. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
  2517. .. rst-class:: classref-enumeration-constant
  2518. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
  2519. 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>`.
  2520. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
  2521. .. rst-class:: classref-item-separator
  2522. ----
  2523. .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
  2524. .. rst-class:: classref-enumeration
  2525. enum **EnvironmentSSRRoughnessQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`
  2526. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
  2527. .. rst-class:: classref-enumeration-constant
  2528. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
  2529. 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.
  2530. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
  2531. .. rst-class:: classref-enumeration-constant
  2532. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
  2533. Low quality of roughness filter for screen-space reflections.
  2534. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
  2535. .. rst-class:: classref-enumeration-constant
  2536. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
  2537. Medium quality of roughness filter for screen-space reflections.
  2538. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
  2539. .. rst-class:: classref-enumeration-constant
  2540. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
  2541. High quality of roughness filter for screen-space reflections. This is the slowest option.
  2542. .. rst-class:: classref-item-separator
  2543. ----
  2544. .. _enum_RenderingServer_EnvironmentSSAOQuality:
  2545. .. rst-class:: classref-enumeration
  2546. enum **EnvironmentSSAOQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSAOQuality>`
  2547. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
  2548. .. rst-class:: classref-enumeration-constant
  2549. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
  2550. Lowest quality of screen-space ambient occlusion.
  2551. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
  2552. .. rst-class:: classref-enumeration-constant
  2553. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
  2554. Low quality screen-space ambient occlusion.
  2555. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
  2556. .. rst-class:: classref-enumeration-constant
  2557. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
  2558. Medium quality screen-space ambient occlusion.
  2559. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
  2560. .. rst-class:: classref-enumeration-constant
  2561. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
  2562. High quality screen-space ambient occlusion.
  2563. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
  2564. .. rst-class:: classref-enumeration-constant
  2565. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
  2566. Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2567. .. rst-class:: classref-item-separator
  2568. ----
  2569. .. _enum_RenderingServer_EnvironmentSSILQuality:
  2570. .. rst-class:: classref-enumeration
  2571. enum **EnvironmentSSILQuality**: :ref:`🔗<enum_RenderingServer_EnvironmentSSILQuality>`
  2572. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
  2573. .. rst-class:: classref-enumeration-constant
  2574. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
  2575. Lowest quality of screen-space indirect lighting.
  2576. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
  2577. .. rst-class:: classref-enumeration-constant
  2578. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
  2579. Low quality screen-space indirect lighting.
  2580. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
  2581. .. rst-class:: classref-enumeration-constant
  2582. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
  2583. High quality screen-space indirect lighting.
  2584. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
  2585. .. rst-class:: classref-enumeration-constant
  2586. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
  2587. High quality screen-space indirect lighting.
  2588. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
  2589. .. rst-class:: classref-enumeration-constant
  2590. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
  2591. Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2592. .. rst-class:: classref-item-separator
  2593. ----
  2594. .. _enum_RenderingServer_EnvironmentSDFGIYScale:
  2595. .. rst-class:: classref-enumeration
  2596. enum **EnvironmentSDFGIYScale**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIYScale>`
  2597. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
  2598. .. rst-class:: classref-enumeration-constant
  2599. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
  2600. 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.
  2601. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
  2602. .. rst-class:: classref-enumeration-constant
  2603. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
  2604. Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
  2605. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
  2606. .. rst-class:: classref-enumeration-constant
  2607. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
  2608. 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.
  2609. .. rst-class:: classref-item-separator
  2610. ----
  2611. .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
  2612. .. rst-class:: classref-enumeration
  2613. enum **EnvironmentSDFGIRayCount**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIRayCount>`
  2614. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
  2615. .. rst-class:: classref-enumeration-constant
  2616. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
  2617. Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
  2618. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
  2619. .. rst-class:: classref-enumeration-constant
  2620. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
  2621. Throw 8 rays per frame when converging SDFGI.
  2622. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
  2623. .. rst-class:: classref-enumeration-constant
  2624. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
  2625. Throw 16 rays per frame when converging SDFGI.
  2626. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
  2627. .. rst-class:: classref-enumeration-constant
  2628. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
  2629. Throw 32 rays per frame when converging SDFGI.
  2630. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
  2631. .. rst-class:: classref-enumeration-constant
  2632. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
  2633. Throw 64 rays per frame when converging SDFGI.
  2634. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
  2635. .. rst-class:: classref-enumeration-constant
  2636. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
  2637. Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
  2638. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
  2639. .. rst-class:: classref-enumeration-constant
  2640. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
  2641. Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
  2642. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
  2643. .. rst-class:: classref-enumeration-constant
  2644. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
  2645. Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
  2646. .. rst-class:: classref-item-separator
  2647. ----
  2648. .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
  2649. .. rst-class:: classref-enumeration
  2650. enum **EnvironmentSDFGIFramesToConverge**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`
  2651. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
  2652. .. rst-class:: classref-enumeration-constant
  2653. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
  2654. Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
  2655. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
  2656. .. rst-class:: classref-enumeration-constant
  2657. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
  2658. Configure SDFGI to fully converge over 10 frames.
  2659. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
  2660. .. rst-class:: classref-enumeration-constant
  2661. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
  2662. Configure SDFGI to fully converge over 15 frames.
  2663. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
  2664. .. rst-class:: classref-enumeration-constant
  2665. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
  2666. Configure SDFGI to fully converge over 20 frames.
  2667. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
  2668. .. rst-class:: classref-enumeration-constant
  2669. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
  2670. Configure SDFGI to fully converge over 25 frames.
  2671. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
  2672. .. rst-class:: classref-enumeration-constant
  2673. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
  2674. Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
  2675. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
  2676. .. rst-class:: classref-enumeration-constant
  2677. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
  2678. Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
  2679. .. rst-class:: classref-item-separator
  2680. ----
  2681. .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
  2682. .. rst-class:: classref-enumeration
  2683. enum **EnvironmentSDFGIFramesToUpdateLight**: :ref:`🔗<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`
  2684. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
  2685. .. rst-class:: classref-enumeration-constant
  2686. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
  2687. Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
  2688. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
  2689. .. rst-class:: classref-enumeration-constant
  2690. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
  2691. Update indirect light from dynamic lights in SDFGI over 2 frames.
  2692. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
  2693. .. rst-class:: classref-enumeration-constant
  2694. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
  2695. Update indirect light from dynamic lights in SDFGI over 4 frames.
  2696. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
  2697. .. rst-class:: classref-enumeration-constant
  2698. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
  2699. Update indirect light from dynamic lights in SDFGI over 8 frames.
  2700. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
  2701. .. rst-class:: classref-enumeration-constant
  2702. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
  2703. Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
  2704. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
  2705. .. rst-class:: classref-enumeration-constant
  2706. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
  2707. Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
  2708. .. rst-class:: classref-item-separator
  2709. ----
  2710. .. _enum_RenderingServer_SubSurfaceScatteringQuality:
  2711. .. rst-class:: classref-enumeration
  2712. enum **SubSurfaceScatteringQuality**: :ref:`🔗<enum_RenderingServer_SubSurfaceScatteringQuality>`
  2713. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
  2714. .. rst-class:: classref-enumeration-constant
  2715. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
  2716. 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.
  2717. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
  2718. .. rst-class:: classref-enumeration-constant
  2719. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
  2720. Low subsurface scattering quality.
  2721. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
  2722. .. rst-class:: classref-enumeration-constant
  2723. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
  2724. Medium subsurface scattering quality.
  2725. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
  2726. .. rst-class:: classref-enumeration-constant
  2727. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
  2728. High subsurface scattering quality. This has the highest GPU requirements.
  2729. .. rst-class:: classref-item-separator
  2730. ----
  2731. .. _enum_RenderingServer_DOFBokehShape:
  2732. .. rst-class:: classref-enumeration
  2733. enum **DOFBokehShape**: :ref:`🔗<enum_RenderingServer_DOFBokehShape>`
  2734. .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
  2735. .. rst-class:: classref-enumeration-constant
  2736. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
  2737. Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
  2738. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
  2739. .. rst-class:: classref-enumeration-constant
  2740. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
  2741. Calculates DOF blur using a hexagon shaped filter.
  2742. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
  2743. .. rst-class:: classref-enumeration-constant
  2744. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
  2745. 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).
  2746. .. rst-class:: classref-item-separator
  2747. ----
  2748. .. _enum_RenderingServer_DOFBlurQuality:
  2749. .. rst-class:: classref-enumeration
  2750. enum **DOFBlurQuality**: :ref:`🔗<enum_RenderingServer_DOFBlurQuality>`
  2751. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
  2752. .. rst-class:: classref-enumeration-constant
  2753. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
  2754. Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
  2755. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
  2756. .. rst-class:: classref-enumeration-constant
  2757. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
  2758. Low quality DOF blur.
  2759. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
  2760. .. rst-class:: classref-enumeration-constant
  2761. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
  2762. Medium quality DOF blur.
  2763. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
  2764. .. rst-class:: classref-enumeration-constant
  2765. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
  2766. Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
  2767. .. rst-class:: classref-item-separator
  2768. ----
  2769. .. _enum_RenderingServer_InstanceType:
  2770. .. rst-class:: classref-enumeration
  2771. enum **InstanceType**: :ref:`🔗<enum_RenderingServer_InstanceType>`
  2772. .. _class_RenderingServer_constant_INSTANCE_NONE:
  2773. .. rst-class:: classref-enumeration-constant
  2774. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
  2775. The instance does not have a type.
  2776. .. _class_RenderingServer_constant_INSTANCE_MESH:
  2777. .. rst-class:: classref-enumeration-constant
  2778. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
  2779. The instance is a mesh.
  2780. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
  2781. .. rst-class:: classref-enumeration-constant
  2782. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
  2783. The instance is a multimesh.
  2784. .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
  2785. .. rst-class:: classref-enumeration-constant
  2786. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
  2787. The instance is a particle emitter.
  2788. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
  2789. .. rst-class:: classref-enumeration-constant
  2790. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
  2791. The instance is a GPUParticles collision shape.
  2792. .. _class_RenderingServer_constant_INSTANCE_LIGHT:
  2793. .. rst-class:: classref-enumeration-constant
  2794. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
  2795. The instance is a light.
  2796. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
  2797. .. rst-class:: classref-enumeration-constant
  2798. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
  2799. The instance is a reflection probe.
  2800. .. _class_RenderingServer_constant_INSTANCE_DECAL:
  2801. .. rst-class:: classref-enumeration-constant
  2802. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
  2803. The instance is a decal.
  2804. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
  2805. .. rst-class:: classref-enumeration-constant
  2806. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
  2807. The instance is a VoxelGI.
  2808. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
  2809. .. rst-class:: classref-enumeration-constant
  2810. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
  2811. The instance is a lightmap.
  2812. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
  2813. .. rst-class:: classref-enumeration-constant
  2814. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
  2815. The instance is an occlusion culling occluder.
  2816. .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
  2817. .. rst-class:: classref-enumeration-constant
  2818. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
  2819. The instance is a visible on-screen notifier.
  2820. .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
  2821. .. rst-class:: classref-enumeration-constant
  2822. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
  2823. The instance is a fog volume.
  2824. .. _class_RenderingServer_constant_INSTANCE_MAX:
  2825. .. rst-class:: classref-enumeration-constant
  2826. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
  2827. Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
  2828. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
  2829. .. rst-class:: classref-enumeration-constant
  2830. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
  2831. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  2832. .. rst-class:: classref-item-separator
  2833. ----
  2834. .. _enum_RenderingServer_InstanceFlags:
  2835. .. rst-class:: classref-enumeration
  2836. enum **InstanceFlags**: :ref:`🔗<enum_RenderingServer_InstanceFlags>`
  2837. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
  2838. .. rst-class:: classref-enumeration-constant
  2839. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
  2840. Allows the instance to be used in baked lighting.
  2841. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
  2842. .. rst-class:: classref-enumeration-constant
  2843. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
  2844. Allows the instance to be used with dynamic global illumination.
  2845. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
  2846. .. rst-class:: classref-enumeration-constant
  2847. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
  2848. When set, manually requests to draw geometry on next frame.
  2849. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
  2850. .. rst-class:: classref-enumeration-constant
  2851. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
  2852. Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
  2853. .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
  2854. .. rst-class:: classref-enumeration-constant
  2855. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
  2856. Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
  2857. .. rst-class:: classref-item-separator
  2858. ----
  2859. .. _enum_RenderingServer_ShadowCastingSetting:
  2860. .. rst-class:: classref-enumeration
  2861. enum **ShadowCastingSetting**: :ref:`🔗<enum_RenderingServer_ShadowCastingSetting>`
  2862. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
  2863. .. rst-class:: classref-enumeration-constant
  2864. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
  2865. Disable shadows from this instance.
  2866. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
  2867. .. rst-class:: classref-enumeration-constant
  2868. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
  2869. Cast shadows from this instance.
  2870. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
  2871. .. rst-class:: classref-enumeration-constant
  2872. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
  2873. Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
  2874. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
  2875. .. rst-class:: classref-enumeration-constant
  2876. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
  2877. Only render the shadows from the object. The object itself will not be drawn.
  2878. .. rst-class:: classref-item-separator
  2879. ----
  2880. .. _enum_RenderingServer_VisibilityRangeFadeMode:
  2881. .. rst-class:: classref-enumeration
  2882. enum **VisibilityRangeFadeMode**: :ref:`🔗<enum_RenderingServer_VisibilityRangeFadeMode>`
  2883. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
  2884. .. rst-class:: classref-enumeration-constant
  2885. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
  2886. Disable visibility range fading for the given instance.
  2887. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
  2888. .. rst-class:: classref-enumeration-constant
  2889. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
  2890. Fade-out the given instance when it approaches its visibility range limits.
  2891. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
  2892. .. rst-class:: classref-enumeration-constant
  2893. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
  2894. Fade-in the given instance's dependencies when reaching its visibility range limits.
  2895. .. rst-class:: classref-item-separator
  2896. ----
  2897. .. _enum_RenderingServer_BakeChannels:
  2898. .. rst-class:: classref-enumeration
  2899. enum **BakeChannels**: :ref:`🔗<enum_RenderingServer_BakeChannels>`
  2900. .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
  2901. .. rst-class:: classref-enumeration-constant
  2902. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
  2903. 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.
  2904. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
  2905. .. rst-class:: classref-enumeration-constant
  2906. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
  2907. 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``.
  2908. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
  2909. .. rst-class:: classref-enumeration-constant
  2910. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
  2911. 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.
  2912. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
  2913. .. rst-class:: classref-enumeration-constant
  2914. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
  2915. 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.
  2916. .. rst-class:: classref-item-separator
  2917. ----
  2918. .. _enum_RenderingServer_CanvasTextureChannel:
  2919. .. rst-class:: classref-enumeration
  2920. enum **CanvasTextureChannel**: :ref:`🔗<enum_RenderingServer_CanvasTextureChannel>`
  2921. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
  2922. .. rst-class:: classref-enumeration-constant
  2923. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
  2924. Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
  2925. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
  2926. .. rst-class:: classref-enumeration-constant
  2927. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
  2928. Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
  2929. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
  2930. .. rst-class:: classref-enumeration-constant
  2931. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
  2932. Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
  2933. .. rst-class:: classref-item-separator
  2934. ----
  2935. .. _enum_RenderingServer_NinePatchAxisMode:
  2936. .. rst-class:: classref-enumeration
  2937. enum **NinePatchAxisMode**: :ref:`🔗<enum_RenderingServer_NinePatchAxisMode>`
  2938. .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
  2939. .. rst-class:: classref-enumeration-constant
  2940. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
  2941. The nine patch gets stretched where needed.
  2942. .. _class_RenderingServer_constant_NINE_PATCH_TILE:
  2943. .. rst-class:: classref-enumeration-constant
  2944. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
  2945. The nine patch gets filled with tiles where needed.
  2946. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
  2947. .. rst-class:: classref-enumeration-constant
  2948. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
  2949. The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  2950. .. rst-class:: classref-item-separator
  2951. ----
  2952. .. _enum_RenderingServer_CanvasItemTextureFilter:
  2953. .. rst-class:: classref-enumeration
  2954. enum **CanvasItemTextureFilter**: :ref:`🔗<enum_RenderingServer_CanvasItemTextureFilter>`
  2955. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
  2956. .. rst-class:: classref-enumeration-constant
  2957. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
  2958. Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
  2959. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
  2960. .. rst-class:: classref-enumeration-constant
  2961. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
  2962. The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).
  2963. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
  2964. .. rst-class:: classref-enumeration-constant
  2965. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
  2966. The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).
  2967. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
  2968. .. rst-class:: classref-enumeration-constant
  2969. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
  2970. The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance.
  2971. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
  2972. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
  2973. .. rst-class:: classref-enumeration-constant
  2974. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
  2975. The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance.
  2976. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
  2977. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
  2978. .. rst-class:: classref-enumeration-constant
  2979. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
  2980. The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  2981. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS>` is usually more appropriate in this case.
  2982. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
  2983. .. rst-class:: classref-enumeration-constant
  2984. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
  2985. The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
  2986. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS>` is usually more appropriate in this case.
  2987. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
  2988. .. rst-class:: classref-enumeration-constant
  2989. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
  2990. Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
  2991. .. rst-class:: classref-item-separator
  2992. ----
  2993. .. _enum_RenderingServer_CanvasItemTextureRepeat:
  2994. .. rst-class:: classref-enumeration
  2995. enum **CanvasItemTextureRepeat**: :ref:`🔗<enum_RenderingServer_CanvasItemTextureRepeat>`
  2996. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
  2997. .. rst-class:: classref-enumeration-constant
  2998. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
  2999. Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
  3000. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
  3001. .. rst-class:: classref-enumeration-constant
  3002. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
  3003. 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.
  3004. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
  3005. .. rst-class:: classref-enumeration-constant
  3006. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
  3007. 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.
  3008. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
  3009. .. rst-class:: classref-enumeration-constant
  3010. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
  3011. Flip the texture when repeating so that the edge lines up instead of abruptly changing.
  3012. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
  3013. .. rst-class:: classref-enumeration-constant
  3014. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
  3015. Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
  3016. .. rst-class:: classref-item-separator
  3017. ----
  3018. .. _enum_RenderingServer_CanvasGroupMode:
  3019. .. rst-class:: classref-enumeration
  3020. enum **CanvasGroupMode**: :ref:`🔗<enum_RenderingServer_CanvasGroupMode>`
  3021. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
  3022. .. rst-class:: classref-enumeration-constant
  3023. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
  3024. Child draws over parent and is not clipped.
  3025. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
  3026. .. rst-class:: classref-enumeration-constant
  3027. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
  3028. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
  3029. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
  3030. .. rst-class:: classref-enumeration-constant
  3031. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
  3032. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
  3033. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
  3034. .. rst-class:: classref-enumeration-constant
  3035. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
  3036. .. container:: contribute
  3037. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3038. .. rst-class:: classref-item-separator
  3039. ----
  3040. .. _enum_RenderingServer_CanvasLightMode:
  3041. .. rst-class:: classref-enumeration
  3042. enum **CanvasLightMode**: :ref:`🔗<enum_RenderingServer_CanvasLightMode>`
  3043. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
  3044. .. rst-class:: classref-enumeration-constant
  3045. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
  3046. 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
  3047. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
  3048. .. rst-class:: classref-enumeration-constant
  3049. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
  3050. 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
  3051. .. rst-class:: classref-item-separator
  3052. ----
  3053. .. _enum_RenderingServer_CanvasLightBlendMode:
  3054. .. rst-class:: classref-enumeration
  3055. enum **CanvasLightBlendMode**: :ref:`🔗<enum_RenderingServer_CanvasLightBlendMode>`
  3056. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
  3057. .. rst-class:: classref-enumeration-constant
  3058. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
  3059. Adds light color additive to the canvas.
  3060. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
  3061. .. rst-class:: classref-enumeration-constant
  3062. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
  3063. Adds light color subtractive to the canvas.
  3064. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
  3065. .. rst-class:: classref-enumeration-constant
  3066. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
  3067. The light adds color depending on transparency.
  3068. .. rst-class:: classref-item-separator
  3069. ----
  3070. .. _enum_RenderingServer_CanvasLightShadowFilter:
  3071. .. rst-class:: classref-enumeration
  3072. enum **CanvasLightShadowFilter**: :ref:`🔗<enum_RenderingServer_CanvasLightShadowFilter>`
  3073. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
  3074. .. rst-class:: classref-enumeration-constant
  3075. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
  3076. Do not apply a filter to canvas light shadows.
  3077. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
  3078. .. rst-class:: classref-enumeration-constant
  3079. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
  3080. Use PCF5 filtering to filter canvas light shadows.
  3081. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
  3082. .. rst-class:: classref-enumeration-constant
  3083. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
  3084. Use PCF13 filtering to filter canvas light shadows.
  3085. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
  3086. .. rst-class:: classref-enumeration-constant
  3087. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
  3088. Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
  3089. .. rst-class:: classref-item-separator
  3090. ----
  3091. .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
  3092. .. rst-class:: classref-enumeration
  3093. enum **CanvasOccluderPolygonCullMode**: :ref:`🔗<enum_RenderingServer_CanvasOccluderPolygonCullMode>`
  3094. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
  3095. .. rst-class:: classref-enumeration-constant
  3096. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
  3097. Culling of the canvas occluder is disabled.
  3098. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
  3099. .. rst-class:: classref-enumeration-constant
  3100. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
  3101. Culling of the canvas occluder is clockwise.
  3102. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
  3103. .. rst-class:: classref-enumeration-constant
  3104. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
  3105. Culling of the canvas occluder is counterclockwise.
  3106. .. rst-class:: classref-item-separator
  3107. ----
  3108. .. _enum_RenderingServer_GlobalShaderParameterType:
  3109. .. rst-class:: classref-enumeration
  3110. enum **GlobalShaderParameterType**: :ref:`🔗<enum_RenderingServer_GlobalShaderParameterType>`
  3111. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
  3112. .. rst-class:: classref-enumeration-constant
  3113. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
  3114. Boolean global shader parameter (``global uniform bool ...``).
  3115. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
  3116. .. rst-class:: classref-enumeration-constant
  3117. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
  3118. 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
  3119. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
  3120. .. rst-class:: classref-enumeration-constant
  3121. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
  3122. 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
  3123. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
  3124. .. rst-class:: classref-enumeration-constant
  3125. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
  3126. 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
  3127. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
  3128. .. rst-class:: classref-enumeration-constant
  3129. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
  3130. Integer global shader parameter (``global uniform int ...``).
  3131. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
  3132. .. rst-class:: classref-enumeration-constant
  3133. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
  3134. 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
  3135. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
  3136. .. rst-class:: classref-enumeration-constant
  3137. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
  3138. 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
  3139. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
  3140. .. rst-class:: classref-enumeration-constant
  3141. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
  3142. 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
  3143. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
  3144. .. rst-class:: classref-enumeration-constant
  3145. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
  3146. 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.
  3147. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
  3148. .. rst-class:: classref-enumeration-constant
  3149. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
  3150. Unsigned integer global shader parameter (``global uniform uint ...``).
  3151. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
  3152. .. rst-class:: classref-enumeration-constant
  3153. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
  3154. 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
  3155. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
  3156. .. rst-class:: classref-enumeration-constant
  3157. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
  3158. 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
  3159. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
  3160. .. rst-class:: classref-enumeration-constant
  3161. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
  3162. 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
  3163. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
  3164. .. rst-class:: classref-enumeration-constant
  3165. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
  3166. Single-precision floating-point global shader parameter (``global uniform float ...``).
  3167. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
  3168. .. rst-class:: classref-enumeration-constant
  3169. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
  3170. 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
  3171. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
  3172. .. rst-class:: classref-enumeration-constant
  3173. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
  3174. 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
  3175. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
  3176. .. rst-class:: classref-enumeration-constant
  3177. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
  3178. 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
  3179. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
  3180. .. rst-class:: classref-enumeration-constant
  3181. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
  3182. 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.
  3183. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
  3184. .. rst-class:: classref-enumeration-constant
  3185. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
  3186. 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.
  3187. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
  3188. .. rst-class:: classref-enumeration-constant
  3189. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
  3190. 2×2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
  3191. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
  3192. .. rst-class:: classref-enumeration-constant
  3193. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
  3194. 3×3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
  3195. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
  3196. .. rst-class:: classref-enumeration-constant
  3197. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
  3198. 4×4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
  3199. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
  3200. .. rst-class:: classref-enumeration-constant
  3201. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
  3202. 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
  3203. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
  3204. .. rst-class:: classref-enumeration-constant
  3205. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
  3206. 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
  3207. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
  3208. .. rst-class:: classref-enumeration-constant
  3209. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
  3210. 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
  3211. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
  3212. .. rst-class:: classref-enumeration-constant
  3213. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
  3214. 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
  3215. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
  3216. .. rst-class:: classref-enumeration-constant
  3217. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
  3218. 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
  3219. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
  3220. .. rst-class:: classref-enumeration-constant
  3221. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
  3222. Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
  3223. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
  3224. .. rst-class:: classref-enumeration-constant
  3225. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``28``
  3226. Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
  3227. .. rst-class:: classref-item-separator
  3228. ----
  3229. .. _enum_RenderingServer_RenderingInfo:
  3230. .. rst-class:: classref-enumeration
  3231. enum **RenderingInfo**: :ref:`🔗<enum_RenderingServer_RenderingInfo>`
  3232. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
  3233. .. rst-class:: classref-enumeration-constant
  3234. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
  3235. Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
  3236. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
  3237. .. rst-class:: classref-enumeration-constant
  3238. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
  3239. Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
  3240. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
  3241. .. rst-class:: classref-enumeration-constant
  3242. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
  3243. Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
  3244. .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
  3245. .. rst-class:: classref-enumeration-constant
  3246. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
  3247. Texture memory used (in bytes).
  3248. .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
  3249. .. rst-class:: classref-enumeration-constant
  3250. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
  3251. Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
  3252. .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
  3253. .. rst-class:: classref-enumeration-constant
  3254. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
  3255. 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>`.
  3256. .. rst-class:: classref-item-separator
  3257. ----
  3258. .. _enum_RenderingServer_Features:
  3259. .. rst-class:: classref-enumeration
  3260. enum **Features**: :ref:`🔗<enum_RenderingServer_Features>`
  3261. .. _class_RenderingServer_constant_FEATURE_SHADERS:
  3262. .. rst-class:: classref-enumeration-constant
  3263. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
  3264. **Deprecated:** This constant has not been used since Godot 3.0.
  3265. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
  3266. .. rst-class:: classref-enumeration-constant
  3267. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
  3268. **Deprecated:** This constant has not been used since Godot 3.0.
  3269. .. rst-class:: classref-section-separator
  3270. ----
  3271. .. rst-class:: classref-descriptions-group
  3272. Constants
  3273. ---------
  3274. .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
  3275. .. rst-class:: classref-constant
  3276. **NO_INDEX_ARRAY** = ``-1`` :ref:`🔗<class_RenderingServer_constant_NO_INDEX_ARRAY>`
  3277. Marks an error that shows that the index array is empty.
  3278. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
  3279. .. rst-class:: classref-constant
  3280. **ARRAY_WEIGHTS_SIZE** = ``4`` :ref:`🔗<class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE>`
  3281. Number of weights/bones per vertex.
  3282. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
  3283. .. rst-class:: classref-constant
  3284. **CANVAS_ITEM_Z_MIN** = ``-4096`` :ref:`🔗<class_RenderingServer_constant_CANVAS_ITEM_Z_MIN>`
  3285. The minimum Z-layer for canvas items.
  3286. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
  3287. .. rst-class:: classref-constant
  3288. **CANVAS_ITEM_Z_MAX** = ``4096`` :ref:`🔗<class_RenderingServer_constant_CANVAS_ITEM_Z_MAX>`
  3289. The maximum Z-layer for canvas items.
  3290. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
  3291. .. rst-class:: classref-constant
  3292. **MAX_GLOW_LEVELS** = ``7`` :ref:`🔗<class_RenderingServer_constant_MAX_GLOW_LEVELS>`
  3293. The maximum number of glow levels that can be used with the glow post-processing effect.
  3294. .. _class_RenderingServer_constant_MAX_CURSORS:
  3295. .. rst-class:: classref-constant
  3296. **MAX_CURSORS** = ``8`` :ref:`🔗<class_RenderingServer_constant_MAX_CURSORS>`
  3297. **Deprecated:** This constant is not used by the engine.
  3298. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
  3299. .. rst-class:: classref-constant
  3300. **MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` :ref:`🔗<class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS>`
  3301. The maximum number of directional lights that can be rendered at a given time in 2D.
  3302. .. _class_RenderingServer_constant_MAX_MESH_SURFACES:
  3303. .. rst-class:: classref-constant
  3304. **MAX_MESH_SURFACES** = ``256`` :ref:`🔗<class_RenderingServer_constant_MAX_MESH_SURFACES>`
  3305. The maximum number of surfaces a mesh can have.
  3306. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
  3307. .. rst-class:: classref-constant
  3308. **MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` :ref:`🔗<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN>`
  3309. The minimum renderpriority of all materials.
  3310. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
  3311. .. rst-class:: classref-constant
  3312. **MATERIAL_RENDER_PRIORITY_MAX** = ``127`` :ref:`🔗<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX>`
  3313. The maximum renderpriority of all materials.
  3314. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
  3315. .. rst-class:: classref-constant
  3316. **ARRAY_CUSTOM_COUNT** = ``4`` :ref:`🔗<class_RenderingServer_constant_ARRAY_CUSTOM_COUNT>`
  3317. 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>`).
  3318. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
  3319. .. rst-class:: classref-constant
  3320. **PARTICLES_EMIT_FLAG_POSITION** = ``1`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION>`
  3321. .. container:: contribute
  3322. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3323. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
  3324. .. rst-class:: classref-constant
  3325. **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE>`
  3326. .. container:: contribute
  3327. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3328. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
  3329. .. rst-class:: classref-constant
  3330. **PARTICLES_EMIT_FLAG_VELOCITY** = ``4`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY>`
  3331. .. container:: contribute
  3332. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3333. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
  3334. .. rst-class:: classref-constant
  3335. **PARTICLES_EMIT_FLAG_COLOR** = ``8`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR>`
  3336. .. container:: contribute
  3337. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3338. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
  3339. .. rst-class:: classref-constant
  3340. **PARTICLES_EMIT_FLAG_CUSTOM** = ``16`` :ref:`🔗<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM>`
  3341. .. container:: contribute
  3342. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3343. .. rst-class:: classref-section-separator
  3344. ----
  3345. .. rst-class:: classref-descriptions-group
  3346. Property Descriptions
  3347. ---------------------
  3348. .. _class_RenderingServer_property_render_loop_enabled:
  3349. .. rst-class:: classref-property
  3350. :ref:`bool<class_bool>` **render_loop_enabled** :ref:`🔗<class_RenderingServer_property_render_loop_enabled>`
  3351. .. rst-class:: classref-property-setget
  3352. - |void| **set_render_loop_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  3353. - :ref:`bool<class_bool>` **is_render_loop_enabled**\ (\ )
  3354. 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.
  3355. .. rst-class:: classref-section-separator
  3356. ----
  3357. .. rst-class:: classref-descriptions-group
  3358. Method Descriptions
  3359. -------------------
  3360. .. _class_RenderingServer_method_bake_render_uv2:
  3361. .. rst-class:: classref-method
  3362. :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] **bake_render_uv2**\ (\ base\: :ref:`RID<class_RID>`, material_overrides\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], image_size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_bake_render_uv2>`
  3363. 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>`.
  3364. .. rst-class:: classref-item-separator
  3365. ----
  3366. .. _class_RenderingServer_method_call_on_render_thread:
  3367. .. rst-class:: classref-method
  3368. |void| **call_on_render_thread**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_call_on_render_thread>`
  3369. As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as :ref:`RenderingDevice<class_RenderingDevice>` and similar RD classes), push a callable via this function so it will be executed on the render thread.
  3370. .. rst-class:: classref-item-separator
  3371. ----
  3372. .. _class_RenderingServer_method_camera_attributes_create:
  3373. .. rst-class:: classref-method
  3374. :ref:`RID<class_RID>` **camera_attributes_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_create>`
  3375. 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.
  3376. 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.
  3377. \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
  3378. .. rst-class:: classref-item-separator
  3379. ----
  3380. .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
  3381. .. rst-class:: classref-method
  3382. |void| **camera_attributes_set_auto_exposure**\ (\ camera_attributes\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, min_sensitivity\: :ref:`float<class_float>`, max_sensitivity\: :ref:`float<class_float>`, speed\: :ref:`float<class_float>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_auto_exposure>`
  3383. 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>`.
  3384. .. rst-class:: classref-item-separator
  3385. ----
  3386. .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
  3387. .. rst-class:: classref-method
  3388. |void| **camera_attributes_set_dof_blur**\ (\ camera_attributes\: :ref:`RID<class_RID>`, far_enable\: :ref:`bool<class_bool>`, far_distance\: :ref:`float<class_float>`, far_transition\: :ref:`float<class_float>`, near_enable\: :ref:`bool<class_bool>`, near_distance\: :ref:`float<class_float>`, near_transition\: :ref:`float<class_float>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur>`
  3389. 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>`.
  3390. .. rst-class:: classref-item-separator
  3391. ----
  3392. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
  3393. .. rst-class:: classref-method
  3394. |void| **camera_attributes_set_dof_blur_bokeh_shape**\ (\ shape\: :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>`
  3395. 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>`.
  3396. .. rst-class:: classref-item-separator
  3397. ----
  3398. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
  3399. .. rst-class:: classref-method
  3400. |void| **camera_attributes_set_dof_blur_quality**\ (\ quality\: :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`, use_jitter\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>`
  3401. 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.
  3402. .. rst-class:: classref-item-separator
  3403. ----
  3404. .. _class_RenderingServer_method_camera_attributes_set_exposure:
  3405. .. rst-class:: classref-method
  3406. |void| **camera_attributes_set_exposure**\ (\ camera_attributes\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, normalization\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_attributes_set_exposure>`
  3407. 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.
  3408. The normalization factor can be calculated from exposure value (EV100) as follows:
  3409. ::
  3410. func get_exposure_normalization(ev100: float):
  3411. return 1.0 / (pow(2.0, ev100) * 1.2)
  3412. The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
  3413. ::
  3414. func get_exposure(aperture: float, shutter_speed: float, sensitivity: float):
  3415. return log((aperture * aperture) / shutter_speed * (100.0 / sensitivity)) / log(2)
  3416. .. rst-class:: classref-item-separator
  3417. ----
  3418. .. _class_RenderingServer_method_camera_create:
  3419. .. rst-class:: classref-method
  3420. :ref:`RID<class_RID>` **camera_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_camera_create>`
  3421. 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.
  3422. 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.
  3423. \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
  3424. .. rst-class:: classref-item-separator
  3425. ----
  3426. .. _class_RenderingServer_method_camera_set_camera_attributes:
  3427. .. rst-class:: classref-method
  3428. |void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_camera_attributes>`
  3429. Sets the camera_attributes created with :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` to the given camera.
  3430. .. rst-class:: classref-item-separator
  3431. ----
  3432. .. _class_RenderingServer_method_camera_set_compositor:
  3433. .. rst-class:: classref-method
  3434. |void| **camera_set_compositor**\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_compositor>`
  3435. Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor<class_Camera3D_property_compositor>`.
  3436. .. rst-class:: classref-item-separator
  3437. ----
  3438. .. _class_RenderingServer_method_camera_set_cull_mask:
  3439. .. rst-class:: classref-method
  3440. |void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_cull_mask>`
  3441. 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>`.
  3442. .. rst-class:: classref-item-separator
  3443. ----
  3444. .. _class_RenderingServer_method_camera_set_environment:
  3445. .. rst-class:: classref-method
  3446. |void| **camera_set_environment**\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_environment>`
  3447. Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
  3448. .. rst-class:: classref-item-separator
  3449. ----
  3450. .. _class_RenderingServer_method_camera_set_frustum:
  3451. .. rst-class:: classref-method
  3452. |void| **camera_set_frustum**\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, offset\: :ref:`Vector2<class_Vector2>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_frustum>`
  3453. Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
  3454. .. rst-class:: classref-item-separator
  3455. ----
  3456. .. _class_RenderingServer_method_camera_set_orthogonal:
  3457. .. rst-class:: classref-method
  3458. |void| **camera_set_orthogonal**\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_orthogonal>`
  3459. 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.
  3460. .. rst-class:: classref-item-separator
  3461. ----
  3462. .. _class_RenderingServer_method_camera_set_perspective:
  3463. .. rst-class:: classref-method
  3464. |void| **camera_set_perspective**\ (\ camera\: :ref:`RID<class_RID>`, fovy_degrees\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_perspective>`
  3465. Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
  3466. .. rst-class:: classref-item-separator
  3467. ----
  3468. .. _class_RenderingServer_method_camera_set_transform:
  3469. .. rst-class:: classref-method
  3470. |void| **camera_set_transform**\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_transform>`
  3471. Sets :ref:`Transform3D<class_Transform3D>` of camera.
  3472. .. rst-class:: classref-item-separator
  3473. ----
  3474. .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
  3475. .. rst-class:: classref-method
  3476. |void| **camera_set_use_vertical_aspect**\ (\ camera\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_camera_set_use_vertical_aspect>`
  3477. 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>`.
  3478. .. rst-class:: classref-item-separator
  3479. ----
  3480. .. _class_RenderingServer_method_canvas_create:
  3481. .. rst-class:: classref-method
  3482. :ref:`RID<class_RID>` **canvas_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_create>`
  3483. 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.
  3484. 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.
  3485. Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
  3486. .. rst-class:: classref-item-separator
  3487. ----
  3488. .. _class_RenderingServer_method_canvas_item_add_animation_slice:
  3489. .. rst-class:: classref-method
  3490. |void| **canvas_item_add_animation_slice**\ (\ item\: :ref:`RID<class_RID>`, animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_animation_slice>`
  3491. 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.
  3492. .. rst-class:: classref-item-separator
  3493. ----
  3494. .. _class_RenderingServer_method_canvas_item_add_circle:
  3495. .. rst-class:: classref-method
  3496. |void| **canvas_item_add_circle**\ (\ item\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_circle>`
  3497. 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>`.
  3498. .. rst-class:: classref-item-separator
  3499. ----
  3500. .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
  3501. .. rst-class:: classref-method
  3502. |void| **canvas_item_add_clip_ignore**\ (\ item\: :ref:`RID<class_RID>`, ignore\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_clip_ignore>`
  3503. If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false.
  3504. .. rst-class:: classref-item-separator
  3505. ----
  3506. .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
  3507. .. rst-class:: classref-method
  3508. |void| **canvas_item_add_lcd_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>`
  3509. See also :ref:`CanvasItem.draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
  3510. .. rst-class:: classref-item-separator
  3511. ----
  3512. .. _class_RenderingServer_method_canvas_item_add_line:
  3513. .. rst-class:: classref-method
  3514. |void| **canvas_item_add_line**\ (\ item\: :ref:`RID<class_RID>`, from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_line>`
  3515. 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>`.
  3516. .. rst-class:: classref-item-separator
  3517. ----
  3518. .. _class_RenderingServer_method_canvas_item_add_mesh:
  3519. .. rst-class:: classref-method
  3520. |void| **canvas_item_add_mesh**\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_mesh>`
  3521. 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>`.
  3522. .. rst-class:: classref-item-separator
  3523. ----
  3524. .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
  3525. .. rst-class:: classref-method
  3526. |void| **canvas_item_add_msdf_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline_size\: :ref:`int<class_int>` = 0, px_range\: :ref:`float<class_float>` = 1.0, scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>`
  3527. See also :ref:`CanvasItem.draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
  3528. .. rst-class:: classref-item-separator
  3529. ----
  3530. .. _class_RenderingServer_method_canvas_item_add_multiline:
  3531. .. rst-class:: classref-method
  3532. |void| **canvas_item_add_multiline**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_multiline>`
  3533. 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>`.
  3534. .. rst-class:: classref-item-separator
  3535. ----
  3536. .. _class_RenderingServer_method_canvas_item_add_multimesh:
  3537. .. rst-class:: classref-method
  3538. |void| **canvas_item_add_multimesh**\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_multimesh>`
  3539. 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>`.
  3540. .. rst-class:: classref-item-separator
  3541. ----
  3542. .. _class_RenderingServer_method_canvas_item_add_nine_patch:
  3543. .. rst-class:: classref-method
  3544. |void| **canvas_item_add_nine_patch**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, source\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, topleft\: :ref:`Vector2<class_Vector2>`, bottomright\: :ref:`Vector2<class_Vector2>`, x_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, y_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, draw_center\: :ref:`bool<class_bool>` = true, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_nine_patch>`
  3545. Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3546. .. rst-class:: classref-item-separator
  3547. ----
  3548. .. _class_RenderingServer_method_canvas_item_add_particles:
  3549. .. rst-class:: classref-method
  3550. |void| **canvas_item_add_particles**\ (\ item\: :ref:`RID<class_RID>`, particles\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_particles>`
  3551. Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3552. .. rst-class:: classref-item-separator
  3553. ----
  3554. .. _class_RenderingServer_method_canvas_item_add_polygon:
  3555. .. rst-class:: classref-method
  3556. |void| **canvas_item_add_polygon**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`RID<class_RID>` = RID()\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_polygon>`
  3557. 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>`.
  3558. .. rst-class:: classref-item-separator
  3559. ----
  3560. .. _class_RenderingServer_method_canvas_item_add_polyline:
  3561. .. rst-class:: classref-method
  3562. |void| **canvas_item_add_polyline**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_polyline>`
  3563. 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>`.
  3564. .. rst-class:: classref-item-separator
  3565. ----
  3566. .. _class_RenderingServer_method_canvas_item_add_primitive:
  3567. .. rst-class:: classref-method
  3568. |void| **canvas_item_add_primitive**\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_primitive>`
  3569. 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>`.
  3570. .. rst-class:: classref-item-separator
  3571. ----
  3572. .. _class_RenderingServer_method_canvas_item_add_rect:
  3573. .. rst-class:: classref-method
  3574. |void| **canvas_item_add_rect**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_rect>`
  3575. 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>`.
  3576. .. rst-class:: classref-item-separator
  3577. ----
  3578. .. _class_RenderingServer_method_canvas_item_add_set_transform:
  3579. .. rst-class:: classref-method
  3580. |void| **canvas_item_add_set_transform**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_set_transform>`
  3581. Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
  3582. .. rst-class:: classref-item-separator
  3583. ----
  3584. .. _class_RenderingServer_method_canvas_item_add_texture_rect:
  3585. .. rst-class:: classref-method
  3586. |void| **canvas_item_add_texture_rect**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, tile\: :ref:`bool<class_bool>` = false, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_texture_rect>`
  3587. 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>`.
  3588. .. rst-class:: classref-item-separator
  3589. ----
  3590. .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
  3591. .. rst-class:: classref-method
  3592. |void| **canvas_item_add_texture_rect_region**\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_texture_rect_region>`
  3593. 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>`.
  3594. .. rst-class:: classref-item-separator
  3595. ----
  3596. .. _class_RenderingServer_method_canvas_item_add_triangle_array:
  3597. .. rst-class:: classref-method
  3598. |void| **canvas_item_add_triangle_array**\ (\ item\: :ref:`RID<class_RID>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), bones\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array<class_PackedFloat32Array>` = PackedFloat32Array(), texture\: :ref:`RID<class_RID>` = RID(), count\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_add_triangle_array>`
  3599. 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>`.
  3600. \ **Note:** ``count`` is unused and can be left unspecified.
  3601. .. rst-class:: classref-item-separator
  3602. ----
  3603. .. _class_RenderingServer_method_canvas_item_clear:
  3604. .. rst-class:: classref-method
  3605. |void| **canvas_item_clear**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_clear>`
  3606. Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
  3607. .. rst-class:: classref-item-separator
  3608. ----
  3609. .. _class_RenderingServer_method_canvas_item_create:
  3610. .. rst-class:: classref-method
  3611. :ref:`RID<class_RID>` **canvas_item_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_create>`
  3612. 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.
  3613. 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.
  3614. \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
  3615. .. rst-class:: classref-item-separator
  3616. ----
  3617. .. _class_RenderingServer_method_canvas_item_reset_physics_interpolation:
  3618. .. rst-class:: classref-method
  3619. |void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`
  3620. Prevents physics interpolation for the current physics tick.
  3621. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  3622. .. rst-class:: classref-item-separator
  3623. ----
  3624. .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
  3625. .. rst-class:: classref-method
  3626. |void| **canvas_item_set_canvas_group_mode**\ (\ item\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>`, clear_margin\: :ref:`float<class_float>` = 5.0, fit_empty\: :ref:`bool<class_bool>` = false, fit_margin\: :ref:`float<class_float>` = 0.0, blur_mipmaps\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_canvas_group_mode>`
  3627. 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.
  3628. \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
  3629. .. rst-class:: classref-item-separator
  3630. ----
  3631. .. _class_RenderingServer_method_canvas_item_set_clip:
  3632. .. rst-class:: classref-method
  3633. |void| **canvas_item_set_clip**\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_clip>`
  3634. 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.
  3635. \ **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.
  3636. .. rst-class:: classref-item-separator
  3637. ----
  3638. .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
  3639. .. rst-class:: classref-method
  3640. |void| **canvas_item_set_copy_to_backbuffer**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>`
  3641. Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
  3642. .. rst-class:: classref-item-separator
  3643. ----
  3644. .. _class_RenderingServer_method_canvas_item_set_custom_rect:
  3645. .. rst-class:: classref-method
  3646. |void| **canvas_item_set_custom_rect**\ (\ item\: :ref:`RID<class_RID>`, use_custom_rect\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_custom_rect>`
  3647. 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.
  3648. .. rst-class:: classref-item-separator
  3649. ----
  3650. .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
  3651. .. rst-class:: classref-method
  3652. |void| **canvas_item_set_default_texture_filter**\ (\ item\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_default_texture_filter>`
  3653. 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>`.
  3654. .. rst-class:: classref-item-separator
  3655. ----
  3656. .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
  3657. .. rst-class:: classref-method
  3658. |void| **canvas_item_set_default_texture_repeat**\ (\ item\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_default_texture_repeat>`
  3659. 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>`.
  3660. .. rst-class:: classref-item-separator
  3661. ----
  3662. .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
  3663. .. rst-class:: classref-method
  3664. |void| **canvas_item_set_distance_field_mode**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_distance_field_mode>`
  3665. 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>`__.
  3666. .. rst-class:: classref-item-separator
  3667. ----
  3668. .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
  3669. .. rst-class:: classref-method
  3670. |void| **canvas_item_set_draw_behind_parent**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_draw_behind_parent>`
  3671. 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>`.
  3672. .. rst-class:: classref-item-separator
  3673. ----
  3674. .. _class_RenderingServer_method_canvas_item_set_draw_index:
  3675. .. rst-class:: classref-method
  3676. |void| **canvas_item_set_draw_index**\ (\ item\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_draw_index>`
  3677. Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
  3678. .. rst-class:: classref-item-separator
  3679. ----
  3680. .. _class_RenderingServer_method_canvas_item_set_interpolated:
  3681. .. rst-class:: classref-method
  3682. |void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_interpolated>`
  3683. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas item.
  3684. .. rst-class:: classref-item-separator
  3685. ----
  3686. .. _class_RenderingServer_method_canvas_item_set_light_mask:
  3687. .. rst-class:: classref-method
  3688. |void| **canvas_item_set_light_mask**\ (\ item\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_light_mask>`
  3689. Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
  3690. .. rst-class:: classref-item-separator
  3691. ----
  3692. .. _class_RenderingServer_method_canvas_item_set_material:
  3693. .. rst-class:: classref-method
  3694. |void| **canvas_item_set_material**\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_material>`
  3695. Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
  3696. .. rst-class:: classref-item-separator
  3697. ----
  3698. .. _class_RenderingServer_method_canvas_item_set_modulate:
  3699. .. rst-class:: classref-method
  3700. |void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_modulate>`
  3701. 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>`.
  3702. .. rst-class:: classref-item-separator
  3703. ----
  3704. .. _class_RenderingServer_method_canvas_item_set_parent:
  3705. .. rst-class:: classref-method
  3706. |void| **canvas_item_set_parent**\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_parent>`
  3707. 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.
  3708. .. rst-class:: classref-item-separator
  3709. ----
  3710. .. _class_RenderingServer_method_canvas_item_set_self_modulate:
  3711. .. rst-class:: classref-method
  3712. |void| **canvas_item_set_self_modulate**\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_self_modulate>`
  3713. 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>`.
  3714. .. rst-class:: classref-item-separator
  3715. ----
  3716. .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
  3717. .. rst-class:: classref-method
  3718. |void| **canvas_item_set_sort_children_by_y**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_sort_children_by_y>`
  3719. 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>`.
  3720. .. rst-class:: classref-item-separator
  3721. ----
  3722. .. _class_RenderingServer_method_canvas_item_set_transform:
  3723. .. rst-class:: classref-method
  3724. |void| **canvas_item_set_transform**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_transform>`
  3725. 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>`.
  3726. .. rst-class:: classref-item-separator
  3727. ----
  3728. .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
  3729. .. rst-class:: classref-method
  3730. |void| **canvas_item_set_use_parent_material**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_use_parent_material>`
  3731. Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
  3732. .. rst-class:: classref-item-separator
  3733. ----
  3734. .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
  3735. .. rst-class:: classref-method
  3736. |void| **canvas_item_set_visibility_layer**\ (\ item\: :ref:`RID<class_RID>`, visibility_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visibility_layer>`
  3737. 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>`.
  3738. .. rst-class:: classref-item-separator
  3739. ----
  3740. .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
  3741. .. rst-class:: classref-method
  3742. |void| **canvas_item_set_visibility_notifier**\ (\ item\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, area\: :ref:`Rect2<class_Rect2>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visibility_notifier>`
  3743. 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.
  3744. This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
  3745. .. rst-class:: classref-item-separator
  3746. ----
  3747. .. _class_RenderingServer_method_canvas_item_set_visible:
  3748. .. rst-class:: classref-method
  3749. |void| **canvas_item_set_visible**\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_visible>`
  3750. Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
  3751. .. rst-class:: classref-item-separator
  3752. ----
  3753. .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
  3754. .. rst-class:: classref-method
  3755. |void| **canvas_item_set_z_as_relative_to_parent**\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>`
  3756. If this is enabled, the Z index of the parent will be added to the children's Z index.
  3757. .. rst-class:: classref-item-separator
  3758. ----
  3759. .. _class_RenderingServer_method_canvas_item_set_z_index:
  3760. .. rst-class:: classref-method
  3761. |void| **canvas_item_set_z_index**\ (\ item\: :ref:`RID<class_RID>`, z_index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_set_z_index>`
  3762. Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
  3763. .. rst-class:: classref-item-separator
  3764. ----
  3765. .. _class_RenderingServer_method_canvas_item_transform_physics_interpolation:
  3766. .. rst-class:: classref-method
  3767. |void| **canvas_item_transform_physics_interpolation**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_item_transform_physics_interpolation>`
  3768. Transforms both the current and previous stored transform for a canvas item.
  3769. This allows transforming a canvas item without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  3770. .. rst-class:: classref-item-separator
  3771. ----
  3772. .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
  3773. .. rst-class:: classref-method
  3774. |void| **canvas_light_attach_to_canvas**\ (\ light\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_attach_to_canvas>`
  3775. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  3776. .. rst-class:: classref-item-separator
  3777. ----
  3778. .. _class_RenderingServer_method_canvas_light_create:
  3779. .. rst-class:: classref-method
  3780. :ref:`RID<class_RID>` **canvas_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_create>`
  3781. 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.
  3782. 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.
  3783. \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
  3784. .. rst-class:: classref-item-separator
  3785. ----
  3786. .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
  3787. .. rst-class:: classref-method
  3788. |void| **canvas_light_occluder_attach_to_canvas**\ (\ occluder\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>`
  3789. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  3790. .. rst-class:: classref-item-separator
  3791. ----
  3792. .. _class_RenderingServer_method_canvas_light_occluder_create:
  3793. .. rst-class:: classref-method
  3794. :ref:`RID<class_RID>` **canvas_light_occluder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_create>`
  3795. 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.
  3796. 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.
  3797. \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
  3798. .. rst-class:: classref-item-separator
  3799. ----
  3800. .. _class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation:
  3801. .. rst-class:: classref-method
  3802. |void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`
  3803. Prevents physics interpolation for the current physics tick.
  3804. This is useful when moving an occluder to a new location, to give an instantaneous change rather than interpolation from the previous location.
  3805. .. rst-class:: classref-item-separator
  3806. ----
  3807. .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
  3808. .. rst-class:: classref-method
  3809. |void| **canvas_light_occluder_set_as_sdf_collision**\ (\ occluder\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>`
  3810. .. container:: contribute
  3811. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3812. .. rst-class:: classref-item-separator
  3813. ----
  3814. .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
  3815. .. rst-class:: classref-method
  3816. |void| **canvas_light_occluder_set_enabled**\ (\ occluder\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_enabled>`
  3817. Enables or disables light occluder.
  3818. .. rst-class:: classref-item-separator
  3819. ----
  3820. .. _class_RenderingServer_method_canvas_light_occluder_set_interpolated:
  3821. .. rst-class:: classref-method
  3822. |void| **canvas_light_occluder_set_interpolated**\ (\ occluder\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_interpolated>`
  3823. If ``interpolated`` is ``true``, turns on physics interpolation for the light occluder.
  3824. .. rst-class:: classref-item-separator
  3825. ----
  3826. .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
  3827. .. rst-class:: classref-method
  3828. |void| **canvas_light_occluder_set_light_mask**\ (\ occluder\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_light_mask>`
  3829. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3830. .. rst-class:: classref-item-separator
  3831. ----
  3832. .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
  3833. .. rst-class:: classref-method
  3834. |void| **canvas_light_occluder_set_polygon**\ (\ occluder\: :ref:`RID<class_RID>`, polygon\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_polygon>`
  3835. Sets a light occluder's polygon.
  3836. .. rst-class:: classref-item-separator
  3837. ----
  3838. .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
  3839. .. rst-class:: classref-method
  3840. |void| **canvas_light_occluder_set_transform**\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_set_transform>`
  3841. Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
  3842. .. rst-class:: classref-item-separator
  3843. ----
  3844. .. _class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation:
  3845. .. rst-class:: classref-method
  3846. |void| **canvas_light_occluder_transform_physics_interpolation**\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation>`
  3847. Transforms both the current and previous stored transform for a light occluder.
  3848. This allows transforming an occluder without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  3849. .. rst-class:: classref-item-separator
  3850. ----
  3851. .. _class_RenderingServer_method_canvas_light_reset_physics_interpolation:
  3852. .. rst-class:: classref-method
  3853. |void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`
  3854. Prevents physics interpolation for the current physics tick.
  3855. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  3856. .. rst-class:: classref-item-separator
  3857. ----
  3858. .. _class_RenderingServer_method_canvas_light_set_blend_mode:
  3859. .. rst-class:: classref-method
  3860. |void| **canvas_light_set_blend_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_blend_mode>`
  3861. 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>`.
  3862. .. rst-class:: classref-item-separator
  3863. ----
  3864. .. _class_RenderingServer_method_canvas_light_set_color:
  3865. .. rst-class:: classref-method
  3866. |void| **canvas_light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_color>`
  3867. Sets the color for a light.
  3868. .. rst-class:: classref-item-separator
  3869. ----
  3870. .. _class_RenderingServer_method_canvas_light_set_enabled:
  3871. .. rst-class:: classref-method
  3872. |void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_enabled>`
  3873. Enables or disables a canvas light.
  3874. .. rst-class:: classref-item-separator
  3875. ----
  3876. .. _class_RenderingServer_method_canvas_light_set_energy:
  3877. .. rst-class:: classref-method
  3878. |void| **canvas_light_set_energy**\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_energy>`
  3879. Sets a canvas light's energy.
  3880. .. rst-class:: classref-item-separator
  3881. ----
  3882. .. _class_RenderingServer_method_canvas_light_set_height:
  3883. .. rst-class:: classref-method
  3884. |void| **canvas_light_set_height**\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_height>`
  3885. Sets a canvas light's height.
  3886. .. rst-class:: classref-item-separator
  3887. ----
  3888. .. _class_RenderingServer_method_canvas_light_set_interpolated:
  3889. .. rst-class:: classref-method
  3890. |void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_interpolated>`
  3891. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas light.
  3892. .. rst-class:: classref-item-separator
  3893. ----
  3894. .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
  3895. .. rst-class:: classref-method
  3896. |void| **canvas_light_set_item_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_item_cull_mask>`
  3897. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3898. .. rst-class:: classref-item-separator
  3899. ----
  3900. .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
  3901. .. rst-class:: classref-method
  3902. |void| **canvas_light_set_item_shadow_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>`
  3903. 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.
  3904. .. rst-class:: classref-item-separator
  3905. ----
  3906. .. _class_RenderingServer_method_canvas_light_set_layer_range:
  3907. .. rst-class:: classref-method
  3908. |void| **canvas_light_set_layer_range**\ (\ light\: :ref:`RID<class_RID>`, min_layer\: :ref:`int<class_int>`, max_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_layer_range>`
  3909. The layer range that gets rendered with this light.
  3910. .. rst-class:: classref-item-separator
  3911. ----
  3912. .. _class_RenderingServer_method_canvas_light_set_mode:
  3913. .. rst-class:: classref-method
  3914. |void| **canvas_light_set_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_mode>`
  3915. The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
  3916. .. rst-class:: classref-item-separator
  3917. ----
  3918. .. _class_RenderingServer_method_canvas_light_set_shadow_color:
  3919. .. rst-class:: classref-method
  3920. |void| **canvas_light_set_shadow_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_color>`
  3921. Sets the color of the canvas light's shadow.
  3922. .. rst-class:: classref-item-separator
  3923. ----
  3924. .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
  3925. .. rst-class:: classref-method
  3926. |void| **canvas_light_set_shadow_enabled**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_enabled>`
  3927. Enables or disables the canvas light's shadow.
  3928. .. rst-class:: classref-item-separator
  3929. ----
  3930. .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
  3931. .. rst-class:: classref-method
  3932. |void| **canvas_light_set_shadow_filter**\ (\ light\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_filter>`
  3933. Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
  3934. .. rst-class:: classref-item-separator
  3935. ----
  3936. .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
  3937. .. rst-class:: classref-method
  3938. |void| **canvas_light_set_shadow_smooth**\ (\ light\: :ref:`RID<class_RID>`, smooth\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_shadow_smooth>`
  3939. Smoothens the shadow. The lower, the smoother.
  3940. .. rst-class:: classref-item-separator
  3941. ----
  3942. .. _class_RenderingServer_method_canvas_light_set_texture:
  3943. .. rst-class:: classref-method
  3944. |void| **canvas_light_set_texture**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture>`
  3945. Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
  3946. .. rst-class:: classref-item-separator
  3947. ----
  3948. .. _class_RenderingServer_method_canvas_light_set_texture_offset:
  3949. .. rst-class:: classref-method
  3950. |void| **canvas_light_set_texture_offset**\ (\ light\: :ref:`RID<class_RID>`, offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture_offset>`
  3951. Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
  3952. .. rst-class:: classref-item-separator
  3953. ----
  3954. .. _class_RenderingServer_method_canvas_light_set_texture_scale:
  3955. .. rst-class:: classref-method
  3956. |void| **canvas_light_set_texture_scale**\ (\ light\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_texture_scale>`
  3957. Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
  3958. .. rst-class:: classref-item-separator
  3959. ----
  3960. .. _class_RenderingServer_method_canvas_light_set_transform:
  3961. .. rst-class:: classref-method
  3962. |void| **canvas_light_set_transform**\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_transform>`
  3963. Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
  3964. .. rst-class:: classref-item-separator
  3965. ----
  3966. .. _class_RenderingServer_method_canvas_light_set_z_range:
  3967. .. rst-class:: classref-method
  3968. |void| **canvas_light_set_z_range**\ (\ light\: :ref:`RID<class_RID>`, min_z\: :ref:`int<class_int>`, max_z\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_set_z_range>`
  3969. 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>`.
  3970. .. rst-class:: classref-item-separator
  3971. ----
  3972. .. _class_RenderingServer_method_canvas_light_transform_physics_interpolation:
  3973. .. rst-class:: classref-method
  3974. |void| **canvas_light_transform_physics_interpolation**\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_light_transform_physics_interpolation>`
  3975. Transforms both the current and previous stored transform for a canvas light.
  3976. This allows transforming a light without creating a "glitch" in the interpolation, which is is particularly useful for large worlds utilizing a shifting origin.
  3977. .. rst-class:: classref-item-separator
  3978. ----
  3979. .. _class_RenderingServer_method_canvas_occluder_polygon_create:
  3980. .. rst-class:: classref-method
  3981. :ref:`RID<class_RID>` **canvas_occluder_polygon_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_create>`
  3982. 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.
  3983. 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.
  3984. \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
  3985. .. rst-class:: classref-item-separator
  3986. ----
  3987. .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
  3988. .. rst-class:: classref-method
  3989. |void| **canvas_occluder_polygon_set_cull_mode**\ (\ occluder_polygon\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>`
  3990. Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
  3991. .. rst-class:: classref-item-separator
  3992. ----
  3993. .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
  3994. .. rst-class:: classref-method
  3995. |void| **canvas_occluder_polygon_set_shape**\ (\ occluder_polygon\: :ref:`RID<class_RID>`, shape\: :ref:`PackedVector2Array<class_PackedVector2Array>`, closed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_occluder_polygon_set_shape>`
  3996. Sets the shape of the occluder polygon.
  3997. .. rst-class:: classref-item-separator
  3998. ----
  3999. .. _class_RenderingServer_method_canvas_set_disable_scale:
  4000. .. rst-class:: classref-method
  4001. |void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_disable_scale>`
  4002. .. container:: contribute
  4003. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4004. .. rst-class:: classref-item-separator
  4005. ----
  4006. .. _class_RenderingServer_method_canvas_set_item_mirroring:
  4007. .. rst-class:: classref-method
  4008. |void| **canvas_set_item_mirroring**\ (\ canvas\: :ref:`RID<class_RID>`, item\: :ref:`RID<class_RID>`, mirroring\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_item_mirroring>`
  4009. A copy of the canvas item will be drawn with a local offset of the ``mirroring``.
  4010. \ **Note:** This is equivalent to calling :ref:`canvas_set_item_repeat<class_RenderingServer_method_canvas_set_item_repeat>` like ``canvas_set_item_repeat(item, mirroring, 1)``, with an additional check ensuring ``canvas`` is a parent of ``item``.
  4011. .. rst-class:: classref-item-separator
  4012. ----
  4013. .. _class_RenderingServer_method_canvas_set_item_repeat:
  4014. .. rst-class:: classref-method
  4015. |void| **canvas_set_item_repeat**\ (\ item\: :ref:`RID<class_RID>`, repeat_size\: :ref:`Vector2<class_Vector2>`, repeat_times\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_item_repeat>`
  4016. A copy of the canvas item will be drawn with a local offset of the ``repeat_size`` by the number of times of the ``repeat_times``. As the ``repeat_times`` increases, the copies will spread away from the origin texture.
  4017. .. rst-class:: classref-item-separator
  4018. ----
  4019. .. _class_RenderingServer_method_canvas_set_modulate:
  4020. .. rst-class:: classref-method
  4021. |void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_modulate>`
  4022. Modulates all colors in the given canvas.
  4023. .. rst-class:: classref-item-separator
  4024. ----
  4025. .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
  4026. .. rst-class:: classref-method
  4027. |void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_set_shadow_texture_size>`
  4028. 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.
  4029. .. rst-class:: classref-item-separator
  4030. ----
  4031. .. _class_RenderingServer_method_canvas_texture_create:
  4032. .. rst-class:: classref-method
  4033. :ref:`RID<class_RID>` **canvas_texture_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_create>`
  4034. 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.
  4035. 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>`.
  4036. \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
  4037. .. rst-class:: classref-item-separator
  4038. ----
  4039. .. _class_RenderingServer_method_canvas_texture_set_channel:
  4040. .. rst-class:: classref-method
  4041. |void| **canvas_texture_set_channel**\ (\ canvas_texture\: :ref:`RID<class_RID>`, channel\: :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_channel>`
  4042. 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>`.
  4043. .. rst-class:: classref-item-separator
  4044. ----
  4045. .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
  4046. .. rst-class:: classref-method
  4047. |void| **canvas_texture_set_shading_parameters**\ (\ canvas_texture\: :ref:`RID<class_RID>`, base_color\: :ref:`Color<class_Color>`, shininess\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_shading_parameters>`
  4048. 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>`.
  4049. .. rst-class:: classref-item-separator
  4050. ----
  4051. .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
  4052. .. rst-class:: classref-method
  4053. |void| **canvas_texture_set_texture_filter**\ (\ canvas_texture\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_texture_filter>`
  4054. Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4055. .. rst-class:: classref-item-separator
  4056. ----
  4057. .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
  4058. .. rst-class:: classref-method
  4059. |void| **canvas_texture_set_texture_repeat**\ (\ canvas_texture\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_canvas_texture_set_texture_repeat>`
  4060. Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4061. .. rst-class:: classref-item-separator
  4062. ----
  4063. .. _class_RenderingServer_method_compositor_create:
  4064. .. rst-class:: classref-method
  4065. :ref:`RID<class_RID>` **compositor_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_compositor_create>`
  4066. Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4067. 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.
  4068. .. rst-class:: classref-item-separator
  4069. ----
  4070. .. _class_RenderingServer_method_compositor_effect_create:
  4071. .. rst-class:: classref-method
  4072. :ref:`RID<class_RID>` **compositor_effect_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_create>`
  4073. Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4074. 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.
  4075. .. rst-class:: classref-item-separator
  4076. ----
  4077. .. _class_RenderingServer_method_compositor_effect_set_callback:
  4078. .. rst-class:: classref-method
  4079. |void| **compositor_effect_set_callback**\ (\ effect\: :ref:`RID<class_RID>`, callback_type\: :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_callback>`
  4080. Sets the callback type (``callback_type``) and callback method(``callback``) for this rendering effect.
  4081. .. rst-class:: classref-item-separator
  4082. ----
  4083. .. _class_RenderingServer_method_compositor_effect_set_enabled:
  4084. .. rst-class:: classref-method
  4085. |void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_enabled>`
  4086. Enables/disables this rendering effect.
  4087. .. rst-class:: classref-item-separator
  4088. ----
  4089. .. _class_RenderingServer_method_compositor_effect_set_flag:
  4090. .. rst-class:: classref-method
  4091. |void| **compositor_effect_set_flag**\ (\ effect\: :ref:`RID<class_RID>`, flag\: :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>`, set\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_compositor_effect_set_flag>`
  4092. Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``set``).
  4093. .. rst-class:: classref-item-separator
  4094. ----
  4095. .. _class_RenderingServer_method_compositor_set_compositor_effects:
  4096. .. rst-class:: classref-method
  4097. |void| **compositor_set_compositor_effects**\ (\ compositor\: :ref:`RID<class_RID>`, effects\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ ) :ref:`🔗<class_RenderingServer_method_compositor_set_compositor_effects>`
  4098. Sets the compositor effects for the specified compositor RID. ``effects`` should be an array containing RIDs created with :ref:`compositor_effect_create<class_RenderingServer_method_compositor_effect_create>`.
  4099. .. rst-class:: classref-item-separator
  4100. ----
  4101. .. _class_RenderingServer_method_create_local_rendering_device:
  4102. .. rst-class:: classref-method
  4103. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_create_local_rendering_device>`
  4104. 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.
  4105. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  4106. .. rst-class:: classref-item-separator
  4107. ----
  4108. .. _class_RenderingServer_method_debug_canvas_item_get_rect:
  4109. .. rst-class:: classref-method
  4110. :ref:`Rect2<class_Rect2>` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_debug_canvas_item_get_rect>`
  4111. Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling.
  4112. \ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2<class_Rect2>` in exported projects.
  4113. .. rst-class:: classref-item-separator
  4114. ----
  4115. .. _class_RenderingServer_method_decal_create:
  4116. .. rst-class:: classref-method
  4117. :ref:`RID<class_RID>` **decal_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_decal_create>`
  4118. 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.
  4119. 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.
  4120. 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.
  4121. \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
  4122. .. rst-class:: classref-item-separator
  4123. ----
  4124. .. _class_RenderingServer_method_decal_set_albedo_mix:
  4125. .. rst-class:: classref-method
  4126. |void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_albedo_mix>`
  4127. Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
  4128. .. rst-class:: classref-item-separator
  4129. ----
  4130. .. _class_RenderingServer_method_decal_set_cull_mask:
  4131. .. rst-class:: classref-method
  4132. |void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_cull_mask>`
  4133. Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
  4134. .. rst-class:: classref-item-separator
  4135. ----
  4136. .. _class_RenderingServer_method_decal_set_distance_fade:
  4137. .. rst-class:: classref-method
  4138. |void| **decal_set_distance_fade**\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_distance_fade>`
  4139. 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>`.
  4140. .. rst-class:: classref-item-separator
  4141. ----
  4142. .. _class_RenderingServer_method_decal_set_emission_energy:
  4143. .. rst-class:: classref-method
  4144. |void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_emission_energy>`
  4145. Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
  4146. .. rst-class:: classref-item-separator
  4147. ----
  4148. .. _class_RenderingServer_method_decal_set_fade:
  4149. .. rst-class:: classref-method
  4150. |void| **decal_set_fade**\ (\ decal\: :ref:`RID<class_RID>`, above\: :ref:`float<class_float>`, below\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_fade>`
  4151. 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>`.
  4152. .. rst-class:: classref-item-separator
  4153. ----
  4154. .. _class_RenderingServer_method_decal_set_modulate:
  4155. .. rst-class:: classref-method
  4156. |void| **decal_set_modulate**\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_modulate>`
  4157. Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
  4158. .. rst-class:: classref-item-separator
  4159. ----
  4160. .. _class_RenderingServer_method_decal_set_normal_fade:
  4161. .. rst-class:: classref-method
  4162. |void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_normal_fade>`
  4163. Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
  4164. .. rst-class:: classref-item-separator
  4165. ----
  4166. .. _class_RenderingServer_method_decal_set_size:
  4167. .. rst-class:: classref-method
  4168. |void| **decal_set_size**\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_size>`
  4169. Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
  4170. .. rst-class:: classref-item-separator
  4171. ----
  4172. .. _class_RenderingServer_method_decal_set_texture:
  4173. .. rst-class:: classref-method
  4174. |void| **decal_set_texture**\ (\ decal\: :ref:`RID<class_RID>`, type\: :ref:`DecalTexture<enum_RenderingServer_DecalTexture>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_decal_set_texture>`
  4175. Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture<class_Decal_method_set_texture>`.
  4176. .. rst-class:: classref-item-separator
  4177. ----
  4178. .. _class_RenderingServer_method_decals_set_filter:
  4179. .. rst-class:: classref-method
  4180. |void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) :ref:`🔗<class_RenderingServer_method_decals_set_filter>`
  4181. Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
  4182. .. rst-class:: classref-item-separator
  4183. ----
  4184. .. _class_RenderingServer_method_directional_light_create:
  4185. .. rst-class:: classref-method
  4186. :ref:`RID<class_RID>` **directional_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_directional_light_create>`
  4187. 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.
  4188. 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.
  4189. 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.
  4190. \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
  4191. .. rst-class:: classref-item-separator
  4192. ----
  4193. .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
  4194. .. rst-class:: classref-method
  4195. |void| **directional_shadow_atlas_set_size**\ (\ size\: :ref:`int<class_int>`, is_16bits\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_directional_shadow_atlas_set_size>`
  4196. 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.
  4197. .. rst-class:: classref-item-separator
  4198. ----
  4199. .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
  4200. .. rst-class:: classref-method
  4201. |void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`🔗<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`
  4202. 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.
  4203. .. rst-class:: classref-item-separator
  4204. ----
  4205. .. _class_RenderingServer_method_environment_bake_panorama:
  4206. .. rst-class:: classref-method
  4207. :ref:`Image<class_Image>` **environment_bake_panorama**\ (\ environment\: :ref:`RID<class_RID>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_environment_bake_panorama>`
  4208. 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>`.
  4209. \ **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.
  4210. \ **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.
  4211. .. rst-class:: classref-item-separator
  4212. ----
  4213. .. _class_RenderingServer_method_environment_create:
  4214. .. rst-class:: classref-method
  4215. :ref:`RID<class_RID>` **environment_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_environment_create>`
  4216. 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.
  4217. 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.
  4218. \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
  4219. .. rst-class:: classref-item-separator
  4220. ----
  4221. .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
  4222. .. rst-class:: classref-method
  4223. |void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`
  4224. 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>`.
  4225. .. rst-class:: classref-item-separator
  4226. ----
  4227. .. _class_RenderingServer_method_environment_set_adjustment:
  4228. .. rst-class:: classref-method
  4229. |void| **environment_set_adjustment**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`, use_1d_color_correction\: :ref:`bool<class_bool>`, color_correction\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_adjustment>`
  4230. Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4231. .. rst-class:: classref-item-separator
  4232. ----
  4233. .. _class_RenderingServer_method_environment_set_ambient_light:
  4234. .. rst-class:: classref-method
  4235. |void| **environment_set_ambient_light**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contibution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ambient_light>`
  4236. Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
  4237. .. rst-class:: classref-item-separator
  4238. ----
  4239. .. _class_RenderingServer_method_environment_set_background:
  4240. .. rst-class:: classref-method
  4241. |void| **environment_set_background**\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_background>`
  4242. Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
  4243. .. rst-class:: classref-item-separator
  4244. ----
  4245. .. _class_RenderingServer_method_environment_set_bg_color:
  4246. .. rst-class:: classref-method
  4247. |void| **environment_set_bg_color**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_bg_color>`
  4248. 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.
  4249. .. rst-class:: classref-item-separator
  4250. ----
  4251. .. _class_RenderingServer_method_environment_set_bg_energy:
  4252. .. rst-class:: classref-method
  4253. |void| **environment_set_bg_energy**\ (\ env\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, exposure_value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_bg_energy>`
  4254. Sets the intensity of the background color.
  4255. .. rst-class:: classref-item-separator
  4256. ----
  4257. .. _class_RenderingServer_method_environment_set_canvas_max_layer:
  4258. .. rst-class:: classref-method
  4259. |void| **environment_set_canvas_max_layer**\ (\ env\: :ref:`RID<class_RID>`, max_layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_canvas_max_layer>`
  4260. Sets the maximum layer to use if using Canvas background mode.
  4261. .. rst-class:: classref-item-separator
  4262. ----
  4263. .. _class_RenderingServer_method_environment_set_fog:
  4264. .. rst-class:: classref-method
  4265. |void| **environment_set_fog**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, light_color\: :ref:`Color<class_Color>`, light_energy\: :ref:`float<class_float>`, sun_scatter\: :ref:`float<class_float>`, density\: :ref:`float<class_float>`, height\: :ref:`float<class_float>`, height_density\: :ref:`float<class_float>`, aerial_perspective\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`, fog_mode\: :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` = 0\ ) :ref:`🔗<class_RenderingServer_method_environment_set_fog>`
  4266. Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4267. .. rst-class:: classref-item-separator
  4268. ----
  4269. .. _class_RenderingServer_method_environment_set_glow:
  4270. .. rst-class:: classref-method
  4271. |void| **environment_set_glow**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, levels\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, intensity\: :ref:`float<class_float>`, strength\: :ref:`float<class_float>`, mix\: :ref:`float<class_float>`, bloom_threshold\: :ref:`float<class_float>`, blend_mode\: :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>`, hdr_bleed_threshold\: :ref:`float<class_float>`, hdr_bleed_scale\: :ref:`float<class_float>`, hdr_luminance_cap\: :ref:`float<class_float>`, glow_map_strength\: :ref:`float<class_float>`, glow_map\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_glow>`
  4272. Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4273. .. rst-class:: classref-item-separator
  4274. ----
  4275. .. _class_RenderingServer_method_environment_set_sdfgi:
  4276. .. rst-class:: classref-method
  4277. |void| **environment_set_sdfgi**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, cascades\: :ref:`int<class_int>`, min_cell_size\: :ref:`float<class_float>`, y_scale\: :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>`, use_occlusion\: :ref:`bool<class_bool>`, bounce_feedback\: :ref:`float<class_float>`, read_sky\: :ref:`bool<class_bool>`, energy\: :ref:`float<class_float>`, normal_bias\: :ref:`float<class_float>`, probe_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi>`
  4278. Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4279. .. rst-class:: classref-item-separator
  4280. ----
  4281. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
  4282. .. rst-class:: classref-method
  4283. |void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`
  4284. 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>`.
  4285. .. rst-class:: classref-item-separator
  4286. ----
  4287. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
  4288. .. rst-class:: classref-method
  4289. |void| **environment_set_sdfgi_frames_to_update_light**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>`
  4290. 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>`.
  4291. .. rst-class:: classref-item-separator
  4292. ----
  4293. .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
  4294. .. rst-class:: classref-method
  4295. |void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sdfgi_ray_count>`
  4296. 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>`.
  4297. .. rst-class:: classref-item-separator
  4298. ----
  4299. .. _class_RenderingServer_method_environment_set_sky:
  4300. .. rst-class:: classref-method
  4301. |void| **environment_set_sky**\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky>`
  4302. 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>`.
  4303. .. rst-class:: classref-item-separator
  4304. ----
  4305. .. _class_RenderingServer_method_environment_set_sky_custom_fov:
  4306. .. rst-class:: classref-method
  4307. |void| **environment_set_sky_custom_fov**\ (\ env\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky_custom_fov>`
  4308. 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>`.
  4309. .. rst-class:: classref-item-separator
  4310. ----
  4311. .. _class_RenderingServer_method_environment_set_sky_orientation:
  4312. .. rst-class:: classref-method
  4313. |void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_sky_orientation>`
  4314. 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>`.
  4315. .. rst-class:: classref-item-separator
  4316. ----
  4317. .. _class_RenderingServer_method_environment_set_ssao:
  4318. .. rst-class:: classref-method
  4319. |void| **environment_set_ssao**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, radius\: :ref:`float<class_float>`, intensity\: :ref:`float<class_float>`, power\: :ref:`float<class_float>`, detail\: :ref:`float<class_float>`, horizon\: :ref:`float<class_float>`, sharpness\: :ref:`float<class_float>`, light_affect\: :ref:`float<class_float>`, ao_channel_affect\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssao>`
  4320. Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4321. .. rst-class:: classref-item-separator
  4322. ----
  4323. .. _class_RenderingServer_method_environment_set_ssao_quality:
  4324. .. rst-class:: classref-method
  4325. |void| **environment_set_ssao_quality**\ (\ quality\: :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssao_quality>`
  4326. Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4327. .. rst-class:: classref-item-separator
  4328. ----
  4329. .. _class_RenderingServer_method_environment_set_ssil_quality:
  4330. .. rst-class:: classref-method
  4331. |void| **environment_set_ssil_quality**\ (\ quality\: :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>`, half_size\: :ref:`bool<class_bool>`, adaptive_target\: :ref:`float<class_float>`, blur_passes\: :ref:`int<class_int>`, fadeout_from\: :ref:`float<class_float>`, fadeout_to\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssil_quality>`
  4332. Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4333. .. rst-class:: classref-item-separator
  4334. ----
  4335. .. _class_RenderingServer_method_environment_set_ssr:
  4336. .. rst-class:: classref-method
  4337. |void| **environment_set_ssr**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, max_steps\: :ref:`int<class_int>`, fade_in\: :ref:`float<class_float>`, fade_out\: :ref:`float<class_float>`, depth_tolerance\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssr>`
  4338. Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4339. .. rst-class:: classref-item-separator
  4340. ----
  4341. .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
  4342. .. rst-class:: classref-method
  4343. |void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_ssr_roughness_quality>`
  4344. .. container:: contribute
  4345. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4346. .. rst-class:: classref-item-separator
  4347. ----
  4348. .. _class_RenderingServer_method_environment_set_tonemap:
  4349. .. rst-class:: classref-method
  4350. |void| **environment_set_tonemap**\ (\ env\: :ref:`RID<class_RID>`, tone_mapper\: :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>`, exposure\: :ref:`float<class_float>`, white\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_tonemap>`
  4351. Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4352. .. rst-class:: classref-item-separator
  4353. ----
  4354. .. _class_RenderingServer_method_environment_set_volumetric_fog:
  4355. .. rst-class:: classref-method
  4356. |void| **environment_set_volumetric_fog**\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, density\: :ref:`float<class_float>`, albedo\: :ref:`Color<class_Color>`, emission\: :ref:`Color<class_Color>`, emission_energy\: :ref:`float<class_float>`, anisotropy\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`, p_detail_spread\: :ref:`float<class_float>`, gi_inject\: :ref:`float<class_float>`, temporal_reprojection\: :ref:`bool<class_bool>`, temporal_reprojection_amount\: :ref:`float<class_float>`, ambient_inject\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog>`
  4357. Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4358. .. rst-class:: classref-item-separator
  4359. ----
  4360. .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
  4361. .. rst-class:: classref-method
  4362. |void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`
  4363. Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
  4364. .. rst-class:: classref-item-separator
  4365. ----
  4366. .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
  4367. .. rst-class:: classref-method
  4368. |void| **environment_set_volumetric_fog_volume_size**\ (\ size\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>`
  4369. 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.
  4370. .. rst-class:: classref-item-separator
  4371. ----
  4372. .. _class_RenderingServer_method_fog_volume_create:
  4373. .. rst-class:: classref-method
  4374. :ref:`RID<class_RID>` **fog_volume_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_create>`
  4375. 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.
  4376. 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.
  4377. \ **Note:** The equivalent node is :ref:`FogVolume<class_FogVolume>`.
  4378. .. rst-class:: classref-item-separator
  4379. ----
  4380. .. _class_RenderingServer_method_fog_volume_set_material:
  4381. .. rst-class:: classref-method
  4382. |void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_material>`
  4383. 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>`.
  4384. .. rst-class:: classref-item-separator
  4385. ----
  4386. .. _class_RenderingServer_method_fog_volume_set_shape:
  4387. .. rst-class:: classref-method
  4388. |void| **fog_volume_set_shape**\ (\ fog_volume\: :ref:`RID<class_RID>`, shape\: :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_shape>`
  4389. 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>`.
  4390. .. rst-class:: classref-item-separator
  4391. ----
  4392. .. _class_RenderingServer_method_fog_volume_set_size:
  4393. .. rst-class:: classref-method
  4394. |void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_fog_volume_set_size>`
  4395. 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>`.
  4396. .. rst-class:: classref-item-separator
  4397. ----
  4398. .. _class_RenderingServer_method_force_draw:
  4399. .. rst-class:: classref-method
  4400. |void| **force_draw**\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) :ref:`🔗<class_RenderingServer_method_force_draw>`
  4401. Forces redrawing of all viewports at once. Must be called from the main thread.
  4402. .. rst-class:: classref-item-separator
  4403. ----
  4404. .. _class_RenderingServer_method_force_sync:
  4405. .. rst-class:: classref-method
  4406. |void| **force_sync**\ (\ ) :ref:`🔗<class_RenderingServer_method_force_sync>`
  4407. 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.
  4408. .. rst-class:: classref-item-separator
  4409. ----
  4410. .. _class_RenderingServer_method_free_rid:
  4411. .. rst-class:: classref-method
  4412. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_free_rid>`
  4413. Tries to free an object in the RenderingServer. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingServer directly.
  4414. .. rst-class:: classref-item-separator
  4415. ----
  4416. .. _class_RenderingServer_method_get_default_clear_color:
  4417. .. rst-class:: classref-method
  4418. :ref:`Color<class_Color>` **get_default_clear_color**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_default_clear_color>`
  4419. 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>`.
  4420. .. rst-class:: classref-item-separator
  4421. ----
  4422. .. _class_RenderingServer_method_get_frame_setup_time_cpu:
  4423. .. rst-class:: classref-method
  4424. :ref:`float<class_float>` **get_frame_setup_time_cpu**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_frame_setup_time_cpu>`
  4425. 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>`.
  4426. .. rst-class:: classref-item-separator
  4427. ----
  4428. .. _class_RenderingServer_method_get_rendering_device:
  4429. .. rst-class:: classref-method
  4430. :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_rendering_device>`
  4431. Returns the global RenderingDevice.
  4432. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  4433. .. rst-class:: classref-item-separator
  4434. ----
  4435. .. _class_RenderingServer_method_get_rendering_info:
  4436. .. rst-class:: classref-method
  4437. :ref:`int<class_int>` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) :ref:`🔗<class_RenderingServer_method_get_rendering_info>`
  4438. 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.
  4439. \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
  4440. \ **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:
  4441. ::
  4442. func _ready():
  4443. for _i in 2:
  4444. await get_tree().process_frame
  4445. print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
  4446. .. rst-class:: classref-item-separator
  4447. ----
  4448. .. _class_RenderingServer_method_get_shader_parameter_list:
  4449. .. rst-class:: classref-method
  4450. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_shader_parameter_list**\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_get_shader_parameter_list>`
  4451. Returns the parameters of a shader.
  4452. .. rst-class:: classref-item-separator
  4453. ----
  4454. .. _class_RenderingServer_method_get_test_cube:
  4455. .. rst-class:: classref-method
  4456. :ref:`RID<class_RID>` **get_test_cube**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_test_cube>`
  4457. 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>`.
  4458. .. rst-class:: classref-item-separator
  4459. ----
  4460. .. _class_RenderingServer_method_get_test_texture:
  4461. .. rst-class:: classref-method
  4462. :ref:`RID<class_RID>` **get_test_texture**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_test_texture>`
  4463. 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>`.
  4464. Example of getting the test texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4465. ::
  4466. var texture_rid = RenderingServer.get_test_texture()
  4467. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4468. $Sprite2D.texture = texture
  4469. .. rst-class:: classref-item-separator
  4470. ----
  4471. .. _class_RenderingServer_method_get_video_adapter_api_version:
  4472. .. rst-class:: classref-method
  4473. :ref:`String<class_String>` **get_video_adapter_api_version**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_api_version>`
  4474. 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>`.
  4475. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4476. .. rst-class:: classref-item-separator
  4477. ----
  4478. .. _class_RenderingServer_method_get_video_adapter_name:
  4479. .. rst-class:: classref-method
  4480. :ref:`String<class_String>` **get_video_adapter_name**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_name>`
  4481. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
  4482. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4483. \ **Note:** On the web platform, some browsers such as Firefox may report a different, fixed GPU name such as "GeForce GTX 980" (regardless of the user's actual GPU model). This is done to make fingerprinting more difficult.
  4484. .. rst-class:: classref-item-separator
  4485. ----
  4486. .. _class_RenderingServer_method_get_video_adapter_type:
  4487. .. rst-class:: classref-method
  4488. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_type>`
  4489. 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.
  4490. \ **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>`.
  4491. .. rst-class:: classref-item-separator
  4492. ----
  4493. .. _class_RenderingServer_method_get_video_adapter_vendor:
  4494. .. rst-class:: classref-method
  4495. :ref:`String<class_String>` **get_video_adapter_vendor**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_get_video_adapter_vendor>`
  4496. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
  4497. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4498. .. rst-class:: classref-item-separator
  4499. ----
  4500. .. _class_RenderingServer_method_get_white_texture:
  4501. .. rst-class:: classref-method
  4502. :ref:`RID<class_RID>` **get_white_texture**\ (\ ) :ref:`🔗<class_RenderingServer_method_get_white_texture>`
  4503. 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>`.
  4504. Example of getting the white texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4505. ::
  4506. var texture_rid = RenderingServer.get_white_texture()
  4507. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4508. $Sprite2D.texture = texture
  4509. .. rst-class:: classref-item-separator
  4510. ----
  4511. .. _class_RenderingServer_method_gi_set_use_half_resolution:
  4512. .. rst-class:: classref-method
  4513. |void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_gi_set_use_half_resolution>`
  4514. 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>`.
  4515. .. rst-class:: classref-item-separator
  4516. ----
  4517. .. _class_RenderingServer_method_global_shader_parameter_add:
  4518. .. rst-class:: classref-method
  4519. |void| **global_shader_parameter_add**\ (\ name\: :ref:`StringName<class_StringName>`, type\: :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>`, default_value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_add>`
  4520. Creates a new global shader uniform.
  4521. \ **Note:** Global shader parameter names are case-sensitive.
  4522. .. rst-class:: classref-item-separator
  4523. ----
  4524. .. _class_RenderingServer_method_global_shader_parameter_get:
  4525. .. rst-class:: classref-method
  4526. :ref:`Variant<class_Variant>` **global_shader_parameter_get**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get>`
  4527. Returns the value of the global shader uniform specified by ``name``.
  4528. \ **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.
  4529. .. rst-class:: classref-item-separator
  4530. ----
  4531. .. _class_RenderingServer_method_global_shader_parameter_get_list:
  4532. .. rst-class:: classref-method
  4533. :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **global_shader_parameter_get_list**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get_list>`
  4534. Returns the list of global shader uniform names.
  4535. \ **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.
  4536. .. rst-class:: classref-item-separator
  4537. ----
  4538. .. _class_RenderingServer_method_global_shader_parameter_get_type:
  4539. .. rst-class:: classref-method
  4540. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **global_shader_parameter_get_type**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_global_shader_parameter_get_type>`
  4541. Returns the type associated to the global shader uniform specified by ``name``.
  4542. \ **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.
  4543. .. rst-class:: classref-item-separator
  4544. ----
  4545. .. _class_RenderingServer_method_global_shader_parameter_remove:
  4546. .. rst-class:: classref-method
  4547. |void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_remove>`
  4548. Removes the global shader uniform specified by ``name``.
  4549. .. rst-class:: classref-item-separator
  4550. ----
  4551. .. _class_RenderingServer_method_global_shader_parameter_set:
  4552. .. rst-class:: classref-method
  4553. |void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_set>`
  4554. Sets the global shader uniform ``name`` to ``value``.
  4555. .. rst-class:: classref-item-separator
  4556. ----
  4557. .. _class_RenderingServer_method_global_shader_parameter_set_override:
  4558. .. rst-class:: classref-method
  4559. |void| **global_shader_parameter_set_override**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_global_shader_parameter_set_override>`
  4560. Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
  4561. .. rst-class:: classref-item-separator
  4562. ----
  4563. .. _class_RenderingServer_method_has_changed:
  4564. .. rst-class:: classref-method
  4565. :ref:`bool<class_bool>` **has_changed**\ (\ ) |const| :ref:`🔗<class_RenderingServer_method_has_changed>`
  4566. 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.
  4567. .. rst-class:: classref-item-separator
  4568. ----
  4569. .. _class_RenderingServer_method_has_feature:
  4570. .. rst-class:: classref-method
  4571. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| :ref:`🔗<class_RenderingServer_method_has_feature>`
  4572. **Deprecated:** This method has not been used since Godot 3.0.
  4573. This method does nothing and always returns ``false``.
  4574. .. rst-class:: classref-item-separator
  4575. ----
  4576. .. _class_RenderingServer_method_has_os_feature:
  4577. .. rst-class:: classref-method
  4578. :ref:`bool<class_bool>` **has_os_feature**\ (\ feature\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_RenderingServer_method_has_os_feature>`
  4579. Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
  4580. .. rst-class:: classref-item-separator
  4581. ----
  4582. .. _class_RenderingServer_method_instance_attach_object_instance_id:
  4583. .. rst-class:: classref-method
  4584. |void| **instance_attach_object_instance_id**\ (\ instance\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_attach_object_instance_id>`
  4585. 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>`.
  4586. .. rst-class:: classref-item-separator
  4587. ----
  4588. .. _class_RenderingServer_method_instance_attach_skeleton:
  4589. .. rst-class:: classref-method
  4590. |void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_attach_skeleton>`
  4591. Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
  4592. .. rst-class:: classref-item-separator
  4593. ----
  4594. .. _class_RenderingServer_method_instance_create:
  4595. .. rst-class:: classref-method
  4596. :ref:`RID<class_RID>` **instance_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_instance_create>`
  4597. 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.
  4598. 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.
  4599. 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>`.
  4600. \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
  4601. .. rst-class:: classref-item-separator
  4602. ----
  4603. .. _class_RenderingServer_method_instance_create2:
  4604. .. rst-class:: classref-method
  4605. :ref:`RID<class_RID>` **instance_create2**\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_create2>`
  4606. 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.
  4607. 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.
  4608. .. rst-class:: classref-item-separator
  4609. ----
  4610. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
  4611. .. rst-class:: classref-method
  4612. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter>`
  4613. 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>`.
  4614. \ **Note:** Per-instance shader parameter names are case-sensitive.
  4615. .. rst-class:: classref-item-separator
  4616. ----
  4617. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
  4618. .. rst-class:: classref-method
  4619. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>`
  4620. 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>`.
  4621. .. rst-class:: classref-item-separator
  4622. ----
  4623. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
  4624. .. rst-class:: classref-method
  4625. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **instance_geometry_get_shader_parameter_list**\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>`
  4626. 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>`.
  4627. .. rst-class:: classref-item-separator
  4628. ----
  4629. .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
  4630. .. rst-class:: classref-method
  4631. |void| **instance_geometry_set_cast_shadows_setting**\ (\ instance\: :ref:`RID<class_RID>`, shadow_casting_setting\: :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>`
  4632. Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
  4633. .. rst-class:: classref-item-separator
  4634. ----
  4635. .. _class_RenderingServer_method_instance_geometry_set_flag:
  4636. .. rst-class:: classref-method
  4637. |void| **instance_geometry_set_flag**\ (\ instance\: :ref:`RID<class_RID>`, flag\: :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_flag>`
  4638. Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
  4639. .. rst-class:: classref-item-separator
  4640. ----
  4641. .. _class_RenderingServer_method_instance_geometry_set_lightmap:
  4642. .. rst-class:: classref-method
  4643. |void| **instance_geometry_set_lightmap**\ (\ instance\: :ref:`RID<class_RID>`, lightmap\: :ref:`RID<class_RID>`, lightmap_uv_scale\: :ref:`Rect2<class_Rect2>`, lightmap_slice\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_lightmap>`
  4644. 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.
  4645. .. rst-class:: classref-item-separator
  4646. ----
  4647. .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
  4648. .. rst-class:: classref-method
  4649. |void| **instance_geometry_set_lod_bias**\ (\ instance\: :ref:`RID<class_RID>`, lod_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_lod_bias>`
  4650. 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>`.
  4651. .. rst-class:: classref-item-separator
  4652. ----
  4653. .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
  4654. .. rst-class:: classref-method
  4655. |void| **instance_geometry_set_material_overlay**\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_material_overlay>`
  4656. 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>`.
  4657. .. rst-class:: classref-item-separator
  4658. ----
  4659. .. _class_RenderingServer_method_instance_geometry_set_material_override:
  4660. .. rst-class:: classref-method
  4661. |void| **instance_geometry_set_material_override**\ (\ instance\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_material_override>`
  4662. 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>`.
  4663. .. rst-class:: classref-item-separator
  4664. ----
  4665. .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
  4666. .. rst-class:: classref-method
  4667. |void| **instance_geometry_set_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_shader_parameter>`
  4668. 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>`.
  4669. .. rst-class:: classref-item-separator
  4670. ----
  4671. .. _class_RenderingServer_method_instance_geometry_set_transparency:
  4672. .. rst-class:: classref-method
  4673. |void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_transparency>`
  4674. Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
  4675. 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.
  4676. In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
  4677. \ **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.
  4678. .. rst-class:: classref-item-separator
  4679. ----
  4680. .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
  4681. .. rst-class:: classref-method
  4682. |void| **instance_geometry_set_visibility_range**\ (\ instance\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`, min_margin\: :ref:`float<class_float>`, max_margin\: :ref:`float<class_float>`, fade_mode\: :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>`\ ) :ref:`🔗<class_RenderingServer_method_instance_geometry_set_visibility_range>`
  4683. 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.
  4684. .. rst-class:: classref-item-separator
  4685. ----
  4686. .. _class_RenderingServer_method_instance_set_base:
  4687. .. rst-class:: classref-method
  4688. |void| **instance_set_base**\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_base>`
  4689. 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.
  4690. .. rst-class:: classref-item-separator
  4691. ----
  4692. .. _class_RenderingServer_method_instance_set_blend_shape_weight:
  4693. .. rst-class:: classref-method
  4694. |void| **instance_set_blend_shape_weight**\ (\ instance\: :ref:`RID<class_RID>`, shape\: :ref:`int<class_int>`, weight\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_blend_shape_weight>`
  4695. Sets the weight for a given blend shape associated with this instance.
  4696. .. rst-class:: classref-item-separator
  4697. ----
  4698. .. _class_RenderingServer_method_instance_set_custom_aabb:
  4699. .. rst-class:: classref-method
  4700. |void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_custom_aabb>`
  4701. 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>`.
  4702. .. rst-class:: classref-item-separator
  4703. ----
  4704. .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
  4705. .. rst-class:: classref-method
  4706. |void| **instance_set_extra_visibility_margin**\ (\ instance\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_extra_visibility_margin>`
  4707. 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>`.
  4708. .. rst-class:: classref-item-separator
  4709. ----
  4710. .. _class_RenderingServer_method_instance_set_ignore_culling:
  4711. .. rst-class:: classref-method
  4712. |void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_ignore_culling>`
  4713. 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.
  4714. .. rst-class:: classref-item-separator
  4715. ----
  4716. .. _class_RenderingServer_method_instance_set_layer_mask:
  4717. .. rst-class:: classref-method
  4718. |void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_layer_mask>`
  4719. Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
  4720. .. rst-class:: classref-item-separator
  4721. ----
  4722. .. _class_RenderingServer_method_instance_set_pivot_data:
  4723. .. rst-class:: classref-method
  4724. |void| **instance_set_pivot_data**\ (\ instance\: :ref:`RID<class_RID>`, sorting_offset\: :ref:`float<class_float>`, use_aabb_center\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_pivot_data>`
  4725. Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
  4726. .. rst-class:: classref-item-separator
  4727. ----
  4728. .. _class_RenderingServer_method_instance_set_scenario:
  4729. .. rst-class:: classref-method
  4730. |void| **instance_set_scenario**\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_scenario>`
  4731. Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
  4732. .. rst-class:: classref-item-separator
  4733. ----
  4734. .. _class_RenderingServer_method_instance_set_surface_override_material:
  4735. .. rst-class:: classref-method
  4736. |void| **instance_set_surface_override_material**\ (\ instance\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_surface_override_material>`
  4737. Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
  4738. .. rst-class:: classref-item-separator
  4739. ----
  4740. .. _class_RenderingServer_method_instance_set_transform:
  4741. .. rst-class:: classref-method
  4742. |void| **instance_set_transform**\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_transform>`
  4743. Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform<class_Node3D_property_global_transform>`.
  4744. .. rst-class:: classref-item-separator
  4745. ----
  4746. .. _class_RenderingServer_method_instance_set_visibility_parent:
  4747. .. rst-class:: classref-method
  4748. |void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_visibility_parent>`
  4749. Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
  4750. .. rst-class:: classref-item-separator
  4751. ----
  4752. .. _class_RenderingServer_method_instance_set_visible:
  4753. .. rst-class:: classref-method
  4754. |void| **instance_set_visible**\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_instance_set_visible>`
  4755. Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
  4756. .. rst-class:: classref-item-separator
  4757. ----
  4758. .. _class_RenderingServer_method_instances_cull_aabb:
  4759. .. rst-class:: classref-method
  4760. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_aabb**\ (\ aabb\: :ref:`AABB<class_AABB>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_aabb>`
  4761. 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.
  4762. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4763. .. rst-class:: classref-item-separator
  4764. ----
  4765. .. _class_RenderingServer_method_instances_cull_convex:
  4766. .. rst-class:: classref-method
  4767. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_convex**\ (\ convex\: :ref:`Array<class_Array>`\[:ref:`Plane<class_Plane>`\], scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_convex>`
  4768. 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.
  4769. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4770. .. rst-class:: classref-item-separator
  4771. ----
  4772. .. _class_RenderingServer_method_instances_cull_ray:
  4773. .. rst-class:: classref-method
  4774. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_ray**\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| :ref:`🔗<class_RenderingServer_method_instances_cull_ray>`
  4775. 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.
  4776. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4777. .. rst-class:: classref-item-separator
  4778. ----
  4779. .. _class_RenderingServer_method_is_on_render_thread:
  4780. .. rst-class:: classref-method
  4781. :ref:`bool<class_bool>` **is_on_render_thread**\ (\ ) :ref:`🔗<class_RenderingServer_method_is_on_render_thread>`
  4782. Returns ``true`` if our code is currently executing on the rendering thread.
  4783. .. rst-class:: classref-item-separator
  4784. ----
  4785. .. _class_RenderingServer_method_light_directional_set_blend_splits:
  4786. .. rst-class:: classref-method
  4787. |void| **light_directional_set_blend_splits**\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_blend_splits>`
  4788. 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>`.
  4789. .. rst-class:: classref-item-separator
  4790. ----
  4791. .. _class_RenderingServer_method_light_directional_set_shadow_mode:
  4792. .. rst-class:: classref-method
  4793. |void| **light_directional_set_shadow_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_shadow_mode>`
  4794. 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.
  4795. .. rst-class:: classref-item-separator
  4796. ----
  4797. .. _class_RenderingServer_method_light_directional_set_sky_mode:
  4798. .. rst-class:: classref-method
  4799. |void| **light_directional_set_sky_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_directional_set_sky_mode>`
  4800. 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.
  4801. .. rst-class:: classref-item-separator
  4802. ----
  4803. .. _class_RenderingServer_method_light_omni_set_shadow_mode:
  4804. .. rst-class:: classref-method
  4805. |void| **light_omni_set_shadow_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_omni_set_shadow_mode>`
  4806. 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>`.
  4807. .. rst-class:: classref-item-separator
  4808. ----
  4809. .. _class_RenderingServer_method_light_projectors_set_filter:
  4810. .. rst-class:: classref-method
  4811. |void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) :ref:`🔗<class_RenderingServer_method_light_projectors_set_filter>`
  4812. Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
  4813. .. rst-class:: classref-item-separator
  4814. ----
  4815. .. _class_RenderingServer_method_light_set_bake_mode:
  4816. .. rst-class:: classref-method
  4817. |void| **light_set_bake_mode**\ (\ light\: :ref:`RID<class_RID>`, bake_mode\: :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_bake_mode>`
  4818. Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
  4819. .. rst-class:: classref-item-separator
  4820. ----
  4821. .. _class_RenderingServer_method_light_set_color:
  4822. .. rst-class:: classref-method
  4823. |void| **light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_color>`
  4824. Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
  4825. .. rst-class:: classref-item-separator
  4826. ----
  4827. .. _class_RenderingServer_method_light_set_cull_mask:
  4828. .. rst-class:: classref-method
  4829. |void| **light_set_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_cull_mask>`
  4830. 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>`.
  4831. .. rst-class:: classref-item-separator
  4832. ----
  4833. .. _class_RenderingServer_method_light_set_distance_fade:
  4834. .. rst-class:: classref-method
  4835. |void| **light_set_distance_fade**\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, shadow\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_distance_fade>`
  4836. 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>`.
  4837. .. rst-class:: classref-item-separator
  4838. ----
  4839. .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
  4840. .. rst-class:: classref-method
  4841. |void| **light_set_max_sdfgi_cascade**\ (\ light\: :ref:`RID<class_RID>`, cascade\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_max_sdfgi_cascade>`
  4842. 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.
  4843. .. rst-class:: classref-item-separator
  4844. ----
  4845. .. _class_RenderingServer_method_light_set_negative:
  4846. .. rst-class:: classref-method
  4847. |void| **light_set_negative**\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_negative>`
  4848. If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
  4849. .. rst-class:: classref-item-separator
  4850. ----
  4851. .. _class_RenderingServer_method_light_set_param:
  4852. .. rst-class:: classref-method
  4853. |void| **light_set_param**\ (\ light\: :ref:`RID<class_RID>`, param\: :ref:`LightParam<enum_RenderingServer_LightParam>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_param>`
  4854. 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>`.
  4855. .. rst-class:: classref-item-separator
  4856. ----
  4857. .. _class_RenderingServer_method_light_set_projector:
  4858. .. rst-class:: classref-method
  4859. |void| **light_set_projector**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_projector>`
  4860. Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
  4861. .. rst-class:: classref-item-separator
  4862. ----
  4863. .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
  4864. .. rst-class:: classref-method
  4865. |void| **light_set_reverse_cull_face_mode**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_reverse_cull_face_mode>`
  4866. 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>`.
  4867. .. rst-class:: classref-item-separator
  4868. ----
  4869. .. _class_RenderingServer_method_light_set_shadow:
  4870. .. rst-class:: classref-method
  4871. |void| **light_set_shadow**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_light_set_shadow>`
  4872. If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
  4873. .. rst-class:: classref-item-separator
  4874. ----
  4875. .. _class_RenderingServer_method_lightmap_create:
  4876. .. rst-class:: classref-method
  4877. :ref:`RID<class_RID>` **lightmap_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_lightmap_create>`
  4878. 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.
  4879. 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.
  4880. \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
  4881. .. rst-class:: classref-item-separator
  4882. ----
  4883. .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
  4884. .. rst-class:: classref-method
  4885. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>`
  4886. .. container:: contribute
  4887. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4888. .. rst-class:: classref-item-separator
  4889. ----
  4890. .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
  4891. .. rst-class:: classref-method
  4892. :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_points>`
  4893. .. container:: contribute
  4894. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4895. .. rst-class:: classref-item-separator
  4896. ----
  4897. .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
  4898. .. rst-class:: classref-method
  4899. :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_sh>`
  4900. .. container:: contribute
  4901. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4902. .. rst-class:: classref-item-separator
  4903. ----
  4904. .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
  4905. .. rst-class:: classref-method
  4906. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`
  4907. .. container:: contribute
  4908. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4909. .. rst-class:: classref-item-separator
  4910. ----
  4911. .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
  4912. .. rst-class:: classref-method
  4913. |void| **lightmap_set_baked_exposure_normalization**\ (\ lightmap\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>`
  4914. 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>`.
  4915. .. rst-class:: classref-item-separator
  4916. ----
  4917. .. _class_RenderingServer_method_lightmap_set_probe_bounds:
  4918. .. rst-class:: classref-method
  4919. |void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_bounds>`
  4920. .. container:: contribute
  4921. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4922. .. rst-class:: classref-item-separator
  4923. ----
  4924. .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
  4925. .. rst-class:: classref-method
  4926. |void| **lightmap_set_probe_capture_data**\ (\ lightmap\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector3Array<class_PackedVector3Array>`, point_sh\: :ref:`PackedColorArray<class_PackedColorArray>`, tetrahedra\: :ref:`PackedInt32Array<class_PackedInt32Array>`, bsp_tree\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_capture_data>`
  4927. .. container:: contribute
  4928. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4929. .. rst-class:: classref-item-separator
  4930. ----
  4931. .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
  4932. .. rst-class:: classref-method
  4933. |void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`
  4934. .. container:: contribute
  4935. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4936. .. rst-class:: classref-item-separator
  4937. ----
  4938. .. _class_RenderingServer_method_lightmap_set_probe_interior:
  4939. .. rst-class:: classref-method
  4940. |void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_probe_interior>`
  4941. .. container:: contribute
  4942. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4943. .. rst-class:: classref-item-separator
  4944. ----
  4945. .. _class_RenderingServer_method_lightmap_set_textures:
  4946. .. rst-class:: classref-method
  4947. |void| **lightmap_set_textures**\ (\ lightmap\: :ref:`RID<class_RID>`, light\: :ref:`RID<class_RID>`, uses_sh\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_lightmap_set_textures>`
  4948. 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``.
  4949. .. rst-class:: classref-item-separator
  4950. ----
  4951. .. _class_RenderingServer_method_make_sphere_mesh:
  4952. .. rst-class:: classref-method
  4953. :ref:`RID<class_RID>` **make_sphere_mesh**\ (\ latitudes\: :ref:`int<class_int>`, longitudes\: :ref:`int<class_int>`, radius\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_make_sphere_mesh>`
  4954. 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>`.
  4955. .. rst-class:: classref-item-separator
  4956. ----
  4957. .. _class_RenderingServer_method_material_create:
  4958. .. rst-class:: classref-method
  4959. :ref:`RID<class_RID>` **material_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_material_create>`
  4960. 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.
  4961. 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.
  4962. \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
  4963. .. rst-class:: classref-item-separator
  4964. ----
  4965. .. _class_RenderingServer_method_material_get_param:
  4966. .. rst-class:: classref-method
  4967. :ref:`Variant<class_Variant>` **material_get_param**\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_material_get_param>`
  4968. Returns the value of a certain material's parameter.
  4969. .. rst-class:: classref-item-separator
  4970. ----
  4971. .. _class_RenderingServer_method_material_set_next_pass:
  4972. .. rst-class:: classref-method
  4973. |void| **material_set_next_pass**\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_next_pass>`
  4974. Sets an object's next material.
  4975. .. rst-class:: classref-item-separator
  4976. ----
  4977. .. _class_RenderingServer_method_material_set_param:
  4978. .. rst-class:: classref-method
  4979. |void| **material_set_param**\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_param>`
  4980. Sets a material's parameter.
  4981. .. rst-class:: classref-item-separator
  4982. ----
  4983. .. _class_RenderingServer_method_material_set_render_priority:
  4984. .. rst-class:: classref-method
  4985. |void| **material_set_render_priority**\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_render_priority>`
  4986. Sets a material's render priority.
  4987. .. rst-class:: classref-item-separator
  4988. ----
  4989. .. _class_RenderingServer_method_material_set_shader:
  4990. .. rst-class:: classref-method
  4991. |void| **material_set_shader**\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_material_set_shader>`
  4992. Sets a shader material's shader.
  4993. .. rst-class:: classref-item-separator
  4994. ----
  4995. .. _class_RenderingServer_method_mesh_add_surface:
  4996. .. rst-class:: classref-method
  4997. |void| **mesh_add_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_add_surface>`
  4998. .. container:: contribute
  4999. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5000. .. rst-class:: classref-item-separator
  5001. ----
  5002. .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
  5003. .. rst-class:: classref-method
  5004. |void| **mesh_add_surface_from_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, primitive\: :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>` = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\] = 0\ ) :ref:`🔗<class_RenderingServer_method_mesh_add_surface_from_arrays>`
  5005. .. container:: contribute
  5006. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5007. .. rst-class:: classref-item-separator
  5008. ----
  5009. .. _class_RenderingServer_method_mesh_clear:
  5010. .. rst-class:: classref-method
  5011. |void| **mesh_clear**\ (\ mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_clear>`
  5012. Removes all surfaces from a mesh.
  5013. .. rst-class:: classref-item-separator
  5014. ----
  5015. .. _class_RenderingServer_method_mesh_create:
  5016. .. rst-class:: classref-method
  5017. :ref:`RID<class_RID>` **mesh_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_mesh_create>`
  5018. 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.
  5019. 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.
  5020. 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.
  5021. \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
  5022. .. rst-class:: classref-item-separator
  5023. ----
  5024. .. _class_RenderingServer_method_mesh_create_from_surfaces:
  5025. .. rst-class:: classref-method
  5026. :ref:`RID<class_RID>` **mesh_create_from_surfaces**\ (\ surfaces\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], blend_shape_count\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_mesh_create_from_surfaces>`
  5027. .. container:: contribute
  5028. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5029. .. rst-class:: classref-item-separator
  5030. ----
  5031. .. _class_RenderingServer_method_mesh_get_blend_shape_count:
  5032. .. rst-class:: classref-method
  5033. :ref:`int<class_int>` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_blend_shape_count>`
  5034. Returns a mesh's blend shape count.
  5035. .. rst-class:: classref-item-separator
  5036. ----
  5037. .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
  5038. .. rst-class:: classref-method
  5039. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_blend_shape_mode>`
  5040. Returns a mesh's blend shape mode.
  5041. .. rst-class:: classref-item-separator
  5042. ----
  5043. .. _class_RenderingServer_method_mesh_get_custom_aabb:
  5044. .. rst-class:: classref-method
  5045. :ref:`AABB<class_AABB>` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_custom_aabb>`
  5046. Returns a mesh's custom aabb.
  5047. .. rst-class:: classref-item-separator
  5048. ----
  5049. .. _class_RenderingServer_method_mesh_get_surface:
  5050. .. rst-class:: classref-method
  5051. :ref:`Dictionary<class_Dictionary>` **mesh_get_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_get_surface>`
  5052. .. container:: contribute
  5053. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5054. .. rst-class:: classref-item-separator
  5055. ----
  5056. .. _class_RenderingServer_method_mesh_get_surface_count:
  5057. .. rst-class:: classref-method
  5058. :ref:`int<class_int>` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_get_surface_count>`
  5059. Returns a mesh's number of surfaces.
  5060. .. rst-class:: classref-item-separator
  5061. ----
  5062. .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
  5063. .. rst-class:: classref-method
  5064. |void| **mesh_set_blend_shape_mode**\ (\ mesh\: :ref:`RID<class_RID>`, mode\: :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_blend_shape_mode>`
  5065. Sets a mesh's blend shape mode.
  5066. .. rst-class:: classref-item-separator
  5067. ----
  5068. .. _class_RenderingServer_method_mesh_set_custom_aabb:
  5069. .. rst-class:: classref-method
  5070. |void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_custom_aabb>`
  5071. Sets a mesh's custom aabb.
  5072. .. rst-class:: classref-item-separator
  5073. ----
  5074. .. _class_RenderingServer_method_mesh_set_shadow_mesh:
  5075. .. rst-class:: classref-method
  5076. |void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_set_shadow_mesh>`
  5077. .. container:: contribute
  5078. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5079. .. rst-class:: classref-item-separator
  5080. ----
  5081. .. _class_RenderingServer_method_mesh_surface_get_arrays:
  5082. .. rst-class:: classref-method
  5083. :ref:`Array<class_Array>` **mesh_surface_get_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_arrays>`
  5084. Returns a mesh's surface's buffer arrays.
  5085. .. rst-class:: classref-item-separator
  5086. ----
  5087. .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
  5088. .. rst-class:: classref-method
  5089. :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] **mesh_surface_get_blend_shape_arrays**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>`
  5090. Returns a mesh's surface's arrays for blend shapes.
  5091. .. rst-class:: classref-item-separator
  5092. ----
  5093. .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
  5094. .. rst-class:: classref-method
  5095. :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>`
  5096. Returns the stride of the attribute buffer for a mesh with given ``format``.
  5097. .. rst-class:: classref-item-separator
  5098. ----
  5099. .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride:
  5100. .. rst-class:: classref-method
  5101. :ref:`int<class_int>` **mesh_surface_get_format_normal_tangent_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride>`
  5102. Returns the stride of the combined normals and tangents for a mesh with given ``format``. Note importantly that, while normals and tangents are in the vertex buffer with vertices, they are only interleaved with each other and so have a different stride than vertex positions.
  5103. .. rst-class:: classref-item-separator
  5104. ----
  5105. .. _class_RenderingServer_method_mesh_surface_get_format_offset:
  5106. .. rst-class:: classref-method
  5107. :ref:`int<class_int>` **mesh_surface_get_format_offset**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`, array_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_offset>`
  5108. Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer.
  5109. .. rst-class:: classref-item-separator
  5110. ----
  5111. .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
  5112. .. rst-class:: classref-method
  5113. :ref:`int<class_int>` **mesh_surface_get_format_skin_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_skin_stride>`
  5114. Returns the stride of the skin buffer for a mesh with given ``format``.
  5115. .. rst-class:: classref-item-separator
  5116. ----
  5117. .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
  5118. .. rst-class:: classref-method
  5119. :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>`
  5120. Returns the stride of the vertex positions for a mesh with given ``format``. Note importantly that vertex positions are stored consecutively and are not interleaved with the other attributes in the vertex buffer (normals and tangents).
  5121. .. rst-class:: classref-item-separator
  5122. ----
  5123. .. _class_RenderingServer_method_mesh_surface_get_material:
  5124. .. rst-class:: classref-method
  5125. :ref:`RID<class_RID>` **mesh_surface_get_material**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_mesh_surface_get_material>`
  5126. Returns a mesh's surface's material.
  5127. .. rst-class:: classref-item-separator
  5128. ----
  5129. .. _class_RenderingServer_method_mesh_surface_set_material:
  5130. .. rst-class:: classref-method
  5131. |void| **mesh_surface_set_material**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_set_material>`
  5132. Sets a mesh's surface's material.
  5133. .. rst-class:: classref-item-separator
  5134. ----
  5135. .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
  5136. .. rst-class:: classref-method
  5137. |void| **mesh_surface_update_attribute_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_attribute_region>`
  5138. .. container:: contribute
  5139. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5140. .. rst-class:: classref-item-separator
  5141. ----
  5142. .. _class_RenderingServer_method_mesh_surface_update_skin_region:
  5143. .. rst-class:: classref-method
  5144. |void| **mesh_surface_update_skin_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_skin_region>`
  5145. .. container:: contribute
  5146. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5147. .. rst-class:: classref-item-separator
  5148. ----
  5149. .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
  5150. .. rst-class:: classref-method
  5151. |void| **mesh_surface_update_vertex_region**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_RenderingServer_method_mesh_surface_update_vertex_region>`
  5152. .. container:: contribute
  5153. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5154. .. rst-class:: classref-item-separator
  5155. ----
  5156. .. _class_RenderingServer_method_multimesh_allocate_data:
  5157. .. rst-class:: classref-method
  5158. |void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_multimesh_allocate_data>`
  5159. .. container:: contribute
  5160. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5161. .. rst-class:: classref-item-separator
  5162. ----
  5163. .. _class_RenderingServer_method_multimesh_create:
  5164. .. rst-class:: classref-method
  5165. :ref:`RID<class_RID>` **multimesh_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_multimesh_create>`
  5166. 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.
  5167. 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.
  5168. 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.
  5169. \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
  5170. .. rst-class:: classref-item-separator
  5171. ----
  5172. .. _class_RenderingServer_method_multimesh_get_aabb:
  5173. .. rst-class:: classref-method
  5174. :ref:`AABB<class_AABB>` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_aabb>`
  5175. Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
  5176. .. rst-class:: classref-item-separator
  5177. ----
  5178. .. _class_RenderingServer_method_multimesh_get_buffer:
  5179. .. rst-class:: classref-method
  5180. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_buffer>`
  5181. Returns the MultiMesh data (such as instance transforms, colors, etc.). See :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` for details on the returned data.
  5182. \ **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.
  5183. .. rst-class:: classref-item-separator
  5184. ----
  5185. .. _class_RenderingServer_method_multimesh_get_custom_aabb:
  5186. .. rst-class:: classref-method
  5187. :ref:`AABB<class_AABB>` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_custom_aabb>`
  5188. Returns the custom AABB defined for this MultiMesh resource.
  5189. .. rst-class:: classref-item-separator
  5190. ----
  5191. .. _class_RenderingServer_method_multimesh_get_instance_count:
  5192. .. rst-class:: classref-method
  5193. :ref:`int<class_int>` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_instance_count>`
  5194. Returns the number of instances allocated for this multimesh.
  5195. .. rst-class:: classref-item-separator
  5196. ----
  5197. .. _class_RenderingServer_method_multimesh_get_mesh:
  5198. .. rst-class:: classref-method
  5199. :ref:`RID<class_RID>` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_mesh>`
  5200. Returns the RID of the mesh that will be used in drawing this multimesh.
  5201. .. rst-class:: classref-item-separator
  5202. ----
  5203. .. _class_RenderingServer_method_multimesh_get_visible_instances:
  5204. .. rst-class:: classref-method
  5205. :ref:`int<class_int>` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_get_visible_instances>`
  5206. Returns the number of visible instances for this multimesh.
  5207. .. rst-class:: classref-item-separator
  5208. ----
  5209. .. _class_RenderingServer_method_multimesh_instance_get_color:
  5210. .. rst-class:: classref-method
  5211. :ref:`Color<class_Color>` **multimesh_instance_get_color**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_color>`
  5212. Returns the color by which the specified instance will be modulated.
  5213. .. rst-class:: classref-item-separator
  5214. ----
  5215. .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
  5216. .. rst-class:: classref-method
  5217. :ref:`Color<class_Color>` **multimesh_instance_get_custom_data**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_custom_data>`
  5218. Returns the custom data associated with the specified instance.
  5219. .. rst-class:: classref-item-separator
  5220. ----
  5221. .. _class_RenderingServer_method_multimesh_instance_get_transform:
  5222. .. rst-class:: classref-method
  5223. :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_transform>`
  5224. Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
  5225. .. rst-class:: classref-item-separator
  5226. ----
  5227. .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
  5228. .. rst-class:: classref-method
  5229. :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_multimesh_instance_get_transform_2d>`
  5230. Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
  5231. .. rst-class:: classref-item-separator
  5232. ----
  5233. .. _class_RenderingServer_method_multimesh_instance_set_color:
  5234. .. rst-class:: classref-method
  5235. |void| **multimesh_instance_set_color**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_color>`
  5236. Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
  5237. .. rst-class:: classref-item-separator
  5238. ----
  5239. .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
  5240. .. rst-class:: classref-method
  5241. |void| **multimesh_instance_set_custom_data**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, custom_data\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_custom_data>`
  5242. 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>`.
  5243. .. rst-class:: classref-item-separator
  5244. ----
  5245. .. _class_RenderingServer_method_multimesh_instance_set_transform:
  5246. .. rst-class:: classref-method
  5247. |void| **multimesh_instance_set_transform**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_transform>`
  5248. Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
  5249. .. rst-class:: classref-item-separator
  5250. ----
  5251. .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
  5252. .. rst-class:: classref-method
  5253. |void| **multimesh_instance_set_transform_2d**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_instance_set_transform_2d>`
  5254. 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>`.
  5255. .. rst-class:: classref-item-separator
  5256. ----
  5257. .. _class_RenderingServer_method_multimesh_set_buffer:
  5258. .. rst-class:: classref-method
  5259. |void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_buffer>`
  5260. 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>`.
  5261. The per-instance data size and expected data order is:
  5262. .. code:: text
  5263. 2D:
  5264. - Position: 8 floats (8 floats for Transform2D)
  5265. - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
  5266. - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
  5267. - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
  5268. 3D:
  5269. - Position: 12 floats (12 floats for Transform3D)
  5270. - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
  5271. - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
  5272. - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
  5273. .. rst-class:: classref-item-separator
  5274. ----
  5275. .. _class_RenderingServer_method_multimesh_set_custom_aabb:
  5276. .. rst-class:: classref-method
  5277. |void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_custom_aabb>`
  5278. Sets the custom AABB for this MultiMesh resource.
  5279. .. rst-class:: classref-item-separator
  5280. ----
  5281. .. _class_RenderingServer_method_multimesh_set_mesh:
  5282. .. rst-class:: classref-method
  5283. |void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_mesh>`
  5284. Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
  5285. .. rst-class:: classref-item-separator
  5286. ----
  5287. .. _class_RenderingServer_method_multimesh_set_visible_instances:
  5288. .. rst-class:: classref-method
  5289. |void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_multimesh_set_visible_instances>`
  5290. 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>`.
  5291. .. rst-class:: classref-item-separator
  5292. ----
  5293. .. _class_RenderingServer_method_occluder_create:
  5294. .. rst-class:: classref-method
  5295. :ref:`RID<class_RID>` **occluder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_occluder_create>`
  5296. 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.
  5297. 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.
  5298. \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
  5299. .. rst-class:: classref-item-separator
  5300. ----
  5301. .. _class_RenderingServer_method_occluder_set_mesh:
  5302. .. rst-class:: classref-method
  5303. |void| **occluder_set_mesh**\ (\ occluder\: :ref:`RID<class_RID>`, vertices\: :ref:`PackedVector3Array<class_PackedVector3Array>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_occluder_set_mesh>`
  5304. Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
  5305. .. rst-class:: classref-item-separator
  5306. ----
  5307. .. _class_RenderingServer_method_omni_light_create:
  5308. .. rst-class:: classref-method
  5309. :ref:`RID<class_RID>` **omni_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_omni_light_create>`
  5310. 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.
  5311. 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.
  5312. 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.
  5313. \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
  5314. .. rst-class:: classref-item-separator
  5315. ----
  5316. .. _class_RenderingServer_method_particles_collision_create:
  5317. .. rst-class:: classref-method
  5318. :ref:`RID<class_RID>` **particles_collision_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_create>`
  5319. 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.
  5320. \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
  5321. .. rst-class:: classref-item-separator
  5322. ----
  5323. .. _class_RenderingServer_method_particles_collision_height_field_update:
  5324. .. rst-class:: classref-method
  5325. |void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_height_field_update>`
  5326. 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>`.
  5327. .. rst-class:: classref-item-separator
  5328. ----
  5329. .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
  5330. .. rst-class:: classref-method
  5331. |void| **particles_collision_set_attractor_attenuation**\ (\ particles_collision\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_attenuation>`
  5332. 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>`.
  5333. .. rst-class:: classref-item-separator
  5334. ----
  5335. .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
  5336. .. rst-class:: classref-method
  5337. |void| **particles_collision_set_attractor_directionality**\ (\ particles_collision\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_directionality>`
  5338. 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>`.
  5339. .. rst-class:: classref-item-separator
  5340. ----
  5341. .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
  5342. .. rst-class:: classref-method
  5343. |void| **particles_collision_set_attractor_strength**\ (\ particles_collision\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_attractor_strength>`
  5344. 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>`.
  5345. .. rst-class:: classref-item-separator
  5346. ----
  5347. .. _class_RenderingServer_method_particles_collision_set_box_extents:
  5348. .. rst-class:: classref-method
  5349. |void| **particles_collision_set_box_extents**\ (\ particles_collision\: :ref:`RID<class_RID>`, extents\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_box_extents>`
  5350. 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.
  5351. .. rst-class:: classref-item-separator
  5352. ----
  5353. .. _class_RenderingServer_method_particles_collision_set_collision_type:
  5354. .. rst-class:: classref-method
  5355. |void| **particles_collision_set_collision_type**\ (\ particles_collision\: :ref:`RID<class_RID>`, type\: :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_collision_type>`
  5356. Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
  5357. .. rst-class:: classref-item-separator
  5358. ----
  5359. .. _class_RenderingServer_method_particles_collision_set_cull_mask:
  5360. .. rst-class:: classref-method
  5361. |void| **particles_collision_set_cull_mask**\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_cull_mask>`
  5362. 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.
  5363. .. rst-class:: classref-item-separator
  5364. ----
  5365. .. _class_RenderingServer_method_particles_collision_set_field_texture:
  5366. .. rst-class:: classref-method
  5367. |void| **particles_collision_set_field_texture**\ (\ particles_collision\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_field_texture>`
  5368. 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.
  5369. .. rst-class:: classref-item-separator
  5370. ----
  5371. .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
  5372. .. rst-class:: classref-method
  5373. |void| **particles_collision_set_height_field_resolution**\ (\ particles_collision\: :ref:`RID<class_RID>`, resolution\: :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_height_field_resolution>`
  5374. 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>`.
  5375. .. rst-class:: classref-item-separator
  5376. ----
  5377. .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
  5378. .. rst-class:: classref-method
  5379. |void| **particles_collision_set_sphere_radius**\ (\ particles_collision\: :ref:`RID<class_RID>`, radius\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_collision_set_sphere_radius>`
  5380. 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.
  5381. .. rst-class:: classref-item-separator
  5382. ----
  5383. .. _class_RenderingServer_method_particles_create:
  5384. .. rst-class:: classref-method
  5385. :ref:`RID<class_RID>` **particles_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_particles_create>`
  5386. 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.
  5387. 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.
  5388. 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.
  5389. \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
  5390. \ **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).
  5391. .. rst-class:: classref-item-separator
  5392. ----
  5393. .. _class_RenderingServer_method_particles_emit:
  5394. .. rst-class:: classref-method
  5395. |void| **particles_emit**\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`, velocity\: :ref:`Vector3<class_Vector3>`, color\: :ref:`Color<class_Color>`, custom\: :ref:`Color<class_Color>`, emit_flags\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_emit>`
  5396. Manually emits particles from the ``particles`` instance.
  5397. .. rst-class:: classref-item-separator
  5398. ----
  5399. .. _class_RenderingServer_method_particles_get_current_aabb:
  5400. .. rst-class:: classref-method
  5401. :ref:`AABB<class_AABB>` **particles_get_current_aabb**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_get_current_aabb>`
  5402. Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
  5403. .. rst-class:: classref-item-separator
  5404. ----
  5405. .. _class_RenderingServer_method_particles_get_emitting:
  5406. .. rst-class:: classref-method
  5407. :ref:`bool<class_bool>` **particles_get_emitting**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_get_emitting>`
  5408. Returns ``true`` if particles are currently set to emitting.
  5409. .. rst-class:: classref-item-separator
  5410. ----
  5411. .. _class_RenderingServer_method_particles_is_inactive:
  5412. .. rst-class:: classref-method
  5413. :ref:`bool<class_bool>` **particles_is_inactive**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_is_inactive>`
  5414. Returns ``true`` if particles are not emitting and particles are set to inactive.
  5415. .. rst-class:: classref-item-separator
  5416. ----
  5417. .. _class_RenderingServer_method_particles_request_process:
  5418. .. rst-class:: classref-method
  5419. |void| **particles_request_process**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_request_process>`
  5420. 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>`.
  5421. .. rst-class:: classref-item-separator
  5422. ----
  5423. .. _class_RenderingServer_method_particles_restart:
  5424. .. rst-class:: classref-method
  5425. |void| **particles_restart**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_restart>`
  5426. Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
  5427. .. rst-class:: classref-item-separator
  5428. ----
  5429. .. _class_RenderingServer_method_particles_set_amount:
  5430. .. rst-class:: classref-method
  5431. |void| **particles_set_amount**\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_amount>`
  5432. Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
  5433. .. rst-class:: classref-item-separator
  5434. ----
  5435. .. _class_RenderingServer_method_particles_set_amount_ratio:
  5436. .. rst-class:: classref-method
  5437. |void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_amount_ratio>`
  5438. Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio<class_GPUParticles3D_property_amount_ratio>`.
  5439. .. rst-class:: classref-item-separator
  5440. ----
  5441. .. _class_RenderingServer_method_particles_set_collision_base_size:
  5442. .. rst-class:: classref-method
  5443. |void| **particles_set_collision_base_size**\ (\ particles\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_collision_base_size>`
  5444. .. container:: contribute
  5445. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5446. .. rst-class:: classref-item-separator
  5447. ----
  5448. .. _class_RenderingServer_method_particles_set_custom_aabb:
  5449. .. rst-class:: classref-method
  5450. |void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_custom_aabb>`
  5451. Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  5452. .. rst-class:: classref-item-separator
  5453. ----
  5454. .. _class_RenderingServer_method_particles_set_draw_order:
  5455. .. rst-class:: classref-method
  5456. |void| **particles_set_draw_order**\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_order>`
  5457. 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>`.
  5458. .. rst-class:: classref-item-separator
  5459. ----
  5460. .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
  5461. .. rst-class:: classref-method
  5462. |void| **particles_set_draw_pass_mesh**\ (\ particles\: :ref:`RID<class_RID>`, pass\: :ref:`int<class_int>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_pass_mesh>`
  5463. 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>`.
  5464. .. rst-class:: classref-item-separator
  5465. ----
  5466. .. _class_RenderingServer_method_particles_set_draw_passes:
  5467. .. rst-class:: classref-method
  5468. |void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_draw_passes>`
  5469. Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
  5470. .. rst-class:: classref-item-separator
  5471. ----
  5472. .. _class_RenderingServer_method_particles_set_emission_transform:
  5473. .. rst-class:: classref-method
  5474. |void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emission_transform>`
  5475. Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
  5476. .. rst-class:: classref-item-separator
  5477. ----
  5478. .. _class_RenderingServer_method_particles_set_emitter_velocity:
  5479. .. rst-class:: classref-method
  5480. |void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emitter_velocity>`
  5481. Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`.
  5482. .. rst-class:: classref-item-separator
  5483. ----
  5484. .. _class_RenderingServer_method_particles_set_emitting:
  5485. .. rst-class:: classref-method
  5486. |void| **particles_set_emitting**\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_emitting>`
  5487. 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>`.
  5488. .. rst-class:: classref-item-separator
  5489. ----
  5490. .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
  5491. .. rst-class:: classref-method
  5492. |void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_explosiveness_ratio>`
  5493. Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
  5494. .. rst-class:: classref-item-separator
  5495. ----
  5496. .. _class_RenderingServer_method_particles_set_fixed_fps:
  5497. .. rst-class:: classref-method
  5498. |void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_fixed_fps>`
  5499. Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
  5500. .. rst-class:: classref-item-separator
  5501. ----
  5502. .. _class_RenderingServer_method_particles_set_fractional_delta:
  5503. .. rst-class:: classref-method
  5504. |void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_fractional_delta>`
  5505. If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
  5506. .. rst-class:: classref-item-separator
  5507. ----
  5508. .. _class_RenderingServer_method_particles_set_interp_to_end:
  5509. .. rst-class:: classref-method
  5510. |void| **particles_set_interp_to_end**\ (\ particles\: :ref:`RID<class_RID>`, factor\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_interp_to_end>`
  5511. Sets the value that informs a :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>` to rush all particles towards the end of their lifetime.
  5512. .. rst-class:: classref-item-separator
  5513. ----
  5514. .. _class_RenderingServer_method_particles_set_interpolate:
  5515. .. rst-class:: classref-method
  5516. |void| **particles_set_interpolate**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_interpolate>`
  5517. .. container:: contribute
  5518. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5519. .. rst-class:: classref-item-separator
  5520. ----
  5521. .. _class_RenderingServer_method_particles_set_lifetime:
  5522. .. rst-class:: classref-method
  5523. |void| **particles_set_lifetime**\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_lifetime>`
  5524. Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
  5525. .. rst-class:: classref-item-separator
  5526. ----
  5527. .. _class_RenderingServer_method_particles_set_mode:
  5528. .. rst-class:: classref-method
  5529. |void| **particles_set_mode**\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_mode>`
  5530. Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
  5531. .. rst-class:: classref-item-separator
  5532. ----
  5533. .. _class_RenderingServer_method_particles_set_one_shot:
  5534. .. rst-class:: classref-method
  5535. |void| **particles_set_one_shot**\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_one_shot>`
  5536. If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
  5537. .. rst-class:: classref-item-separator
  5538. ----
  5539. .. _class_RenderingServer_method_particles_set_pre_process_time:
  5540. .. rst-class:: classref-method
  5541. |void| **particles_set_pre_process_time**\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_pre_process_time>`
  5542. 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>`.
  5543. .. rst-class:: classref-item-separator
  5544. ----
  5545. .. _class_RenderingServer_method_particles_set_process_material:
  5546. .. rst-class:: classref-method
  5547. |void| **particles_set_process_material**\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_process_material>`
  5548. Sets the material for processing the particles.
  5549. \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
  5550. .. rst-class:: classref-item-separator
  5551. ----
  5552. .. _class_RenderingServer_method_particles_set_randomness_ratio:
  5553. .. rst-class:: classref-method
  5554. |void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_randomness_ratio>`
  5555. Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
  5556. .. rst-class:: classref-item-separator
  5557. ----
  5558. .. _class_RenderingServer_method_particles_set_speed_scale:
  5559. .. rst-class:: classref-method
  5560. |void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_speed_scale>`
  5561. Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
  5562. .. rst-class:: classref-item-separator
  5563. ----
  5564. .. _class_RenderingServer_method_particles_set_subemitter:
  5565. .. rst-class:: classref-method
  5566. |void| **particles_set_subemitter**\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_subemitter>`
  5567. .. container:: contribute
  5568. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5569. .. rst-class:: classref-item-separator
  5570. ----
  5571. .. _class_RenderingServer_method_particles_set_trail_bind_poses:
  5572. .. rst-class:: classref-method
  5573. |void| **particles_set_trail_bind_poses**\ (\ particles\: :ref:`RID<class_RID>`, bind_poses\: :ref:`Array<class_Array>`\[:ref:`Transform3D<class_Transform3D>`\]\ ) :ref:`🔗<class_RenderingServer_method_particles_set_trail_bind_poses>`
  5574. .. container:: contribute
  5575. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5576. .. rst-class:: classref-item-separator
  5577. ----
  5578. .. _class_RenderingServer_method_particles_set_trails:
  5579. .. rst-class:: classref-method
  5580. |void| **particles_set_trails**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, length_sec\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_trails>`
  5581. 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>`.
  5582. .. rst-class:: classref-item-separator
  5583. ----
  5584. .. _class_RenderingServer_method_particles_set_transform_align:
  5585. .. rst-class:: classref-method
  5586. |void| **particles_set_transform_align**\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_transform_align>`
  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_particles_set_use_local_coordinates:
  5592. .. rst-class:: classref-method
  5593. |void| **particles_set_use_local_coordinates**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_particles_set_use_local_coordinates>`
  5594. If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
  5595. .. rst-class:: classref-item-separator
  5596. ----
  5597. .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
  5598. .. rst-class:: classref-method
  5599. |void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`🔗<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`
  5600. 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.
  5601. .. rst-class:: classref-item-separator
  5602. ----
  5603. .. _class_RenderingServer_method_reflection_probe_create:
  5604. .. rst-class:: classref-method
  5605. :ref:`RID<class_RID>` **reflection_probe_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_create>`
  5606. 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.
  5607. 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.
  5608. 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.
  5609. \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
  5610. .. rst-class:: classref-item-separator
  5611. ----
  5612. .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
  5613. .. rst-class:: classref-method
  5614. |void| **reflection_probe_set_ambient_color**\ (\ probe\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_color>`
  5615. Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
  5616. .. rst-class:: classref-item-separator
  5617. ----
  5618. .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
  5619. .. rst-class:: classref-method
  5620. |void| **reflection_probe_set_ambient_energy**\ (\ probe\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_energy>`
  5621. Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
  5622. .. rst-class:: classref-item-separator
  5623. ----
  5624. .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
  5625. .. rst-class:: classref-method
  5626. |void| **reflection_probe_set_ambient_mode**\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_ambient_mode>`
  5627. Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
  5628. .. rst-class:: classref-item-separator
  5629. ----
  5630. .. _class_RenderingServer_method_reflection_probe_set_as_interior:
  5631. .. rst-class:: classref-method
  5632. |void| **reflection_probe_set_as_interior**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_as_interior>`
  5633. If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
  5634. .. rst-class:: classref-item-separator
  5635. ----
  5636. .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
  5637. .. rst-class:: classref-method
  5638. |void| **reflection_probe_set_cull_mask**\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_cull_mask>`
  5639. Sets the render cull mask for this reflection probe. Only instances with a matching layer will be reflected by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
  5640. .. rst-class:: classref-item-separator
  5641. ----
  5642. .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
  5643. .. rst-class:: classref-method
  5644. |void| **reflection_probe_set_enable_box_projection**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_enable_box_projection>`
  5645. 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>`.
  5646. .. rst-class:: classref-item-separator
  5647. ----
  5648. .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
  5649. .. rst-class:: classref-method
  5650. |void| **reflection_probe_set_enable_shadows**\ (\ probe\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_enable_shadows>`
  5651. 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>`.
  5652. .. rst-class:: classref-item-separator
  5653. ----
  5654. .. _class_RenderingServer_method_reflection_probe_set_intensity:
  5655. .. rst-class:: classref-method
  5656. |void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_intensity>`
  5657. Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
  5658. .. rst-class:: classref-item-separator
  5659. ----
  5660. .. _class_RenderingServer_method_reflection_probe_set_max_distance:
  5661. .. rst-class:: classref-method
  5662. |void| **reflection_probe_set_max_distance**\ (\ probe\: :ref:`RID<class_RID>`, distance\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_max_distance>`
  5663. 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>`.
  5664. .. rst-class:: classref-item-separator
  5665. ----
  5666. .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
  5667. .. rst-class:: classref-method
  5668. |void| **reflection_probe_set_mesh_lod_threshold**\ (\ probe\: :ref:`RID<class_RID>`, pixels\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>`
  5669. 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>`.
  5670. .. rst-class:: classref-item-separator
  5671. ----
  5672. .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
  5673. .. rst-class:: classref-method
  5674. |void| **reflection_probe_set_origin_offset**\ (\ probe\: :ref:`RID<class_RID>`, offset\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_origin_offset>`
  5675. 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>`.
  5676. .. rst-class:: classref-item-separator
  5677. ----
  5678. .. _class_RenderingServer_method_reflection_probe_set_reflection_mask:
  5679. .. rst-class:: classref-method
  5680. |void| **reflection_probe_set_reflection_mask**\ (\ probe\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_reflection_mask>`
  5681. Sets the render reflection mask for this reflection probe. Only instances with a matching layer will have reflections applied from this probe. Equivalent to :ref:`ReflectionProbe.reflection_mask<class_ReflectionProbe_property_reflection_mask>`.
  5682. .. rst-class:: classref-item-separator
  5683. ----
  5684. .. _class_RenderingServer_method_reflection_probe_set_resolution:
  5685. .. rst-class:: classref-method
  5686. |void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_resolution>`
  5687. 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).
  5688. .. rst-class:: classref-item-separator
  5689. ----
  5690. .. _class_RenderingServer_method_reflection_probe_set_size:
  5691. .. rst-class:: classref-method
  5692. |void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_size>`
  5693. Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
  5694. .. rst-class:: classref-item-separator
  5695. ----
  5696. .. _class_RenderingServer_method_reflection_probe_set_update_mode:
  5697. .. rst-class:: classref-method
  5698. |void| **reflection_probe_set_update_mode**\ (\ probe\: :ref:`RID<class_RID>`, mode\: :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_reflection_probe_set_update_mode>`
  5699. Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
  5700. .. rst-class:: classref-item-separator
  5701. ----
  5702. .. _class_RenderingServer_method_request_frame_drawn_callback:
  5703. .. rst-class:: classref-method
  5704. |void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_request_frame_drawn_callback>`
  5705. Schedules a callback to the given callable after a frame has been drawn.
  5706. .. rst-class:: classref-item-separator
  5707. ----
  5708. .. _class_RenderingServer_method_scenario_create:
  5709. .. rst-class:: classref-method
  5710. :ref:`RID<class_RID>` **scenario_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_scenario_create>`
  5711. 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.
  5712. 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.
  5713. The scenario is the 3D world that all the visual instances exist in.
  5714. .. rst-class:: classref-item-separator
  5715. ----
  5716. .. _class_RenderingServer_method_scenario_set_camera_attributes:
  5717. .. rst-class:: classref-method
  5718. |void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_camera_attributes>`
  5719. Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
  5720. .. rst-class:: classref-item-separator
  5721. ----
  5722. .. _class_RenderingServer_method_scenario_set_compositor:
  5723. .. rst-class:: classref-method
  5724. |void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_compositor>`
  5725. Sets the compositor (``compositor``) that will be used with this scenario. See also :ref:`Compositor<class_Compositor>`.
  5726. .. rst-class:: classref-item-separator
  5727. ----
  5728. .. _class_RenderingServer_method_scenario_set_environment:
  5729. .. rst-class:: classref-method
  5730. |void| **scenario_set_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_environment>`
  5731. Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
  5732. .. rst-class:: classref-item-separator
  5733. ----
  5734. .. _class_RenderingServer_method_scenario_set_fallback_environment:
  5735. .. rst-class:: classref-method
  5736. |void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_scenario_set_fallback_environment>`
  5737. 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.
  5738. .. rst-class:: classref-item-separator
  5739. ----
  5740. .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
  5741. .. rst-class:: classref-method
  5742. |void| **screen_space_roughness_limiter_set_active**\ (\ enable\: :ref:`bool<class_bool>`, amount\: :ref:`float<class_float>`, limit\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_screen_space_roughness_limiter_set_active>`
  5743. 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>`.
  5744. .. rst-class:: classref-item-separator
  5745. ----
  5746. .. _class_RenderingServer_method_set_boot_image:
  5747. .. rst-class:: classref-method
  5748. |void| **set_boot_image**\ (\ image\: :ref:`Image<class_Image>`, color\: :ref:`Color<class_Color>`, scale\: :ref:`bool<class_bool>`, use_filter\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_RenderingServer_method_set_boot_image>`
  5749. 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.
  5750. .. rst-class:: classref-item-separator
  5751. ----
  5752. .. _class_RenderingServer_method_set_debug_generate_wireframes:
  5753. .. rst-class:: classref-method
  5754. |void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_set_debug_generate_wireframes>`
  5755. This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``.
  5756. .. rst-class:: classref-item-separator
  5757. ----
  5758. .. _class_RenderingServer_method_set_default_clear_color:
  5759. .. rst-class:: classref-method
  5760. |void| **set_default_clear_color**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_RenderingServer_method_set_default_clear_color>`
  5761. 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>`.
  5762. .. rst-class:: classref-item-separator
  5763. ----
  5764. .. _class_RenderingServer_method_shader_create:
  5765. .. rst-class:: classref-method
  5766. :ref:`RID<class_RID>` **shader_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_shader_create>`
  5767. 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.
  5768. 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.
  5769. \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
  5770. .. rst-class:: classref-item-separator
  5771. ----
  5772. .. _class_RenderingServer_method_shader_get_code:
  5773. .. rst-class:: classref-method
  5774. :ref:`String<class_String>` **shader_get_code**\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_code>`
  5775. Returns a shader's source code as a string.
  5776. .. rst-class:: classref-item-separator
  5777. ----
  5778. .. _class_RenderingServer_method_shader_get_default_texture_parameter:
  5779. .. rst-class:: classref-method
  5780. :ref:`RID<class_RID>` **shader_get_default_texture_parameter**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, index\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_default_texture_parameter>`
  5781. Returns a default texture from a shader searched by name.
  5782. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5783. .. rst-class:: classref-item-separator
  5784. ----
  5785. .. _class_RenderingServer_method_shader_get_parameter_default:
  5786. .. rst-class:: classref-method
  5787. :ref:`Variant<class_Variant>` **shader_get_parameter_default**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_RenderingServer_method_shader_get_parameter_default>`
  5788. Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
  5789. .. rst-class:: classref-item-separator
  5790. ----
  5791. .. _class_RenderingServer_method_shader_set_code:
  5792. .. rst-class:: classref-method
  5793. |void| **shader_set_code**\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_shader_set_code>`
  5794. Sets the shader's source code (which triggers recompilation after being changed).
  5795. .. rst-class:: classref-item-separator
  5796. ----
  5797. .. _class_RenderingServer_method_shader_set_default_texture_parameter:
  5798. .. rst-class:: classref-method
  5799. |void| **shader_set_default_texture_parameter**\ (\ shader\: :ref:`RID<class_RID>`, name\: :ref:`StringName<class_StringName>`, texture\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_shader_set_default_texture_parameter>`
  5800. Sets a shader's default texture. Overwrites the texture given by name.
  5801. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5802. .. rst-class:: classref-item-separator
  5803. ----
  5804. .. _class_RenderingServer_method_shader_set_path_hint:
  5805. .. rst-class:: classref-method
  5806. |void| **shader_set_path_hint**\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_shader_set_path_hint>`
  5807. 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>`.
  5808. .. rst-class:: classref-item-separator
  5809. ----
  5810. .. _class_RenderingServer_method_skeleton_allocate_data:
  5811. .. rst-class:: classref-method
  5812. |void| **skeleton_allocate_data**\ (\ skeleton\: :ref:`RID<class_RID>`, bones\: :ref:`int<class_int>`, is_2d_skeleton\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_skeleton_allocate_data>`
  5813. .. container:: contribute
  5814. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5815. .. rst-class:: classref-item-separator
  5816. ----
  5817. .. _class_RenderingServer_method_skeleton_bone_get_transform:
  5818. .. rst-class:: classref-method
  5819. :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_bone_get_transform>`
  5820. Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
  5821. .. rst-class:: classref-item-separator
  5822. ----
  5823. .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
  5824. .. rst-class:: classref-method
  5825. :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_bone_get_transform_2d>`
  5826. Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
  5827. .. rst-class:: classref-item-separator
  5828. ----
  5829. .. _class_RenderingServer_method_skeleton_bone_set_transform:
  5830. .. rst-class:: classref-method
  5831. |void| **skeleton_bone_set_transform**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_bone_set_transform>`
  5832. Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
  5833. .. rst-class:: classref-item-separator
  5834. ----
  5835. .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
  5836. .. rst-class:: classref-method
  5837. |void| **skeleton_bone_set_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, bone\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_bone_set_transform_2d>`
  5838. Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
  5839. .. rst-class:: classref-item-separator
  5840. ----
  5841. .. _class_RenderingServer_method_skeleton_create:
  5842. .. rst-class:: classref-method
  5843. :ref:`RID<class_RID>` **skeleton_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_skeleton_create>`
  5844. 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.
  5845. 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.
  5846. .. rst-class:: classref-item-separator
  5847. ----
  5848. .. _class_RenderingServer_method_skeleton_get_bone_count:
  5849. .. rst-class:: classref-method
  5850. :ref:`int<class_int>` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_skeleton_get_bone_count>`
  5851. Returns the number of bones allocated for this skeleton.
  5852. .. rst-class:: classref-item-separator
  5853. ----
  5854. .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
  5855. .. rst-class:: classref-method
  5856. |void| **skeleton_set_base_transform_2d**\ (\ skeleton\: :ref:`RID<class_RID>`, base_transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_skeleton_set_base_transform_2d>`
  5857. .. container:: contribute
  5858. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5859. .. rst-class:: classref-item-separator
  5860. ----
  5861. .. _class_RenderingServer_method_sky_bake_panorama:
  5862. .. rst-class:: classref-method
  5863. :ref:`Image<class_Image>` **sky_bake_panorama**\ (\ sky\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_RenderingServer_method_sky_bake_panorama>`
  5864. 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>`.
  5865. \ **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.
  5866. \ **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.
  5867. .. rst-class:: classref-item-separator
  5868. ----
  5869. .. _class_RenderingServer_method_sky_create:
  5870. .. rst-class:: classref-method
  5871. :ref:`RID<class_RID>` **sky_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_sky_create>`
  5872. 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.
  5873. 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.
  5874. .. rst-class:: classref-item-separator
  5875. ----
  5876. .. _class_RenderingServer_method_sky_set_material:
  5877. .. rst-class:: classref-method
  5878. |void| **sky_set_material**\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_material>`
  5879. Sets the material that the sky uses to render the background, ambient and reflection maps.
  5880. .. rst-class:: classref-item-separator
  5881. ----
  5882. .. _class_RenderingServer_method_sky_set_mode:
  5883. .. rst-class:: classref-method
  5884. |void| **sky_set_mode**\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_mode>`
  5885. Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
  5886. .. rst-class:: classref-item-separator
  5887. ----
  5888. .. _class_RenderingServer_method_sky_set_radiance_size:
  5889. .. rst-class:: classref-method
  5890. |void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_sky_set_radiance_size>`
  5891. 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>`.
  5892. .. rst-class:: classref-item-separator
  5893. ----
  5894. .. _class_RenderingServer_method_spot_light_create:
  5895. .. rst-class:: classref-method
  5896. :ref:`RID<class_RID>` **spot_light_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_spot_light_create>`
  5897. 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.
  5898. 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.
  5899. 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.
  5900. .. rst-class:: classref-item-separator
  5901. ----
  5902. .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
  5903. .. rst-class:: classref-method
  5904. |void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) :ref:`🔗<class_RenderingServer_method_sub_surface_scattering_set_quality>`
  5905. 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.
  5906. .. rst-class:: classref-item-separator
  5907. ----
  5908. .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
  5909. .. rst-class:: classref-method
  5910. |void| **sub_surface_scattering_set_scale**\ (\ scale\: :ref:`float<class_float>`, depth_scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_sub_surface_scattering_set_scale>`
  5911. 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.
  5912. .. rst-class:: classref-item-separator
  5913. ----
  5914. .. _class_RenderingServer_method_texture_2d_create:
  5915. .. rst-class:: classref-method
  5916. :ref:`RID<class_RID>` **texture_2d_create**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_create>`
  5917. 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.
  5918. 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.
  5919. \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
  5920. \ **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.
  5921. .. rst-class:: classref-item-separator
  5922. ----
  5923. .. _class_RenderingServer_method_texture_2d_get:
  5924. .. rst-class:: classref-method
  5925. :ref:`Image<class_Image>` **texture_2d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_2d_get>`
  5926. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
  5927. 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:
  5928. ::
  5929. var texture_rid = RenderingServer.get_test_texture()
  5930. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  5931. $Sprite2D.texture = texture
  5932. .. rst-class:: classref-item-separator
  5933. ----
  5934. .. _class_RenderingServer_method_texture_2d_layer_get:
  5935. .. rst-class:: classref-method
  5936. :ref:`Image<class_Image>` **texture_2d_layer_get**\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_2d_layer_get>`
  5937. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
  5938. .. rst-class:: classref-item-separator
  5939. ----
  5940. .. _class_RenderingServer_method_texture_2d_layered_create:
  5941. .. rst-class:: classref-method
  5942. :ref:`RID<class_RID>` **texture_2d_layered_create**\ (\ layers\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\], layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_layered_create>`
  5943. 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.
  5944. 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.
  5945. \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
  5946. .. rst-class:: classref-item-separator
  5947. ----
  5948. .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
  5949. .. rst-class:: classref-method
  5950. :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create**\ (\ layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_layered_placeholder_create>`
  5951. 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>`.
  5952. \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
  5953. .. rst-class:: classref-item-separator
  5954. ----
  5955. .. _class_RenderingServer_method_texture_2d_placeholder_create:
  5956. .. rst-class:: classref-method
  5957. :ref:`RID<class_RID>` **texture_2d_placeholder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_placeholder_create>`
  5958. 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>`\
  5959. 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.
  5960. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
  5961. .. rst-class:: classref-item-separator
  5962. ----
  5963. .. _class_RenderingServer_method_texture_2d_update:
  5964. .. rst-class:: classref-method
  5965. |void| **texture_2d_update**\ (\ texture\: :ref:`RID<class_RID>`, image\: :ref:`Image<class_Image>`, layer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_texture_2d_update>`
  5966. 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>`).
  5967. \ **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.
  5968. .. rst-class:: classref-item-separator
  5969. ----
  5970. .. _class_RenderingServer_method_texture_3d_create:
  5971. .. rst-class:: classref-method
  5972. :ref:`RID<class_RID>` **texture_3d_create**\ (\ format\: :ref:`Format<enum_Image_Format>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, mipmaps\: :ref:`bool<class_bool>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_create>`
  5973. **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
  5974. .. rst-class:: classref-item-separator
  5975. ----
  5976. .. _class_RenderingServer_method_texture_3d_get:
  5977. .. rst-class:: classref-method
  5978. :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] **texture_3d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_3d_get>`
  5979. Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
  5980. .. rst-class:: classref-item-separator
  5981. ----
  5982. .. _class_RenderingServer_method_texture_3d_placeholder_create:
  5983. .. rst-class:: classref-method
  5984. :ref:`RID<class_RID>` **texture_3d_placeholder_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_placeholder_create>`
  5985. 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.
  5986. 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.
  5987. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
  5988. .. rst-class:: classref-item-separator
  5989. ----
  5990. .. _class_RenderingServer_method_texture_3d_update:
  5991. .. rst-class:: classref-method
  5992. |void| **texture_3d_update**\ (\ texture\: :ref:`RID<class_RID>`, data\: :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\]\ ) :ref:`🔗<class_RenderingServer_method_texture_3d_update>`
  5993. 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.
  5994. \ **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.
  5995. .. rst-class:: classref-item-separator
  5996. ----
  5997. .. _class_RenderingServer_method_texture_get_format:
  5998. .. rst-class:: classref-method
  5999. :ref:`Format<enum_Image_Format>` **texture_get_format**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_format>`
  6000. Returns the format for the texture.
  6001. .. rst-class:: classref-item-separator
  6002. ----
  6003. .. _class_RenderingServer_method_texture_get_native_handle:
  6004. .. rst-class:: classref-method
  6005. :ref:`int<class_int>` **texture_get_native_handle**\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_native_handle>`
  6006. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  6007. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  6008. .. rst-class:: classref-item-separator
  6009. ----
  6010. .. _class_RenderingServer_method_texture_get_path:
  6011. .. rst-class:: classref-method
  6012. :ref:`String<class_String>` **texture_get_path**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_path>`
  6013. .. container:: contribute
  6014. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6015. .. rst-class:: classref-item-separator
  6016. ----
  6017. .. _class_RenderingServer_method_texture_get_rd_texture:
  6018. .. rst-class:: classref-method
  6019. :ref:`RID<class_RID>` **texture_get_rd_texture**\ (\ texture\: :ref:`RID<class_RID>`, srgb\: :ref:`bool<class_bool>` = false\ ) |const| :ref:`🔗<class_RenderingServer_method_texture_get_rd_texture>`
  6020. Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
  6021. .. rst-class:: classref-item-separator
  6022. ----
  6023. .. _class_RenderingServer_method_texture_proxy_create:
  6024. .. rst-class:: classref-method
  6025. :ref:`RID<class_RID>` **texture_proxy_create**\ (\ base\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_proxy_create>`
  6026. **Deprecated:** ProxyTexture was removed in Godot 4.
  6027. This method does nothing and always returns an invalid :ref:`RID<class_RID>`.
  6028. .. rst-class:: classref-item-separator
  6029. ----
  6030. .. _class_RenderingServer_method_texture_proxy_update:
  6031. .. rst-class:: classref-method
  6032. |void| **texture_proxy_update**\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_proxy_update>`
  6033. **Deprecated:** ProxyTexture was removed in Godot 4.
  6034. This method does nothing.
  6035. .. rst-class:: classref-item-separator
  6036. ----
  6037. .. _class_RenderingServer_method_texture_rd_create:
  6038. .. rst-class:: classref-method
  6039. :ref:`RID<class_RID>` **texture_rd_create**\ (\ rd_texture\: :ref:`RID<class_RID>`, layer_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) :ref:`🔗<class_RenderingServer_method_texture_rd_create>`
  6040. Creates a new texture object based on a texture created directly on the :ref:`RenderingDevice<class_RenderingDevice>`. If the texture contains layers, ``layer_type`` is used to define the layer type.
  6041. .. rst-class:: classref-item-separator
  6042. ----
  6043. .. _class_RenderingServer_method_texture_replace:
  6044. .. rst-class:: classref-method
  6045. |void| **texture_replace**\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_texture_replace>`
  6046. Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
  6047. .. rst-class:: classref-item-separator
  6048. ----
  6049. .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
  6050. .. rst-class:: classref-method
  6051. |void| **texture_set_force_redraw_if_visible**\ (\ texture\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_force_redraw_if_visible>`
  6052. .. container:: contribute
  6053. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6054. .. rst-class:: classref-item-separator
  6055. ----
  6056. .. _class_RenderingServer_method_texture_set_path:
  6057. .. rst-class:: classref-method
  6058. |void| **texture_set_path**\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_path>`
  6059. .. container:: contribute
  6060. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6061. .. rst-class:: classref-item-separator
  6062. ----
  6063. .. _class_RenderingServer_method_texture_set_size_override:
  6064. .. rst-class:: classref-method
  6065. |void| **texture_set_size_override**\ (\ texture\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_texture_set_size_override>`
  6066. .. container:: contribute
  6067. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6068. .. rst-class:: classref-item-separator
  6069. ----
  6070. .. _class_RenderingServer_method_viewport_attach_camera:
  6071. .. rst-class:: classref-method
  6072. |void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_camera>`
  6073. Sets a viewport's camera.
  6074. .. rst-class:: classref-item-separator
  6075. ----
  6076. .. _class_RenderingServer_method_viewport_attach_canvas:
  6077. .. rst-class:: classref-method
  6078. |void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_canvas>`
  6079. Sets a viewport's canvas.
  6080. .. rst-class:: classref-item-separator
  6081. ----
  6082. .. _class_RenderingServer_method_viewport_attach_to_screen:
  6083. .. rst-class:: classref-method
  6084. |void| **viewport_attach_to_screen**\ (\ viewport\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), screen\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_RenderingServer_method_viewport_attach_to_screen>`
  6085. 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.
  6086. For example, you can set the root viewport to not render at all with the following code:
  6087. FIXME: The method seems to be non-existent.
  6088. .. tabs::
  6089. .. code-tab:: gdscript
  6090. func _ready():
  6091. get_viewport().set_attach_to_screen_rect(Rect2())
  6092. $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
  6093. 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>`.
  6094. .. rst-class:: classref-item-separator
  6095. ----
  6096. .. _class_RenderingServer_method_viewport_create:
  6097. .. rst-class:: classref-method
  6098. :ref:`RID<class_RID>` **viewport_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_viewport_create>`
  6099. 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.
  6100. 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.
  6101. \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
  6102. .. rst-class:: classref-item-separator
  6103. ----
  6104. .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
  6105. .. rst-class:: classref-method
  6106. :ref:`float<class_float>` **viewport_get_measured_render_time_cpu**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`
  6107. 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>`.
  6108. \ **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``.
  6109. .. rst-class:: classref-item-separator
  6110. ----
  6111. .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
  6112. .. rst-class:: classref-method
  6113. :ref:`float<class_float>` **viewport_get_measured_render_time_gpu**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`
  6114. 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>`.
  6115. \ **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``.
  6116. \ **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.
  6117. .. rst-class:: classref-item-separator
  6118. ----
  6119. .. _class_RenderingServer_method_viewport_get_render_info:
  6120. .. rst-class:: classref-method
  6121. :ref:`int<class_int>` **viewport_get_render_info**\ (\ viewport\: :ref:`RID<class_RID>`, type\: :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>`, info\: :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_get_render_info>`
  6122. 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.
  6123. See also :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
  6124. \ **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:
  6125. ::
  6126. func _ready():
  6127. for _i in 2:
  6128. await get_tree().process_frame
  6129. print(
  6130. RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
  6131. RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  6132. RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
  6133. )
  6134. .. rst-class:: classref-item-separator
  6135. ----
  6136. .. _class_RenderingServer_method_viewport_get_render_target:
  6137. .. rst-class:: classref-method
  6138. :ref:`RID<class_RID>` **viewport_get_render_target**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_render_target>`
  6139. Returns the render target for the viewport.
  6140. .. rst-class:: classref-item-separator
  6141. ----
  6142. .. _class_RenderingServer_method_viewport_get_texture:
  6143. .. rst-class:: classref-method
  6144. :ref:`RID<class_RID>` **viewport_get_texture**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_texture>`
  6145. Returns the viewport's last rendered frame.
  6146. .. rst-class:: classref-item-separator
  6147. ----
  6148. .. _class_RenderingServer_method_viewport_get_update_mode:
  6149. .. rst-class:: classref-method
  6150. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_viewport_get_update_mode>`
  6151. Returns the viewport's update mode. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  6152. \ **Warning:** Calling this from any thread other than the rendering thread will be detrimental to performance.
  6153. .. rst-class:: classref-item-separator
  6154. ----
  6155. .. _class_RenderingServer_method_viewport_remove_canvas:
  6156. .. rst-class:: classref-method
  6157. |void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_remove_canvas>`
  6158. Detaches a viewport from a canvas.
  6159. .. rst-class:: classref-item-separator
  6160. ----
  6161. .. _class_RenderingServer_method_viewport_set_active:
  6162. .. rst-class:: classref-method
  6163. |void| **viewport_set_active**\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_active>`
  6164. If ``true``, sets the viewport active, else sets it inactive.
  6165. .. rst-class:: classref-item-separator
  6166. ----
  6167. .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
  6168. .. rst-class:: classref-method
  6169. |void| **viewport_set_canvas_cull_mask**\ (\ viewport\: :ref:`RID<class_RID>`, canvas_cull_mask\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_cull_mask>`
  6170. 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>`.
  6171. .. rst-class:: classref-item-separator
  6172. ----
  6173. .. _class_RenderingServer_method_viewport_set_canvas_stacking:
  6174. .. rst-class:: classref-method
  6175. |void| **viewport_set_canvas_stacking**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, sublayer\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_stacking>`
  6176. Sets the stacking order for a viewport's canvas.
  6177. \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
  6178. .. rst-class:: classref-item-separator
  6179. ----
  6180. .. _class_RenderingServer_method_viewport_set_canvas_transform:
  6181. .. rst-class:: classref-method
  6182. |void| **viewport_set_canvas_transform**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, offset\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_canvas_transform>`
  6183. Sets the transformation of a viewport's canvas.
  6184. .. rst-class:: classref-item-separator
  6185. ----
  6186. .. _class_RenderingServer_method_viewport_set_clear_mode:
  6187. .. rst-class:: classref-method
  6188. |void| **viewport_set_clear_mode**\ (\ viewport\: :ref:`RID<class_RID>`, clear_mode\: :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_clear_mode>`
  6189. Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
  6190. .. rst-class:: classref-item-separator
  6191. ----
  6192. .. _class_RenderingServer_method_viewport_set_debug_draw:
  6193. .. rst-class:: classref-method
  6194. |void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_debug_draw>`
  6195. Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
  6196. .. rst-class:: classref-item-separator
  6197. ----
  6198. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
  6199. .. rst-class:: classref-method
  6200. |void| **viewport_set_default_canvas_item_texture_filter**\ (\ viewport\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>`
  6201. Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` for options.
  6202. .. rst-class:: classref-item-separator
  6203. ----
  6204. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
  6205. .. rst-class:: classref-method
  6206. |void| **viewport_set_default_canvas_item_texture_repeat**\ (\ viewport\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>`
  6207. Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` for options.
  6208. .. rst-class:: classref-item-separator
  6209. ----
  6210. .. _class_RenderingServer_method_viewport_set_disable_2d:
  6211. .. rst-class:: classref-method
  6212. |void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_disable_2d>`
  6213. If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
  6214. .. rst-class:: classref-item-separator
  6215. ----
  6216. .. _class_RenderingServer_method_viewport_set_disable_3d:
  6217. .. rst-class:: classref-method
  6218. |void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_disable_3d>`
  6219. If ``true``, the viewport's 3D elements are not rendered.
  6220. .. rst-class:: classref-item-separator
  6221. ----
  6222. .. _class_RenderingServer_method_viewport_set_environment_mode:
  6223. .. rst-class:: classref-method
  6224. |void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_environment_mode>`
  6225. 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>`.
  6226. .. rst-class:: classref-item-separator
  6227. ----
  6228. .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
  6229. .. rst-class:: classref-method
  6230. |void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_fsr_sharpness>`
  6231. 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.
  6232. .. rst-class:: classref-item-separator
  6233. ----
  6234. .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
  6235. .. rst-class:: classref-method
  6236. |void| **viewport_set_global_canvas_transform**\ (\ viewport\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_global_canvas_transform>`
  6237. Sets the viewport's global transformation matrix.
  6238. .. rst-class:: classref-item-separator
  6239. ----
  6240. .. _class_RenderingServer_method_viewport_set_measure_render_time:
  6241. .. rst-class:: classref-method
  6242. |void| **viewport_set_measure_render_time**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_measure_render_time>`
  6243. 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``.
  6244. .. rst-class:: classref-item-separator
  6245. ----
  6246. .. _class_RenderingServer_method_viewport_set_msaa_2d:
  6247. .. rst-class:: classref-method
  6248. |void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_msaa_2d>`
  6249. Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  6250. .. rst-class:: classref-item-separator
  6251. ----
  6252. .. _class_RenderingServer_method_viewport_set_msaa_3d:
  6253. .. rst-class:: classref-method
  6254. |void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_msaa_3d>`
  6255. Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  6256. .. rst-class:: classref-item-separator
  6257. ----
  6258. .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
  6259. .. rst-class:: classref-method
  6260. |void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`
  6261. 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.
  6262. .. rst-class:: classref-item-separator
  6263. ----
  6264. .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
  6265. .. rst-class:: classref-method
  6266. |void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`
  6267. 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.
  6268. .. rst-class:: classref-item-separator
  6269. ----
  6270. .. _class_RenderingServer_method_viewport_set_parent_viewport:
  6271. .. rst-class:: classref-method
  6272. |void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_parent_viewport>`
  6273. Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
  6274. .. rst-class:: classref-item-separator
  6275. ----
  6276. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
  6277. .. rst-class:: classref-method
  6278. |void| **viewport_set_positional_shadow_atlas_quadrant_subdivision**\ (\ viewport\: :ref:`RID<class_RID>`, quadrant\: :ref:`int<class_int>`, subdivision\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>`
  6279. 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>`.
  6280. .. rst-class:: classref-item-separator
  6281. ----
  6282. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
  6283. .. rst-class:: classref-method
  6284. |void| **viewport_set_positional_shadow_atlas_size**\ (\ viewport\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, use_16_bits\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>`
  6285. 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.
  6286. \ **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).
  6287. .. rst-class:: classref-item-separator
  6288. ----
  6289. .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
  6290. .. rst-class:: classref-method
  6291. |void| **viewport_set_render_direct_to_screen**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_render_direct_to_screen>`
  6292. 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.
  6293. .. rst-class:: classref-item-separator
  6294. ----
  6295. .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
  6296. .. rst-class:: classref-method
  6297. |void| **viewport_set_scaling_3d_mode**\ (\ viewport\: :ref:`RID<class_RID>`, scaling_3d_mode\: :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scaling_3d_mode>`
  6298. 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.
  6299. .. rst-class:: classref-item-separator
  6300. ----
  6301. .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
  6302. .. rst-class:: classref-method
  6303. |void| **viewport_set_scaling_3d_scale**\ (\ viewport\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scaling_3d_scale>`
  6304. 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.
  6305. 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.
  6306. .. rst-class:: classref-item-separator
  6307. ----
  6308. .. _class_RenderingServer_method_viewport_set_scenario:
  6309. .. rst-class:: classref-method
  6310. |void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_scenario>`
  6311. Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
  6312. .. rst-class:: classref-item-separator
  6313. ----
  6314. .. _class_RenderingServer_method_viewport_set_screen_space_aa:
  6315. .. rst-class:: classref-method
  6316. |void| **viewport_set_screen_space_aa**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_screen_space_aa>`
  6317. Sets the viewport's screen-space antialiasing mode.
  6318. .. rst-class:: classref-item-separator
  6319. ----
  6320. .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
  6321. .. rst-class:: classref-method
  6322. |void| **viewport_set_sdf_oversize_and_scale**\ (\ viewport\: :ref:`RID<class_RID>`, oversize\: :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>`, scale\: :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>`
  6323. 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.
  6324. .. rst-class:: classref-item-separator
  6325. ----
  6326. .. _class_RenderingServer_method_viewport_set_size:
  6327. .. rst-class:: classref-method
  6328. |void| **viewport_set_size**\ (\ viewport\: :ref:`RID<class_RID>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_size>`
  6329. Sets the viewport's width and height in pixels.
  6330. .. rst-class:: classref-item-separator
  6331. ----
  6332. .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
  6333. .. rst-class:: classref-method
  6334. |void| **viewport_set_snap_2d_transforms_to_pixel**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>`
  6335. 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>`.
  6336. .. rst-class:: classref-item-separator
  6337. ----
  6338. .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
  6339. .. rst-class:: classref-method
  6340. |void| **viewport_set_snap_2d_vertices_to_pixel**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>`
  6341. 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>`.
  6342. .. rst-class:: classref-item-separator
  6343. ----
  6344. .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
  6345. .. rst-class:: classref-method
  6346. |void| **viewport_set_texture_mipmap_bias**\ (\ viewport\: :ref:`RID<class_RID>`, mipmap_bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_texture_mipmap_bias>`
  6347. 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.
  6348. \ **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``.
  6349. .. rst-class:: classref-item-separator
  6350. ----
  6351. .. _class_RenderingServer_method_viewport_set_transparent_background:
  6352. .. rst-class:: classref-method
  6353. |void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_transparent_background>`
  6354. If ``true``, the viewport renders its background as transparent.
  6355. .. rst-class:: classref-item-separator
  6356. ----
  6357. .. _class_RenderingServer_method_viewport_set_update_mode:
  6358. .. rst-class:: classref-method
  6359. |void| **viewport_set_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`, update_mode\: :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_update_mode>`
  6360. Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  6361. .. rst-class:: classref-item-separator
  6362. ----
  6363. .. _class_RenderingServer_method_viewport_set_use_debanding:
  6364. .. rst-class:: classref-method
  6365. |void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_debanding>`
  6366. 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>`.
  6367. .. rst-class:: classref-item-separator
  6368. ----
  6369. .. _class_RenderingServer_method_viewport_set_use_hdr_2d:
  6370. .. rst-class:: classref-method
  6371. |void| **viewport_set_use_hdr_2d**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_hdr_2d>`
  6372. If ``true``, 2D rendering will use a high dynamic range (HDR) format framebuffer matching the bit depth of the 3D framebuffer. When using the Forward+ renderer this will be an ``RGBA16`` framebuffer, while when using the Mobile renderer it will be an ``RGB10_A2`` framebuffer. Additionally, 2D rendering will take place in linear color space and will be converted to sRGB space immediately before blitting to the screen (if the Viewport is attached to the screen). Practically speaking, this means that the end result of the Viewport will not be clamped into the ``0-1`` range and can be used in 3D rendering without color space adjustments. This allows 2D rendering to take advantage of effects requiring high dynamic range (e.g. 2D glow) as well as substantially improves the appearance of effects requiring highly detailed gradients. This setting has the same effect as :ref:`Viewport.use_hdr_2d<class_Viewport_property_use_hdr_2d>`.
  6373. \ **Note:** This setting will have no effect when using the GL Compatibility renderer as the GL Compatibility renderer always renders in low dynamic range for performance reasons.
  6374. .. rst-class:: classref-item-separator
  6375. ----
  6376. .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
  6377. .. rst-class:: classref-method
  6378. |void| **viewport_set_use_occlusion_culling**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_occlusion_culling>`
  6379. 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>`.
  6380. .. rst-class:: classref-item-separator
  6381. ----
  6382. .. _class_RenderingServer_method_viewport_set_use_taa:
  6383. .. rst-class:: classref-method
  6384. |void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_taa>`
  6385. 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>`.
  6386. .. rst-class:: classref-item-separator
  6387. ----
  6388. .. _class_RenderingServer_method_viewport_set_use_xr:
  6389. .. rst-class:: classref-method
  6390. |void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_use_xr>`
  6391. If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
  6392. .. rst-class:: classref-item-separator
  6393. ----
  6394. .. _class_RenderingServer_method_viewport_set_vrs_mode:
  6395. .. rst-class:: classref-method
  6396. |void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_mode>`
  6397. 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>`.
  6398. .. rst-class:: classref-item-separator
  6399. ----
  6400. .. _class_RenderingServer_method_viewport_set_vrs_texture:
  6401. .. rst-class:: classref-method
  6402. |void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_texture>`
  6403. 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>`.
  6404. .. rst-class:: classref-item-separator
  6405. ----
  6406. .. _class_RenderingServer_method_viewport_set_vrs_update_mode:
  6407. .. rst-class:: classref-method
  6408. |void| **viewport_set_vrs_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>`\ ) :ref:`🔗<class_RenderingServer_method_viewport_set_vrs_update_mode>`
  6409. Sets the update mode for Variable Rate Shading (VRS) for the viewport. VRS requires the input texture to be converted to the format usable by the VRS method supported by the hardware. The update mode defines how often this happens. If the GPU does not support VRS, or VRS is not enabled, this property is ignored.
  6410. If set to :ref:`VIEWPORT_VRS_UPDATE_ONCE<class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE>`, the input texture is copied once and the mode is changed to :ref:`VIEWPORT_VRS_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED>`.
  6411. .. rst-class:: classref-item-separator
  6412. ----
  6413. .. _class_RenderingServer_method_visibility_notifier_create:
  6414. .. rst-class:: classref-method
  6415. :ref:`RID<class_RID>` **visibility_notifier_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_create>`
  6416. 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.
  6417. 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.
  6418. 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.
  6419. \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
  6420. .. rst-class:: classref-item-separator
  6421. ----
  6422. .. _class_RenderingServer_method_visibility_notifier_set_aabb:
  6423. .. rst-class:: classref-method
  6424. |void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_set_aabb>`
  6425. .. container:: contribute
  6426. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6427. .. rst-class:: classref-item-separator
  6428. ----
  6429. .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
  6430. .. rst-class:: classref-method
  6431. |void| **visibility_notifier_set_callbacks**\ (\ notifier\: :ref:`RID<class_RID>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_RenderingServer_method_visibility_notifier_set_callbacks>`
  6432. .. container:: contribute
  6433. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6434. .. rst-class:: classref-item-separator
  6435. ----
  6436. .. _class_RenderingServer_method_voxel_gi_allocate_data:
  6437. .. rst-class:: classref-method
  6438. |void| **voxel_gi_allocate_data**\ (\ voxel_gi\: :ref:`RID<class_RID>`, to_cell_xform\: :ref:`Transform3D<class_Transform3D>`, aabb\: :ref:`AABB<class_AABB>`, octree_size\: :ref:`Vector3i<class_Vector3i>`, octree_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, data_cells\: :ref:`PackedByteArray<class_PackedByteArray>`, distance_field\: :ref:`PackedByteArray<class_PackedByteArray>`, level_counts\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_allocate_data>`
  6439. .. container:: contribute
  6440. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6441. .. rst-class:: classref-item-separator
  6442. ----
  6443. .. _class_RenderingServer_method_voxel_gi_create:
  6444. .. rst-class:: classref-method
  6445. :ref:`RID<class_RID>` **voxel_gi_create**\ (\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_create>`
  6446. 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.
  6447. 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.
  6448. \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
  6449. .. rst-class:: classref-item-separator
  6450. ----
  6451. .. _class_RenderingServer_method_voxel_gi_get_data_cells:
  6452. .. rst-class:: classref-method
  6453. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_data_cells>`
  6454. .. container:: contribute
  6455. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6456. .. rst-class:: classref-item-separator
  6457. ----
  6458. .. _class_RenderingServer_method_voxel_gi_get_distance_field:
  6459. .. rst-class:: classref-method
  6460. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_distance_field>`
  6461. .. container:: contribute
  6462. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6463. .. rst-class:: classref-item-separator
  6464. ----
  6465. .. _class_RenderingServer_method_voxel_gi_get_level_counts:
  6466. .. rst-class:: classref-method
  6467. :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_level_counts>`
  6468. .. container:: contribute
  6469. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6470. .. rst-class:: classref-item-separator
  6471. ----
  6472. .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
  6473. .. rst-class:: classref-method
  6474. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_octree_cells>`
  6475. .. container:: contribute
  6476. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6477. .. rst-class:: classref-item-separator
  6478. ----
  6479. .. _class_RenderingServer_method_voxel_gi_get_octree_size:
  6480. .. rst-class:: classref-method
  6481. :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_octree_size>`
  6482. .. container:: contribute
  6483. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6484. .. rst-class:: classref-item-separator
  6485. ----
  6486. .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
  6487. .. rst-class:: classref-method
  6488. :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform**\ (\ voxel_gi\: :ref:`RID<class_RID>`\ ) |const| :ref:`🔗<class_RenderingServer_method_voxel_gi_get_to_cell_xform>`
  6489. .. container:: contribute
  6490. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6491. .. rst-class:: classref-item-separator
  6492. ----
  6493. .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
  6494. .. rst-class:: classref-method
  6495. |void| **voxel_gi_set_baked_exposure_normalization**\ (\ voxel_gi\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>`
  6496. 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>`.
  6497. .. rst-class:: classref-item-separator
  6498. ----
  6499. .. _class_RenderingServer_method_voxel_gi_set_bias:
  6500. .. rst-class:: classref-method
  6501. |void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_bias>`
  6502. Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6503. .. rst-class:: classref-item-separator
  6504. ----
  6505. .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
  6506. .. rst-class:: classref-method
  6507. |void| **voxel_gi_set_dynamic_range**\ (\ voxel_gi\: :ref:`RID<class_RID>`, range\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_dynamic_range>`
  6508. Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6509. .. rst-class:: classref-item-separator
  6510. ----
  6511. .. _class_RenderingServer_method_voxel_gi_set_energy:
  6512. .. rst-class:: classref-method
  6513. |void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_energy>`
  6514. Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6515. .. rst-class:: classref-item-separator
  6516. ----
  6517. .. _class_RenderingServer_method_voxel_gi_set_interior:
  6518. .. rst-class:: classref-method
  6519. |void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_interior>`
  6520. Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6521. .. rst-class:: classref-item-separator
  6522. ----
  6523. .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
  6524. .. rst-class:: classref-method
  6525. |void| **voxel_gi_set_normal_bias**\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_normal_bias>`
  6526. Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6527. .. rst-class:: classref-item-separator
  6528. ----
  6529. .. _class_RenderingServer_method_voxel_gi_set_propagation:
  6530. .. rst-class:: classref-method
  6531. |void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_propagation>`
  6532. Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6533. .. rst-class:: classref-item-separator
  6534. ----
  6535. .. _class_RenderingServer_method_voxel_gi_set_quality:
  6536. .. rst-class:: classref-method
  6537. |void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_quality>`
  6538. 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.
  6539. .. rst-class:: classref-item-separator
  6540. ----
  6541. .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
  6542. .. rst-class:: classref-method
  6543. |void| **voxel_gi_set_use_two_bounces**\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_RenderingServer_method_voxel_gi_set_use_two_bounces>`
  6544. 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>`.
  6545. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  6546. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  6547. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  6548. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  6549. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  6550. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  6551. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  6552. .. |void| replace:: :abbr:`void (No return value.)`