class_renderingserver.rst 1.2 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingServer.xml.
  6. .. _class_RenderingServer:
  7. RenderingServer
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Server for anything visible.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. The rendering server is the API backend for everything visible. The whole scene system mounts on it to display. The rendering server is completely opaque: the internals are entirely implementation-specific and cannot be accessed.
  15. The rendering server can be used to bypass the scene/:ref:`Node<class_Node>` system entirely. This can improve performance in cases where the scene system is the bottleneck, but won't improve performance otherwise (for instance, if the GPU is already fully utilized).
  16. Resources are created using the ``*_create`` functions. These functions return :ref:`RID<class_RID>`\ s which are not references to the objects themselves, but opaque *pointers* towards these objects.
  17. All objects are drawn to a viewport. You can use the :ref:`Viewport<class_Viewport>` attached to the :ref:`SceneTree<class_SceneTree>` or you can create one yourself with :ref:`viewport_create()<class_RenderingServer_method_viewport_create>`. When using a custom scenario or canvas, the scenario or canvas needs to be attached to the viewport using :ref:`viewport_set_scenario()<class_RenderingServer_method_viewport_set_scenario>` or :ref:`viewport_attach_canvas()<class_RenderingServer_method_viewport_attach_canvas>`.
  18. \ **Scenarios:** In 3D, all visual objects must be associated with a scenario. The scenario is a visual representation of the world. If accessing the rendering server from a running game, the scenario can be accessed from the scene tree from any :ref:`Node3D<class_Node3D>` node with :ref:`Node3D.get_world_3d()<class_Node3D_method_get_world_3d>`. Otherwise, a scenario can be created with :ref:`scenario_create()<class_RenderingServer_method_scenario_create>`.
  19. Similarly, in 2D, a canvas is needed to draw all canvas items.
  20. \ **3D:** In 3D, all visible objects are comprised of a resource and an instance. A resource can be a mesh, a particle system, a light, or any other 3D object. In order to be visible resources must be attached to an instance using :ref:`instance_set_base()<class_RenderingServer_method_instance_set_base>`. The instance must also be attached to the scenario using :ref:`instance_set_scenario()<class_RenderingServer_method_instance_set_scenario>` in order to be visible. RenderingServer methods that don't have a prefix are usually 3D-specific (but not always).
  21. \ **2D:** In 2D, all visible objects are some form of canvas item. In order to be visible, a canvas item needs to be the child of a canvas attached to a viewport, or it needs to be the child of another canvas item that is eventually attached to the canvas. 2D-specific RenderingServer methods generally start with ``canvas_*``.
  22. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **RenderingServer** will return dummy values in this case.
  23. .. rst-class:: classref-introduction-group
  24. Tutorials
  25. ---------
  26. - :doc:`Optimization using Servers <../tutorials/performance/using_servers>`
  27. .. rst-class:: classref-reftable-group
  28. Properties
  29. ----------
  30. .. table::
  31. :widths: auto
  32. +-------------------------+--------------------------------------------------------------------------------+
  33. | :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_RenderingServer_property_render_loop_enabled>` |
  34. +-------------------------+--------------------------------------------------------------------------------+
  35. .. rst-class:: classref-reftable-group
  36. Methods
  37. -------
  38. .. table::
  39. :widths: auto
  40. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>`\ (\ base\: :ref:`RID<class_RID>`, material_overrides\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], image_size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  42. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`call_on_render_thread<class_RenderingServer_method_call_on_render_thread>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  44. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | :ref:`RID<class_RID>` | :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>`\ (\ ) |
  46. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | |void| | :ref:`camera_attributes_set_auto_exposure<class_RenderingServer_method_camera_attributes_set_auto_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, min_sensitivity\: :ref:`float<class_float>`, max_sensitivity\: :ref:`float<class_float>`, speed\: :ref:`float<class_float>`, scale\: :ref:`float<class_float>`\ ) |
  48. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | |void| | :ref:`camera_attributes_set_dof_blur<class_RenderingServer_method_camera_attributes_set_dof_blur>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, far_enable\: :ref:`bool<class_bool>`, far_distance\: :ref:`float<class_float>`, far_transition\: :ref:`float<class_float>`, near_enable\: :ref:`bool<class_bool>`, near_distance\: :ref:`float<class_float>`, near_transition\: :ref:`float<class_float>`, amount\: :ref:`float<class_float>`\ ) |
  50. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`camera_attributes_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>`\ (\ shape\: :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`\ ) |
  52. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`camera_attributes_set_dof_blur_quality<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>`\ (\ quality\: :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`, use_jitter\: :ref:`bool<class_bool>`\ ) |
  54. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>`\ (\ camera_attributes\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, normalization\: :ref:`float<class_float>`\ ) |
  56. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>`\ (\ ) |
  58. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`camera_set_camera_attributes<class_RenderingServer_method_camera_set_camera_attributes>`\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  60. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | |void| | :ref:`camera_set_compositor<class_RenderingServer_method_camera_set_compositor>`\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  62. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | |void| | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>`\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) |
  64. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | |void| | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>`\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) |
  66. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, offset\: :ref:`Vector2<class_Vector2>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  68. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>`\ (\ camera\: :ref:`RID<class_RID>`, size\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  70. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>`\ (\ camera\: :ref:`RID<class_RID>`, fovy_degrees\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |
  72. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | |void| | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>`\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  74. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | |void| | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>`\ (\ camera\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  76. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>`\ (\ ) |
  78. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`canvas_item_add_animation_slice<class_RenderingServer_method_canvas_item_add_animation_slice>`\ (\ item\: :ref:`RID<class_RID>`, animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) |
  80. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>`\ (\ item\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  82. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>`\ (\ item\: :ref:`RID<class_RID>`, ignore\: :ref:`bool<class_bool>`\ ) |
  84. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`canvas_item_add_lcd_texture_rect_region<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>`\ ) |
  86. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>`\ (\ item\: :ref:`RID<class_RID>`, from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  88. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  90. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline_size\: :ref:`int<class_int>` = 0, px_range\: :ref:`float<class_float>` = 1.0, scale\: :ref:`float<class_float>` = 1.0\ ) |
  92. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`canvas_item_add_multiline<class_RenderingServer_method_canvas_item_add_multiline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  94. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>`\ (\ item\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>` = RID()\ ) |
  96. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, source\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, topleft\: :ref:`Vector2<class_Vector2>`, bottomright\: :ref:`Vector2<class_Vector2>`, x_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, y_axis_mode\: :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` = 0, draw_center\: :ref:`bool<class_bool>` = true, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |
  98. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>`\ (\ item\: :ref:`RID<class_RID>`, particles\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  100. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | |void| | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`RID<class_RID>` = RID()\ ) |
  102. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | |void| | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  104. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | |void| | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>`\ (\ item\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`RID<class_RID>`\ ) |
  106. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | |void| | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, antialiased\: :ref:`bool<class_bool>` = false\ ) |
  108. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | |void| | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  110. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | |void| | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, tile\: :ref:`bool<class_bool>` = false, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) |
  112. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | |void| | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>`\ (\ item\: :ref:`RID<class_RID>`, rect\: :ref:`Rect2<class_Rect2>`, texture\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) |
  114. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | |void| | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`\ (\ item\: :ref:`RID<class_RID>`, indices\: :ref:`PackedInt32Array<class_PackedInt32Array>`, points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), bones\: :ref:`PackedInt32Array<class_PackedInt32Array>` = PackedInt32Array(), weights\: :ref:`PackedFloat32Array<class_PackedFloat32Array>` = PackedFloat32Array(), texture\: :ref:`RID<class_RID>` = RID(), count\: :ref:`int<class_int>` = -1\ ) |
  116. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | |void| | :ref:`canvas_item_attach_skeleton<class_RenderingServer_method_canvas_item_attach_skeleton>`\ (\ item\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) |
  118. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | |void| | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  120. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>`\ (\ ) |
  122. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Variant<class_Variant>` | :ref:`canvas_item_get_instance_shader_parameter<class_RenderingServer_method_canvas_item_get_instance_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  124. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`Variant<class_Variant>` | :ref:`canvas_item_get_instance_shader_parameter_default_value<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  126. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`canvas_item_get_instance_shader_parameter_list<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| |
  128. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | |void| | :ref:`canvas_item_reset_physics_interpolation<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  130. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | |void| | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>`\ (\ item\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>`, clear_margin\: :ref:`float<class_float>` = 5.0, fit_empty\: :ref:`bool<class_bool>` = false, fit_margin\: :ref:`float<class_float>` = 0.0, blur_mipmaps\: :ref:`bool<class_bool>` = false\ ) |
  132. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | |void| | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>`\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) |
  134. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | |void| | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>`\ ) |
  136. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | |void| | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>`\ (\ item\: :ref:`RID<class_RID>`, use_custom_rect\: :ref:`bool<class_bool>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) |
  138. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | |void| | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>`\ (\ item\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  140. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | |void| | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  142. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | |void| | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  144. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | |void| | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  146. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | |void| | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>`\ (\ item\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  148. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | |void| | :ref:`canvas_item_set_instance_shader_parameter<class_RenderingServer_method_canvas_item_set_instance_shader_parameter>`\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  150. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | |void| | :ref:`canvas_item_set_interpolated<class_RenderingServer_method_canvas_item_set_interpolated>`\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  152. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | |void| | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>`\ (\ item\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  154. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | |void| | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>`\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  156. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | |void| | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  158. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | |void| | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>`\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  160. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | |void| | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>`\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  162. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | |void| | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  164. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  166. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  168. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`canvas_item_set_visibility_layer<class_RenderingServer_method_canvas_item_set_visibility_layer>`\ (\ item\: :ref:`RID<class_RID>`, visibility_layer\: :ref:`int<class_int>`\ ) |
  170. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>`\ (\ item\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, area\: :ref:`Rect2<class_Rect2>`, enter_callable\: :ref:`Callable<class_Callable>`, exit_callable\: :ref:`Callable<class_Callable>`\ ) |
  172. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |void| | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>`\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  174. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>`\ (\ item\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  176. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>`\ (\ item\: :ref:`RID<class_RID>`, z_index\: :ref:`int<class_int>`\ ) |
  178. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`canvas_item_transform_physics_interpolation<class_RenderingServer_method_canvas_item_transform_physics_interpolation>`\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  180. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>`\ (\ light\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  182. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>`\ (\ ) |
  184. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>`\ (\ occluder\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  186. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>`\ (\ ) |
  188. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`canvas_light_occluder_reset_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`\ ) |
  190. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>`\ (\ occluder\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  192. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>`\ (\ occluder\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  194. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`canvas_light_occluder_set_interpolated<class_RenderingServer_method_canvas_light_occluder_set_interpolated>`\ (\ occluder\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  196. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>`\ (\ occluder\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  198. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>`\ (\ occluder\: :ref:`RID<class_RID>`, polygon\: :ref:`RID<class_RID>`\ ) |
  200. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  202. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |void| | :ref:`canvas_light_occluder_transform_physics_interpolation<class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation>`\ (\ occluder\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  204. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |void| | :ref:`canvas_light_reset_physics_interpolation<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`\ ) |
  206. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`canvas_light_set_blend_mode<class_RenderingServer_method_canvas_light_set_blend_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>`\ ) |
  208. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  210. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  212. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>`\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  214. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>`\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) |
  216. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`canvas_light_set_interpolated<class_RenderingServer_method_canvas_light_set_interpolated>`\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  218. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |void| | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  220. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  222. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>`\ (\ light\: :ref:`RID<class_RID>`, min_layer\: :ref:`int<class_int>`, max_layer\: :ref:`int<class_int>`\ ) |
  224. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) |
  226. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  228. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  230. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>`\ (\ light\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>`\ ) |
  232. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>`\ (\ light\: :ref:`RID<class_RID>`, smooth\: :ref:`float<class_float>`\ ) |
  234. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  236. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>`\ (\ light\: :ref:`RID<class_RID>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
  238. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |void| | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>`\ (\ light\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  240. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  242. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>`\ (\ light\: :ref:`RID<class_RID>`, min_z\: :ref:`int<class_int>`, max_z\: :ref:`int<class_int>`\ ) |
  244. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`canvas_light_transform_physics_interpolation<class_RenderingServer_method_canvas_light_transform_physics_interpolation>`\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  246. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>`\ (\ ) |
  248. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>`\ ) |
  250. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>`\ (\ occluder_polygon\: :ref:`RID<class_RID>`, shape\: :ref:`PackedVector2Array<class_PackedVector2Array>`, closed\: :ref:`bool<class_bool>`\ ) |
  252. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>`\ (\ disable\: :ref:`bool<class_bool>`\ ) |
  254. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |void| | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>`\ (\ canvas\: :ref:`RID<class_RID>`, item\: :ref:`RID<class_RID>`, mirroring\: :ref:`Vector2<class_Vector2>`\ ) |
  256. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`canvas_set_item_repeat<class_RenderingServer_method_canvas_set_item_repeat>`\ (\ item\: :ref:`RID<class_RID>`, repeat_size\: :ref:`Vector2<class_Vector2>`, repeat_times\: :ref:`int<class_int>`\ ) |
  258. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>`\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  260. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>`\ (\ size\: :ref:`int<class_int>`\ ) |
  262. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>`\ (\ ) |
  264. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |void| | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, channel\: :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>`, texture\: :ref:`RID<class_RID>`\ ) |
  266. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |void| | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, base_color\: :ref:`Color<class_Color>`, shininess\: :ref:`float<class_float>`\ ) |
  268. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, filter\: :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>`\ ) |
  270. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | |void| | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>`\ (\ canvas_texture\: :ref:`RID<class_RID>`, repeat\: :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>`\ ) |
  272. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`RID<class_RID>` | :ref:`compositor_create<class_RenderingServer_method_compositor_create>`\ (\ ) |
  274. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`RID<class_RID>` | :ref:`compositor_effect_create<class_RenderingServer_method_compositor_effect_create>`\ (\ ) |
  276. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`compositor_effect_set_callback<class_RenderingServer_method_compositor_effect_set_callback>`\ (\ effect\: :ref:`RID<class_RID>`, callback_type\: :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  278. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | |void| | :ref:`compositor_effect_set_enabled<class_RenderingServer_method_compositor_effect_set_enabled>`\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  280. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | |void| | :ref:`compositor_effect_set_flag<class_RenderingServer_method_compositor_effect_set_flag>`\ (\ effect\: :ref:`RID<class_RID>`, flag\: :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>`, set\: :ref:`bool<class_bool>`\ ) |
  282. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | |void| | :ref:`compositor_set_compositor_effects<class_RenderingServer_method_compositor_set_compositor_effects>`\ (\ compositor\: :ref:`RID<class_RID>`, effects\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\]\ ) |
  284. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>`\ (\ ) |const| |
  286. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`Rect2<class_Rect2>` | :ref:`debug_canvas_item_get_rect<class_RenderingServer_method_debug_canvas_item_get_rect>`\ (\ item\: :ref:`RID<class_RID>`\ ) |
  288. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>`\ (\ ) |
  290. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | |void| | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>`\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) |
  292. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | |void| | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>`\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  294. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | |void| | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  296. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | |void| | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>`\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  298. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | |void| | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>`\ (\ decal\: :ref:`RID<class_RID>`, above\: :ref:`float<class_float>`, below\: :ref:`float<class_float>`\ ) |
  300. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | |void| | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>`\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  302. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | |void| | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>`\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) |
  304. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | |void| | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>`\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  306. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | |void| | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>`\ (\ decal\: :ref:`RID<class_RID>`, type\: :ref:`DecalTexture<enum_RenderingServer_DecalTexture>`, texture\: :ref:`RID<class_RID>`\ ) |
  308. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | |void| | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>`\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) |
  310. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>`\ (\ ) |
  312. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | |void| | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>`\ (\ size\: :ref:`int<class_int>`, is_16bits\: :ref:`bool<class_bool>`\ ) |
  314. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | |void| | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  316. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>`\ (\ environment\: :ref:`RID<class_RID>`, bake_irradiance\: :ref:`bool<class_bool>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  318. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>`\ (\ ) |
  320. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |void| | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  322. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |void| | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, brightness\: :ref:`float<class_float>`, contrast\: :ref:`float<class_float>`, saturation\: :ref:`float<class_float>`, use_1d_color_correction\: :ref:`bool<class_bool>`, color_correction\: :ref:`RID<class_RID>`\ ) |
  324. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contribution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) |
  326. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>`\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) |
  328. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |void| | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>`\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  330. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |void| | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>`\ (\ env\: :ref:`RID<class_RID>`, multiplier\: :ref:`float<class_float>`, exposure_value\: :ref:`float<class_float>`\ ) |
  332. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |void| | :ref:`environment_set_camera_id<class_RenderingServer_method_environment_set_camera_id>`\ (\ env\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) |
  334. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | |void| | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>`\ (\ env\: :ref:`RID<class_RID>`, max_layer\: :ref:`int<class_int>`\ ) |
  336. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | |void| | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>`\ (\ env\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`, light_color\: :ref:`Color<class_Color>`, light_energy\: :ref:`float<class_float>`, sun_scatter\: :ref:`float<class_float>`, density\: :ref:`float<class_float>`, height\: :ref:`float<class_float>`, height_density\: :ref:`float<class_float>`, aerial_perspective\: :ref:`float<class_float>`, sky_affect\: :ref:`float<class_float>`, fog_mode\: :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` = 0\ ) |
  338. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | |void| | :ref:`environment_set_fog_depth<class_RenderingServer_method_environment_set_fog_depth>`\ (\ env\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`, begin\: :ref:`float<class_float>`, end\: :ref:`float<class_float>`\ ) |
  340. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | |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>`\ ) |
  342. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | |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>`\ ) |
  344. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | |void| | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) |
  346. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | |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>`\ ) |
  348. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | |void| | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>`\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) |
  350. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | |void| | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>`\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) |
  352. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | |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>`\ ) |
  354. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | |void| | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>`\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) |
  356. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |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>`\ ) |
  358. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | |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>`\ ) |
  360. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | |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>`\ ) |
  362. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | |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>`\ ) |
  364. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | |void| | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>`\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) |
  366. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | |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>`\ ) |
  368. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | |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>`\ ) |
  370. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | |void| | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`\ (\ active\: :ref:`bool<class_bool>`\ ) |
  372. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | |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>`\ ) |
  374. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>`\ (\ ) |
  376. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | |void| | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>`\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  378. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | |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>`\ ) |
  380. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | |void| | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>`\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  382. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | |void| | :ref:`force_draw<class_RenderingServer_method_force_draw>`\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) |
  384. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | |void| | :ref:`force_sync<class_RenderingServer_method_force_sync>`\ (\ ) |
  386. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | |void| | :ref:`free_rid<class_RenderingServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  388. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`String<class_String>` | :ref:`get_current_rendering_driver_name<class_RenderingServer_method_get_current_rendering_driver_name>`\ (\ ) |const| |
  390. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`String<class_String>` | :ref:`get_current_rendering_method<class_RenderingServer_method_get_current_rendering_method>`\ (\ ) |const| |
  392. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>`\ (\ ) |
  394. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>`\ (\ ) |const| |
  396. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>`\ (\ ) |const| |
  398. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) |
  400. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :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| |
  402. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>`\ (\ ) |
  404. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>`\ (\ ) |
  406. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>`\ (\ ) |const| |
  408. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>`\ (\ ) |const| |
  410. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>`\ (\ ) |const| |
  412. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>`\ (\ ) |const| |
  414. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>`\ (\ ) |
  416. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | |void| | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>`\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) |
  418. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | |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>`\ ) |
  420. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
  422. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>`\ (\ ) |const| |
  424. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | :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| |
  426. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |void| | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
  428. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |void| | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  430. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | |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>`\ ) |
  432. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>`\ (\ ) |const| |
  434. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>`\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| |
  436. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>`\ (\ feature\: :ref:`String<class_String>`\ ) |const| |
  438. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | |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>`\ ) |
  440. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | |void| | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>`\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) |
  442. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>`\ (\ ) |
  444. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>`\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  446. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :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| |
  448. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :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| |
  450. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | :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| |
  452. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | |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>`\ ) |
  454. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | |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>`\ ) |
  456. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | |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>`\ ) |
  458. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | |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>`\ ) |
  460. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | |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>`\ ) |
  462. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | |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>`\ ) |
  464. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | |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>`\ ) |
  466. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | |void| | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>`\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) |
  468. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | |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>`\ ) |
  470. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | |void| | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>`\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) |
  472. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | |void| | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>`\ (\ instance\: :ref:`RID<class_RID>`, shape\: :ref:`int<class_int>`, weight\: :ref:`float<class_float>`\ ) |
  474. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | |void| | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>`\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  476. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | |void| | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>`\ (\ instance\: :ref:`RID<class_RID>`, margin\: :ref:`float<class_float>`\ ) |
  478. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | |void| | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>`\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  480. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | |void| | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>`\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  482. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | |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>`\ ) |
  484. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | |void| | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>`\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  486. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | |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>`\ ) |
  488. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | |void| | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>`\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  490. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | |void| | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>`\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) |
  492. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | |void| | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>`\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) |
  494. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | |void| | :ref:`instance_teleport<class_RenderingServer_method_instance_teleport>`\ (\ instance\: :ref:`RID<class_RID>`\ ) |
  496. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>`\ (\ aabb\: :ref:`AABB<class_AABB>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  498. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>`\ (\ convex\: :ref:`Array<class_Array>`\[:ref:`Plane<class_Plane>`\], scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  500. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  501. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>`\ (\ from\: :ref:`Vector3<class_Vector3>`, to\: :ref:`Vector3<class_Vector3>`, scenario\: :ref:`RID<class_RID>` = RID()\ ) |const| |
  502. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  503. | :ref:`bool<class_bool>` | :ref:`is_on_render_thread<class_RenderingServer_method_is_on_render_thread>`\ (\ ) |
  504. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  505. | |void| | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  506. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  507. | |void| | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>`\ ) |
  508. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  509. | |void| | :ref:`light_directional_set_sky_mode<class_RenderingServer_method_light_directional_set_sky_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>`\ ) |
  510. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  511. | |void| | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>`\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>`\ ) |
  512. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  513. | |void| | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>`\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) |
  514. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  515. | |void| | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>`\ (\ light\: :ref:`RID<class_RID>`, bake_mode\: :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>`\ ) |
  516. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  517. | |void| | :ref:`light_set_color<class_RenderingServer_method_light_set_color>`\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  518. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  519. | |void| | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  520. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  521. | |void| | :ref:`light_set_distance_fade<class_RenderingServer_method_light_set_distance_fade>`\ (\ decal\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`, begin\: :ref:`float<class_float>`, shadow\: :ref:`float<class_float>`, length\: :ref:`float<class_float>`\ ) |
  522. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  523. | |void| | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>`\ (\ light\: :ref:`RID<class_RID>`, cascade\: :ref:`int<class_int>`\ ) |
  524. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  525. | |void| | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>`\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  526. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  527. | |void| | :ref:`light_set_param<class_RenderingServer_method_light_set_param>`\ (\ light\: :ref:`RID<class_RID>`, param\: :ref:`LightParam<enum_RenderingServer_LightParam>`, value\: :ref:`float<class_float>`\ ) |
  528. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  529. | |void| | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>`\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  530. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  531. | |void| | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  532. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  533. | |void| | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>`\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  534. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  535. | |void| | :ref:`light_set_shadow_caster_mask<class_RenderingServer_method_light_set_shadow_caster_mask>`\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  536. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  537. | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>`\ (\ ) |
  538. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  539. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  540. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  541. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  542. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  543. | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  544. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  545. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| |
  546. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  547. | |void| | :ref:`lightmap_set_baked_exposure_normalization<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>`\ (\ lightmap\: :ref:`RID<class_RID>`, baked_exposure\: :ref:`float<class_float>`\ ) |
  548. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  549. | |void| | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>`\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) |
  550. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  551. | |void| | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>`\ (\ lightmap\: :ref:`RID<class_RID>`, points\: :ref:`PackedVector3Array<class_PackedVector3Array>`, point_sh\: :ref:`PackedColorArray<class_PackedColorArray>`, tetrahedra\: :ref:`PackedInt32Array<class_PackedInt32Array>`, bsp_tree\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  552. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  553. | |void| | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`\ (\ speed\: :ref:`float<class_float>`\ ) |
  554. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  555. | |void| | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>`\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) |
  556. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  557. | |void| | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>`\ (\ lightmap\: :ref:`RID<class_RID>`, light\: :ref:`RID<class_RID>`, uses_sh\: :ref:`bool<class_bool>`\ ) |
  558. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  559. | |void| | :ref:`lightmaps_set_bicubic_filter<class_RenderingServer_method_lightmaps_set_bicubic_filter>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  560. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  561. | :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>`\ (\ latitudes\: :ref:`int<class_int>`, longitudes\: :ref:`int<class_int>`, radius\: :ref:`float<class_float>`\ ) |
  562. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  563. | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>`\ (\ ) |
  564. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  565. | :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| |
  566. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  567. | |void| | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>`\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) |
  568. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  569. | |void| | :ref:`material_set_param<class_RenderingServer_method_material_set_param>`\ (\ material\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) |
  570. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  571. | |void| | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>`\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) |
  572. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  573. | |void| | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>`\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) |
  574. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  575. | |void| | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) |
  576. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  577. | |void| | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, primitive\: :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>`, arrays\: :ref:`Array<class_Array>`, blend_shapes\: :ref:`Array<class_Array>` = [], lods\: :ref:`Dictionary<class_Dictionary>` = {}, compress_format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\] = 0\ ) |
  578. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  579. | |void| | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |
  580. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  581. | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>`\ (\ ) |
  582. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  583. | :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>`\ (\ surfaces\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], blend_shape_count\: :ref:`int<class_int>` = 0\ ) |
  584. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  585. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  586. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  587. | :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  588. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  589. | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  590. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  591. | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |
  592. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  593. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>`\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| |
  594. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  595. | |void| | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>`\ (\ mesh\: :ref:`RID<class_RID>`, mode\: :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>`\ ) |
  596. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  597. | |void| | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>`\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  598. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  599. | |void| | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>`\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) |
  600. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  601. | :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  602. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  603. | :ref:`Array<class_Array>`\[:ref:`Array<class_Array>`\] | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |const| |
  604. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  605. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  606. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  607. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_index_stride<class_RenderingServer_method_mesh_surface_get_format_index_stride>`\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| |
  608. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  609. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_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| |
  610. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  611. | :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| |
  612. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  613. | :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| |
  614. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  615. | :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| |
  616. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  617. | :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| |
  618. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  619. | |void| | :ref:`mesh_surface_remove<class_RenderingServer_method_mesh_surface_remove>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) |
  620. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  621. | |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>`\ ) |
  622. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  623. | |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>`\ ) |
  624. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  625. | |void| | :ref:`mesh_surface_update_index_region<class_RenderingServer_method_mesh_surface_update_index_region>`\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`, offset\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  626. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  627. | |void| | :ref:`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>`\ ) |
  628. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  629. | |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>`\ ) |
  630. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  631. | |void| | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>`\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false, use_indirect\: :ref:`bool<class_bool>` = false\ ) |
  632. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  633. | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>`\ (\ ) |
  634. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  635. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  636. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  637. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  638. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  639. | :ref:`RID<class_RID>` | :ref:`multimesh_get_buffer_rd_rid<class_RenderingServer_method_multimesh_get_buffer_rd_rid>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  640. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  641. | :ref:`RID<class_RID>` | :ref:`multimesh_get_command_buffer_rd_rid<class_RenderingServer_method_multimesh_get_command_buffer_rd_rid>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  642. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  643. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_custom_aabb<class_RenderingServer_method_multimesh_get_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  644. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  645. | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  646. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  647. | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  648. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  649. | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| |
  650. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  651. | :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| |
  652. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  653. | :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| |
  654. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  655. | :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| |
  656. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  657. | :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| |
  658. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  659. | |void| | :ref:`multimesh_instance_reset_physics_interpolation<class_RenderingServer_method_multimesh_instance_reset_physics_interpolation>`\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  660. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  661. | |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>`\ ) |
  662. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  663. | |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>`\ ) |
  664. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  665. | |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>`\ ) |
  666. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  667. | |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>`\ ) |
  668. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  669. | |void| | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>`\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  670. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  671. | |void| | :ref:`multimesh_set_buffer_interpolated<class_RenderingServer_method_multimesh_set_buffer_interpolated>`\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, buffer_previous\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  672. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  673. | |void| | :ref:`multimesh_set_custom_aabb<class_RenderingServer_method_multimesh_set_custom_aabb>`\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  674. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  675. | |void| | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>`\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) |
  676. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  677. | |void| | :ref:`multimesh_set_physics_interpolated<class_RenderingServer_method_multimesh_set_physics_interpolated>`\ (\ multimesh\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) |
  678. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  679. | |void| | :ref:`multimesh_set_physics_interpolation_quality<class_RenderingServer_method_multimesh_set_physics_interpolation_quality>`\ (\ multimesh\: :ref:`RID<class_RID>`, quality\: :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`\ ) |
  680. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  681. | |void| | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>`\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) |
  682. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  683. | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>`\ (\ ) |
  684. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  685. | |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>`\ ) |
  686. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  687. | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>`\ (\ ) |
  688. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  689. | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>`\ (\ ) |
  690. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  691. | |void| | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>`\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) |
  692. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  693. | |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>`\ ) |
  694. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  695. | |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>`\ ) |
  696. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  697. | |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>`\ ) |
  698. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  699. | |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>`\ ) |
  700. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  701. | |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>`\ ) |
  702. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  703. | |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>`\ ) |
  704. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  705. | |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>`\ ) |
  706. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  707. | |void| | :ref:`particles_collision_set_height_field_mask<class_RenderingServer_method_particles_collision_set_height_field_mask>`\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) |
  708. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  709. | |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>`\ ) |
  710. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  711. | |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>`\ ) |
  712. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  713. | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>`\ (\ ) |
  714. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  715. | |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>`\ ) |
  716. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  717. | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  718. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  719. | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  720. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  721. | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  722. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  723. | |void| | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  724. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  725. | |void| | :ref:`particles_request_process_time<class_RenderingServer_method_particles_request_process_time>`\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) |
  726. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  727. | |void| | :ref:`particles_restart<class_RenderingServer_method_particles_restart>`\ (\ particles\: :ref:`RID<class_RID>`\ ) |
  728. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  729. | |void| | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>`\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) |
  730. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  731. | |void| | :ref:`particles_set_amount_ratio<class_RenderingServer_method_particles_set_amount_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  732. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  733. | |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>`\ ) |
  734. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  735. | |void| | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>`\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  736. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  737. | |void| | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>`\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) |
  738. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  739. | |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>`\ ) |
  740. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  741. | |void| | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>`\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  742. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  743. | |void| | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>`\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) |
  744. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  745. | |void| | :ref:`particles_set_emitter_velocity<class_RenderingServer_method_particles_set_emitter_velocity>`\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) |
  746. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  747. | |void| | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>`\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) |
  748. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  749. | |void| | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  750. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  751. | |void| | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>`\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) |
  752. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  753. | |void| | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  754. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  755. | |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>`\ ) |
  756. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  757. | |void| | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>`\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  758. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  759. | |void| | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>`\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) |
  760. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  761. | |void| | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>`\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) |
  762. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  763. | |void| | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>`\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) |
  764. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  765. | |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>`\ ) |
  766. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  767. | |void| | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>`\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  768. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  769. | |void| | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>`\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) |
  770. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  771. | |void| | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>`\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) |
  772. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  773. | |void| | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>`\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) |
  774. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  775. | |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>`\]\ ) |
  776. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  777. | |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>`\ ) |
  778. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  779. | |void| | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>`\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) |
  780. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  781. | |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>`\ ) |
  782. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  783. | |void| | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) |
  784. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  785. | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>`\ (\ ) |
  786. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  787. | |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>`\ ) |
  788. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  789. | |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>`\ ) |
  790. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  791. | |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>`\ ) |
  792. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  793. | |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>`\ ) |
  794. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  795. | |void| | :ref:`reflection_probe_set_blend_distance<class_RenderingServer_method_reflection_probe_set_blend_distance>`\ (\ probe\: :ref:`RID<class_RID>`, blend_distance\: :ref:`float<class_float>`\ ) |
  796. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  797. | |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>`\ ) |
  798. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  799. | |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>`\ ) |
  800. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  801. | |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>`\ ) |
  802. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  803. | |void| | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>`\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) |
  804. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  805. | |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>`\ ) |
  806. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  807. | |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>`\ ) |
  808. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  809. | |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>`\ ) |
  810. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  811. | |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>`\ ) |
  812. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  813. | |void| | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>`\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) |
  814. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  815. | |void| | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>`\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) |
  816. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  817. | |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>`\ ) |
  818. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  819. | |void| | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  820. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  821. | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>`\ (\ ) |
  822. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  823. | |void| | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>`\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) |
  824. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  825. | |void| | :ref:`scenario_set_compositor<class_RenderingServer_method_scenario_set_compositor>`\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) |
  826. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  827. | |void| | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  828. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  829. | |void| | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>`\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) |
  830. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  831. | |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>`\ ) |
  832. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  833. | |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\ ) |
  834. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  835. | |void| | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>`\ (\ generate\: :ref:`bool<class_bool>`\ ) |
  836. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  837. | |void| | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>`\ (\ color\: :ref:`Color<class_Color>`\ ) |
  838. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  839. | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>`\ (\ ) |
  840. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  841. | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| |
  842. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  843. | :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| |
  844. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  845. | :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| |
  846. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  847. | |void| | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>`\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) |
  848. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  849. | |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\ ) |
  850. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  851. | |void| | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>`\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  852. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  853. | |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\ ) |
  854. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  855. | :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| |
  856. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  857. | :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| |
  858. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  859. | |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>`\ ) |
  860. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  861. | |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>`\ ) |
  862. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  863. | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>`\ (\ ) |
  864. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  865. | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>`\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| |
  866. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  867. | |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>`\ ) |
  868. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  869. | :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>`\ ) |
  870. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  871. | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>`\ (\ ) |
  872. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  873. | |void| | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>`\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) |
  874. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  875. | |void| | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>`\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) |
  876. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  877. | |void| | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>`\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) |
  878. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  879. | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>`\ (\ ) |
  880. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  881. | |void| | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>`\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) |
  882. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  883. | |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>`\ ) |
  884. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  885. | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
  886. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  887. | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  888. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  889. | :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| |
  890. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  891. | :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>`\ ) |
  892. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  893. | :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>`\ ) |
  894. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  895. | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>`\ (\ ) |
  896. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  897. | |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>`\ ) |
  898. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  899. | :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>`\]\ ) |
  900. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  901. | :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  902. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  903. | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>`\ (\ ) |
  904. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  905. | |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>`\]\ ) |
  906. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  907. | :ref:`RID<class_RID>` | :ref:`texture_create_from_native_handle<class_RenderingServer_method_texture_create_from_native_handle>`\ (\ type\: :ref:`TextureType<enum_RenderingServer_TextureType>`, format\: :ref:`Format<enum_Image_Format>`, native_handle\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>` = 1, layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) |
  908. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  909. | :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_RenderingServer_method_texture_get_format>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  910. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  911. | :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| |
  912. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  913. | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| |
  914. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  915. | :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| |
  916. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  917. | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>`\ (\ base\: :ref:`RID<class_RID>`\ ) |
  918. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  919. | |void| | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>`\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) |
  920. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  921. | :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\ ) |
  922. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  923. | |void| | :ref:`texture_replace<class_RenderingServer_method_texture_replace>`\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) |
  924. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  925. | |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>`\ ) |
  926. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  927. | |void| | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>`\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) |
  928. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  929. | |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>`\ ) |
  930. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  931. | |void| | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>`\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) |
  932. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  933. | |void| | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  934. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  935. | |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\ ) |
  936. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  937. | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>`\ (\ ) |
  938. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  939. | :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| |
  940. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  941. | :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| |
  942. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  943. | :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>`\ ) |
  944. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  945. | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  946. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  947. | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  948. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  949. | :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` | :ref:`viewport_get_update_mode<class_RenderingServer_method_viewport_get_update_mode>`\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| |
  950. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  951. | |void| | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>`\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) |
  952. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  953. | |void| | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>`\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) |
  954. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  955. | |void| | :ref:`viewport_set_anisotropic_filtering_level<class_RenderingServer_method_viewport_set_anisotropic_filtering_level>`\ (\ viewport\: :ref:`RID<class_RID>`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>`\ ) |
  956. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  957. | |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>`\ ) |
  958. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  959. | |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>`\ ) |
  960. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  961. | |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>`\ ) |
  962. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  963. | |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>`\ ) |
  964. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  965. | |void| | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>`\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) |
  966. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  967. | |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>`\ ) |
  968. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  969. | |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>`\ ) |
  970. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  971. | |void| | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  972. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  973. | |void| | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) |
  974. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  975. | |void| | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) |
  976. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  977. | |void| | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>`\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) |
  978. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  979. | |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>`\ ) |
  980. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  981. | |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>`\ ) |
  982. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  983. | |void| | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  984. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  985. | |void| | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>`\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) |
  986. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  987. | |void| | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) |
  988. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  989. | |void| | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) |
  990. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  991. | |void| | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>`\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) |
  992. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  993. | |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>`\ ) |
  994. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  995. | |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\ ) |
  996. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  997. | |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>`\ ) |
  998. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  999. | |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>`\ ) |
  1000. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1001. | |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>`\ ) |
  1002. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1003. | |void| | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>`\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) |
  1004. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1005. | |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>`\ ) |
  1006. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1007. | |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>`\ ) |
  1008. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1009. | |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>`\ ) |
  1010. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1011. | |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>`\ ) |
  1012. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1013. | |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>`\ ) |
  1014. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1015. | |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>`\ ) |
  1016. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1017. | |void| | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>`\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  1018. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1019. | |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>`\ ) |
  1020. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1021. | |void| | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1022. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1023. | |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>`\ ) |
  1024. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1025. | |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>`\ ) |
  1026. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1027. | |void| | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>`\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1028. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1029. | |void| | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>`\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) |
  1030. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1031. | |void| | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>`\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) |
  1032. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1033. | |void| | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>`\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) |
  1034. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1035. | |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>`\ ) |
  1036. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1037. | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>`\ (\ ) |
  1038. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1039. | |void| | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>`\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) |
  1040. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1041. | |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>`\ ) |
  1042. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1043. | |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>`\ ) |
  1044. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1045. | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>`\ (\ ) |
  1046. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1047. | :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| |
  1048. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1049. | :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| |
  1050. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1051. | :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| |
  1052. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1053. | :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| |
  1054. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1055. | :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| |
  1056. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1057. | :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| |
  1058. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1059. | |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>`\ ) |
  1060. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1061. | |void| | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) |
  1062. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1063. | |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>`\ ) |
  1064. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1065. | |void| | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) |
  1066. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1067. | |void| | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) |
  1068. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1069. | |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>`\ ) |
  1070. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1071. | |void| | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>`\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) |
  1072. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1073. | |void| | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>`\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) |
  1074. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1075. | |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>`\ ) |
  1076. +----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  1077. .. rst-class:: classref-section-separator
  1078. ----
  1079. .. rst-class:: classref-descriptions-group
  1080. Signals
  1081. -------
  1082. .. _class_RenderingServer_signal_frame_post_draw:
  1083. .. rst-class:: classref-signal
  1084. **frame_post_draw**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_signal_frame_post_draw>`
  1085. Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
  1086. .. rst-class:: classref-item-separator
  1087. ----
  1088. .. _class_RenderingServer_signal_frame_pre_draw:
  1089. .. rst-class:: classref-signal
  1090. **frame_pre_draw**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_signal_frame_pre_draw>`
  1091. Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
  1092. .. rst-class:: classref-section-separator
  1093. ----
  1094. .. rst-class:: classref-descriptions-group
  1095. Enumerations
  1096. ------------
  1097. .. _enum_RenderingServer_TextureType:
  1098. .. rst-class:: classref-enumeration
  1099. enum **TextureType**: :ref:`๐Ÿ”—<enum_RenderingServer_TextureType>`
  1100. .. _class_RenderingServer_constant_TEXTURE_TYPE_2D:
  1101. .. rst-class:: classref-enumeration-constant
  1102. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_2D** = ``0``
  1103. 2D texture.
  1104. .. _class_RenderingServer_constant_TEXTURE_TYPE_LAYERED:
  1105. .. rst-class:: classref-enumeration-constant
  1106. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_LAYERED** = ``1``
  1107. Layered texture.
  1108. .. _class_RenderingServer_constant_TEXTURE_TYPE_3D:
  1109. .. rst-class:: classref-enumeration-constant
  1110. :ref:`TextureType<enum_RenderingServer_TextureType>` **TEXTURE_TYPE_3D** = ``2``
  1111. 3D texture.
  1112. .. rst-class:: classref-item-separator
  1113. ----
  1114. .. _enum_RenderingServer_TextureLayeredType:
  1115. .. rst-class:: classref-enumeration
  1116. enum **TextureLayeredType**: :ref:`๐Ÿ”—<enum_RenderingServer_TextureLayeredType>`
  1117. .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
  1118. .. rst-class:: classref-enumeration-constant
  1119. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
  1120. Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
  1121. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
  1122. .. rst-class:: classref-enumeration-constant
  1123. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
  1124. Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
  1125. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
  1126. .. rst-class:: classref-enumeration-constant
  1127. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
  1128. Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
  1129. .. rst-class:: classref-item-separator
  1130. ----
  1131. .. _enum_RenderingServer_CubeMapLayer:
  1132. .. rst-class:: classref-enumeration
  1133. enum **CubeMapLayer**: :ref:`๐Ÿ”—<enum_RenderingServer_CubeMapLayer>`
  1134. .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
  1135. .. rst-class:: classref-enumeration-constant
  1136. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
  1137. Left face of a :ref:`Cubemap<class_Cubemap>`.
  1138. .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
  1139. .. rst-class:: classref-enumeration-constant
  1140. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
  1141. Right face of a :ref:`Cubemap<class_Cubemap>`.
  1142. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
  1143. .. rst-class:: classref-enumeration-constant
  1144. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
  1145. Bottom face of a :ref:`Cubemap<class_Cubemap>`.
  1146. .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
  1147. .. rst-class:: classref-enumeration-constant
  1148. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
  1149. Top face of a :ref:`Cubemap<class_Cubemap>`.
  1150. .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
  1151. .. rst-class:: classref-enumeration-constant
  1152. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
  1153. Front face of a :ref:`Cubemap<class_Cubemap>`.
  1154. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
  1155. .. rst-class:: classref-enumeration-constant
  1156. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
  1157. Back face of a :ref:`Cubemap<class_Cubemap>`.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _enum_RenderingServer_ShaderMode:
  1161. .. rst-class:: classref-enumeration
  1162. enum **ShaderMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ShaderMode>`
  1163. .. _class_RenderingServer_constant_SHADER_SPATIAL:
  1164. .. rst-class:: classref-enumeration-constant
  1165. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
  1166. Shader is a 3D shader.
  1167. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
  1168. .. rst-class:: classref-enumeration-constant
  1169. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
  1170. Shader is a 2D shader.
  1171. .. _class_RenderingServer_constant_SHADER_PARTICLES:
  1172. .. rst-class:: classref-enumeration-constant
  1173. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
  1174. Shader is a particle shader (can be used in both 2D and 3D).
  1175. .. _class_RenderingServer_constant_SHADER_SKY:
  1176. .. rst-class:: classref-enumeration-constant
  1177. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
  1178. Shader is a 3D sky shader.
  1179. .. _class_RenderingServer_constant_SHADER_FOG:
  1180. .. rst-class:: classref-enumeration-constant
  1181. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
  1182. Shader is a 3D fog shader.
  1183. .. _class_RenderingServer_constant_SHADER_MAX:
  1184. .. rst-class:: classref-enumeration-constant
  1185. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
  1186. Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
  1187. .. rst-class:: classref-item-separator
  1188. ----
  1189. .. _enum_RenderingServer_ArrayType:
  1190. .. rst-class:: classref-enumeration
  1191. enum **ArrayType**: :ref:`๐Ÿ”—<enum_RenderingServer_ArrayType>`
  1192. .. _class_RenderingServer_constant_ARRAY_VERTEX:
  1193. .. rst-class:: classref-enumeration-constant
  1194. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
  1195. Array is a vertex position array.
  1196. .. _class_RenderingServer_constant_ARRAY_NORMAL:
  1197. .. rst-class:: classref-enumeration-constant
  1198. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
  1199. Array is a normal array.
  1200. .. _class_RenderingServer_constant_ARRAY_TANGENT:
  1201. .. rst-class:: classref-enumeration-constant
  1202. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
  1203. Array is a tangent array.
  1204. .. _class_RenderingServer_constant_ARRAY_COLOR:
  1205. .. rst-class:: classref-enumeration-constant
  1206. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
  1207. Array is a vertex color array.
  1208. .. _class_RenderingServer_constant_ARRAY_TEX_UV:
  1209. .. rst-class:: classref-enumeration-constant
  1210. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
  1211. Array is a UV coordinates array.
  1212. .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
  1213. .. rst-class:: classref-enumeration-constant
  1214. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
  1215. Array is a UV coordinates array for the second set of UV coordinates.
  1216. .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
  1217. .. rst-class:: classref-enumeration-constant
  1218. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
  1219. Array is a custom data array for the first set of custom data.
  1220. .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
  1221. .. rst-class:: classref-enumeration-constant
  1222. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
  1223. Array is a custom data array for the second set of custom data.
  1224. .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
  1225. .. rst-class:: classref-enumeration-constant
  1226. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
  1227. Array is a custom data array for the third set of custom data.
  1228. .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
  1229. .. rst-class:: classref-enumeration-constant
  1230. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
  1231. Array is a custom data array for the fourth set of custom data.
  1232. .. _class_RenderingServer_constant_ARRAY_BONES:
  1233. .. rst-class:: classref-enumeration-constant
  1234. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
  1235. Array contains bone information.
  1236. .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
  1237. .. rst-class:: classref-enumeration-constant
  1238. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
  1239. Array is weight information.
  1240. .. _class_RenderingServer_constant_ARRAY_INDEX:
  1241. .. rst-class:: classref-enumeration-constant
  1242. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
  1243. Array is an index array.
  1244. .. _class_RenderingServer_constant_ARRAY_MAX:
  1245. .. rst-class:: classref-enumeration-constant
  1246. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
  1247. Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
  1248. .. rst-class:: classref-item-separator
  1249. ----
  1250. .. _enum_RenderingServer_ArrayCustomFormat:
  1251. .. rst-class:: classref-enumeration
  1252. enum **ArrayCustomFormat**: :ref:`๐Ÿ”—<enum_RenderingServer_ArrayCustomFormat>`
  1253. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
  1254. .. rst-class:: classref-enumeration-constant
  1255. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
  1256. 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.
  1257. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
  1258. .. rst-class:: classref-enumeration-constant
  1259. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
  1260. 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.
  1261. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
  1262. .. rst-class:: classref-enumeration-constant
  1263. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
  1264. Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
  1265. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
  1266. .. rst-class:: classref-enumeration-constant
  1267. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
  1268. Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
  1269. .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
  1270. .. rst-class:: classref-enumeration-constant
  1271. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
  1272. Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
  1273. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
  1274. .. rst-class:: classref-enumeration-constant
  1275. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
  1276. Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
  1277. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
  1278. .. rst-class:: classref-enumeration-constant
  1279. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
  1280. Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
  1281. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
  1282. .. rst-class:: classref-enumeration-constant
  1283. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
  1284. Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
  1285. .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
  1286. .. rst-class:: classref-enumeration-constant
  1287. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
  1288. Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _enum_RenderingServer_ArrayFormat:
  1292. .. rst-class:: classref-enumeration
  1293. flags **ArrayFormat**: :ref:`๐Ÿ”—<enum_RenderingServer_ArrayFormat>`
  1294. .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
  1295. .. rst-class:: classref-enumeration-constant
  1296. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
  1297. Flag used to mark a vertex position array.
  1298. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
  1299. .. rst-class:: classref-enumeration-constant
  1300. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
  1301. Flag used to mark a normal array.
  1302. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
  1303. .. rst-class:: classref-enumeration-constant
  1304. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
  1305. Flag used to mark a tangent array.
  1306. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
  1307. .. rst-class:: classref-enumeration-constant
  1308. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
  1309. Flag used to mark a vertex color array.
  1310. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
  1311. .. rst-class:: classref-enumeration-constant
  1312. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
  1313. Flag used to mark a UV coordinates array.
  1314. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
  1315. .. rst-class:: classref-enumeration-constant
  1316. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
  1317. Flag used to mark a UV coordinates array for the second UV coordinates.
  1318. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
  1319. .. rst-class:: classref-enumeration-constant
  1320. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
  1321. Flag used to mark an array of custom per-vertex data for the first set of custom data.
  1322. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
  1323. .. rst-class:: classref-enumeration-constant
  1324. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
  1325. Flag used to mark an array of custom per-vertex data for the second set of custom data.
  1326. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
  1327. .. rst-class:: classref-enumeration-constant
  1328. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
  1329. Flag used to mark an array of custom per-vertex data for the third set of custom data.
  1330. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
  1331. .. rst-class:: classref-enumeration-constant
  1332. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
  1333. Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
  1334. .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
  1335. .. rst-class:: classref-enumeration-constant
  1336. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
  1337. Flag used to mark a bone information array.
  1338. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
  1339. .. rst-class:: classref-enumeration-constant
  1340. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
  1341. Flag used to mark a weights array.
  1342. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
  1343. .. rst-class:: classref-enumeration-constant
  1344. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
  1345. Flag used to mark an index array.
  1346. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
  1347. .. rst-class:: classref-enumeration-constant
  1348. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
  1349. Mask of mesh channels permitted in blend shapes.
  1350. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
  1351. .. rst-class:: classref-enumeration-constant
  1352. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
  1353. Shift of first custom channel.
  1354. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
  1355. .. rst-class:: classref-enumeration-constant
  1356. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
  1357. Number of format bits per custom channel. See :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>`.
  1358. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
  1359. .. rst-class:: classref-enumeration-constant
  1360. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
  1361. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 0.
  1362. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
  1363. .. rst-class:: classref-enumeration-constant
  1364. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
  1365. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 1.
  1366. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
  1367. .. rst-class:: classref-enumeration-constant
  1368. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
  1369. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 2.
  1370. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
  1371. .. rst-class:: classref-enumeration-constant
  1372. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
  1373. Amount to shift :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` for custom channel index 3.
  1374. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
  1375. .. rst-class:: classref-enumeration-constant
  1376. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
  1377. Mask of custom format bits per custom channel. Must be shifted by one of the SHIFT constants. See :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>`.
  1378. .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
  1379. .. rst-class:: classref-enumeration-constant
  1380. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
  1381. Shift of first compress flag. Compress flags should be passed to :ref:`ArrayMesh.add_surface_from_arrays()<class_ArrayMesh_method_add_surface_from_arrays>` and :ref:`SurfaceTool.commit()<class_SurfaceTool_method_commit>`.
  1382. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
  1383. .. rst-class:: classref-enumeration-constant
  1384. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
  1385. Flag used to mark that the array contains 2D vertices.
  1386. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
  1387. .. rst-class:: classref-enumeration-constant
  1388. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
  1389. Flag used to mark that the mesh data will use ``GL_DYNAMIC_DRAW`` on GLES. Unused on Vulkan.
  1390. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
  1391. .. rst-class:: classref-enumeration-constant
  1392. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
  1393. Flag used to mark that the array uses 8 bone weights instead of 4.
  1394. .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
  1395. .. rst-class:: classref-enumeration-constant
  1396. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
  1397. 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.
  1398. .. _class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES:
  1399. .. rst-class:: classref-enumeration-constant
  1400. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912``
  1401. 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.
  1402. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE:
  1403. .. rst-class:: classref-enumeration-constant
  1404. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_BASE** = ``35``
  1405. Flag used to mark the start of the bits used to store the mesh version.
  1406. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT:
  1407. .. rst-class:: classref-enumeration-constant
  1408. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_SHIFT** = ``35``
  1409. Flag used to shift a mesh format int to bring the version into the lowest digits.
  1410. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1:
  1411. .. rst-class:: classref-enumeration-constant
  1412. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_1** = ``0``
  1413. Flag used to record the format used by prior mesh versions before the introduction of a version.
  1414. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_2** = ``34359738368``
  1417. 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.
  1418. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_CURRENT_VERSION:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_CURRENT_VERSION** = ``34359738368``
  1421. 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>`.
  1422. .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_MASK:
  1423. .. rst-class:: classref-enumeration-constant
  1424. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_MASK** = ``255``
  1425. 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.
  1426. .. rst-class:: classref-item-separator
  1427. ----
  1428. .. _enum_RenderingServer_PrimitiveType:
  1429. .. rst-class:: classref-enumeration
  1430. enum **PrimitiveType**: :ref:`๐Ÿ”—<enum_RenderingServer_PrimitiveType>`
  1431. .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
  1432. .. rst-class:: classref-enumeration-constant
  1433. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
  1434. Primitive to draw consists of points.
  1435. .. _class_RenderingServer_constant_PRIMITIVE_LINES:
  1436. .. rst-class:: classref-enumeration-constant
  1437. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
  1438. Primitive to draw consists of lines.
  1439. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
  1440. .. rst-class:: classref-enumeration-constant
  1441. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
  1442. Primitive to draw consists of a line strip from start to end.
  1443. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
  1444. .. rst-class:: classref-enumeration-constant
  1445. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
  1446. Primitive to draw consists of triangles.
  1447. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
  1448. .. rst-class:: classref-enumeration-constant
  1449. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
  1450. Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  1451. .. _class_RenderingServer_constant_PRIMITIVE_MAX:
  1452. .. rst-class:: classref-enumeration-constant
  1453. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
  1454. Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
  1455. .. rst-class:: classref-item-separator
  1456. ----
  1457. .. _enum_RenderingServer_BlendShapeMode:
  1458. .. rst-class:: classref-enumeration
  1459. enum **BlendShapeMode**: :ref:`๐Ÿ”—<enum_RenderingServer_BlendShapeMode>`
  1460. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
  1461. .. rst-class:: classref-enumeration-constant
  1462. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
  1463. Blend shapes are normalized.
  1464. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
  1465. .. rst-class:: classref-enumeration-constant
  1466. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
  1467. Blend shapes are relative to base weight.
  1468. .. rst-class:: classref-item-separator
  1469. ----
  1470. .. _enum_RenderingServer_MultimeshTransformFormat:
  1471. .. rst-class:: classref-enumeration
  1472. enum **MultimeshTransformFormat**: :ref:`๐Ÿ”—<enum_RenderingServer_MultimeshTransformFormat>`
  1473. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
  1474. .. rst-class:: classref-enumeration-constant
  1475. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
  1476. Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
  1477. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
  1478. .. rst-class:: classref-enumeration-constant
  1479. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
  1480. Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
  1481. .. rst-class:: classref-item-separator
  1482. ----
  1483. .. _enum_RenderingServer_MultimeshPhysicsInterpolationQuality:
  1484. .. rst-class:: classref-enumeration
  1485. enum **MultimeshPhysicsInterpolationQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`
  1486. .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_FAST:
  1487. .. rst-class:: classref-enumeration-constant
  1488. :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>` **MULTIMESH_INTERP_QUALITY_FAST** = ``0``
  1489. MultiMesh physics interpolation favors speed over quality.
  1490. .. _class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_HIGH:
  1491. .. rst-class:: classref-enumeration-constant
  1492. :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>` **MULTIMESH_INTERP_QUALITY_HIGH** = ``1``
  1493. MultiMesh physics interpolation favors quality over speed.
  1494. .. rst-class:: classref-item-separator
  1495. ----
  1496. .. _enum_RenderingServer_LightProjectorFilter:
  1497. .. rst-class:: classref-enumeration
  1498. enum **LightProjectorFilter**: :ref:`๐Ÿ”—<enum_RenderingServer_LightProjectorFilter>`
  1499. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
  1500. .. rst-class:: classref-enumeration-constant
  1501. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
  1502. 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.
  1503. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
  1504. .. rst-class:: classref-enumeration-constant
  1505. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
  1506. 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.
  1507. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
  1508. .. rst-class:: classref-enumeration-constant
  1509. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
  1510. 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.
  1511. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
  1512. .. rst-class:: classref-enumeration-constant
  1513. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
  1514. 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.
  1515. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1516. .. rst-class:: classref-enumeration-constant
  1517. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1518. 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>`.
  1519. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1520. .. rst-class:: classref-enumeration-constant
  1521. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1522. 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>`.
  1523. .. rst-class:: classref-item-separator
  1524. ----
  1525. .. _enum_RenderingServer_LightType:
  1526. .. rst-class:: classref-enumeration
  1527. enum **LightType**: :ref:`๐Ÿ”—<enum_RenderingServer_LightType>`
  1528. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
  1529. .. rst-class:: classref-enumeration-constant
  1530. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
  1531. Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
  1532. .. _class_RenderingServer_constant_LIGHT_OMNI:
  1533. .. rst-class:: classref-enumeration-constant
  1534. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
  1535. Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
  1536. .. _class_RenderingServer_constant_LIGHT_SPOT:
  1537. .. rst-class:: classref-enumeration-constant
  1538. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
  1539. Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
  1540. .. rst-class:: classref-item-separator
  1541. ----
  1542. .. _enum_RenderingServer_LightParam:
  1543. .. rst-class:: classref-enumeration
  1544. enum **LightParam**: :ref:`๐Ÿ”—<enum_RenderingServer_LightParam>`
  1545. .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
  1546. .. rst-class:: classref-enumeration-constant
  1547. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
  1548. The light's energy multiplier.
  1549. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
  1550. .. rst-class:: classref-enumeration-constant
  1551. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
  1552. 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>`).
  1553. .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
  1554. .. rst-class:: classref-enumeration-constant
  1555. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
  1556. 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>`).
  1557. .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
  1558. .. rst-class:: classref-enumeration-constant
  1559. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
  1560. The light's influence on specularity.
  1561. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
  1562. .. rst-class:: classref-enumeration-constant
  1563. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
  1564. The light's range.
  1565. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
  1566. .. rst-class:: classref-enumeration-constant
  1567. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
  1568. The size of the light when using spot light or omni light. The angular size of the light when using directional light.
  1569. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
  1570. .. rst-class:: classref-enumeration-constant
  1571. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
  1572. The light's attenuation.
  1573. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
  1574. .. rst-class:: classref-enumeration-constant
  1575. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
  1576. The spotlight's angle.
  1577. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
  1578. .. rst-class:: classref-enumeration-constant
  1579. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
  1580. The spotlight's attenuation.
  1581. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
  1582. .. rst-class:: classref-enumeration-constant
  1583. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
  1584. 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).
  1585. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
  1586. .. rst-class:: classref-enumeration-constant
  1587. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
  1588. Proportion of shadow atlas occupied by the first split.
  1589. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
  1590. .. rst-class:: classref-enumeration-constant
  1591. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
  1592. Proportion of shadow atlas occupied by the second split.
  1593. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
  1594. .. rst-class:: classref-enumeration-constant
  1595. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
  1596. Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
  1597. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
  1598. .. rst-class:: classref-enumeration-constant
  1599. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
  1600. Proportion of shadow max distance where the shadow will start to fade out.
  1601. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
  1602. .. rst-class:: classref-enumeration-constant
  1603. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
  1604. Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
  1605. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
  1606. .. rst-class:: classref-enumeration-constant
  1607. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
  1608. Bias for the shadow lookup to fix self-shadowing artifacts.
  1609. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
  1610. .. rst-class:: classref-enumeration-constant
  1611. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
  1612. 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.
  1613. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
  1614. .. rst-class:: classref-enumeration-constant
  1615. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
  1616. 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.
  1617. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
  1618. .. rst-class:: classref-enumeration-constant
  1619. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
  1620. 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.
  1621. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
  1622. .. rst-class:: classref-enumeration-constant
  1623. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
  1624. .. container:: contribute
  1625. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1626. .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
  1627. .. rst-class:: classref-enumeration-constant
  1628. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
  1629. 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``.
  1630. .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
  1631. .. rst-class:: classref-enumeration-constant
  1632. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
  1633. Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _enum_RenderingServer_LightBakeMode:
  1637. .. rst-class:: classref-enumeration
  1638. enum **LightBakeMode**: :ref:`๐Ÿ”—<enum_RenderingServer_LightBakeMode>`
  1639. .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
  1640. .. rst-class:: classref-enumeration-constant
  1641. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
  1642. 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.
  1643. .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
  1644. .. rst-class:: classref-enumeration-constant
  1645. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
  1646. 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.
  1647. .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
  1648. .. rst-class:: classref-enumeration-constant
  1649. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
  1650. 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>`.
  1651. .. rst-class:: classref-item-separator
  1652. ----
  1653. .. _enum_RenderingServer_LightOmniShadowMode:
  1654. .. rst-class:: classref-enumeration
  1655. enum **LightOmniShadowMode**: :ref:`๐Ÿ”—<enum_RenderingServer_LightOmniShadowMode>`
  1656. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
  1657. .. rst-class:: classref-enumeration-constant
  1658. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
  1659. Use a dual paraboloid shadow map for omni lights.
  1660. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
  1661. .. rst-class:: classref-enumeration-constant
  1662. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
  1663. Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
  1664. .. rst-class:: classref-item-separator
  1665. ----
  1666. .. _enum_RenderingServer_LightDirectionalShadowMode:
  1667. .. rst-class:: classref-enumeration
  1668. enum **LightDirectionalShadowMode**: :ref:`๐Ÿ”—<enum_RenderingServer_LightDirectionalShadowMode>`
  1669. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
  1670. .. rst-class:: classref-enumeration-constant
  1671. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
  1672. Use orthogonal shadow projection for directional light.
  1673. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
  1674. .. rst-class:: classref-enumeration-constant
  1675. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
  1676. Use 2 splits for shadow projection when using directional light.
  1677. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
  1678. .. rst-class:: classref-enumeration-constant
  1679. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
  1680. Use 4 splits for shadow projection when using directional light.
  1681. .. rst-class:: classref-item-separator
  1682. ----
  1683. .. _enum_RenderingServer_LightDirectionalSkyMode:
  1684. .. rst-class:: classref-enumeration
  1685. enum **LightDirectionalSkyMode**: :ref:`๐Ÿ”—<enum_RenderingServer_LightDirectionalSkyMode>`
  1686. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
  1687. .. rst-class:: classref-enumeration-constant
  1688. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
  1689. Use DirectionalLight3D in both sky rendering and scene lighting.
  1690. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
  1691. .. rst-class:: classref-enumeration-constant
  1692. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
  1693. Only use DirectionalLight3D in scene lighting.
  1694. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
  1695. .. rst-class:: classref-enumeration-constant
  1696. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
  1697. Only use DirectionalLight3D in sky rendering.
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _enum_RenderingServer_ShadowQuality:
  1701. .. rst-class:: classref-enumeration
  1702. enum **ShadowQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_ShadowQuality>`
  1703. .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
  1704. .. rst-class:: classref-enumeration-constant
  1705. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
  1706. 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``.
  1707. \ **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.
  1708. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
  1709. .. rst-class:: classref-enumeration-constant
  1710. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
  1711. 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``).
  1712. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
  1713. .. rst-class:: classref-enumeration-constant
  1714. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
  1715. Low shadow filtering quality (fast).
  1716. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
  1717. .. rst-class:: classref-enumeration-constant
  1718. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
  1719. Medium low shadow filtering quality (average).
  1720. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
  1721. .. rst-class:: classref-enumeration-constant
  1722. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
  1723. 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``).
  1724. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
  1725. .. rst-class:: classref-enumeration-constant
  1726. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
  1727. 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``).
  1728. .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
  1729. .. rst-class:: classref-enumeration-constant
  1730. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
  1731. Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
  1732. .. rst-class:: classref-item-separator
  1733. ----
  1734. .. _enum_RenderingServer_ReflectionProbeUpdateMode:
  1735. .. rst-class:: classref-enumeration
  1736. enum **ReflectionProbeUpdateMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ReflectionProbeUpdateMode>`
  1737. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
  1738. .. rst-class:: classref-enumeration-constant
  1739. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
  1740. Reflection probe will update reflections once and then stop.
  1741. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
  1742. .. rst-class:: classref-enumeration-constant
  1743. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
  1744. Reflection probe will update each frame. This mode is necessary to capture moving objects.
  1745. .. rst-class:: classref-item-separator
  1746. ----
  1747. .. _enum_RenderingServer_ReflectionProbeAmbientMode:
  1748. .. rst-class:: classref-enumeration
  1749. enum **ReflectionProbeAmbientMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ReflectionProbeAmbientMode>`
  1750. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
  1751. .. rst-class:: classref-enumeration-constant
  1752. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
  1753. Do not apply any ambient lighting inside the reflection probe's box defined by its size.
  1754. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
  1755. .. rst-class:: classref-enumeration-constant
  1756. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
  1757. Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
  1758. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
  1759. .. rst-class:: classref-enumeration-constant
  1760. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
  1761. 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>`.
  1762. .. rst-class:: classref-item-separator
  1763. ----
  1764. .. _enum_RenderingServer_DecalTexture:
  1765. .. rst-class:: classref-enumeration
  1766. enum **DecalTexture**: :ref:`๐Ÿ”—<enum_RenderingServer_DecalTexture>`
  1767. .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
  1768. .. rst-class:: classref-enumeration-constant
  1769. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
  1770. Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
  1771. .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
  1772. .. rst-class:: classref-enumeration-constant
  1773. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
  1774. Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
  1775. .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
  1776. .. rst-class:: classref-enumeration-constant
  1777. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
  1778. Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
  1779. .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
  1780. .. rst-class:: classref-enumeration-constant
  1781. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
  1782. Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
  1783. .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
  1784. .. rst-class:: classref-enumeration-constant
  1785. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
  1786. Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
  1787. .. rst-class:: classref-item-separator
  1788. ----
  1789. .. _enum_RenderingServer_DecalFilter:
  1790. .. rst-class:: classref-enumeration
  1791. enum **DecalFilter**: :ref:`๐Ÿ”—<enum_RenderingServer_DecalFilter>`
  1792. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
  1793. .. rst-class:: classref-enumeration-constant
  1794. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
  1795. 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.
  1796. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
  1797. .. rst-class:: classref-enumeration-constant
  1798. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
  1799. 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.
  1800. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
  1801. .. rst-class:: classref-enumeration-constant
  1802. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
  1803. 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.
  1804. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
  1805. .. rst-class:: classref-enumeration-constant
  1806. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
  1807. 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.
  1808. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1809. .. rst-class:: classref-enumeration-constant
  1810. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1811. 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>`.
  1812. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1813. .. rst-class:: classref-enumeration-constant
  1814. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1815. 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>`.
  1816. .. rst-class:: classref-item-separator
  1817. ----
  1818. .. _enum_RenderingServer_VoxelGIQuality:
  1819. .. rst-class:: classref-enumeration
  1820. enum **VoxelGIQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_VoxelGIQuality>`
  1821. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
  1822. .. rst-class:: classref-enumeration-constant
  1823. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
  1824. Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
  1825. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
  1826. .. rst-class:: classref-enumeration-constant
  1827. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
  1828. High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _enum_RenderingServer_ParticlesMode:
  1832. .. rst-class:: classref-enumeration
  1833. enum **ParticlesMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ParticlesMode>`
  1834. .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
  1835. .. rst-class:: classref-enumeration-constant
  1836. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
  1837. 2D particles.
  1838. .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
  1839. .. rst-class:: classref-enumeration-constant
  1840. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
  1841. 3D particles.
  1842. .. rst-class:: classref-item-separator
  1843. ----
  1844. .. _enum_RenderingServer_ParticlesTransformAlign:
  1845. .. rst-class:: classref-enumeration
  1846. enum **ParticlesTransformAlign**: :ref:`๐Ÿ”—<enum_RenderingServer_ParticlesTransformAlign>`
  1847. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
  1848. .. rst-class:: classref-enumeration-constant
  1849. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
  1850. .. container:: contribute
  1851. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1852. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
  1853. .. rst-class:: classref-enumeration-constant
  1854. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
  1855. .. container:: contribute
  1856. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1857. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
  1858. .. rst-class:: classref-enumeration-constant
  1859. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
  1860. .. container:: contribute
  1861. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1862. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
  1863. .. rst-class:: classref-enumeration-constant
  1864. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
  1865. .. container:: contribute
  1866. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1867. .. rst-class:: classref-item-separator
  1868. ----
  1869. .. _enum_RenderingServer_ParticlesDrawOrder:
  1870. .. rst-class:: classref-enumeration
  1871. enum **ParticlesDrawOrder**: :ref:`๐Ÿ”—<enum_RenderingServer_ParticlesDrawOrder>`
  1872. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
  1873. .. rst-class:: classref-enumeration-constant
  1874. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
  1875. Draw particles in the order that they appear in the particles array.
  1876. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
  1877. .. rst-class:: classref-enumeration-constant
  1878. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
  1879. Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front.
  1880. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
  1881. .. rst-class:: classref-enumeration-constant
  1882. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
  1883. Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front.
  1884. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
  1885. .. rst-class:: classref-enumeration-constant
  1886. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
  1887. Sort particles based on their distance to the camera.
  1888. .. rst-class:: classref-item-separator
  1889. ----
  1890. .. _enum_RenderingServer_ParticlesCollisionType:
  1891. .. rst-class:: classref-enumeration
  1892. enum **ParticlesCollisionType**: :ref:`๐Ÿ”—<enum_RenderingServer_ParticlesCollisionType>`
  1893. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1894. .. rst-class:: classref-enumeration-constant
  1895. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
  1896. .. container:: contribute
  1897. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1898. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
  1899. .. rst-class:: classref-enumeration-constant
  1900. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
  1901. .. container:: contribute
  1902. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1903. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
  1904. .. rst-class:: classref-enumeration-constant
  1905. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
  1906. .. container:: contribute
  1907. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1908. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
  1909. .. rst-class:: classref-enumeration-constant
  1910. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
  1911. .. container:: contribute
  1912. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1913. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
  1914. .. rst-class:: classref-enumeration-constant
  1915. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
  1916. .. container:: contribute
  1917. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1918. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
  1919. .. rst-class:: classref-enumeration-constant
  1920. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
  1921. .. container:: contribute
  1922. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1923. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
  1924. .. rst-class:: classref-enumeration-constant
  1925. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
  1926. .. container:: contribute
  1927. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1928. .. rst-class:: classref-item-separator
  1929. ----
  1930. .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
  1931. .. rst-class:: classref-enumeration
  1932. enum **ParticlesCollisionHeightfieldResolution**: :ref:`๐Ÿ”—<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>`
  1933. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
  1934. .. rst-class:: classref-enumeration-constant
  1935. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
  1936. .. container:: contribute
  1937. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1938. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
  1939. .. rst-class:: classref-enumeration-constant
  1940. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
  1941. .. container:: contribute
  1942. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1943. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
  1944. .. rst-class:: classref-enumeration-constant
  1945. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
  1946. .. container:: contribute
  1947. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1948. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
  1949. .. rst-class:: classref-enumeration-constant
  1950. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
  1951. .. container:: contribute
  1952. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1953. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
  1954. .. rst-class:: classref-enumeration-constant
  1955. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
  1956. .. container:: contribute
  1957. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1958. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
  1959. .. rst-class:: classref-enumeration-constant
  1960. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
  1961. .. container:: contribute
  1962. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1963. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
  1964. .. rst-class:: classref-enumeration-constant
  1965. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
  1966. Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
  1967. .. rst-class:: classref-item-separator
  1968. ----
  1969. .. _enum_RenderingServer_FogVolumeShape:
  1970. .. rst-class:: classref-enumeration
  1971. enum **FogVolumeShape**: :ref:`๐Ÿ”—<enum_RenderingServer_FogVolumeShape>`
  1972. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
  1973. .. rst-class:: classref-enumeration-constant
  1974. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
  1975. :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
  1976. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
  1977. .. rst-class:: classref-enumeration-constant
  1978. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
  1979. :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).
  1980. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
  1981. .. rst-class:: classref-enumeration-constant
  1982. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
  1983. :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).
  1984. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
  1985. .. rst-class:: classref-enumeration-constant
  1986. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
  1987. :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
  1988. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
  1989. .. rst-class:: classref-enumeration-constant
  1990. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
  1991. :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
  1992. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
  1993. .. rst-class:: classref-enumeration-constant
  1994. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
  1995. Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _enum_RenderingServer_ViewportScaling3DMode:
  1999. .. rst-class:: classref-enumeration
  2000. enum **ViewportScaling3DMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportScaling3DMode>`
  2001. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
  2002. .. rst-class:: classref-enumeration-constant
  2003. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
  2004. 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.
  2005. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
  2006. .. rst-class:: classref-enumeration-constant
  2007. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
  2008. 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 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.
  2009. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2:
  2010. .. rst-class:: classref-enumeration-constant
  2011. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2``
  2012. 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 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.
  2013. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL:
  2014. .. rst-class:: classref-enumeration-constant
  2015. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_METALFX_SPATIAL** = ``3``
  2016. Use MetalFX spatial upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling.
  2017. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
  2018. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL:
  2019. .. rst-class:: classref-enumeration-constant
  2020. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_METALFX_TEMPORAL** = ``4``
  2021. Use MetalFX temporal upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will result in the viewport being upscaled using MetalFX. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use MetalFX at native resolution as a TAA solution.
  2022. \ **Note:** Only supported when the Metal rendering driver is in use, which limits this scaling mode to macOS and iOS.
  2023. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
  2024. .. rst-class:: classref-enumeration-constant
  2025. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``5``
  2026. Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _enum_RenderingServer_ViewportUpdateMode:
  2030. .. rst-class:: classref-enumeration
  2031. enum **ViewportUpdateMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportUpdateMode>`
  2032. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
  2033. .. rst-class:: classref-enumeration-constant
  2034. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
  2035. Do not update the viewport's render target.
  2036. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
  2037. .. rst-class:: classref-enumeration-constant
  2038. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
  2039. Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
  2040. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
  2041. .. rst-class:: classref-enumeration-constant
  2042. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
  2043. Update the viewport's render target only when it is visible. This is the default value.
  2044. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
  2045. .. rst-class:: classref-enumeration-constant
  2046. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
  2047. Update the viewport's render target only when its parent is visible.
  2048. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
  2049. .. rst-class:: classref-enumeration-constant
  2050. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
  2051. Always update the viewport's render target.
  2052. .. rst-class:: classref-item-separator
  2053. ----
  2054. .. _enum_RenderingServer_ViewportClearMode:
  2055. .. rst-class:: classref-enumeration
  2056. enum **ViewportClearMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportClearMode>`
  2057. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
  2058. .. rst-class:: classref-enumeration-constant
  2059. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
  2060. Always clear the viewport's render target before drawing.
  2061. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
  2062. .. rst-class:: classref-enumeration-constant
  2063. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
  2064. Never clear the viewport's render target.
  2065. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
  2066. .. rst-class:: classref-enumeration-constant
  2067. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
  2068. Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
  2069. .. rst-class:: classref-item-separator
  2070. ----
  2071. .. _enum_RenderingServer_ViewportEnvironmentMode:
  2072. .. rst-class:: classref-enumeration
  2073. enum **ViewportEnvironmentMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportEnvironmentMode>`
  2074. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
  2075. .. rst-class:: classref-enumeration-constant
  2076. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
  2077. Disable rendering of 3D environment over 2D canvas.
  2078. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
  2079. .. rst-class:: classref-enumeration-constant
  2080. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
  2081. Enable rendering of 3D environment over 2D canvas.
  2082. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
  2083. .. rst-class:: classref-enumeration-constant
  2084. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
  2085. 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>`.
  2086. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
  2087. .. rst-class:: classref-enumeration-constant
  2088. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
  2089. Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
  2090. .. rst-class:: classref-item-separator
  2091. ----
  2092. .. _enum_RenderingServer_ViewportSDFOversize:
  2093. .. rst-class:: classref-enumeration
  2094. enum **ViewportSDFOversize**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportSDFOversize>`
  2095. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
  2096. .. rst-class:: classref-enumeration-constant
  2097. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
  2098. 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.
  2099. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
  2100. .. rst-class:: classref-enumeration-constant
  2101. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
  2102. 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2103. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
  2104. .. rst-class:: classref-enumeration-constant
  2105. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
  2106. 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  2107. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
  2108. .. rst-class:: classref-enumeration-constant
  2109. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
  2110. 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.
  2111. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
  2112. .. rst-class:: classref-enumeration-constant
  2113. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
  2114. Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
  2115. .. rst-class:: classref-item-separator
  2116. ----
  2117. .. _enum_RenderingServer_ViewportSDFScale:
  2118. .. rst-class:: classref-enumeration
  2119. enum **ViewportSDFScale**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportSDFScale>`
  2120. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
  2121. .. rst-class:: classref-enumeration-constant
  2122. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
  2123. Full resolution 2D signed distance field scale. This has the highest GPU requirements.
  2124. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
  2125. .. rst-class:: classref-enumeration-constant
  2126. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
  2127. Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
  2128. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
  2129. .. rst-class:: classref-enumeration-constant
  2130. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
  2131. Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
  2132. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
  2133. .. rst-class:: classref-enumeration-constant
  2134. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
  2135. Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _enum_RenderingServer_ViewportMSAA:
  2139. .. rst-class:: classref-enumeration
  2140. enum **ViewportMSAA**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportMSAA>`
  2141. .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
  2142. .. rst-class:: classref-enumeration-constant
  2143. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
  2144. Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
  2145. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
  2146. .. rst-class:: classref-enumeration-constant
  2147. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
  2148. Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
  2149. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
  2150. .. rst-class:: classref-enumeration-constant
  2151. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
  2152. Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
  2153. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
  2154. .. rst-class:: classref-enumeration-constant
  2155. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
  2156. 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.
  2157. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
  2158. .. rst-class:: classref-enumeration-constant
  2159. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
  2160. Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
  2161. .. rst-class:: classref-item-separator
  2162. ----
  2163. .. _enum_RenderingServer_ViewportAnisotropicFiltering:
  2164. .. rst-class:: classref-enumeration
  2165. enum **ViewportAnisotropicFiltering**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportAnisotropicFiltering>`
  2166. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_DISABLED:
  2167. .. rst-class:: classref-enumeration-constant
  2168. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_DISABLED** = ``0``
  2169. Anisotropic filtering is disabled.
  2170. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_2X:
  2171. .. rst-class:: classref-enumeration-constant
  2172. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_2X** = ``1``
  2173. Use 2ร— anisotropic filtering.
  2174. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_4X:
  2175. .. rst-class:: classref-enumeration-constant
  2176. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_4X** = ``2``
  2177. Use 4ร— anisotropic filtering. This is the default value.
  2178. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_8X:
  2179. .. rst-class:: classref-enumeration-constant
  2180. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_8X** = ``3``
  2181. Use 8ร— anisotropic filtering.
  2182. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_16X:
  2183. .. rst-class:: classref-enumeration-constant
  2184. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_16X** = ``4``
  2185. Use 16ร— anisotropic filtering.
  2186. .. _class_RenderingServer_constant_VIEWPORT_ANISOTROPY_MAX:
  2187. .. rst-class:: classref-enumeration-constant
  2188. :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` **VIEWPORT_ANISOTROPY_MAX** = ``5``
  2189. Represents the size of the :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>` enum.
  2190. .. rst-class:: classref-item-separator
  2191. ----
  2192. .. _enum_RenderingServer_ViewportScreenSpaceAA:
  2193. .. rst-class:: classref-enumeration
  2194. enum **ViewportScreenSpaceAA**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportScreenSpaceAA>`
  2195. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
  2196. .. rst-class:: classref-enumeration-constant
  2197. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
  2198. Do not perform any antialiasing in the full screen post-process.
  2199. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
  2200. .. rst-class:: classref-enumeration-constant
  2201. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
  2202. 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.
  2203. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_SMAA:
  2204. .. rst-class:: classref-enumeration-constant
  2205. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_SMAA** = ``2``
  2206. Use subpixel morphological antialiasing. SMAA may produce clearer results than FXAA, but at a slightly higher performance cost.
  2207. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
  2208. .. rst-class:: classref-enumeration-constant
  2209. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``3``
  2210. Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
  2211. .. rst-class:: classref-item-separator
  2212. ----
  2213. .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
  2214. .. rst-class:: classref-enumeration
  2215. enum **ViewportOcclusionCullingBuildQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`
  2216. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
  2217. .. rst-class:: classref-enumeration-constant
  2218. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
  2219. Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
  2220. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
  2221. .. rst-class:: classref-enumeration-constant
  2222. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
  2223. Medium occlusion culling BVH build quality (as defined by Embree).
  2224. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
  2225. .. rst-class:: classref-enumeration-constant
  2226. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
  2227. High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
  2228. .. rst-class:: classref-item-separator
  2229. ----
  2230. .. _enum_RenderingServer_ViewportRenderInfo:
  2231. .. rst-class:: classref-enumeration
  2232. enum **ViewportRenderInfo**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportRenderInfo>`
  2233. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
  2234. .. rst-class:: classref-enumeration-constant
  2235. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
  2236. Number of objects drawn in a single frame.
  2237. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
  2238. .. rst-class:: classref-enumeration-constant
  2239. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
  2240. Number of points, lines, or triangles drawn in a single frame.
  2241. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
  2242. .. rst-class:: classref-enumeration-constant
  2243. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
  2244. Number of draw calls during this frame.
  2245. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
  2246. .. rst-class:: classref-enumeration-constant
  2247. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
  2248. Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
  2249. .. rst-class:: classref-item-separator
  2250. ----
  2251. .. _enum_RenderingServer_ViewportRenderInfoType:
  2252. .. rst-class:: classref-enumeration
  2253. enum **ViewportRenderInfoType**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportRenderInfoType>`
  2254. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
  2255. .. rst-class:: classref-enumeration-constant
  2256. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
  2257. Visible render pass (excluding shadows).
  2258. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
  2259. .. rst-class:: classref-enumeration-constant
  2260. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
  2261. 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.
  2262. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_CANVAS:
  2263. .. rst-class:: classref-enumeration-constant
  2264. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_CANVAS** = ``2``
  2265. Canvas item rendering. This includes all 2D rendering.
  2266. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
  2267. .. rst-class:: classref-enumeration-constant
  2268. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``3``
  2269. Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
  2270. .. rst-class:: classref-item-separator
  2271. ----
  2272. .. _enum_RenderingServer_ViewportDebugDraw:
  2273. .. rst-class:: classref-enumeration
  2274. enum **ViewportDebugDraw**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportDebugDraw>`
  2275. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
  2276. .. rst-class:: classref-enumeration-constant
  2277. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
  2278. Debug draw is disabled. Default setting.
  2279. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
  2280. .. rst-class:: classref-enumeration-constant
  2281. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
  2282. Objects are displayed without light information.
  2283. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
  2284. .. rst-class:: classref-enumeration-constant
  2285. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
  2286. Objects are displayed with only light information.
  2287. \ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
  2288. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
  2289. .. rst-class:: classref-enumeration-constant
  2290. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
  2291. 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.
  2292. \ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
  2293. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
  2294. .. rst-class:: classref-enumeration-constant
  2295. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
  2296. Debug draw draws objects in wireframe.
  2297. \ **Note:** :ref:`set_debug_generate_wireframes()<class_RenderingServer_method_set_debug_generate_wireframes>` must be called before loading any meshes for wireframes to be visible when using the Compatibility renderer.
  2298. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
  2299. .. rst-class:: classref-enumeration-constant
  2300. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
  2301. Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
  2302. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
  2303. .. rst-class:: classref-enumeration-constant
  2304. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
  2305. Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s. Requires at least one visible :ref:`VoxelGI<class_VoxelGI>` node that has been baked to have a visible effect.
  2306. \ **Note:** Only supported when using the Forward+ rendering method.
  2307. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
  2308. .. rst-class:: classref-enumeration-constant
  2309. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
  2310. Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s. Requires at least one visible :ref:`VoxelGI<class_VoxelGI>` node that has been baked to have a visible effect.
  2311. \ **Note:** Only supported when using the Forward+ rendering method.
  2312. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
  2313. .. rst-class:: classref-enumeration-constant
  2314. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
  2315. Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s. Requires at least one visible :ref:`VoxelGI<class_VoxelGI>` node that has been baked to have a visible effect.
  2316. \ **Note:** Only supported when using the Forward+ rendering method.
  2317. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
  2318. .. rst-class:: classref-enumeration-constant
  2319. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
  2320. 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>`.
  2321. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
  2322. .. rst-class:: classref-enumeration-constant
  2323. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
  2324. Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2325. 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.
  2326. The last cascade shows all frustum slices to illustrate the coverage of all slices.
  2327. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
  2328. .. rst-class:: classref-enumeration-constant
  2329. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
  2330. Draws the estimated scene luminance. This is a 1ร—1 texture that is generated when autoexposure is enabled to control the scene's exposure.
  2331. \ **Note:** Only supported when using the Forward+ or Mobile rendering methods.
  2332. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
  2333. .. rst-class:: classref-enumeration-constant
  2334. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
  2335. 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>`.
  2336. \ **Note:** Only supported when using the Forward+ rendering method.
  2337. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
  2338. .. rst-class:: classref-enumeration-constant
  2339. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
  2340. 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>`.
  2341. \ **Note:** Only supported when using the Forward+ rendering method.
  2342. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
  2343. .. rst-class:: classref-enumeration-constant
  2344. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
  2345. 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 (from closest to furthest from the camera), they are colored red, green, blue, and yellow.
  2346. \ **Note:** When using this debug draw mode, custom shaders are ignored since all materials in the scene temporarily use a debug material. This means the result from custom shader functions (such as vertex displacement) won't be visible anymore when using this debug draw mode.
  2347. \ **Note:** Only supported when using the Forward+ or Mobile rendering methods.
  2348. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
  2349. .. rst-class:: classref-enumeration-constant
  2350. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
  2351. Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
  2352. \ **Note:** Only supported when using the Forward+ or Mobile rendering methods.
  2353. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
  2354. .. rst-class:: classref-enumeration-constant
  2355. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
  2356. Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
  2357. \ **Note:** Only supported when using the Forward+ rendering method.
  2358. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
  2359. .. rst-class:: classref-enumeration-constant
  2360. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
  2361. Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
  2362. \ **Note:** Only supported when using the Forward+ rendering method.
  2363. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
  2364. .. rst-class:: classref-enumeration-constant
  2365. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
  2366. Draws the global illumination buffer from :ref:`VoxelGI<class_VoxelGI>` or SDFGI. Requires :ref:`VoxelGI<class_VoxelGI>` (at least one visible baked VoxelGI node) or SDFGI (:ref:`Environment.sdfgi_enabled<class_Environment_property_sdfgi_enabled>`) to be enabled to have a visible effect.
  2367. \ **Note:** Only supported when using the Forward+ rendering method.
  2368. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
  2369. .. rst-class:: classref-enumeration-constant
  2370. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
  2371. Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
  2372. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
  2373. .. rst-class:: classref-enumeration-constant
  2374. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
  2375. 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.
  2376. \ **Note:** Only supported when using the Forward+ rendering method.
  2377. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
  2378. .. rst-class:: classref-enumeration-constant
  2379. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
  2380. 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.
  2381. \ **Note:** Only supported when using the Forward+ rendering method.
  2382. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
  2383. .. rst-class:: classref-enumeration-constant
  2384. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
  2385. 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.
  2386. \ **Note:** Only supported when using the Forward+ rendering method.
  2387. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
  2388. .. rst-class:: classref-enumeration-constant
  2389. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
  2390. 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.
  2391. \ **Note:** Only supported when using the Forward+ rendering method.
  2392. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
  2393. .. rst-class:: classref-enumeration-constant
  2394. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
  2395. 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.
  2396. \ **Note:** Only supported when using the Forward+ or Mobile rendering methods.
  2397. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
  2398. .. rst-class:: classref-enumeration-constant
  2399. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
  2400. Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
  2401. \ **Note:** Only supported when using the Forward+ rendering method.
  2402. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER:
  2403. .. rst-class:: classref-enumeration-constant
  2404. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26``
  2405. Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
  2406. \ **Note:** Only supported when using the Forward+ or Mobile rendering methods.
  2407. .. rst-class:: classref-item-separator
  2408. ----
  2409. .. _enum_RenderingServer_ViewportVRSMode:
  2410. .. rst-class:: classref-enumeration
  2411. enum **ViewportVRSMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportVRSMode>`
  2412. .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
  2413. .. rst-class:: classref-enumeration-constant
  2414. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
  2415. Variable rate shading is disabled.
  2416. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
  2417. .. rst-class:: classref-enumeration-constant
  2418. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
  2419. Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
  2420. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
  2421. .. rst-class:: classref-enumeration-constant
  2422. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
  2423. Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`. Note that this may override the update mode.
  2424. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
  2425. .. rst-class:: classref-enumeration-constant
  2426. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
  2427. Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
  2428. .. rst-class:: classref-item-separator
  2429. ----
  2430. .. _enum_RenderingServer_ViewportVRSUpdateMode:
  2431. .. rst-class:: classref-enumeration
  2432. enum **ViewportVRSUpdateMode**: :ref:`๐Ÿ”—<enum_RenderingServer_ViewportVRSUpdateMode>`
  2433. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_DISABLED:
  2434. .. rst-class:: classref-enumeration-constant
  2435. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_DISABLED** = ``0``
  2436. The input texture for variable rate shading will not be processed.
  2437. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ONCE:
  2438. .. rst-class:: classref-enumeration-constant
  2439. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ONCE** = ``1``
  2440. The input texture for variable rate shading will be processed once.
  2441. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_ALWAYS:
  2442. .. rst-class:: classref-enumeration-constant
  2443. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_ALWAYS** = ``2``
  2444. The input texture for variable rate shading will be processed each frame.
  2445. .. _class_RenderingServer_constant_VIEWPORT_VRS_UPDATE_MAX:
  2446. .. rst-class:: classref-enumeration-constant
  2447. :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` **VIEWPORT_VRS_UPDATE_MAX** = ``3``
  2448. Represents the size of the :ref:`ViewportVRSUpdateMode<enum_RenderingServer_ViewportVRSUpdateMode>` enum.
  2449. .. rst-class:: classref-item-separator
  2450. ----
  2451. .. _enum_RenderingServer_SkyMode:
  2452. .. rst-class:: classref-enumeration
  2453. enum **SkyMode**: :ref:`๐Ÿ”—<enum_RenderingServer_SkyMode>`
  2454. .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
  2455. .. rst-class:: classref-enumeration-constant
  2456. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
  2457. 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>`.
  2458. .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
  2459. .. rst-class:: classref-enumeration-constant
  2460. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
  2461. 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>`.
  2462. .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
  2463. .. rst-class:: classref-enumeration-constant
  2464. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
  2465. 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.
  2466. .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
  2467. .. rst-class:: classref-enumeration-constant
  2468. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
  2469. 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>`.
  2470. \ **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.
  2471. .. rst-class:: classref-item-separator
  2472. ----
  2473. .. _enum_RenderingServer_CompositorEffectFlags:
  2474. .. rst-class:: classref-enumeration
  2475. enum **CompositorEffectFlags**: :ref:`๐Ÿ”—<enum_RenderingServer_CompositorEffectFlags>`
  2476. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR:
  2477. .. rst-class:: classref-enumeration-constant
  2478. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_COLOR** = ``1``
  2479. The rendering effect requires the color buffer to be resolved if MSAA is enabled.
  2480. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH:
  2481. .. rst-class:: classref-enumeration-constant
  2482. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_ACCESS_RESOLVED_DEPTH** = ``2``
  2483. The rendering effect requires the depth buffer to be resolved if MSAA is enabled.
  2484. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS:
  2485. .. rst-class:: classref-enumeration-constant
  2486. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_MOTION_VECTORS** = ``4``
  2487. The rendering effect requires motion vectors to be produced.
  2488. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS:
  2489. .. rst-class:: classref-enumeration-constant
  2490. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_ROUGHNESS** = ``8``
  2491. The rendering effect requires normals and roughness g-buffer to be produced (Forward+ only).
  2492. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR:
  2493. .. rst-class:: classref-enumeration-constant
  2494. :ref:`CompositorEffectFlags<enum_RenderingServer_CompositorEffectFlags>` **COMPOSITOR_EFFECT_FLAG_NEEDS_SEPARATE_SPECULAR** = ``16``
  2495. The rendering effect requires specular data to be separated out (Forward+ only).
  2496. .. rst-class:: classref-item-separator
  2497. ----
  2498. .. _enum_RenderingServer_CompositorEffectCallbackType:
  2499. .. rst-class:: classref-enumeration
  2500. enum **CompositorEffectCallbackType**: :ref:`๐Ÿ”—<enum_RenderingServer_CompositorEffectCallbackType>`
  2501. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE:
  2502. .. rst-class:: classref-enumeration-constant
  2503. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_OPAQUE** = ``0``
  2504. The callback is called before our opaque rendering pass, but after depth prepass (if applicable).
  2505. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE:
  2506. .. rst-class:: classref-enumeration-constant
  2507. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_OPAQUE** = ``1``
  2508. The callback is called after our opaque rendering pass, but before our sky is rendered.
  2509. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY:
  2510. .. rst-class:: classref-enumeration-constant
  2511. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_SKY** = ``2``
  2512. 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).
  2513. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT:
  2514. .. rst-class:: classref-enumeration-constant
  2515. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT** = ``3``
  2516. The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.
  2517. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT:
  2518. .. rst-class:: classref-enumeration-constant
  2519. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_POST_TRANSPARENT** = ``4``
  2520. The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target.
  2521. .. _class_RenderingServer_constant_COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY:
  2522. .. rst-class:: classref-enumeration-constant
  2523. :ref:`CompositorEffectCallbackType<enum_RenderingServer_CompositorEffectCallbackType>` **COMPOSITOR_EFFECT_CALLBACK_TYPE_ANY** = ``-1``
  2524. .. container:: contribute
  2525. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2526. .. rst-class:: classref-item-separator
  2527. ----
  2528. .. _enum_RenderingServer_EnvironmentBG:
  2529. .. rst-class:: classref-enumeration
  2530. enum **EnvironmentBG**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentBG>`
  2531. .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
  2532. .. rst-class:: classref-enumeration-constant
  2533. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
  2534. Use the clear color as background.
  2535. .. _class_RenderingServer_constant_ENV_BG_COLOR:
  2536. .. rst-class:: classref-enumeration-constant
  2537. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
  2538. Use a specified color as the background.
  2539. .. _class_RenderingServer_constant_ENV_BG_SKY:
  2540. .. rst-class:: classref-enumeration-constant
  2541. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
  2542. Use a sky resource for the background.
  2543. .. _class_RenderingServer_constant_ENV_BG_CANVAS:
  2544. .. rst-class:: classref-enumeration-constant
  2545. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
  2546. Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
  2547. .. _class_RenderingServer_constant_ENV_BG_KEEP:
  2548. .. rst-class:: classref-enumeration-constant
  2549. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
  2550. Do not clear the background, use whatever was rendered last frame as the background.
  2551. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
  2552. .. rst-class:: classref-enumeration-constant
  2553. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
  2554. Displays a camera feed in the background.
  2555. .. _class_RenderingServer_constant_ENV_BG_MAX:
  2556. .. rst-class:: classref-enumeration-constant
  2557. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
  2558. Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
  2559. .. rst-class:: classref-item-separator
  2560. ----
  2561. .. _enum_RenderingServer_EnvironmentAmbientSource:
  2562. .. rst-class:: classref-enumeration
  2563. enum **EnvironmentAmbientSource**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentAmbientSource>`
  2564. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
  2565. .. rst-class:: classref-enumeration-constant
  2566. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
  2567. Gather ambient light from whichever source is specified as the background.
  2568. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
  2569. .. rst-class:: classref-enumeration-constant
  2570. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
  2571. Disable ambient light.
  2572. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
  2573. .. rst-class:: classref-enumeration-constant
  2574. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
  2575. Specify a specific :ref:`Color<class_Color>` for ambient light.
  2576. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
  2577. .. rst-class:: classref-enumeration-constant
  2578. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
  2579. Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
  2580. .. rst-class:: classref-item-separator
  2581. ----
  2582. .. _enum_RenderingServer_EnvironmentReflectionSource:
  2583. .. rst-class:: classref-enumeration
  2584. enum **EnvironmentReflectionSource**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentReflectionSource>`
  2585. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
  2586. .. rst-class:: classref-enumeration-constant
  2587. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
  2588. Use the background for reflections.
  2589. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
  2590. .. rst-class:: classref-enumeration-constant
  2591. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
  2592. Disable reflections.
  2593. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
  2594. .. rst-class:: classref-enumeration-constant
  2595. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
  2596. Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
  2597. .. rst-class:: classref-item-separator
  2598. ----
  2599. .. _enum_RenderingServer_EnvironmentGlowBlendMode:
  2600. .. rst-class:: classref-enumeration
  2601. enum **EnvironmentGlowBlendMode**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentGlowBlendMode>`
  2602. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
  2603. .. rst-class:: classref-enumeration-constant
  2604. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
  2605. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  2606. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
  2607. .. rst-class:: classref-enumeration-constant
  2608. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
  2609. Screen glow blending mode. Increases brightness, used frequently with bloom.
  2610. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
  2611. .. rst-class:: classref-enumeration-constant
  2612. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
  2613. Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
  2614. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
  2615. .. rst-class:: classref-enumeration-constant
  2616. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
  2617. 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.
  2618. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
  2619. .. rst-class:: classref-enumeration-constant
  2620. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
  2621. Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
  2622. .. rst-class:: classref-item-separator
  2623. ----
  2624. .. _enum_RenderingServer_EnvironmentFogMode:
  2625. .. rst-class:: classref-enumeration
  2626. enum **EnvironmentFogMode**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentFogMode>`
  2627. .. _class_RenderingServer_constant_ENV_FOG_MODE_EXPONENTIAL:
  2628. .. rst-class:: classref-enumeration-constant
  2629. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_EXPONENTIAL** = ``0``
  2630. Use a physically-based fog model defined primarily by fog density.
  2631. .. _class_RenderingServer_constant_ENV_FOG_MODE_DEPTH:
  2632. .. rst-class:: classref-enumeration-constant
  2633. :ref:`EnvironmentFogMode<enum_RenderingServer_EnvironmentFogMode>` **ENV_FOG_MODE_DEPTH** = ``1``
  2634. 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.
  2635. .. rst-class:: classref-item-separator
  2636. ----
  2637. .. _enum_RenderingServer_EnvironmentToneMapper:
  2638. .. rst-class:: classref-enumeration
  2639. enum **EnvironmentToneMapper**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentToneMapper>`
  2640. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
  2641. .. rst-class:: classref-enumeration-constant
  2642. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
  2643. Does not modify color data, resulting in a linear tonemapping curve which unnaturally clips bright values, causing bright lighting to look blown out. The simplest and fastest tonemapper.
  2644. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
  2645. .. rst-class:: classref-enumeration-constant
  2646. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
  2647. A simple tonemapping curve that rolls off bright values to prevent clipping. This results in an image that can appear dull and low contrast. Slower than :ref:`ENV_TONE_MAPPER_LINEAR<class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR>`.
  2648. \ **Note:** When :ref:`Environment.tonemap_white<class_Environment_property_tonemap_white>` is left at the default value of ``1.0``, :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>` produces an identical image to :ref:`ENV_TONE_MAPPER_LINEAR<class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR>`.
  2649. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
  2650. .. rst-class:: classref-enumeration-constant
  2651. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
  2652. Uses a film-like tonemapping curve to prevent clipping of bright values and provide better contrast than :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>`. Slightly slower than :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>`.
  2653. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
  2654. .. rst-class:: classref-enumeration-constant
  2655. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
  2656. Uses a high-contrast film-like tonemapping curve and desaturates bright values for a more realistic appearance. Slightly slower than :ref:`ENV_TONE_MAPPER_FILMIC<class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC>`.
  2657. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
  2658. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_AGX:
  2659. .. rst-class:: classref-enumeration-constant
  2660. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_AGX** = ``4``
  2661. Uses a film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option.
  2662. \ **Note:** :ref:`Environment.tonemap_white<class_Environment_property_tonemap_white>` is fixed at a value of ``16.29``, which makes :ref:`ENV_TONE_MAPPER_AGX<class_RenderingServer_constant_ENV_TONE_MAPPER_AGX>` unsuitable for use with the Mobile rendering method.
  2663. .. rst-class:: classref-item-separator
  2664. ----
  2665. .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
  2666. .. rst-class:: classref-enumeration
  2667. enum **EnvironmentSSRRoughnessQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`
  2668. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
  2669. .. rst-class:: classref-enumeration-constant
  2670. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
  2671. 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.
  2672. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
  2673. .. rst-class:: classref-enumeration-constant
  2674. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
  2675. Low quality of roughness filter for screen-space reflections.
  2676. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
  2677. .. rst-class:: classref-enumeration-constant
  2678. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
  2679. Medium quality of roughness filter for screen-space reflections.
  2680. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
  2681. .. rst-class:: classref-enumeration-constant
  2682. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
  2683. High quality of roughness filter for screen-space reflections. This is the slowest option.
  2684. .. rst-class:: classref-item-separator
  2685. ----
  2686. .. _enum_RenderingServer_EnvironmentSSAOQuality:
  2687. .. rst-class:: classref-enumeration
  2688. enum **EnvironmentSSAOQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSSAOQuality>`
  2689. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
  2690. .. rst-class:: classref-enumeration-constant
  2691. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
  2692. Lowest quality of screen-space ambient occlusion.
  2693. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
  2694. .. rst-class:: classref-enumeration-constant
  2695. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
  2696. Low quality screen-space ambient occlusion.
  2697. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
  2698. .. rst-class:: classref-enumeration-constant
  2699. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
  2700. Medium quality screen-space ambient occlusion.
  2701. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
  2702. .. rst-class:: classref-enumeration-constant
  2703. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
  2704. High quality screen-space ambient occlusion.
  2705. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
  2706. .. rst-class:: classref-enumeration-constant
  2707. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
  2708. Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2709. .. rst-class:: classref-item-separator
  2710. ----
  2711. .. _enum_RenderingServer_EnvironmentSSILQuality:
  2712. .. rst-class:: classref-enumeration
  2713. enum **EnvironmentSSILQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSSILQuality>`
  2714. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
  2715. .. rst-class:: classref-enumeration-constant
  2716. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
  2717. Lowest quality of screen-space indirect lighting.
  2718. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
  2719. .. rst-class:: classref-enumeration-constant
  2720. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
  2721. Low quality screen-space indirect lighting.
  2722. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
  2723. .. rst-class:: classref-enumeration-constant
  2724. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
  2725. High quality screen-space indirect lighting.
  2726. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
  2727. .. rst-class:: classref-enumeration-constant
  2728. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
  2729. High quality screen-space indirect lighting.
  2730. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
  2731. .. rst-class:: classref-enumeration-constant
  2732. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
  2733. Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2734. .. rst-class:: classref-item-separator
  2735. ----
  2736. .. _enum_RenderingServer_EnvironmentSDFGIYScale:
  2737. .. rst-class:: classref-enumeration
  2738. enum **EnvironmentSDFGIYScale**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSDFGIYScale>`
  2739. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
  2740. .. rst-class:: classref-enumeration-constant
  2741. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
  2742. 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.
  2743. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
  2744. .. rst-class:: classref-enumeration-constant
  2745. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
  2746. Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
  2747. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
  2748. .. rst-class:: classref-enumeration-constant
  2749. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
  2750. 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.
  2751. .. rst-class:: classref-item-separator
  2752. ----
  2753. .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
  2754. .. rst-class:: classref-enumeration
  2755. enum **EnvironmentSDFGIRayCount**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSDFGIRayCount>`
  2756. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
  2757. .. rst-class:: classref-enumeration-constant
  2758. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
  2759. Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
  2760. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
  2761. .. rst-class:: classref-enumeration-constant
  2762. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
  2763. Throw 8 rays per frame when converging SDFGI.
  2764. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
  2765. .. rst-class:: classref-enumeration-constant
  2766. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
  2767. Throw 16 rays per frame when converging SDFGI.
  2768. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
  2769. .. rst-class:: classref-enumeration-constant
  2770. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
  2771. Throw 32 rays per frame when converging SDFGI.
  2772. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
  2773. .. rst-class:: classref-enumeration-constant
  2774. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
  2775. Throw 64 rays per frame when converging SDFGI.
  2776. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
  2777. .. rst-class:: classref-enumeration-constant
  2778. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
  2779. Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
  2780. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
  2781. .. rst-class:: classref-enumeration-constant
  2782. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
  2783. Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
  2784. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
  2785. .. rst-class:: classref-enumeration-constant
  2786. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
  2787. Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
  2788. .. rst-class:: classref-item-separator
  2789. ----
  2790. .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
  2791. .. rst-class:: classref-enumeration
  2792. enum **EnvironmentSDFGIFramesToConverge**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`
  2793. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
  2794. .. rst-class:: classref-enumeration-constant
  2795. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
  2796. Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
  2797. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
  2798. .. rst-class:: classref-enumeration-constant
  2799. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
  2800. Configure SDFGI to fully converge over 10 frames.
  2801. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
  2802. .. rst-class:: classref-enumeration-constant
  2803. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
  2804. Configure SDFGI to fully converge over 15 frames.
  2805. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
  2806. .. rst-class:: classref-enumeration-constant
  2807. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
  2808. Configure SDFGI to fully converge over 20 frames.
  2809. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
  2810. .. rst-class:: classref-enumeration-constant
  2811. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
  2812. Configure SDFGI to fully converge over 25 frames.
  2813. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
  2814. .. rst-class:: classref-enumeration-constant
  2815. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
  2816. Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
  2817. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
  2818. .. rst-class:: classref-enumeration-constant
  2819. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
  2820. Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
  2821. .. rst-class:: classref-item-separator
  2822. ----
  2823. .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
  2824. .. rst-class:: classref-enumeration
  2825. enum **EnvironmentSDFGIFramesToUpdateLight**: :ref:`๐Ÿ”—<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>`
  2826. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
  2827. .. rst-class:: classref-enumeration-constant
  2828. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
  2829. Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
  2830. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
  2831. .. rst-class:: classref-enumeration-constant
  2832. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
  2833. Update indirect light from dynamic lights in SDFGI over 2 frames.
  2834. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
  2835. .. rst-class:: classref-enumeration-constant
  2836. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
  2837. Update indirect light from dynamic lights in SDFGI over 4 frames.
  2838. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
  2839. .. rst-class:: classref-enumeration-constant
  2840. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
  2841. Update indirect light from dynamic lights in SDFGI over 8 frames.
  2842. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
  2843. .. rst-class:: classref-enumeration-constant
  2844. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
  2845. Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
  2846. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
  2847. .. rst-class:: classref-enumeration-constant
  2848. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
  2849. Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
  2850. .. rst-class:: classref-item-separator
  2851. ----
  2852. .. _enum_RenderingServer_SubSurfaceScatteringQuality:
  2853. .. rst-class:: classref-enumeration
  2854. enum **SubSurfaceScatteringQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_SubSurfaceScatteringQuality>`
  2855. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
  2856. .. rst-class:: classref-enumeration-constant
  2857. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
  2858. 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.
  2859. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
  2860. .. rst-class:: classref-enumeration-constant
  2861. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
  2862. Low subsurface scattering quality.
  2863. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
  2864. .. rst-class:: classref-enumeration-constant
  2865. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
  2866. Medium subsurface scattering quality.
  2867. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
  2868. .. rst-class:: classref-enumeration-constant
  2869. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
  2870. High subsurface scattering quality. This has the highest GPU requirements.
  2871. .. rst-class:: classref-item-separator
  2872. ----
  2873. .. _enum_RenderingServer_DOFBokehShape:
  2874. .. rst-class:: classref-enumeration
  2875. enum **DOFBokehShape**: :ref:`๐Ÿ”—<enum_RenderingServer_DOFBokehShape>`
  2876. .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
  2877. .. rst-class:: classref-enumeration-constant
  2878. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
  2879. Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
  2880. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
  2881. .. rst-class:: classref-enumeration-constant
  2882. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
  2883. Calculates DOF blur using a hexagon shaped filter.
  2884. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
  2885. .. rst-class:: classref-enumeration-constant
  2886. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
  2887. 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).
  2888. .. rst-class:: classref-item-separator
  2889. ----
  2890. .. _enum_RenderingServer_DOFBlurQuality:
  2891. .. rst-class:: classref-enumeration
  2892. enum **DOFBlurQuality**: :ref:`๐Ÿ”—<enum_RenderingServer_DOFBlurQuality>`
  2893. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
  2894. .. rst-class:: classref-enumeration-constant
  2895. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
  2896. Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
  2897. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
  2898. .. rst-class:: classref-enumeration-constant
  2899. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
  2900. Low quality DOF blur.
  2901. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
  2902. .. rst-class:: classref-enumeration-constant
  2903. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
  2904. Medium quality DOF blur.
  2905. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
  2906. .. rst-class:: classref-enumeration-constant
  2907. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
  2908. Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
  2909. .. rst-class:: classref-item-separator
  2910. ----
  2911. .. _enum_RenderingServer_InstanceType:
  2912. .. rst-class:: classref-enumeration
  2913. enum **InstanceType**: :ref:`๐Ÿ”—<enum_RenderingServer_InstanceType>`
  2914. .. _class_RenderingServer_constant_INSTANCE_NONE:
  2915. .. rst-class:: classref-enumeration-constant
  2916. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
  2917. The instance does not have a type.
  2918. .. _class_RenderingServer_constant_INSTANCE_MESH:
  2919. .. rst-class:: classref-enumeration-constant
  2920. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
  2921. The instance is a mesh.
  2922. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
  2923. .. rst-class:: classref-enumeration-constant
  2924. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
  2925. The instance is a multimesh.
  2926. .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
  2927. .. rst-class:: classref-enumeration-constant
  2928. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
  2929. The instance is a particle emitter.
  2930. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
  2931. .. rst-class:: classref-enumeration-constant
  2932. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
  2933. The instance is a GPUParticles collision shape.
  2934. .. _class_RenderingServer_constant_INSTANCE_LIGHT:
  2935. .. rst-class:: classref-enumeration-constant
  2936. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
  2937. The instance is a light.
  2938. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
  2939. .. rst-class:: classref-enumeration-constant
  2940. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
  2941. The instance is a reflection probe.
  2942. .. _class_RenderingServer_constant_INSTANCE_DECAL:
  2943. .. rst-class:: classref-enumeration-constant
  2944. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
  2945. The instance is a decal.
  2946. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
  2947. .. rst-class:: classref-enumeration-constant
  2948. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
  2949. The instance is a VoxelGI.
  2950. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
  2951. .. rst-class:: classref-enumeration-constant
  2952. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
  2953. The instance is a lightmap.
  2954. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
  2955. .. rst-class:: classref-enumeration-constant
  2956. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
  2957. The instance is an occlusion culling occluder.
  2958. .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
  2959. .. rst-class:: classref-enumeration-constant
  2960. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
  2961. The instance is a visible on-screen notifier.
  2962. .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
  2963. .. rst-class:: classref-enumeration-constant
  2964. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
  2965. The instance is a fog volume.
  2966. .. _class_RenderingServer_constant_INSTANCE_MAX:
  2967. .. rst-class:: classref-enumeration-constant
  2968. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
  2969. Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
  2970. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
  2971. .. rst-class:: classref-enumeration-constant
  2972. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
  2973. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  2974. .. rst-class:: classref-item-separator
  2975. ----
  2976. .. _enum_RenderingServer_InstanceFlags:
  2977. .. rst-class:: classref-enumeration
  2978. enum **InstanceFlags**: :ref:`๐Ÿ”—<enum_RenderingServer_InstanceFlags>`
  2979. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
  2980. .. rst-class:: classref-enumeration-constant
  2981. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
  2982. Allows the instance to be used in baked lighting.
  2983. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
  2984. .. rst-class:: classref-enumeration-constant
  2985. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
  2986. Allows the instance to be used with dynamic global illumination.
  2987. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
  2988. .. rst-class:: classref-enumeration-constant
  2989. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
  2990. When set, manually requests to draw geometry on next frame.
  2991. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
  2992. .. rst-class:: classref-enumeration-constant
  2993. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
  2994. Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
  2995. .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
  2996. .. rst-class:: classref-enumeration-constant
  2997. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
  2998. Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
  2999. .. rst-class:: classref-item-separator
  3000. ----
  3001. .. _enum_RenderingServer_ShadowCastingSetting:
  3002. .. rst-class:: classref-enumeration
  3003. enum **ShadowCastingSetting**: :ref:`๐Ÿ”—<enum_RenderingServer_ShadowCastingSetting>`
  3004. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
  3005. .. rst-class:: classref-enumeration-constant
  3006. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
  3007. Disable shadows from this instance.
  3008. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
  3009. .. rst-class:: classref-enumeration-constant
  3010. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
  3011. Cast shadows from this instance.
  3012. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
  3013. .. rst-class:: classref-enumeration-constant
  3014. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
  3015. Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
  3016. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
  3017. .. rst-class:: classref-enumeration-constant
  3018. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
  3019. Only render the shadows from the object. The object itself will not be drawn.
  3020. .. rst-class:: classref-item-separator
  3021. ----
  3022. .. _enum_RenderingServer_VisibilityRangeFadeMode:
  3023. .. rst-class:: classref-enumeration
  3024. enum **VisibilityRangeFadeMode**: :ref:`๐Ÿ”—<enum_RenderingServer_VisibilityRangeFadeMode>`
  3025. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
  3026. .. rst-class:: classref-enumeration-constant
  3027. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
  3028. Disable visibility range fading for the given instance.
  3029. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
  3030. .. rst-class:: classref-enumeration-constant
  3031. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
  3032. Fade-out the given instance when it approaches its visibility range limits.
  3033. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
  3034. .. rst-class:: classref-enumeration-constant
  3035. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
  3036. Fade-in the given instance's dependencies when reaching its visibility range limits.
  3037. .. rst-class:: classref-item-separator
  3038. ----
  3039. .. _enum_RenderingServer_BakeChannels:
  3040. .. rst-class:: classref-enumeration
  3041. enum **BakeChannels**: :ref:`๐Ÿ”—<enum_RenderingServer_BakeChannels>`
  3042. .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
  3043. .. rst-class:: classref-enumeration-constant
  3044. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
  3045. 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.
  3046. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
  3047. .. rst-class:: classref-enumeration-constant
  3048. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
  3049. 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``.
  3050. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
  3051. .. rst-class:: classref-enumeration-constant
  3052. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
  3053. 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.
  3054. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
  3055. .. rst-class:: classref-enumeration-constant
  3056. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
  3057. 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.
  3058. .. rst-class:: classref-item-separator
  3059. ----
  3060. .. _enum_RenderingServer_CanvasTextureChannel:
  3061. .. rst-class:: classref-enumeration
  3062. enum **CanvasTextureChannel**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasTextureChannel>`
  3063. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
  3064. .. rst-class:: classref-enumeration-constant
  3065. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
  3066. Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
  3067. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
  3068. .. rst-class:: classref-enumeration-constant
  3069. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
  3070. Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
  3071. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
  3072. .. rst-class:: classref-enumeration-constant
  3073. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
  3074. Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
  3075. .. rst-class:: classref-item-separator
  3076. ----
  3077. .. _enum_RenderingServer_NinePatchAxisMode:
  3078. .. rst-class:: classref-enumeration
  3079. enum **NinePatchAxisMode**: :ref:`๐Ÿ”—<enum_RenderingServer_NinePatchAxisMode>`
  3080. .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
  3081. .. rst-class:: classref-enumeration-constant
  3082. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
  3083. The nine patch gets stretched where needed.
  3084. .. _class_RenderingServer_constant_NINE_PATCH_TILE:
  3085. .. rst-class:: classref-enumeration-constant
  3086. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
  3087. The nine patch gets filled with tiles where needed.
  3088. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
  3089. .. rst-class:: classref-enumeration-constant
  3090. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
  3091. The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  3092. .. rst-class:: classref-item-separator
  3093. ----
  3094. .. _enum_RenderingServer_CanvasItemTextureFilter:
  3095. .. rst-class:: classref-enumeration
  3096. enum **CanvasItemTextureFilter**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasItemTextureFilter>`
  3097. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
  3098. .. rst-class:: classref-enumeration-constant
  3099. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
  3100. Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
  3101. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
  3102. .. rst-class:: classref-enumeration-constant
  3103. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
  3104. 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).
  3105. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
  3106. .. rst-class:: classref-enumeration-constant
  3107. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
  3108. 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).
  3109. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
  3110. .. rst-class:: classref-enumeration-constant
  3111. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
  3112. 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.
  3113. 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.
  3114. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
  3115. .. rst-class:: classref-enumeration-constant
  3116. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
  3117. 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.
  3118. 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.
  3119. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
  3120. .. rst-class:: classref-enumeration-constant
  3121. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
  3122. 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>`.
  3123. \ **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.
  3124. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
  3125. .. rst-class:: classref-enumeration-constant
  3126. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
  3127. 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>`.
  3128. \ **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.
  3129. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
  3130. .. rst-class:: classref-enumeration-constant
  3131. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
  3132. Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
  3133. .. rst-class:: classref-item-separator
  3134. ----
  3135. .. _enum_RenderingServer_CanvasItemTextureRepeat:
  3136. .. rst-class:: classref-enumeration
  3137. enum **CanvasItemTextureRepeat**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasItemTextureRepeat>`
  3138. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
  3139. .. rst-class:: classref-enumeration-constant
  3140. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
  3141. Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
  3142. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
  3143. .. rst-class:: classref-enumeration-constant
  3144. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
  3145. 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.
  3146. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
  3147. .. rst-class:: classref-enumeration-constant
  3148. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
  3149. 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.
  3150. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
  3151. .. rst-class:: classref-enumeration-constant
  3152. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
  3153. Flip the texture when repeating so that the edge lines up instead of abruptly changing.
  3154. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
  3155. .. rst-class:: classref-enumeration-constant
  3156. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
  3157. Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
  3158. .. rst-class:: classref-item-separator
  3159. ----
  3160. .. _enum_RenderingServer_CanvasGroupMode:
  3161. .. rst-class:: classref-enumeration
  3162. enum **CanvasGroupMode**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasGroupMode>`
  3163. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
  3164. .. rst-class:: classref-enumeration-constant
  3165. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
  3166. Child draws over parent and is not clipped.
  3167. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
  3168. .. rst-class:: classref-enumeration-constant
  3169. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
  3170. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
  3171. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
  3172. .. rst-class:: classref-enumeration-constant
  3173. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
  3174. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
  3175. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
  3176. .. rst-class:: classref-enumeration-constant
  3177. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
  3178. .. container:: contribute
  3179. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3180. .. rst-class:: classref-item-separator
  3181. ----
  3182. .. _enum_RenderingServer_CanvasLightMode:
  3183. .. rst-class:: classref-enumeration
  3184. enum **CanvasLightMode**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasLightMode>`
  3185. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
  3186. .. rst-class:: classref-enumeration-constant
  3187. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
  3188. 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
  3189. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
  3190. .. rst-class:: classref-enumeration-constant
  3191. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
  3192. 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
  3193. .. rst-class:: classref-item-separator
  3194. ----
  3195. .. _enum_RenderingServer_CanvasLightBlendMode:
  3196. .. rst-class:: classref-enumeration
  3197. enum **CanvasLightBlendMode**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasLightBlendMode>`
  3198. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
  3199. .. rst-class:: classref-enumeration-constant
  3200. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
  3201. Adds light color additive to the canvas.
  3202. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
  3203. .. rst-class:: classref-enumeration-constant
  3204. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
  3205. Adds light color subtractive to the canvas.
  3206. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
  3207. .. rst-class:: classref-enumeration-constant
  3208. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
  3209. The light adds color depending on transparency.
  3210. .. rst-class:: classref-item-separator
  3211. ----
  3212. .. _enum_RenderingServer_CanvasLightShadowFilter:
  3213. .. rst-class:: classref-enumeration
  3214. enum **CanvasLightShadowFilter**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasLightShadowFilter>`
  3215. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
  3216. .. rst-class:: classref-enumeration-constant
  3217. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
  3218. Do not apply a filter to canvas light shadows.
  3219. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
  3220. .. rst-class:: classref-enumeration-constant
  3221. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
  3222. Use PCF5 filtering to filter canvas light shadows.
  3223. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
  3224. .. rst-class:: classref-enumeration-constant
  3225. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
  3226. Use PCF13 filtering to filter canvas light shadows.
  3227. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
  3228. .. rst-class:: classref-enumeration-constant
  3229. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
  3230. Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
  3231. .. rst-class:: classref-item-separator
  3232. ----
  3233. .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
  3234. .. rst-class:: classref-enumeration
  3235. enum **CanvasOccluderPolygonCullMode**: :ref:`๐Ÿ”—<enum_RenderingServer_CanvasOccluderPolygonCullMode>`
  3236. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
  3237. .. rst-class:: classref-enumeration-constant
  3238. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
  3239. Culling of the canvas occluder is disabled.
  3240. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
  3241. .. rst-class:: classref-enumeration-constant
  3242. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
  3243. Culling of the canvas occluder is clockwise.
  3244. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
  3245. .. rst-class:: classref-enumeration-constant
  3246. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
  3247. Culling of the canvas occluder is counterclockwise.
  3248. .. rst-class:: classref-item-separator
  3249. ----
  3250. .. _enum_RenderingServer_GlobalShaderParameterType:
  3251. .. rst-class:: classref-enumeration
  3252. enum **GlobalShaderParameterType**: :ref:`๐Ÿ”—<enum_RenderingServer_GlobalShaderParameterType>`
  3253. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
  3254. .. rst-class:: classref-enumeration-constant
  3255. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
  3256. Boolean global shader parameter (``global uniform bool ...``).
  3257. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
  3258. .. rst-class:: classref-enumeration-constant
  3259. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
  3260. 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
  3261. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
  3262. .. rst-class:: classref-enumeration-constant
  3263. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
  3264. 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
  3265. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
  3266. .. rst-class:: classref-enumeration-constant
  3267. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
  3268. 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
  3269. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
  3270. .. rst-class:: classref-enumeration-constant
  3271. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
  3272. Integer global shader parameter (``global uniform int ...``).
  3273. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
  3274. .. rst-class:: classref-enumeration-constant
  3275. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
  3276. 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
  3277. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
  3278. .. rst-class:: classref-enumeration-constant
  3279. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
  3280. 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
  3281. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
  3282. .. rst-class:: classref-enumeration-constant
  3283. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
  3284. 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
  3285. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
  3286. .. rst-class:: classref-enumeration-constant
  3287. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
  3288. 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.
  3289. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
  3290. .. rst-class:: classref-enumeration-constant
  3291. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
  3292. Unsigned integer global shader parameter (``global uniform uint ...``).
  3293. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
  3294. .. rst-class:: classref-enumeration-constant
  3295. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
  3296. 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
  3297. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
  3298. .. rst-class:: classref-enumeration-constant
  3299. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
  3300. 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
  3301. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
  3302. .. rst-class:: classref-enumeration-constant
  3303. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
  3304. 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
  3305. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
  3306. .. rst-class:: classref-enumeration-constant
  3307. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
  3308. Single-precision floating-point global shader parameter (``global uniform float ...``).
  3309. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
  3310. .. rst-class:: classref-enumeration-constant
  3311. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
  3312. 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
  3313. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
  3314. .. rst-class:: classref-enumeration-constant
  3315. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
  3316. 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
  3317. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
  3318. .. rst-class:: classref-enumeration-constant
  3319. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
  3320. 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
  3321. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
  3322. .. rst-class:: classref-enumeration-constant
  3323. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
  3324. 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.
  3325. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
  3326. .. rst-class:: classref-enumeration-constant
  3327. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
  3328. 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.
  3329. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
  3330. .. rst-class:: classref-enumeration-constant
  3331. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
  3332. 2ร—2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
  3333. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
  3334. .. rst-class:: classref-enumeration-constant
  3335. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
  3336. 3ร—3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
  3337. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
  3338. .. rst-class:: classref-enumeration-constant
  3339. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
  3340. 4ร—4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
  3341. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
  3342. .. rst-class:: classref-enumeration-constant
  3343. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
  3344. 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
  3345. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
  3346. .. rst-class:: classref-enumeration-constant
  3347. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
  3348. 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
  3349. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
  3350. .. rst-class:: classref-enumeration-constant
  3351. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
  3352. 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
  3353. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
  3354. .. rst-class:: classref-enumeration-constant
  3355. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
  3356. 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
  3357. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
  3358. .. rst-class:: classref-enumeration-constant
  3359. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
  3360. 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
  3361. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
  3362. .. rst-class:: classref-enumeration-constant
  3363. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
  3364. Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
  3365. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLEREXT:
  3366. .. rst-class:: classref-enumeration-constant
  3367. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLEREXT** = ``28``
  3368. External sampler global shader parameter (``global uniform samplerExternalOES ...``). Exposed as an :ref:`ExternalTexture<class_ExternalTexture>` in the editor UI.
  3369. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
  3370. .. rst-class:: classref-enumeration-constant
  3371. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``29``
  3372. Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
  3373. .. rst-class:: classref-item-separator
  3374. ----
  3375. .. _enum_RenderingServer_RenderingInfo:
  3376. .. rst-class:: classref-enumeration
  3377. enum **RenderingInfo**: :ref:`๐Ÿ”—<enum_RenderingServer_RenderingInfo>`
  3378. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
  3379. .. rst-class:: classref-enumeration-constant
  3380. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
  3381. Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
  3382. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
  3383. .. rst-class:: classref-enumeration-constant
  3384. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
  3385. Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
  3386. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
  3387. .. rst-class:: classref-enumeration-constant
  3388. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
  3389. Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
  3390. .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
  3391. .. rst-class:: classref-enumeration-constant
  3392. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
  3393. Texture memory used (in bytes).
  3394. .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
  3395. .. rst-class:: classref-enumeration-constant
  3396. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
  3397. Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
  3398. .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
  3399. .. rst-class:: classref-enumeration-constant
  3400. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
  3401. Video memory used (in bytes). When using the Forward+ or Mobile renderers, this is always greater than the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`, since there is miscellaneous data not accounted for by those two metrics. When using the Compatibility renderer, this is equal to the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`.
  3402. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS:
  3403. .. rst-class:: classref-enumeration-constant
  3404. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_CANVAS** = ``6``
  3405. Number of pipeline compilations that were triggered by the 2D canvas renderer.
  3406. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_MESH:
  3407. .. rst-class:: classref-enumeration-constant
  3408. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_MESH** = ``7``
  3409. Number of pipeline compilations that were triggered by loading meshes. These compilations will show up as longer loading times the first time a user runs the game and the pipeline is required.
  3410. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE:
  3411. .. rst-class:: classref-enumeration-constant
  3412. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_SURFACE** = ``8``
  3413. Number of pipeline compilations that were triggered by building the surface cache before rendering the scene. These compilations will show up as a stutter when loading a scene the first time a user runs the game and the pipeline is required.
  3414. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW:
  3415. .. rst-class:: classref-enumeration-constant
  3416. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_DRAW** = ``9``
  3417. Number of pipeline compilations that were triggered while drawing the scene. These compilations will show up as stutters during gameplay the first time a user runs the game and the pipeline is required.
  3418. .. _class_RenderingServer_constant_RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION:
  3419. .. rst-class:: classref-enumeration-constant
  3420. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_PIPELINE_COMPILATIONS_SPECIALIZATION** = ``10``
  3421. Number of pipeline compilations that were triggered to optimize the current scene. These compilations are done in the background and should not cause any stutters whatsoever.
  3422. .. rst-class:: classref-item-separator
  3423. ----
  3424. .. _enum_RenderingServer_PipelineSource:
  3425. .. rst-class:: classref-enumeration
  3426. enum **PipelineSource**: :ref:`๐Ÿ”—<enum_RenderingServer_PipelineSource>`
  3427. .. _class_RenderingServer_constant_PIPELINE_SOURCE_CANVAS:
  3428. .. rst-class:: classref-enumeration-constant
  3429. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_CANVAS** = ``0``
  3430. Pipeline compilation that was triggered by the 2D canvas renderer.
  3431. .. _class_RenderingServer_constant_PIPELINE_SOURCE_MESH:
  3432. .. rst-class:: classref-enumeration-constant
  3433. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_MESH** = ``1``
  3434. Pipeline compilation that was triggered by loading a mesh.
  3435. .. _class_RenderingServer_constant_PIPELINE_SOURCE_SURFACE:
  3436. .. rst-class:: classref-enumeration-constant
  3437. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_SURFACE** = ``2``
  3438. Pipeline compilation that was triggered by building the surface cache before rendering the scene.
  3439. .. _class_RenderingServer_constant_PIPELINE_SOURCE_DRAW:
  3440. .. rst-class:: classref-enumeration-constant
  3441. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_DRAW** = ``3``
  3442. Pipeline compilation that was triggered while drawing the scene.
  3443. .. _class_RenderingServer_constant_PIPELINE_SOURCE_SPECIALIZATION:
  3444. .. rst-class:: classref-enumeration-constant
  3445. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_SPECIALIZATION** = ``4``
  3446. Pipeline compilation that was triggered to optimize the current scene.
  3447. .. _class_RenderingServer_constant_PIPELINE_SOURCE_MAX:
  3448. .. rst-class:: classref-enumeration-constant
  3449. :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` **PIPELINE_SOURCE_MAX** = ``5``
  3450. Represents the size of the :ref:`PipelineSource<enum_RenderingServer_PipelineSource>` enum.
  3451. .. rst-class:: classref-item-separator
  3452. ----
  3453. .. _enum_RenderingServer_Features:
  3454. .. rst-class:: classref-enumeration
  3455. enum **Features**: :ref:`๐Ÿ”—<enum_RenderingServer_Features>`
  3456. .. _class_RenderingServer_constant_FEATURE_SHADERS:
  3457. .. rst-class:: classref-enumeration-constant
  3458. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
  3459. **Deprecated:** This constant has not been used since Godot 3.0.
  3460. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
  3461. .. rst-class:: classref-enumeration-constant
  3462. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
  3463. **Deprecated:** This constant has not been used since Godot 3.0.
  3464. .. rst-class:: classref-section-separator
  3465. ----
  3466. .. rst-class:: classref-descriptions-group
  3467. Constants
  3468. ---------
  3469. .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
  3470. .. rst-class:: classref-constant
  3471. **NO_INDEX_ARRAY** = ``-1`` :ref:`๐Ÿ”—<class_RenderingServer_constant_NO_INDEX_ARRAY>`
  3472. Marks an error that shows that the index array is empty.
  3473. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
  3474. .. rst-class:: classref-constant
  3475. **ARRAY_WEIGHTS_SIZE** = ``4`` :ref:`๐Ÿ”—<class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE>`
  3476. Number of weights/bones per vertex.
  3477. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
  3478. .. rst-class:: classref-constant
  3479. **CANVAS_ITEM_Z_MIN** = ``-4096`` :ref:`๐Ÿ”—<class_RenderingServer_constant_CANVAS_ITEM_Z_MIN>`
  3480. The minimum Z-layer for canvas items.
  3481. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
  3482. .. rst-class:: classref-constant
  3483. **CANVAS_ITEM_Z_MAX** = ``4096`` :ref:`๐Ÿ”—<class_RenderingServer_constant_CANVAS_ITEM_Z_MAX>`
  3484. The maximum Z-layer for canvas items.
  3485. .. _class_RenderingServer_constant_CANVAS_LAYER_MIN:
  3486. .. rst-class:: classref-constant
  3487. **CANVAS_LAYER_MIN** = ``-2147483648`` :ref:`๐Ÿ”—<class_RenderingServer_constant_CANVAS_LAYER_MIN>`
  3488. The minimum canvas layer.
  3489. .. _class_RenderingServer_constant_CANVAS_LAYER_MAX:
  3490. .. rst-class:: classref-constant
  3491. **CANVAS_LAYER_MAX** = ``2147483647`` :ref:`๐Ÿ”—<class_RenderingServer_constant_CANVAS_LAYER_MAX>`
  3492. The maximum canvas layer.
  3493. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
  3494. .. rst-class:: classref-constant
  3495. **MAX_GLOW_LEVELS** = ``7`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MAX_GLOW_LEVELS>`
  3496. The maximum number of glow levels that can be used with the glow post-processing effect.
  3497. .. _class_RenderingServer_constant_MAX_CURSORS:
  3498. .. rst-class:: classref-constant
  3499. **MAX_CURSORS** = ``8`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MAX_CURSORS>`
  3500. **Deprecated:** This constant is not used by the engine.
  3501. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
  3502. .. rst-class:: classref-constant
  3503. **MAX_2D_DIRECTIONAL_LIGHTS** = ``8`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS>`
  3504. The maximum number of directional lights that can be rendered at a given time in 2D.
  3505. .. _class_RenderingServer_constant_MAX_MESH_SURFACES:
  3506. .. rst-class:: classref-constant
  3507. **MAX_MESH_SURFACES** = ``256`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MAX_MESH_SURFACES>`
  3508. The maximum number of surfaces a mesh can have.
  3509. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
  3510. .. rst-class:: classref-constant
  3511. **MATERIAL_RENDER_PRIORITY_MIN** = ``-128`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN>`
  3512. The minimum renderpriority of all materials.
  3513. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
  3514. .. rst-class:: classref-constant
  3515. **MATERIAL_RENDER_PRIORITY_MAX** = ``127`` :ref:`๐Ÿ”—<class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX>`
  3516. The maximum renderpriority of all materials.
  3517. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
  3518. .. rst-class:: classref-constant
  3519. **ARRAY_CUSTOM_COUNT** = ``4`` :ref:`๐Ÿ”—<class_RenderingServer_constant_ARRAY_CUSTOM_COUNT>`
  3520. 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>`).
  3521. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
  3522. .. rst-class:: classref-constant
  3523. **PARTICLES_EMIT_FLAG_POSITION** = ``1`` :ref:`๐Ÿ”—<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION>`
  3524. .. container:: contribute
  3525. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3526. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
  3527. .. rst-class:: classref-constant
  3528. **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2`` :ref:`๐Ÿ”—<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE>`
  3529. .. container:: contribute
  3530. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3531. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
  3532. .. rst-class:: classref-constant
  3533. **PARTICLES_EMIT_FLAG_VELOCITY** = ``4`` :ref:`๐Ÿ”—<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY>`
  3534. .. container:: contribute
  3535. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3536. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
  3537. .. rst-class:: classref-constant
  3538. **PARTICLES_EMIT_FLAG_COLOR** = ``8`` :ref:`๐Ÿ”—<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR>`
  3539. .. container:: contribute
  3540. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3541. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
  3542. .. rst-class:: classref-constant
  3543. **PARTICLES_EMIT_FLAG_CUSTOM** = ``16`` :ref:`๐Ÿ”—<class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM>`
  3544. .. container:: contribute
  3545. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3546. .. rst-class:: classref-section-separator
  3547. ----
  3548. .. rst-class:: classref-descriptions-group
  3549. Property Descriptions
  3550. ---------------------
  3551. .. _class_RenderingServer_property_render_loop_enabled:
  3552. .. rst-class:: classref-property
  3553. :ref:`bool<class_bool>` **render_loop_enabled** :ref:`๐Ÿ”—<class_RenderingServer_property_render_loop_enabled>`
  3554. .. rst-class:: classref-property-setget
  3555. - |void| **set_render_loop_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  3556. - :ref:`bool<class_bool>` **is_render_loop_enabled**\ (\ )
  3557. 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.
  3558. .. rst-class:: classref-section-separator
  3559. ----
  3560. .. rst-class:: classref-descriptions-group
  3561. Method Descriptions
  3562. -------------------
  3563. .. _class_RenderingServer_method_bake_render_uv2:
  3564. .. rst-class:: classref-method
  3565. :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>`
  3566. 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>`.
  3567. .. rst-class:: classref-item-separator
  3568. ----
  3569. .. _class_RenderingServer_method_call_on_render_thread:
  3570. .. rst-class:: classref-method
  3571. |void| **call_on_render_thread**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_call_on_render_thread>`
  3572. As the RenderingServer actual logic may run on a 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.
  3573. .. rst-class:: classref-item-separator
  3574. ----
  3575. .. _class_RenderingServer_method_camera_attributes_create:
  3576. .. rst-class:: classref-method
  3577. :ref:`RID<class_RID>` **camera_attributes_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_attributes_create>`
  3578. 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.
  3579. 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.
  3580. \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
  3581. .. rst-class:: classref-item-separator
  3582. ----
  3583. .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
  3584. .. rst-class:: classref-method
  3585. |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>`
  3586. 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>`.
  3587. .. rst-class:: classref-item-separator
  3588. ----
  3589. .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
  3590. .. rst-class:: classref-method
  3591. |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>`
  3592. 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>`.
  3593. .. rst-class:: classref-item-separator
  3594. ----
  3595. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
  3596. .. rst-class:: classref-method
  3597. |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>`
  3598. Sets the shape of the DOF bokeh pattern to ``shape``. Different shapes may be used to achieve artistic effect, or to meet performance targets.
  3599. .. rst-class:: classref-item-separator
  3600. ----
  3601. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
  3602. .. rst-class:: classref-method
  3603. |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>`
  3604. Sets the quality level of the DOF blur effect to ``quality``. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
  3605. .. rst-class:: classref-item-separator
  3606. ----
  3607. .. _class_RenderingServer_method_camera_attributes_set_exposure:
  3608. .. rst-class:: classref-method
  3609. |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>`
  3610. 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.
  3611. The normalization factor can be calculated from exposure value (EV100) as follows:
  3612. ::
  3613. func get_exposure_normalization(ev100: float):
  3614. return 1.0 / (pow(2.0, ev100) * 1.2)
  3615. The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
  3616. ::
  3617. func get_exposure(aperture: float, shutter_speed: float, sensitivity: float):
  3618. return log((aperture * aperture) / shutter_speed * (100.0 / sensitivity)) / log(2)
  3619. .. rst-class:: classref-item-separator
  3620. ----
  3621. .. _class_RenderingServer_method_camera_create:
  3622. .. rst-class:: classref-method
  3623. :ref:`RID<class_RID>` **camera_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_create>`
  3624. 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.
  3625. 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.
  3626. \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
  3627. .. rst-class:: classref-item-separator
  3628. ----
  3629. .. _class_RenderingServer_method_camera_set_camera_attributes:
  3630. .. rst-class:: classref-method
  3631. |void| **camera_set_camera_attributes**\ (\ camera\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_set_camera_attributes>`
  3632. Sets the camera_attributes created with :ref:`camera_attributes_create()<class_RenderingServer_method_camera_attributes_create>` to the given camera.
  3633. .. rst-class:: classref-item-separator
  3634. ----
  3635. .. _class_RenderingServer_method_camera_set_compositor:
  3636. .. rst-class:: classref-method
  3637. |void| **camera_set_compositor**\ (\ camera\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_set_compositor>`
  3638. Sets the compositor used by this camera. Equivalent to :ref:`Camera3D.compositor<class_Camera3D_property_compositor>`.
  3639. .. rst-class:: classref-item-separator
  3640. ----
  3641. .. _class_RenderingServer_method_camera_set_cull_mask:
  3642. .. rst-class:: classref-method
  3643. |void| **camera_set_cull_mask**\ (\ camera\: :ref:`RID<class_RID>`, layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_set_cull_mask>`
  3644. 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>`.
  3645. .. rst-class:: classref-item-separator
  3646. ----
  3647. .. _class_RenderingServer_method_camera_set_environment:
  3648. .. rst-class:: classref-method
  3649. |void| **camera_set_environment**\ (\ camera\: :ref:`RID<class_RID>`, env\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_set_environment>`
  3650. Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
  3651. .. rst-class:: classref-item-separator
  3652. ----
  3653. .. _class_RenderingServer_method_camera_set_frustum:
  3654. .. rst-class:: classref-method
  3655. |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>`
  3656. Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
  3657. .. rst-class:: classref-item-separator
  3658. ----
  3659. .. _class_RenderingServer_method_camera_set_orthogonal:
  3660. .. rst-class:: classref-method
  3661. |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>`
  3662. 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.
  3663. .. rst-class:: classref-item-separator
  3664. ----
  3665. .. _class_RenderingServer_method_camera_set_perspective:
  3666. .. rst-class:: classref-method
  3667. |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>`
  3668. Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
  3669. .. rst-class:: classref-item-separator
  3670. ----
  3671. .. _class_RenderingServer_method_camera_set_transform:
  3672. .. rst-class:: classref-method
  3673. |void| **camera_set_transform**\ (\ camera\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_camera_set_transform>`
  3674. Sets :ref:`Transform3D<class_Transform3D>` of camera.
  3675. .. rst-class:: classref-item-separator
  3676. ----
  3677. .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
  3678. .. rst-class:: classref-method
  3679. |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>`
  3680. 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>`.
  3681. .. rst-class:: classref-item-separator
  3682. ----
  3683. .. _class_RenderingServer_method_canvas_create:
  3684. .. rst-class:: classref-method
  3685. :ref:`RID<class_RID>` **canvas_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_create>`
  3686. 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.
  3687. 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.
  3688. Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
  3689. .. rst-class:: classref-item-separator
  3690. ----
  3691. .. _class_RenderingServer_method_canvas_item_add_animation_slice:
  3692. .. rst-class:: classref-method
  3693. |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>`
  3694. 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.
  3695. .. rst-class:: classref-item-separator
  3696. ----
  3697. .. _class_RenderingServer_method_canvas_item_add_circle:
  3698. .. rst-class:: classref-method
  3699. |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>`
  3700. 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>`.
  3701. .. rst-class:: classref-item-separator
  3702. ----
  3703. .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
  3704. .. rst-class:: classref-method
  3705. |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>`
  3706. If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to ``false``.
  3707. .. rst-class:: classref-item-separator
  3708. ----
  3709. .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
  3710. .. rst-class:: classref-method
  3711. |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>`
  3712. See also :ref:`CanvasItem.draw_lcd_texture_rect_region()<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
  3713. .. rst-class:: classref-item-separator
  3714. ----
  3715. .. _class_RenderingServer_method_canvas_item_add_line:
  3716. .. rst-class:: classref-method
  3717. |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>`
  3718. 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>`.
  3719. .. rst-class:: classref-item-separator
  3720. ----
  3721. .. _class_RenderingServer_method_canvas_item_add_mesh:
  3722. .. rst-class:: classref-method
  3723. |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>`
  3724. 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>`.
  3725. .. rst-class:: classref-item-separator
  3726. ----
  3727. .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
  3728. .. rst-class:: classref-method
  3729. |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>`
  3730. See also :ref:`CanvasItem.draw_msdf_texture_rect_region()<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
  3731. .. rst-class:: classref-item-separator
  3732. ----
  3733. .. _class_RenderingServer_method_canvas_item_add_multiline:
  3734. .. rst-class:: classref-method
  3735. |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>`
  3736. 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>`.
  3737. .. rst-class:: classref-item-separator
  3738. ----
  3739. .. _class_RenderingServer_method_canvas_item_add_multimesh:
  3740. .. rst-class:: classref-method
  3741. |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>`
  3742. 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>`.
  3743. .. rst-class:: classref-item-separator
  3744. ----
  3745. .. _class_RenderingServer_method_canvas_item_add_nine_patch:
  3746. .. rst-class:: classref-method
  3747. |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>`
  3748. Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3749. .. rst-class:: classref-item-separator
  3750. ----
  3751. .. _class_RenderingServer_method_canvas_item_add_particles:
  3752. .. rst-class:: classref-method
  3753. |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>`
  3754. Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3755. .. rst-class:: classref-item-separator
  3756. ----
  3757. .. _class_RenderingServer_method_canvas_item_add_polygon:
  3758. .. rst-class:: classref-method
  3759. |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>`
  3760. 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>`.
  3761. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon()<class_Geometry2D_method_triangulate_polygon>` and using :ref:`CanvasItem.draw_mesh()<class_CanvasItem_method_draw_mesh>`, :ref:`CanvasItem.draw_multimesh()<class_CanvasItem_method_draw_multimesh>`, or :ref:`canvas_item_add_triangle_array()<class_RenderingServer_method_canvas_item_add_triangle_array>`.
  3762. .. rst-class:: classref-item-separator
  3763. ----
  3764. .. _class_RenderingServer_method_canvas_item_add_polyline:
  3765. .. rst-class:: classref-method
  3766. |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>`
  3767. 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>`.
  3768. .. rst-class:: classref-item-separator
  3769. ----
  3770. .. _class_RenderingServer_method_canvas_item_add_primitive:
  3771. .. rst-class:: classref-method
  3772. |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>`
  3773. 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>`.
  3774. .. rst-class:: classref-item-separator
  3775. ----
  3776. .. _class_RenderingServer_method_canvas_item_add_rect:
  3777. .. rst-class:: classref-method
  3778. |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>`
  3779. 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>`.
  3780. .. rst-class:: classref-item-separator
  3781. ----
  3782. .. _class_RenderingServer_method_canvas_item_add_set_transform:
  3783. .. rst-class:: classref-method
  3784. |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>`
  3785. Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
  3786. .. rst-class:: classref-item-separator
  3787. ----
  3788. .. _class_RenderingServer_method_canvas_item_add_texture_rect:
  3789. .. rst-class:: classref-method
  3790. |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>`
  3791. 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>`.
  3792. .. rst-class:: classref-item-separator
  3793. ----
  3794. .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
  3795. .. rst-class:: classref-method
  3796. |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>`
  3797. 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>`.
  3798. .. rst-class:: classref-item-separator
  3799. ----
  3800. .. _class_RenderingServer_method_canvas_item_add_triangle_array:
  3801. .. rst-class:: classref-method
  3802. |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>`
  3803. 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>`.
  3804. \ **Note:** If ``count`` is set to a non-negative value, only the first ``count * 3`` indices (corresponding to ``count`` triangles) will be drawn. Otherwise, all indices are drawn.
  3805. .. rst-class:: classref-item-separator
  3806. ----
  3807. .. _class_RenderingServer_method_canvas_item_attach_skeleton:
  3808. .. rst-class:: classref-method
  3809. |void| **canvas_item_attach_skeleton**\ (\ item\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_attach_skeleton>`
  3810. Attaches a skeleton to the :ref:`CanvasItem<class_CanvasItem>`. Removes the previous skeleton.
  3811. .. rst-class:: classref-item-separator
  3812. ----
  3813. .. _class_RenderingServer_method_canvas_item_clear:
  3814. .. rst-class:: classref-method
  3815. |void| **canvas_item_clear**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_clear>`
  3816. Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
  3817. .. rst-class:: classref-item-separator
  3818. ----
  3819. .. _class_RenderingServer_method_canvas_item_create:
  3820. .. rst-class:: classref-method
  3821. :ref:`RID<class_RID>` **canvas_item_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_create>`
  3822. 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.
  3823. 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.
  3824. \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
  3825. .. rst-class:: classref-item-separator
  3826. ----
  3827. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter:
  3828. .. rst-class:: classref-method
  3829. :ref:`Variant<class_Variant>` **canvas_item_get_instance_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_get_instance_shader_parameter>`
  3830. Returns the value of the per-instance shader uniform from the specified canvas item instance. Equivalent to :ref:`CanvasItem.get_instance_shader_parameter()<class_CanvasItem_method_get_instance_shader_parameter>`.
  3831. .. rst-class:: classref-item-separator
  3832. ----
  3833. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value:
  3834. .. rst-class:: classref-method
  3835. :ref:`Variant<class_Variant>` **canvas_item_get_instance_shader_parameter_default_value**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_default_value>`
  3836. Returns the default value of the per-instance shader uniform from the specified canvas item instance. Equivalent to :ref:`CanvasItem.get_instance_shader_parameter()<class_CanvasItem_method_get_instance_shader_parameter>`.
  3837. .. rst-class:: classref-item-separator
  3838. ----
  3839. .. _class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list:
  3840. .. rst-class:: classref-method
  3841. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **canvas_item_get_instance_shader_parameter_list**\ (\ instance\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_get_instance_shader_parameter_list>`
  3842. Returns a dictionary of per-instance shader uniform names of the per-instance shader uniform from the specified canvas item instance.
  3843. The returned dictionary is in PropertyInfo format, with the keys ``name``, ``class_name``, ``type``, ``hint``, ``hint_string``, and ``usage``.
  3844. .. rst-class:: classref-item-separator
  3845. ----
  3846. .. _class_RenderingServer_method_canvas_item_reset_physics_interpolation:
  3847. .. rst-class:: classref-method
  3848. |void| **canvas_item_reset_physics_interpolation**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_reset_physics_interpolation>`
  3849. Prevents physics interpolation for the current physics tick.
  3850. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  3851. .. rst-class:: classref-item-separator
  3852. ----
  3853. .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
  3854. .. rst-class:: classref-method
  3855. |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>`
  3856. 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.
  3857. \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
  3858. .. rst-class:: classref-item-separator
  3859. ----
  3860. .. _class_RenderingServer_method_canvas_item_set_clip:
  3861. .. rst-class:: classref-method
  3862. |void| **canvas_item_set_clip**\ (\ item\: :ref:`RID<class_RID>`, clip\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_clip>`
  3863. 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.
  3864. \ **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.
  3865. .. rst-class:: classref-item-separator
  3866. ----
  3867. .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
  3868. .. rst-class:: classref-method
  3869. |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>`
  3870. Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
  3871. .. rst-class:: classref-item-separator
  3872. ----
  3873. .. _class_RenderingServer_method_canvas_item_set_custom_rect:
  3874. .. rst-class:: classref-method
  3875. |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>`
  3876. 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.
  3877. .. rst-class:: classref-item-separator
  3878. ----
  3879. .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
  3880. .. rst-class:: classref-method
  3881. |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>`
  3882. 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>`.
  3883. .. rst-class:: classref-item-separator
  3884. ----
  3885. .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
  3886. .. rst-class:: classref-method
  3887. |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>`
  3888. 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>`.
  3889. .. rst-class:: classref-item-separator
  3890. ----
  3891. .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
  3892. .. rst-class:: classref-method
  3893. |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>`
  3894. 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>`__.
  3895. .. rst-class:: classref-item-separator
  3896. ----
  3897. .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
  3898. .. rst-class:: classref-method
  3899. |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>`
  3900. 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>`.
  3901. .. rst-class:: classref-item-separator
  3902. ----
  3903. .. _class_RenderingServer_method_canvas_item_set_draw_index:
  3904. .. rst-class:: classref-method
  3905. |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>`
  3906. Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
  3907. .. rst-class:: classref-item-separator
  3908. ----
  3909. .. _class_RenderingServer_method_canvas_item_set_instance_shader_parameter:
  3910. .. rst-class:: classref-method
  3911. |void| **canvas_item_set_instance_shader_parameter**\ (\ instance\: :ref:`RID<class_RID>`, parameter\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_instance_shader_parameter>`
  3912. Sets the per-instance shader uniform on the specified canvas item instance. Equivalent to :ref:`CanvasItem.set_instance_shader_parameter()<class_CanvasItem_method_set_instance_shader_parameter>`.
  3913. .. rst-class:: classref-item-separator
  3914. ----
  3915. .. _class_RenderingServer_method_canvas_item_set_interpolated:
  3916. .. rst-class:: classref-method
  3917. |void| **canvas_item_set_interpolated**\ (\ item\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_interpolated>`
  3918. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas item.
  3919. .. rst-class:: classref-item-separator
  3920. ----
  3921. .. _class_RenderingServer_method_canvas_item_set_light_mask:
  3922. .. rst-class:: classref-method
  3923. |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>`
  3924. Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
  3925. .. rst-class:: classref-item-separator
  3926. ----
  3927. .. _class_RenderingServer_method_canvas_item_set_material:
  3928. .. rst-class:: classref-method
  3929. |void| **canvas_item_set_material**\ (\ item\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_material>`
  3930. Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
  3931. .. rst-class:: classref-item-separator
  3932. ----
  3933. .. _class_RenderingServer_method_canvas_item_set_modulate:
  3934. .. rst-class:: classref-method
  3935. |void| **canvas_item_set_modulate**\ (\ item\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_modulate>`
  3936. 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>`.
  3937. .. rst-class:: classref-item-separator
  3938. ----
  3939. .. _class_RenderingServer_method_canvas_item_set_parent:
  3940. .. rst-class:: classref-method
  3941. |void| **canvas_item_set_parent**\ (\ item\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_parent>`
  3942. 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.
  3943. .. rst-class:: classref-item-separator
  3944. ----
  3945. .. _class_RenderingServer_method_canvas_item_set_self_modulate:
  3946. .. rst-class:: classref-method
  3947. |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>`
  3948. 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>`.
  3949. .. rst-class:: classref-item-separator
  3950. ----
  3951. .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
  3952. .. rst-class:: classref-method
  3953. |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>`
  3954. 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>`.
  3955. .. rst-class:: classref-item-separator
  3956. ----
  3957. .. _class_RenderingServer_method_canvas_item_set_transform:
  3958. .. rst-class:: classref-method
  3959. |void| **canvas_item_set_transform**\ (\ item\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_transform>`
  3960. 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>`.
  3961. .. rst-class:: classref-item-separator
  3962. ----
  3963. .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
  3964. .. rst-class:: classref-method
  3965. |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>`
  3966. Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
  3967. .. rst-class:: classref-item-separator
  3968. ----
  3969. .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
  3970. .. rst-class:: classref-method
  3971. |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>`
  3972. 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>`.
  3973. .. rst-class:: classref-item-separator
  3974. ----
  3975. .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
  3976. .. rst-class:: classref-method
  3977. |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>`
  3978. 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.
  3979. This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
  3980. .. rst-class:: classref-item-separator
  3981. ----
  3982. .. _class_RenderingServer_method_canvas_item_set_visible:
  3983. .. rst-class:: classref-method
  3984. |void| **canvas_item_set_visible**\ (\ item\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_item_set_visible>`
  3985. Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
  3986. .. rst-class:: classref-item-separator
  3987. ----
  3988. .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
  3989. .. rst-class:: classref-method
  3990. |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>`
  3991. If this is enabled, the Z index of the parent will be added to the children's Z index.
  3992. .. rst-class:: classref-item-separator
  3993. ----
  3994. .. _class_RenderingServer_method_canvas_item_set_z_index:
  3995. .. rst-class:: classref-method
  3996. |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>`
  3997. Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
  3998. .. rst-class:: classref-item-separator
  3999. ----
  4000. .. _class_RenderingServer_method_canvas_item_transform_physics_interpolation:
  4001. .. rst-class:: classref-method
  4002. |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>`
  4003. Transforms both the current and previous stored transform for a canvas item.
  4004. This allows transforming a canvas item without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  4005. .. rst-class:: classref-item-separator
  4006. ----
  4007. .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
  4008. .. rst-class:: classref-method
  4009. |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>`
  4010. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  4011. .. rst-class:: classref-item-separator
  4012. ----
  4013. .. _class_RenderingServer_method_canvas_light_create:
  4014. .. rst-class:: classref-method
  4015. :ref:`RID<class_RID>` **canvas_light_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_create>`
  4016. 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.
  4017. 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.
  4018. \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
  4019. .. rst-class:: classref-item-separator
  4020. ----
  4021. .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
  4022. .. rst-class:: classref-method
  4023. |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>`
  4024. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  4025. .. rst-class:: classref-item-separator
  4026. ----
  4027. .. _class_RenderingServer_method_canvas_light_occluder_create:
  4028. .. rst-class:: classref-method
  4029. :ref:`RID<class_RID>` **canvas_light_occluder_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_occluder_create>`
  4030. 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.
  4031. 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.
  4032. \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
  4033. .. rst-class:: classref-item-separator
  4034. ----
  4035. .. _class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation:
  4036. .. rst-class:: classref-method
  4037. |void| **canvas_light_occluder_reset_physics_interpolation**\ (\ occluder\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_occluder_reset_physics_interpolation>`
  4038. Prevents physics interpolation for the current physics tick.
  4039. This is useful when moving an occluder to a new location, to give an instantaneous change rather than interpolation from the previous location.
  4040. .. rst-class:: classref-item-separator
  4041. ----
  4042. .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
  4043. .. rst-class:: classref-method
  4044. |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>`
  4045. .. container:: contribute
  4046. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4047. .. rst-class:: classref-item-separator
  4048. ----
  4049. .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
  4050. .. rst-class:: classref-method
  4051. |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>`
  4052. Enables or disables light occluder.
  4053. .. rst-class:: classref-item-separator
  4054. ----
  4055. .. _class_RenderingServer_method_canvas_light_occluder_set_interpolated:
  4056. .. rst-class:: classref-method
  4057. |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>`
  4058. If ``interpolated`` is ``true``, turns on physics interpolation for the light occluder.
  4059. .. rst-class:: classref-item-separator
  4060. ----
  4061. .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
  4062. .. rst-class:: classref-method
  4063. |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>`
  4064. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  4065. .. rst-class:: classref-item-separator
  4066. ----
  4067. .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
  4068. .. rst-class:: classref-method
  4069. |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>`
  4070. Sets a light occluder's polygon.
  4071. .. rst-class:: classref-item-separator
  4072. ----
  4073. .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
  4074. .. rst-class:: classref-method
  4075. |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>`
  4076. Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
  4077. .. rst-class:: classref-item-separator
  4078. ----
  4079. .. _class_RenderingServer_method_canvas_light_occluder_transform_physics_interpolation:
  4080. .. rst-class:: classref-method
  4081. |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>`
  4082. Transforms both the current and previous stored transform for a light occluder.
  4083. This allows transforming an occluder without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  4084. .. rst-class:: classref-item-separator
  4085. ----
  4086. .. _class_RenderingServer_method_canvas_light_reset_physics_interpolation:
  4087. .. rst-class:: classref-method
  4088. |void| **canvas_light_reset_physics_interpolation**\ (\ light\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_reset_physics_interpolation>`
  4089. Prevents physics interpolation for the current physics tick.
  4090. This is useful when moving a canvas item to a new location, to give an instantaneous change rather than interpolation from the previous location.
  4091. .. rst-class:: classref-item-separator
  4092. ----
  4093. .. _class_RenderingServer_method_canvas_light_set_blend_mode:
  4094. .. rst-class:: classref-method
  4095. |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>`
  4096. Sets the blend mode for the given canvas light to ``mode``. Equivalent to :ref:`Light2D.blend_mode<class_Light2D_property_blend_mode>`.
  4097. .. rst-class:: classref-item-separator
  4098. ----
  4099. .. _class_RenderingServer_method_canvas_light_set_color:
  4100. .. rst-class:: classref-method
  4101. |void| **canvas_light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_color>`
  4102. Sets the color for a light.
  4103. .. rst-class:: classref-item-separator
  4104. ----
  4105. .. _class_RenderingServer_method_canvas_light_set_enabled:
  4106. .. rst-class:: classref-method
  4107. |void| **canvas_light_set_enabled**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_enabled>`
  4108. Enables or disables a canvas light.
  4109. .. rst-class:: classref-item-separator
  4110. ----
  4111. .. _class_RenderingServer_method_canvas_light_set_energy:
  4112. .. rst-class:: classref-method
  4113. |void| **canvas_light_set_energy**\ (\ light\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_energy>`
  4114. Sets a canvas light's energy.
  4115. .. rst-class:: classref-item-separator
  4116. ----
  4117. .. _class_RenderingServer_method_canvas_light_set_height:
  4118. .. rst-class:: classref-method
  4119. |void| **canvas_light_set_height**\ (\ light\: :ref:`RID<class_RID>`, height\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_height>`
  4120. Sets a canvas light's height.
  4121. .. rst-class:: classref-item-separator
  4122. ----
  4123. .. _class_RenderingServer_method_canvas_light_set_interpolated:
  4124. .. rst-class:: classref-method
  4125. |void| **canvas_light_set_interpolated**\ (\ light\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_interpolated>`
  4126. If ``interpolated`` is ``true``, turns on physics interpolation for the canvas light.
  4127. .. rst-class:: classref-item-separator
  4128. ----
  4129. .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
  4130. .. rst-class:: classref-method
  4131. |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>`
  4132. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  4133. .. rst-class:: classref-item-separator
  4134. ----
  4135. .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
  4136. .. rst-class:: classref-method
  4137. |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>`
  4138. 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.
  4139. .. rst-class:: classref-item-separator
  4140. ----
  4141. .. _class_RenderingServer_method_canvas_light_set_layer_range:
  4142. .. rst-class:: classref-method
  4143. |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>`
  4144. The layer range that gets rendered with this light.
  4145. .. rst-class:: classref-item-separator
  4146. ----
  4147. .. _class_RenderingServer_method_canvas_light_set_mode:
  4148. .. rst-class:: classref-method
  4149. |void| **canvas_light_set_mode**\ (\ light\: :ref:`RID<class_RID>`, mode\: :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_mode>`
  4150. Sets the mode of the canvas light.
  4151. .. rst-class:: classref-item-separator
  4152. ----
  4153. .. _class_RenderingServer_method_canvas_light_set_shadow_color:
  4154. .. rst-class:: classref-method
  4155. |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>`
  4156. Sets the color of the canvas light's shadow.
  4157. .. rst-class:: classref-item-separator
  4158. ----
  4159. .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
  4160. .. rst-class:: classref-method
  4161. |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>`
  4162. Enables or disables the canvas light's shadow.
  4163. .. rst-class:: classref-item-separator
  4164. ----
  4165. .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
  4166. .. rst-class:: classref-method
  4167. |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>`
  4168. Sets the canvas light's shadow's filter.
  4169. .. rst-class:: classref-item-separator
  4170. ----
  4171. .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
  4172. .. rst-class:: classref-method
  4173. |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>`
  4174. Smoothens the shadow. The lower, the smoother.
  4175. .. rst-class:: classref-item-separator
  4176. ----
  4177. .. _class_RenderingServer_method_canvas_light_set_texture:
  4178. .. rst-class:: classref-method
  4179. |void| **canvas_light_set_texture**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_texture>`
  4180. Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
  4181. .. rst-class:: classref-item-separator
  4182. ----
  4183. .. _class_RenderingServer_method_canvas_light_set_texture_offset:
  4184. .. rst-class:: classref-method
  4185. |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>`
  4186. Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
  4187. .. rst-class:: classref-item-separator
  4188. ----
  4189. .. _class_RenderingServer_method_canvas_light_set_texture_scale:
  4190. .. rst-class:: classref-method
  4191. |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>`
  4192. Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
  4193. .. rst-class:: classref-item-separator
  4194. ----
  4195. .. _class_RenderingServer_method_canvas_light_set_transform:
  4196. .. rst-class:: classref-method
  4197. |void| **canvas_light_set_transform**\ (\ light\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_light_set_transform>`
  4198. Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
  4199. .. rst-class:: classref-item-separator
  4200. ----
  4201. .. _class_RenderingServer_method_canvas_light_set_z_range:
  4202. .. rst-class:: classref-method
  4203. |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>`
  4204. 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>`.
  4205. .. rst-class:: classref-item-separator
  4206. ----
  4207. .. _class_RenderingServer_method_canvas_light_transform_physics_interpolation:
  4208. .. rst-class:: classref-method
  4209. |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>`
  4210. Transforms both the current and previous stored transform for a canvas light.
  4211. This allows transforming a light without creating a "glitch" in the interpolation, which is particularly useful for large worlds utilizing a shifting origin.
  4212. .. rst-class:: classref-item-separator
  4213. ----
  4214. .. _class_RenderingServer_method_canvas_occluder_polygon_create:
  4215. .. rst-class:: classref-method
  4216. :ref:`RID<class_RID>` **canvas_occluder_polygon_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_occluder_polygon_create>`
  4217. 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.
  4218. 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.
  4219. \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
  4220. .. rst-class:: classref-item-separator
  4221. ----
  4222. .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
  4223. .. rst-class:: classref-method
  4224. |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>`
  4225. Sets an occluder polygon's cull mode.
  4226. .. rst-class:: classref-item-separator
  4227. ----
  4228. .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
  4229. .. rst-class:: classref-method
  4230. |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>`
  4231. Sets the shape of the occluder polygon.
  4232. .. rst-class:: classref-item-separator
  4233. ----
  4234. .. _class_RenderingServer_method_canvas_set_disable_scale:
  4235. .. rst-class:: classref-method
  4236. |void| **canvas_set_disable_scale**\ (\ disable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_set_disable_scale>`
  4237. .. container:: contribute
  4238. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4239. .. rst-class:: classref-item-separator
  4240. ----
  4241. .. _class_RenderingServer_method_canvas_set_item_mirroring:
  4242. .. rst-class:: classref-method
  4243. |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>`
  4244. A copy of the canvas item will be drawn with a local offset of the ``mirroring``.
  4245. \ **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``.
  4246. .. rst-class:: classref-item-separator
  4247. ----
  4248. .. _class_RenderingServer_method_canvas_set_item_repeat:
  4249. .. rst-class:: classref-method
  4250. |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>`
  4251. 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.
  4252. .. rst-class:: classref-item-separator
  4253. ----
  4254. .. _class_RenderingServer_method_canvas_set_modulate:
  4255. .. rst-class:: classref-method
  4256. |void| **canvas_set_modulate**\ (\ canvas\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_set_modulate>`
  4257. Modulates all colors in the given canvas.
  4258. .. rst-class:: classref-item-separator
  4259. ----
  4260. .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
  4261. .. rst-class:: classref-method
  4262. |void| **canvas_set_shadow_texture_size**\ (\ size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_set_shadow_texture_size>`
  4263. 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.
  4264. .. rst-class:: classref-item-separator
  4265. ----
  4266. .. _class_RenderingServer_method_canvas_texture_create:
  4267. .. rst-class:: classref-method
  4268. :ref:`RID<class_RID>` **canvas_texture_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_canvas_texture_create>`
  4269. 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.
  4270. 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>`.
  4271. \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
  4272. .. rst-class:: classref-item-separator
  4273. ----
  4274. .. _class_RenderingServer_method_canvas_texture_set_channel:
  4275. .. rst-class:: classref-method
  4276. |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>`
  4277. 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>`.
  4278. .. rst-class:: classref-item-separator
  4279. ----
  4280. .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
  4281. .. rst-class:: classref-method
  4282. |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>`
  4283. 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>`.
  4284. .. rst-class:: classref-item-separator
  4285. ----
  4286. .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
  4287. .. rst-class:: classref-method
  4288. |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>`
  4289. Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4290. .. rst-class:: classref-item-separator
  4291. ----
  4292. .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
  4293. .. rst-class:: classref-method
  4294. |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>`
  4295. Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  4296. .. rst-class:: classref-item-separator
  4297. ----
  4298. .. _class_RenderingServer_method_compositor_create:
  4299. .. rst-class:: classref-method
  4300. :ref:`RID<class_RID>` **compositor_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_compositor_create>`
  4301. Creates a new compositor and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4302. 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.
  4303. .. rst-class:: classref-item-separator
  4304. ----
  4305. .. _class_RenderingServer_method_compositor_effect_create:
  4306. .. rst-class:: classref-method
  4307. :ref:`RID<class_RID>` **compositor_effect_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_compositor_effect_create>`
  4308. Creates a new rendering effect and adds it to the RenderingServer. It can be accessed with the RID that is returned.
  4309. 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.
  4310. .. rst-class:: classref-item-separator
  4311. ----
  4312. .. _class_RenderingServer_method_compositor_effect_set_callback:
  4313. .. rst-class:: classref-method
  4314. |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>`
  4315. Sets the callback type (``callback_type``) and callback method(``callback``) for this rendering effect.
  4316. .. rst-class:: classref-item-separator
  4317. ----
  4318. .. _class_RenderingServer_method_compositor_effect_set_enabled:
  4319. .. rst-class:: classref-method
  4320. |void| **compositor_effect_set_enabled**\ (\ effect\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_compositor_effect_set_enabled>`
  4321. Enables/disables this rendering effect.
  4322. .. rst-class:: classref-item-separator
  4323. ----
  4324. .. _class_RenderingServer_method_compositor_effect_set_flag:
  4325. .. rst-class:: classref-method
  4326. |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>`
  4327. Sets the flag (``flag``) for this rendering effect to ``true`` or ``false`` (``set``).
  4328. .. rst-class:: classref-item-separator
  4329. ----
  4330. .. _class_RenderingServer_method_compositor_set_compositor_effects:
  4331. .. rst-class:: classref-method
  4332. |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>`
  4333. 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>`.
  4334. .. rst-class:: classref-item-separator
  4335. ----
  4336. .. _class_RenderingServer_method_create_local_rendering_device:
  4337. .. rst-class:: classref-method
  4338. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_create_local_rendering_device>`
  4339. 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.
  4340. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns ``null``.
  4341. .. rst-class:: classref-item-separator
  4342. ----
  4343. .. _class_RenderingServer_method_debug_canvas_item_get_rect:
  4344. .. rst-class:: classref-method
  4345. :ref:`Rect2<class_Rect2>` **debug_canvas_item_get_rect**\ (\ item\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_debug_canvas_item_get_rect>`
  4346. Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling.
  4347. \ **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.
  4348. .. rst-class:: classref-item-separator
  4349. ----
  4350. .. _class_RenderingServer_method_decal_create:
  4351. .. rst-class:: classref-method
  4352. :ref:`RID<class_RID>` **decal_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_create>`
  4353. 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.
  4354. 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.
  4355. 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.
  4356. \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
  4357. .. rst-class:: classref-item-separator
  4358. ----
  4359. .. _class_RenderingServer_method_decal_set_albedo_mix:
  4360. .. rst-class:: classref-method
  4361. |void| **decal_set_albedo_mix**\ (\ decal\: :ref:`RID<class_RID>`, albedo_mix\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_albedo_mix>`
  4362. Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
  4363. .. rst-class:: classref-item-separator
  4364. ----
  4365. .. _class_RenderingServer_method_decal_set_cull_mask:
  4366. .. rst-class:: classref-method
  4367. |void| **decal_set_cull_mask**\ (\ decal\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_cull_mask>`
  4368. Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
  4369. .. rst-class:: classref-item-separator
  4370. ----
  4371. .. _class_RenderingServer_method_decal_set_distance_fade:
  4372. .. rst-class:: classref-method
  4373. |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>`
  4374. 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>`.
  4375. .. rst-class:: classref-item-separator
  4376. ----
  4377. .. _class_RenderingServer_method_decal_set_emission_energy:
  4378. .. rst-class:: classref-method
  4379. |void| **decal_set_emission_energy**\ (\ decal\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_emission_energy>`
  4380. Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
  4381. .. rst-class:: classref-item-separator
  4382. ----
  4383. .. _class_RenderingServer_method_decal_set_fade:
  4384. .. rst-class:: classref-method
  4385. |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>`
  4386. 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>`.
  4387. .. rst-class:: classref-item-separator
  4388. ----
  4389. .. _class_RenderingServer_method_decal_set_modulate:
  4390. .. rst-class:: classref-method
  4391. |void| **decal_set_modulate**\ (\ decal\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_modulate>`
  4392. Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
  4393. .. rst-class:: classref-item-separator
  4394. ----
  4395. .. _class_RenderingServer_method_decal_set_normal_fade:
  4396. .. rst-class:: classref-method
  4397. |void| **decal_set_normal_fade**\ (\ decal\: :ref:`RID<class_RID>`, fade\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_normal_fade>`
  4398. Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
  4399. .. rst-class:: classref-item-separator
  4400. ----
  4401. .. _class_RenderingServer_method_decal_set_size:
  4402. .. rst-class:: classref-method
  4403. |void| **decal_set_size**\ (\ decal\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decal_set_size>`
  4404. Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
  4405. .. rst-class:: classref-item-separator
  4406. ----
  4407. .. _class_RenderingServer_method_decal_set_texture:
  4408. .. rst-class:: classref-method
  4409. |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>`
  4410. Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture()<class_Decal_method_set_texture>`.
  4411. .. rst-class:: classref-item-separator
  4412. ----
  4413. .. _class_RenderingServer_method_decals_set_filter:
  4414. .. rst-class:: classref-method
  4415. |void| **decals_set_filter**\ (\ filter\: :ref:`DecalFilter<enum_RenderingServer_DecalFilter>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_decals_set_filter>`
  4416. Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
  4417. .. rst-class:: classref-item-separator
  4418. ----
  4419. .. _class_RenderingServer_method_directional_light_create:
  4420. .. rst-class:: classref-method
  4421. :ref:`RID<class_RID>` **directional_light_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_directional_light_create>`
  4422. 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.
  4423. 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.
  4424. 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.
  4425. \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
  4426. .. rst-class:: classref-item-separator
  4427. ----
  4428. .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
  4429. .. rst-class:: classref-method
  4430. |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>`
  4431. 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.
  4432. .. rst-class:: classref-item-separator
  4433. ----
  4434. .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
  4435. .. rst-class:: classref-method
  4436. |void| **directional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>`
  4437. 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.
  4438. .. rst-class:: classref-item-separator
  4439. ----
  4440. .. _class_RenderingServer_method_environment_bake_panorama:
  4441. .. rst-class:: classref-method
  4442. :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>`
  4443. 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>`.
  4444. \ **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.
  4445. \ **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.
  4446. .. rst-class:: classref-item-separator
  4447. ----
  4448. .. _class_RenderingServer_method_environment_create:
  4449. .. rst-class:: classref-method
  4450. :ref:`RID<class_RID>` **environment_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_create>`
  4451. 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.
  4452. 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.
  4453. \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
  4454. .. rst-class:: classref-item-separator
  4455. ----
  4456. .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
  4457. .. rst-class:: classref-method
  4458. |void| **environment_glow_set_use_bicubic_upscale**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>`
  4459. 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>`.
  4460. \ **Note:** This setting is only effective when using the Forward+ or Mobile rendering methods, as Compatibility uses a different glow implementation.
  4461. .. rst-class:: classref-item-separator
  4462. ----
  4463. .. _class_RenderingServer_method_environment_set_adjustment:
  4464. .. rst-class:: classref-method
  4465. |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>`
  4466. Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4467. .. rst-class:: classref-item-separator
  4468. ----
  4469. .. _class_RenderingServer_method_environment_set_ambient_light:
  4470. .. rst-class:: classref-method
  4471. |void| **environment_set_ambient_light**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, ambient\: :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` = 0, energy\: :ref:`float<class_float>` = 1.0, sky_contribution\: :ref:`float<class_float>` = 0.0, reflection_source\: :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_ambient_light>`
  4472. Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
  4473. .. rst-class:: classref-item-separator
  4474. ----
  4475. .. _class_RenderingServer_method_environment_set_background:
  4476. .. rst-class:: classref-method
  4477. |void| **environment_set_background**\ (\ env\: :ref:`RID<class_RID>`, bg\: :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_background>`
  4478. Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
  4479. .. rst-class:: classref-item-separator
  4480. ----
  4481. .. _class_RenderingServer_method_environment_set_bg_color:
  4482. .. rst-class:: classref-method
  4483. |void| **environment_set_bg_color**\ (\ env\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_bg_color>`
  4484. 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.
  4485. .. rst-class:: classref-item-separator
  4486. ----
  4487. .. _class_RenderingServer_method_environment_set_bg_energy:
  4488. .. rst-class:: classref-method
  4489. |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>`
  4490. Sets the intensity of the background color.
  4491. .. rst-class:: classref-item-separator
  4492. ----
  4493. .. _class_RenderingServer_method_environment_set_camera_id:
  4494. .. rst-class:: classref-method
  4495. |void| **environment_set_camera_id**\ (\ env\: :ref:`RID<class_RID>`, id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_camera_id>`
  4496. Sets the camera ID to be used as environment background.
  4497. .. rst-class:: classref-item-separator
  4498. ----
  4499. .. _class_RenderingServer_method_environment_set_canvas_max_layer:
  4500. .. rst-class:: classref-method
  4501. |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>`
  4502. Sets the maximum layer to use if using Canvas background mode.
  4503. .. rst-class:: classref-item-separator
  4504. ----
  4505. .. _class_RenderingServer_method_environment_set_fog:
  4506. .. rst-class:: classref-method
  4507. |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>`
  4508. Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4509. .. rst-class:: classref-item-separator
  4510. ----
  4511. .. _class_RenderingServer_method_environment_set_fog_depth:
  4512. .. rst-class:: classref-method
  4513. |void| **environment_set_fog_depth**\ (\ env\: :ref:`RID<class_RID>`, curve\: :ref:`float<class_float>`, begin\: :ref:`float<class_float>`, end\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_fog_depth>`
  4514. Configures fog depth for the specified environment RID. Only has an effect when the fog mode of the environment is :ref:`ENV_FOG_MODE_DEPTH<class_RenderingServer_constant_ENV_FOG_MODE_DEPTH>`. See ``fog_depth_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4515. .. rst-class:: classref-item-separator
  4516. ----
  4517. .. _class_RenderingServer_method_environment_set_glow:
  4518. .. rst-class:: classref-method
  4519. |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>`
  4520. Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4521. .. rst-class:: classref-item-separator
  4522. ----
  4523. .. _class_RenderingServer_method_environment_set_sdfgi:
  4524. .. rst-class:: classref-method
  4525. |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>`
  4526. Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
  4527. .. rst-class:: classref-item-separator
  4528. ----
  4529. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
  4530. .. rst-class:: classref-method
  4531. |void| **environment_set_sdfgi_frames_to_converge**\ (\ frames\: :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>`
  4532. 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>`.
  4533. .. rst-class:: classref-item-separator
  4534. ----
  4535. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
  4536. .. rst-class:: classref-method
  4537. |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>`
  4538. 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>`.
  4539. .. rst-class:: classref-item-separator
  4540. ----
  4541. .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
  4542. .. rst-class:: classref-method
  4543. |void| **environment_set_sdfgi_ray_count**\ (\ ray_count\: :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_sdfgi_ray_count>`
  4544. 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>`.
  4545. .. rst-class:: classref-item-separator
  4546. ----
  4547. .. _class_RenderingServer_method_environment_set_sky:
  4548. .. rst-class:: classref-method
  4549. |void| **environment_set_sky**\ (\ env\: :ref:`RID<class_RID>`, sky\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_sky>`
  4550. 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>`.
  4551. .. rst-class:: classref-item-separator
  4552. ----
  4553. .. _class_RenderingServer_method_environment_set_sky_custom_fov:
  4554. .. rst-class:: classref-method
  4555. |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>`
  4556. 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>`.
  4557. .. rst-class:: classref-item-separator
  4558. ----
  4559. .. _class_RenderingServer_method_environment_set_sky_orientation:
  4560. .. rst-class:: classref-method
  4561. |void| **environment_set_sky_orientation**\ (\ env\: :ref:`RID<class_RID>`, orientation\: :ref:`Basis<class_Basis>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_sky_orientation>`
  4562. 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>`.
  4563. .. rst-class:: classref-item-separator
  4564. ----
  4565. .. _class_RenderingServer_method_environment_set_ssao:
  4566. .. rst-class:: classref-method
  4567. |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>`
  4568. Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4569. .. rst-class:: classref-item-separator
  4570. ----
  4571. .. _class_RenderingServer_method_environment_set_ssao_quality:
  4572. .. rst-class:: classref-method
  4573. |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>`
  4574. Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4575. .. rst-class:: classref-item-separator
  4576. ----
  4577. .. _class_RenderingServer_method_environment_set_ssil_quality:
  4578. .. rst-class:: classref-method
  4579. |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>`
  4580. Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4581. .. rst-class:: classref-item-separator
  4582. ----
  4583. .. _class_RenderingServer_method_environment_set_ssr:
  4584. .. rst-class:: classref-method
  4585. |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>`
  4586. Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4587. .. rst-class:: classref-item-separator
  4588. ----
  4589. .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
  4590. .. rst-class:: classref-method
  4591. |void| **environment_set_ssr_roughness_quality**\ (\ quality\: :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_ssr_roughness_quality>`
  4592. .. container:: contribute
  4593. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4594. .. rst-class:: classref-item-separator
  4595. ----
  4596. .. _class_RenderingServer_method_environment_set_tonemap:
  4597. .. rst-class:: classref-method
  4598. |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>`
  4599. Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4600. .. rst-class:: classref-item-separator
  4601. ----
  4602. .. _class_RenderingServer_method_environment_set_volumetric_fog:
  4603. .. rst-class:: classref-method
  4604. |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>`
  4605. Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
  4606. .. rst-class:: classref-item-separator
  4607. ----
  4608. .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
  4609. .. rst-class:: classref-method
  4610. |void| **environment_set_volumetric_fog_filter_active**\ (\ active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>`
  4611. Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
  4612. .. rst-class:: classref-item-separator
  4613. ----
  4614. .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
  4615. .. rst-class:: classref-method
  4616. |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>`
  4617. 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.
  4618. .. rst-class:: classref-item-separator
  4619. ----
  4620. .. _class_RenderingServer_method_fog_volume_create:
  4621. .. rst-class:: classref-method
  4622. :ref:`RID<class_RID>` **fog_volume_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_fog_volume_create>`
  4623. 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.
  4624. 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.
  4625. \ **Note:** The equivalent node is :ref:`FogVolume<class_FogVolume>`.
  4626. .. rst-class:: classref-item-separator
  4627. ----
  4628. .. _class_RenderingServer_method_fog_volume_set_material:
  4629. .. rst-class:: classref-method
  4630. |void| **fog_volume_set_material**\ (\ fog_volume\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_fog_volume_set_material>`
  4631. 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>`.
  4632. .. rst-class:: classref-item-separator
  4633. ----
  4634. .. _class_RenderingServer_method_fog_volume_set_shape:
  4635. .. rst-class:: classref-method
  4636. |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>`
  4637. 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>`.
  4638. .. rst-class:: classref-item-separator
  4639. ----
  4640. .. _class_RenderingServer_method_fog_volume_set_size:
  4641. .. rst-class:: classref-method
  4642. |void| **fog_volume_set_size**\ (\ fog_volume\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_fog_volume_set_size>`
  4643. 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>`.
  4644. .. rst-class:: classref-item-separator
  4645. ----
  4646. .. _class_RenderingServer_method_force_draw:
  4647. .. rst-class:: classref-method
  4648. |void| **force_draw**\ (\ swap_buffers\: :ref:`bool<class_bool>` = true, frame_step\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_force_draw>`
  4649. Forces redrawing of all viewports at once. Must be called from the main thread.
  4650. .. rst-class:: classref-item-separator
  4651. ----
  4652. .. _class_RenderingServer_method_force_sync:
  4653. .. rst-class:: classref-method
  4654. |void| **force_sync**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_force_sync>`
  4655. 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.
  4656. .. rst-class:: classref-item-separator
  4657. ----
  4658. .. _class_RenderingServer_method_free_rid:
  4659. .. rst-class:: classref-method
  4660. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_free_rid>`
  4661. 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.
  4662. .. rst-class:: classref-item-separator
  4663. ----
  4664. .. _class_RenderingServer_method_get_current_rendering_driver_name:
  4665. .. rst-class:: classref-method
  4666. :ref:`String<class_String>` **get_current_rendering_driver_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_current_rendering_driver_name>`
  4667. Returns the name of the current rendering driver. This can be ``vulkan``, ``d3d12``, ``metal``, ``opengl3``, ``opengl3_es``, or ``opengl3_angle``. See also :ref:`get_current_rendering_method()<class_RenderingServer_method_get_current_rendering_method>`.
  4668. The rendering driver is determined by :ref:`ProjectSettings.rendering/rendering_device/driver<class_ProjectSettings_property_rendering/rendering_device/driver>`, the ``--rendering-driver`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
  4669. .. rst-class:: classref-item-separator
  4670. ----
  4671. .. _class_RenderingServer_method_get_current_rendering_method:
  4672. .. rst-class:: classref-method
  4673. :ref:`String<class_String>` **get_current_rendering_method**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_current_rendering_method>`
  4674. Returns the name of the current rendering method. This can be ``forward_plus``, ``mobile``, or ``gl_compatibility``. See also :ref:`get_current_rendering_driver_name()<class_RenderingServer_method_get_current_rendering_driver_name>`.
  4675. The rendering method is determined by :ref:`ProjectSettings.rendering/renderer/rendering_method<class_ProjectSettings_property_rendering/renderer/rendering_method>`, the ``--rendering-method`` command line argument that overrides this project setting, or an automatic fallback that is applied depending on the hardware.
  4676. .. rst-class:: classref-item-separator
  4677. ----
  4678. .. _class_RenderingServer_method_get_default_clear_color:
  4679. .. rst-class:: classref-method
  4680. :ref:`Color<class_Color>` **get_default_clear_color**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_get_default_clear_color>`
  4681. 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>`.
  4682. .. rst-class:: classref-item-separator
  4683. ----
  4684. .. _class_RenderingServer_method_get_frame_setup_time_cpu:
  4685. .. rst-class:: classref-method
  4686. :ref:`float<class_float>` **get_frame_setup_time_cpu**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_frame_setup_time_cpu>`
  4687. 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>`.
  4688. .. rst-class:: classref-item-separator
  4689. ----
  4690. .. _class_RenderingServer_method_get_rendering_device:
  4691. .. rst-class:: classref-method
  4692. :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_rendering_device>`
  4693. Returns the global RenderingDevice.
  4694. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns ``null``.
  4695. .. rst-class:: classref-item-separator
  4696. ----
  4697. .. _class_RenderingServer_method_get_rendering_info:
  4698. .. rst-class:: classref-method
  4699. :ref:`int<class_int>` **get_rendering_info**\ (\ info\: :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_get_rendering_info>`
  4700. Returns a statistic about the rendering engine which can be used for performance profiling. See also :ref:`viewport_get_render_info()<class_RenderingServer_method_viewport_get_render_info>`, which returns information specific to a viewport.
  4701. \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
  4702. \ **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:
  4703. ::
  4704. func _ready():
  4705. for _i in 2:
  4706. await get_tree().process_frame
  4707. print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
  4708. .. rst-class:: classref-item-separator
  4709. ----
  4710. .. _class_RenderingServer_method_get_shader_parameter_list:
  4711. .. rst-class:: classref-method
  4712. :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>`
  4713. Returns the parameters of a shader.
  4714. .. rst-class:: classref-item-separator
  4715. ----
  4716. .. _class_RenderingServer_method_get_test_cube:
  4717. .. rst-class:: classref-method
  4718. :ref:`RID<class_RID>` **get_test_cube**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_get_test_cube>`
  4719. 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>`.
  4720. .. rst-class:: classref-item-separator
  4721. ----
  4722. .. _class_RenderingServer_method_get_test_texture:
  4723. .. rst-class:: classref-method
  4724. :ref:`RID<class_RID>` **get_test_texture**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_get_test_texture>`
  4725. 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>`.
  4726. \ **Example:** Get the test texture and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4727. ::
  4728. var texture_rid = RenderingServer.get_test_texture()
  4729. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4730. $Sprite2D.texture = texture
  4731. .. rst-class:: classref-item-separator
  4732. ----
  4733. .. _class_RenderingServer_method_get_video_adapter_api_version:
  4734. .. rst-class:: classref-method
  4735. :ref:`String<class_String>` **get_video_adapter_api_version**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_video_adapter_api_version>`
  4736. 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>`.
  4737. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4738. .. rst-class:: classref-item-separator
  4739. ----
  4740. .. _class_RenderingServer_method_get_video_adapter_name:
  4741. .. rst-class:: classref-method
  4742. :ref:`String<class_String>` **get_video_adapter_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_video_adapter_name>`
  4743. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
  4744. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4745. \ **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.
  4746. .. rst-class:: classref-item-separator
  4747. ----
  4748. .. _class_RenderingServer_method_get_video_adapter_type:
  4749. .. rst-class:: classref-method
  4750. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_video_adapter_type>`
  4751. 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.
  4752. \ **Note:** When using the OpenGL rendering driver or when running in headless mode, this function always returns :ref:`RenderingDevice.DEVICE_TYPE_OTHER<class_RenderingDevice_constant_DEVICE_TYPE_OTHER>`.
  4753. .. rst-class:: classref-item-separator
  4754. ----
  4755. .. _class_RenderingServer_method_get_video_adapter_vendor:
  4756. .. rst-class:: classref-method
  4757. :ref:`String<class_String>` **get_video_adapter_vendor**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_get_video_adapter_vendor>`
  4758. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
  4759. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4760. .. rst-class:: classref-item-separator
  4761. ----
  4762. .. _class_RenderingServer_method_get_white_texture:
  4763. .. rst-class:: classref-method
  4764. :ref:`RID<class_RID>` **get_white_texture**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_get_white_texture>`
  4765. 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>`.
  4766. \ **Example:** Get the white texture and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4767. ::
  4768. var texture_rid = RenderingServer.get_white_texture()
  4769. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4770. $Sprite2D.texture = texture
  4771. .. rst-class:: classref-item-separator
  4772. ----
  4773. .. _class_RenderingServer_method_gi_set_use_half_resolution:
  4774. .. rst-class:: classref-method
  4775. |void| **gi_set_use_half_resolution**\ (\ half_resolution\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_gi_set_use_half_resolution>`
  4776. 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>`.
  4777. .. rst-class:: classref-item-separator
  4778. ----
  4779. .. _class_RenderingServer_method_global_shader_parameter_add:
  4780. .. rst-class:: classref-method
  4781. |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>`
  4782. Creates a new global shader uniform.
  4783. \ **Note:** Global shader parameter names are case-sensitive.
  4784. .. rst-class:: classref-item-separator
  4785. ----
  4786. .. _class_RenderingServer_method_global_shader_parameter_get:
  4787. .. rst-class:: classref-method
  4788. :ref:`Variant<class_Variant>` **global_shader_parameter_get**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_global_shader_parameter_get>`
  4789. Returns the value of the global shader uniform specified by ``name``.
  4790. \ **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.
  4791. .. rst-class:: classref-item-separator
  4792. ----
  4793. .. _class_RenderingServer_method_global_shader_parameter_get_list:
  4794. .. rst-class:: classref-method
  4795. :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] **global_shader_parameter_get_list**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_global_shader_parameter_get_list>`
  4796. Returns the list of global shader uniform names.
  4797. \ **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.
  4798. .. rst-class:: classref-item-separator
  4799. ----
  4800. .. _class_RenderingServer_method_global_shader_parameter_get_type:
  4801. .. rst-class:: classref-method
  4802. :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>`
  4803. Returns the type associated to the global shader uniform specified by ``name``.
  4804. \ **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.
  4805. .. rst-class:: classref-item-separator
  4806. ----
  4807. .. _class_RenderingServer_method_global_shader_parameter_remove:
  4808. .. rst-class:: classref-method
  4809. |void| **global_shader_parameter_remove**\ (\ name\: :ref:`StringName<class_StringName>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_global_shader_parameter_remove>`
  4810. Removes the global shader uniform specified by ``name``.
  4811. .. rst-class:: classref-item-separator
  4812. ----
  4813. .. _class_RenderingServer_method_global_shader_parameter_set:
  4814. .. rst-class:: classref-method
  4815. |void| **global_shader_parameter_set**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_global_shader_parameter_set>`
  4816. Sets the global shader uniform ``name`` to ``value``.
  4817. .. rst-class:: classref-item-separator
  4818. ----
  4819. .. _class_RenderingServer_method_global_shader_parameter_set_override:
  4820. .. rst-class:: classref-method
  4821. |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>`
  4822. Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
  4823. .. rst-class:: classref-item-separator
  4824. ----
  4825. .. _class_RenderingServer_method_has_changed:
  4826. .. rst-class:: classref-method
  4827. :ref:`bool<class_bool>` **has_changed**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_has_changed>`
  4828. 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.
  4829. .. rst-class:: classref-item-separator
  4830. ----
  4831. .. _class_RenderingServer_method_has_feature:
  4832. .. rst-class:: classref-method
  4833. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Features<enum_RenderingServer_Features>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_has_feature>`
  4834. **Deprecated:** This method has not been used since Godot 3.0.
  4835. This method does nothing and always returns ``false``.
  4836. .. rst-class:: classref-item-separator
  4837. ----
  4838. .. _class_RenderingServer_method_has_os_feature:
  4839. .. rst-class:: classref-method
  4840. :ref:`bool<class_bool>` **has_os_feature**\ (\ feature\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_has_os_feature>`
  4841. Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
  4842. .. rst-class:: classref-item-separator
  4843. ----
  4844. .. _class_RenderingServer_method_instance_attach_object_instance_id:
  4845. .. rst-class:: classref-method
  4846. |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>`
  4847. 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>`.
  4848. .. rst-class:: classref-item-separator
  4849. ----
  4850. .. _class_RenderingServer_method_instance_attach_skeleton:
  4851. .. rst-class:: classref-method
  4852. |void| **instance_attach_skeleton**\ (\ instance\: :ref:`RID<class_RID>`, skeleton\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_attach_skeleton>`
  4853. Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
  4854. .. rst-class:: classref-item-separator
  4855. ----
  4856. .. _class_RenderingServer_method_instance_create:
  4857. .. rst-class:: classref-method
  4858. :ref:`RID<class_RID>` **instance_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_create>`
  4859. 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.
  4860. 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.
  4861. 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>`.
  4862. \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
  4863. .. rst-class:: classref-item-separator
  4864. ----
  4865. .. _class_RenderingServer_method_instance_create2:
  4866. .. rst-class:: classref-method
  4867. :ref:`RID<class_RID>` **instance_create2**\ (\ base\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_create2>`
  4868. 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.
  4869. 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.
  4870. .. rst-class:: classref-item-separator
  4871. ----
  4872. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
  4873. .. rst-class:: classref-method
  4874. :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>`
  4875. 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>`.
  4876. \ **Note:** Per-instance shader parameter names are case-sensitive.
  4877. .. rst-class:: classref-item-separator
  4878. ----
  4879. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
  4880. .. rst-class:: classref-method
  4881. :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>`
  4882. 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>`.
  4883. .. rst-class:: classref-item-separator
  4884. ----
  4885. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
  4886. .. rst-class:: classref-method
  4887. :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>`
  4888. 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>`.
  4889. .. rst-class:: classref-item-separator
  4890. ----
  4891. .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
  4892. .. rst-class:: classref-method
  4893. |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>`
  4894. Sets the shadow casting setting. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
  4895. .. rst-class:: classref-item-separator
  4896. ----
  4897. .. _class_RenderingServer_method_instance_geometry_set_flag:
  4898. .. rst-class:: classref-method
  4899. |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>`
  4900. Sets the ``flag`` for a given ``instance`` to ``enabled``.
  4901. .. rst-class:: classref-item-separator
  4902. ----
  4903. .. _class_RenderingServer_method_instance_geometry_set_lightmap:
  4904. .. rst-class:: classref-method
  4905. |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>`
  4906. 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.
  4907. .. rst-class:: classref-item-separator
  4908. ----
  4909. .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
  4910. .. rst-class:: classref-method
  4911. |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>`
  4912. 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>`.
  4913. .. rst-class:: classref-item-separator
  4914. ----
  4915. .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
  4916. .. rst-class:: classref-method
  4917. |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>`
  4918. 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>`.
  4919. .. rst-class:: classref-item-separator
  4920. ----
  4921. .. _class_RenderingServer_method_instance_geometry_set_material_override:
  4922. .. rst-class:: classref-method
  4923. |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>`
  4924. 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>`.
  4925. .. rst-class:: classref-item-separator
  4926. ----
  4927. .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
  4928. .. rst-class:: classref-method
  4929. |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>`
  4930. 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>`.
  4931. .. rst-class:: classref-item-separator
  4932. ----
  4933. .. _class_RenderingServer_method_instance_geometry_set_transparency:
  4934. .. rst-class:: classref-method
  4935. |void| **instance_geometry_set_transparency**\ (\ instance\: :ref:`RID<class_RID>`, transparency\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_geometry_set_transparency>`
  4936. Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
  4937. 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.
  4938. In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
  4939. \ **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.
  4940. .. rst-class:: classref-item-separator
  4941. ----
  4942. .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
  4943. .. rst-class:: classref-method
  4944. |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>`
  4945. 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.
  4946. .. rst-class:: classref-item-separator
  4947. ----
  4948. .. _class_RenderingServer_method_instance_set_base:
  4949. .. rst-class:: classref-method
  4950. |void| **instance_set_base**\ (\ instance\: :ref:`RID<class_RID>`, base\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_base>`
  4951. 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.
  4952. .. rst-class:: classref-item-separator
  4953. ----
  4954. .. _class_RenderingServer_method_instance_set_blend_shape_weight:
  4955. .. rst-class:: classref-method
  4956. |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>`
  4957. Sets the weight for a given blend shape associated with this instance.
  4958. .. rst-class:: classref-item-separator
  4959. ----
  4960. .. _class_RenderingServer_method_instance_set_custom_aabb:
  4961. .. rst-class:: classref-method
  4962. |void| **instance_set_custom_aabb**\ (\ instance\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_custom_aabb>`
  4963. 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>`.
  4964. .. rst-class:: classref-item-separator
  4965. ----
  4966. .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
  4967. .. rst-class:: classref-method
  4968. |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>`
  4969. 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>`.
  4970. .. rst-class:: classref-item-separator
  4971. ----
  4972. .. _class_RenderingServer_method_instance_set_ignore_culling:
  4973. .. rst-class:: classref-method
  4974. |void| **instance_set_ignore_culling**\ (\ instance\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_ignore_culling>`
  4975. 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.
  4976. .. rst-class:: classref-item-separator
  4977. ----
  4978. .. _class_RenderingServer_method_instance_set_layer_mask:
  4979. .. rst-class:: classref-method
  4980. |void| **instance_set_layer_mask**\ (\ instance\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_layer_mask>`
  4981. Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
  4982. .. rst-class:: classref-item-separator
  4983. ----
  4984. .. _class_RenderingServer_method_instance_set_pivot_data:
  4985. .. rst-class:: classref-method
  4986. |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>`
  4987. Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
  4988. .. rst-class:: classref-item-separator
  4989. ----
  4990. .. _class_RenderingServer_method_instance_set_scenario:
  4991. .. rst-class:: classref-method
  4992. |void| **instance_set_scenario**\ (\ instance\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_scenario>`
  4993. Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
  4994. .. rst-class:: classref-item-separator
  4995. ----
  4996. .. _class_RenderingServer_method_instance_set_surface_override_material:
  4997. .. rst-class:: classref-method
  4998. |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>`
  4999. Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material()<class_MeshInstance3D_method_set_surface_override_material>`.
  5000. .. rst-class:: classref-item-separator
  5001. ----
  5002. .. _class_RenderingServer_method_instance_set_transform:
  5003. .. rst-class:: classref-method
  5004. |void| **instance_set_transform**\ (\ instance\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_transform>`
  5005. Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform<class_Node3D_property_global_transform>`.
  5006. .. rst-class:: classref-item-separator
  5007. ----
  5008. .. _class_RenderingServer_method_instance_set_visibility_parent:
  5009. .. rst-class:: classref-method
  5010. |void| **instance_set_visibility_parent**\ (\ instance\: :ref:`RID<class_RID>`, parent\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_visibility_parent>`
  5011. Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
  5012. .. rst-class:: classref-item-separator
  5013. ----
  5014. .. _class_RenderingServer_method_instance_set_visible:
  5015. .. rst-class:: classref-method
  5016. |void| **instance_set_visible**\ (\ instance\: :ref:`RID<class_RID>`, visible\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_set_visible>`
  5017. Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
  5018. .. rst-class:: classref-item-separator
  5019. ----
  5020. .. _class_RenderingServer_method_instance_teleport:
  5021. .. rst-class:: classref-method
  5022. |void| **instance_teleport**\ (\ instance\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_instance_teleport>`
  5023. Resets motion vectors and other interpolated values. Use this *after* teleporting a mesh from one position to another to avoid ghosting artifacts.
  5024. .. rst-class:: classref-item-separator
  5025. ----
  5026. .. _class_RenderingServer_method_instances_cull_aabb:
  5027. .. rst-class:: classref-method
  5028. :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>`
  5029. 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.
  5030. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  5031. .. rst-class:: classref-item-separator
  5032. ----
  5033. .. _class_RenderingServer_method_instances_cull_convex:
  5034. .. rst-class:: classref-method
  5035. :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>`
  5036. 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.
  5037. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  5038. .. rst-class:: classref-item-separator
  5039. ----
  5040. .. _class_RenderingServer_method_instances_cull_ray:
  5041. .. rst-class:: classref-method
  5042. :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>`
  5043. 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.
  5044. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  5045. .. rst-class:: classref-item-separator
  5046. ----
  5047. .. _class_RenderingServer_method_is_on_render_thread:
  5048. .. rst-class:: classref-method
  5049. :ref:`bool<class_bool>` **is_on_render_thread**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_is_on_render_thread>`
  5050. Returns ``true`` if our code is currently executing on the rendering thread.
  5051. .. rst-class:: classref-item-separator
  5052. ----
  5053. .. _class_RenderingServer_method_light_directional_set_blend_splits:
  5054. .. rst-class:: classref-method
  5055. |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>`
  5056. 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>`.
  5057. .. rst-class:: classref-item-separator
  5058. ----
  5059. .. _class_RenderingServer_method_light_directional_set_shadow_mode:
  5060. .. rst-class:: classref-method
  5061. |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>`
  5062. Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode<class_DirectionalLight3D_property_directional_shadow_mode>`.
  5063. .. rst-class:: classref-item-separator
  5064. ----
  5065. .. _class_RenderingServer_method_light_directional_set_sky_mode:
  5066. .. rst-class:: classref-method
  5067. |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>`
  5068. 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.
  5069. .. rst-class:: classref-item-separator
  5070. ----
  5071. .. _class_RenderingServer_method_light_omni_set_shadow_mode:
  5072. .. rst-class:: classref-method
  5073. |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>`
  5074. 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>`.
  5075. .. rst-class:: classref-item-separator
  5076. ----
  5077. .. _class_RenderingServer_method_light_projectors_set_filter:
  5078. .. rst-class:: classref-method
  5079. |void| **light_projectors_set_filter**\ (\ filter\: :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_projectors_set_filter>`
  5080. Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
  5081. .. rst-class:: classref-item-separator
  5082. ----
  5083. .. _class_RenderingServer_method_light_set_bake_mode:
  5084. .. rst-class:: classref-method
  5085. |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>`
  5086. Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
  5087. .. rst-class:: classref-item-separator
  5088. ----
  5089. .. _class_RenderingServer_method_light_set_color:
  5090. .. rst-class:: classref-method
  5091. |void| **light_set_color**\ (\ light\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_color>`
  5092. Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
  5093. .. rst-class:: classref-item-separator
  5094. ----
  5095. .. _class_RenderingServer_method_light_set_cull_mask:
  5096. .. rst-class:: classref-method
  5097. |void| **light_set_cull_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_cull_mask>`
  5098. 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>`.
  5099. .. rst-class:: classref-item-separator
  5100. ----
  5101. .. _class_RenderingServer_method_light_set_distance_fade:
  5102. .. rst-class:: classref-method
  5103. |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>`
  5104. 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>`.
  5105. .. rst-class:: classref-item-separator
  5106. ----
  5107. .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
  5108. .. rst-class:: classref-method
  5109. |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>`
  5110. 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.
  5111. .. rst-class:: classref-item-separator
  5112. ----
  5113. .. _class_RenderingServer_method_light_set_negative:
  5114. .. rst-class:: classref-method
  5115. |void| **light_set_negative**\ (\ light\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_negative>`
  5116. If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
  5117. .. rst-class:: classref-item-separator
  5118. ----
  5119. .. _class_RenderingServer_method_light_set_param:
  5120. .. rst-class:: classref-method
  5121. |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>`
  5122. Sets the specified 3D light parameter. Equivalent to :ref:`Light3D.set_param()<class_Light3D_method_set_param>`.
  5123. .. rst-class:: classref-item-separator
  5124. ----
  5125. .. _class_RenderingServer_method_light_set_projector:
  5126. .. rst-class:: classref-method
  5127. |void| **light_set_projector**\ (\ light\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_projector>`
  5128. Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
  5129. .. rst-class:: classref-item-separator
  5130. ----
  5131. .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
  5132. .. rst-class:: classref-method
  5133. |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>`
  5134. 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>`.
  5135. .. rst-class:: classref-item-separator
  5136. ----
  5137. .. _class_RenderingServer_method_light_set_shadow:
  5138. .. rst-class:: classref-method
  5139. |void| **light_set_shadow**\ (\ light\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_shadow>`
  5140. If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
  5141. .. rst-class:: classref-item-separator
  5142. ----
  5143. .. _class_RenderingServer_method_light_set_shadow_caster_mask:
  5144. .. rst-class:: classref-method
  5145. |void| **light_set_shadow_caster_mask**\ (\ light\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_light_set_shadow_caster_mask>`
  5146. Sets the shadow caster mask for this 3D light. Shadows will only be cast using objects in the selected layers. Equivalent to :ref:`Light3D.shadow_caster_mask<class_Light3D_property_shadow_caster_mask>`.
  5147. .. rst-class:: classref-item-separator
  5148. ----
  5149. .. _class_RenderingServer_method_lightmap_create:
  5150. .. rst-class:: classref-method
  5151. :ref:`RID<class_RID>` **lightmap_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_create>`
  5152. 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.
  5153. 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.
  5154. \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
  5155. .. rst-class:: classref-item-separator
  5156. ----
  5157. .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
  5158. .. rst-class:: classref-method
  5159. :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>`
  5160. .. container:: contribute
  5161. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5162. .. rst-class:: classref-item-separator
  5163. ----
  5164. .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
  5165. .. rst-class:: classref-method
  5166. :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_get_probe_capture_points>`
  5167. .. container:: contribute
  5168. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5169. .. rst-class:: classref-item-separator
  5170. ----
  5171. .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
  5172. .. rst-class:: classref-method
  5173. :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_get_probe_capture_sh>`
  5174. .. container:: contribute
  5175. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5176. .. rst-class:: classref-item-separator
  5177. ----
  5178. .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
  5179. .. rst-class:: classref-method
  5180. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra**\ (\ lightmap\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>`
  5181. .. container:: contribute
  5182. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5183. .. rst-class:: classref-item-separator
  5184. ----
  5185. .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
  5186. .. rst-class:: classref-method
  5187. |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>`
  5188. 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>`.
  5189. .. rst-class:: classref-item-separator
  5190. ----
  5191. .. _class_RenderingServer_method_lightmap_set_probe_bounds:
  5192. .. rst-class:: classref-method
  5193. |void| **lightmap_set_probe_bounds**\ (\ lightmap\: :ref:`RID<class_RID>`, bounds\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_set_probe_bounds>`
  5194. .. container:: contribute
  5195. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5196. .. rst-class:: classref-item-separator
  5197. ----
  5198. .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
  5199. .. rst-class:: classref-method
  5200. |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>`
  5201. .. container:: contribute
  5202. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5203. .. rst-class:: classref-item-separator
  5204. ----
  5205. .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
  5206. .. rst-class:: classref-method
  5207. |void| **lightmap_set_probe_capture_update_speed**\ (\ speed\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>`
  5208. .. container:: contribute
  5209. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5210. .. rst-class:: classref-item-separator
  5211. ----
  5212. .. _class_RenderingServer_method_lightmap_set_probe_interior:
  5213. .. rst-class:: classref-method
  5214. |void| **lightmap_set_probe_interior**\ (\ lightmap\: :ref:`RID<class_RID>`, interior\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_lightmap_set_probe_interior>`
  5215. .. container:: contribute
  5216. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5217. .. rst-class:: classref-item-separator
  5218. ----
  5219. .. _class_RenderingServer_method_lightmap_set_textures:
  5220. .. rst-class:: classref-method
  5221. |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>`
  5222. 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``.
  5223. .. rst-class:: classref-item-separator
  5224. ----
  5225. .. _class_RenderingServer_method_lightmaps_set_bicubic_filter:
  5226. .. rst-class:: classref-method
  5227. |void| **lightmaps_set_bicubic_filter**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_lightmaps_set_bicubic_filter>`
  5228. Toggles whether a bicubic filter should be used when lightmaps are sampled. This smoothens their appearance at a performance cost.
  5229. .. rst-class:: classref-item-separator
  5230. ----
  5231. .. _class_RenderingServer_method_make_sphere_mesh:
  5232. .. rst-class:: classref-method
  5233. :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>`
  5234. 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>`.
  5235. .. rst-class:: classref-item-separator
  5236. ----
  5237. .. _class_RenderingServer_method_material_create:
  5238. .. rst-class:: classref-method
  5239. :ref:`RID<class_RID>` **material_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_material_create>`
  5240. 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.
  5241. 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.
  5242. \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
  5243. .. rst-class:: classref-item-separator
  5244. ----
  5245. .. _class_RenderingServer_method_material_get_param:
  5246. .. rst-class:: classref-method
  5247. :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>`
  5248. Returns the value of a certain material's parameter.
  5249. .. rst-class:: classref-item-separator
  5250. ----
  5251. .. _class_RenderingServer_method_material_set_next_pass:
  5252. .. rst-class:: classref-method
  5253. |void| **material_set_next_pass**\ (\ material\: :ref:`RID<class_RID>`, next_material\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_material_set_next_pass>`
  5254. Sets an object's next material.
  5255. .. rst-class:: classref-item-separator
  5256. ----
  5257. .. _class_RenderingServer_method_material_set_param:
  5258. .. rst-class:: classref-method
  5259. |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>`
  5260. Sets a material's parameter.
  5261. .. rst-class:: classref-item-separator
  5262. ----
  5263. .. _class_RenderingServer_method_material_set_render_priority:
  5264. .. rst-class:: classref-method
  5265. |void| **material_set_render_priority**\ (\ material\: :ref:`RID<class_RID>`, priority\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_material_set_render_priority>`
  5266. Sets a material's render priority.
  5267. .. rst-class:: classref-item-separator
  5268. ----
  5269. .. _class_RenderingServer_method_material_set_shader:
  5270. .. rst-class:: classref-method
  5271. |void| **material_set_shader**\ (\ shader_material\: :ref:`RID<class_RID>`, shader\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_material_set_shader>`
  5272. Sets a shader material's shader.
  5273. .. rst-class:: classref-item-separator
  5274. ----
  5275. .. _class_RenderingServer_method_mesh_add_surface:
  5276. .. rst-class:: classref-method
  5277. |void| **mesh_add_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_add_surface>`
  5278. .. container:: contribute
  5279. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5280. .. rst-class:: classref-item-separator
  5281. ----
  5282. .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
  5283. .. rst-class:: classref-method
  5284. |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>`
  5285. .. container:: contribute
  5286. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5287. .. rst-class:: classref-item-separator
  5288. ----
  5289. .. _class_RenderingServer_method_mesh_clear:
  5290. .. rst-class:: classref-method
  5291. |void| **mesh_clear**\ (\ mesh\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_clear>`
  5292. Removes all surfaces from a mesh.
  5293. .. rst-class:: classref-item-separator
  5294. ----
  5295. .. _class_RenderingServer_method_mesh_create:
  5296. .. rst-class:: classref-method
  5297. :ref:`RID<class_RID>` **mesh_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_create>`
  5298. 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.
  5299. 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.
  5300. 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.
  5301. \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
  5302. .. rst-class:: classref-item-separator
  5303. ----
  5304. .. _class_RenderingServer_method_mesh_create_from_surfaces:
  5305. .. rst-class:: classref-method
  5306. :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>`
  5307. .. container:: contribute
  5308. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5309. .. rst-class:: classref-item-separator
  5310. ----
  5311. .. _class_RenderingServer_method_mesh_get_blend_shape_count:
  5312. .. rst-class:: classref-method
  5313. :ref:`int<class_int>` **mesh_get_blend_shape_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_get_blend_shape_count>`
  5314. Returns a mesh's blend shape count.
  5315. .. rst-class:: classref-item-separator
  5316. ----
  5317. .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
  5318. .. rst-class:: classref-method
  5319. :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>`
  5320. Returns a mesh's blend shape mode.
  5321. .. rst-class:: classref-item-separator
  5322. ----
  5323. .. _class_RenderingServer_method_mesh_get_custom_aabb:
  5324. .. rst-class:: classref-method
  5325. :ref:`AABB<class_AABB>` **mesh_get_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_get_custom_aabb>`
  5326. Returns a mesh's custom aabb.
  5327. .. rst-class:: classref-item-separator
  5328. ----
  5329. .. _class_RenderingServer_method_mesh_get_surface:
  5330. .. rst-class:: classref-method
  5331. :ref:`Dictionary<class_Dictionary>` **mesh_get_surface**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_get_surface>`
  5332. .. container:: contribute
  5333. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5334. .. rst-class:: classref-item-separator
  5335. ----
  5336. .. _class_RenderingServer_method_mesh_get_surface_count:
  5337. .. rst-class:: classref-method
  5338. :ref:`int<class_int>` **mesh_get_surface_count**\ (\ mesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_get_surface_count>`
  5339. Returns a mesh's number of surfaces.
  5340. .. rst-class:: classref-item-separator
  5341. ----
  5342. .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
  5343. .. rst-class:: classref-method
  5344. |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>`
  5345. Sets a mesh's blend shape mode.
  5346. .. rst-class:: classref-item-separator
  5347. ----
  5348. .. _class_RenderingServer_method_mesh_set_custom_aabb:
  5349. .. rst-class:: classref-method
  5350. |void| **mesh_set_custom_aabb**\ (\ mesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_set_custom_aabb>`
  5351. Sets a mesh's custom aabb.
  5352. .. rst-class:: classref-item-separator
  5353. ----
  5354. .. _class_RenderingServer_method_mesh_set_shadow_mesh:
  5355. .. rst-class:: classref-method
  5356. |void| **mesh_set_shadow_mesh**\ (\ mesh\: :ref:`RID<class_RID>`, shadow_mesh\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_set_shadow_mesh>`
  5357. .. container:: contribute
  5358. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5359. .. rst-class:: classref-item-separator
  5360. ----
  5361. .. _class_RenderingServer_method_mesh_surface_get_arrays:
  5362. .. rst-class:: classref-method
  5363. :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>`
  5364. Returns a mesh's surface's buffer arrays.
  5365. .. rst-class:: classref-item-separator
  5366. ----
  5367. .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
  5368. .. rst-class:: classref-method
  5369. :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>`
  5370. Returns a mesh's surface's arrays for blend shapes.
  5371. .. rst-class:: classref-item-separator
  5372. ----
  5373. .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
  5374. .. rst-class:: classref-method
  5375. :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>`
  5376. Returns the stride of the attribute buffer for a mesh with given ``format``.
  5377. .. rst-class:: classref-item-separator
  5378. ----
  5379. .. _class_RenderingServer_method_mesh_surface_get_format_index_stride:
  5380. .. rst-class:: classref-method
  5381. :ref:`int<class_int>` **mesh_surface_get_format_index_stride**\ (\ format\: |bitfield|\[:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\], vertex_count\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_surface_get_format_index_stride>`
  5382. Returns the stride of the index buffer for a mesh with the given ``format``.
  5383. .. rst-class:: classref-item-separator
  5384. ----
  5385. .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride:
  5386. .. rst-class:: classref-method
  5387. :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>`
  5388. 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.
  5389. .. rst-class:: classref-item-separator
  5390. ----
  5391. .. _class_RenderingServer_method_mesh_surface_get_format_offset:
  5392. .. rst-class:: classref-method
  5393. :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>`
  5394. Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer.
  5395. .. rst-class:: classref-item-separator
  5396. ----
  5397. .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
  5398. .. rst-class:: classref-method
  5399. :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>`
  5400. Returns the stride of the skin buffer for a mesh with given ``format``.
  5401. .. rst-class:: classref-item-separator
  5402. ----
  5403. .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
  5404. .. rst-class:: classref-method
  5405. :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>`
  5406. 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).
  5407. .. rst-class:: classref-item-separator
  5408. ----
  5409. .. _class_RenderingServer_method_mesh_surface_get_material:
  5410. .. rst-class:: classref-method
  5411. :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>`
  5412. Returns a mesh's surface's material.
  5413. .. rst-class:: classref-item-separator
  5414. ----
  5415. .. _class_RenderingServer_method_mesh_surface_remove:
  5416. .. rst-class:: classref-method
  5417. |void| **mesh_surface_remove**\ (\ mesh\: :ref:`RID<class_RID>`, surface\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_mesh_surface_remove>`
  5418. Removes the surface at the given index from the Mesh, shifting surfaces with higher index down by one.
  5419. .. rst-class:: classref-item-separator
  5420. ----
  5421. .. _class_RenderingServer_method_mesh_surface_set_material:
  5422. .. rst-class:: classref-method
  5423. |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>`
  5424. Sets a mesh's surface's material.
  5425. .. rst-class:: classref-item-separator
  5426. ----
  5427. .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
  5428. .. rst-class:: classref-method
  5429. |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>`
  5430. .. container:: contribute
  5431. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5432. .. rst-class:: classref-item-separator
  5433. ----
  5434. .. _class_RenderingServer_method_mesh_surface_update_index_region:
  5435. .. rst-class:: classref-method
  5436. |void| **mesh_surface_update_index_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_index_region>`
  5437. Updates the index buffer of the mesh surface with the given ``data``. The expected data are 16 or 32-bit unsigned integers, which can be determined with :ref:`mesh_surface_get_format_index_stride()<class_RenderingServer_method_mesh_surface_get_format_index_stride>`.
  5438. .. rst-class:: classref-item-separator
  5439. ----
  5440. .. _class_RenderingServer_method_mesh_surface_update_skin_region:
  5441. .. rst-class:: classref-method
  5442. |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>`
  5443. .. container:: contribute
  5444. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5445. .. rst-class:: classref-item-separator
  5446. ----
  5447. .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
  5448. .. rst-class:: classref-method
  5449. |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>`
  5450. .. container:: contribute
  5451. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5452. .. rst-class:: classref-item-separator
  5453. ----
  5454. .. _class_RenderingServer_method_multimesh_allocate_data:
  5455. .. rst-class:: classref-method
  5456. |void| **multimesh_allocate_data**\ (\ multimesh\: :ref:`RID<class_RID>`, instances\: :ref:`int<class_int>`, transform_format\: :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>`, color_format\: :ref:`bool<class_bool>` = false, custom_data_format\: :ref:`bool<class_bool>` = false, use_indirect\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_allocate_data>`
  5457. .. container:: contribute
  5458. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5459. .. rst-class:: classref-item-separator
  5460. ----
  5461. .. _class_RenderingServer_method_multimesh_create:
  5462. .. rst-class:: classref-method
  5463. :ref:`RID<class_RID>` **multimesh_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_create>`
  5464. 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.
  5465. 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.
  5466. 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.
  5467. \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
  5468. .. rst-class:: classref-item-separator
  5469. ----
  5470. .. _class_RenderingServer_method_multimesh_get_aabb:
  5471. .. rst-class:: classref-method
  5472. :ref:`AABB<class_AABB>` **multimesh_get_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_aabb>`
  5473. Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
  5474. .. rst-class:: classref-item-separator
  5475. ----
  5476. .. _class_RenderingServer_method_multimesh_get_buffer:
  5477. .. rst-class:: classref-method
  5478. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_buffer>`
  5479. 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.
  5480. \ **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.
  5481. .. rst-class:: classref-item-separator
  5482. ----
  5483. .. _class_RenderingServer_method_multimesh_get_buffer_rd_rid:
  5484. .. rst-class:: classref-method
  5485. :ref:`RID<class_RID>` **multimesh_get_buffer_rd_rid**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_buffer_rd_rid>`
  5486. Returns the :ref:`RenderingDevice<class_RenderingDevice>` :ref:`RID<class_RID>` handle of the :ref:`MultiMesh<class_MultiMesh>`, which can be used as any other buffer on the Rendering Device.
  5487. .. rst-class:: classref-item-separator
  5488. ----
  5489. .. _class_RenderingServer_method_multimesh_get_command_buffer_rd_rid:
  5490. .. rst-class:: classref-method
  5491. :ref:`RID<class_RID>` **multimesh_get_command_buffer_rd_rid**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_command_buffer_rd_rid>`
  5492. Returns the :ref:`RenderingDevice<class_RenderingDevice>` :ref:`RID<class_RID>` handle of the :ref:`MultiMesh<class_MultiMesh>` command buffer. This :ref:`RID<class_RID>` is only valid if ``use_indirect`` is set to ``true`` when allocating data through :ref:`multimesh_allocate_data()<class_RenderingServer_method_multimesh_allocate_data>`. It can be used to directly modify the instance count via buffer.
  5493. The data structure is dependent on both how many surfaces the mesh contains and whether it is indexed or not, the buffer has 5 integers in it, with the last unused if the mesh is not indexed.
  5494. Each of the values in the buffer correspond to these options:
  5495. .. code:: text
  5496. Indexed:
  5497. 0 - indexCount;
  5498. 1 - instanceCount;
  5499. 2 - firstIndex;
  5500. 3 - vertexOffset;
  5501. 4 - firstInstance;
  5502. Non Indexed:
  5503. 0 - vertexCount;
  5504. 1 - instanceCount;
  5505. 2 - firstVertex;
  5506. 3 - firstInstance;
  5507. 4 - unused;
  5508. .. rst-class:: classref-item-separator
  5509. ----
  5510. .. _class_RenderingServer_method_multimesh_get_custom_aabb:
  5511. .. rst-class:: classref-method
  5512. :ref:`AABB<class_AABB>` **multimesh_get_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_custom_aabb>`
  5513. Returns the custom AABB defined for this MultiMesh resource.
  5514. .. rst-class:: classref-item-separator
  5515. ----
  5516. .. _class_RenderingServer_method_multimesh_get_instance_count:
  5517. .. rst-class:: classref-method
  5518. :ref:`int<class_int>` **multimesh_get_instance_count**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_instance_count>`
  5519. Returns the number of instances allocated for this multimesh.
  5520. .. rst-class:: classref-item-separator
  5521. ----
  5522. .. _class_RenderingServer_method_multimesh_get_mesh:
  5523. .. rst-class:: classref-method
  5524. :ref:`RID<class_RID>` **multimesh_get_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_mesh>`
  5525. Returns the RID of the mesh that will be used in drawing this multimesh.
  5526. .. rst-class:: classref-item-separator
  5527. ----
  5528. .. _class_RenderingServer_method_multimesh_get_visible_instances:
  5529. .. rst-class:: classref-method
  5530. :ref:`int<class_int>` **multimesh_get_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_get_visible_instances>`
  5531. Returns the number of visible instances for this multimesh.
  5532. .. rst-class:: classref-item-separator
  5533. ----
  5534. .. _class_RenderingServer_method_multimesh_instance_get_color:
  5535. .. rst-class:: classref-method
  5536. :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>`
  5537. Returns the color by which the specified instance will be modulated.
  5538. .. rst-class:: classref-item-separator
  5539. ----
  5540. .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
  5541. .. rst-class:: classref-method
  5542. :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>`
  5543. Returns the custom data associated with the specified instance.
  5544. .. rst-class:: classref-item-separator
  5545. ----
  5546. .. _class_RenderingServer_method_multimesh_instance_get_transform:
  5547. .. rst-class:: classref-method
  5548. :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>`
  5549. Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
  5550. .. rst-class:: classref-item-separator
  5551. ----
  5552. .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
  5553. .. rst-class:: classref-method
  5554. :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>`
  5555. Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
  5556. .. rst-class:: classref-item-separator
  5557. ----
  5558. .. _class_RenderingServer_method_multimesh_instance_reset_physics_interpolation:
  5559. .. rst-class:: classref-method
  5560. |void| **multimesh_instance_reset_physics_interpolation**\ (\ multimesh\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_instance_reset_physics_interpolation>`
  5561. Prevents physics interpolation for the specified instance during the current physics tick.
  5562. This is useful when moving an instance to a new location, to give an instantaneous change rather than interpolation from the previous location.
  5563. .. rst-class:: classref-item-separator
  5564. ----
  5565. .. _class_RenderingServer_method_multimesh_instance_set_color:
  5566. .. rst-class:: classref-method
  5567. |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>`
  5568. Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color()<class_MultiMesh_method_set_instance_color>`.
  5569. .. rst-class:: classref-item-separator
  5570. ----
  5571. .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
  5572. .. rst-class:: classref-method
  5573. |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>`
  5574. 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>`.
  5575. .. rst-class:: classref-item-separator
  5576. ----
  5577. .. _class_RenderingServer_method_multimesh_instance_set_transform:
  5578. .. rst-class:: classref-method
  5579. |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>`
  5580. Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform()<class_MultiMesh_method_set_instance_transform>`.
  5581. .. rst-class:: classref-item-separator
  5582. ----
  5583. .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
  5584. .. rst-class:: classref-method
  5585. |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>`
  5586. 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>`.
  5587. .. rst-class:: classref-item-separator
  5588. ----
  5589. .. _class_RenderingServer_method_multimesh_set_buffer:
  5590. .. rst-class:: classref-method
  5591. |void| **multimesh_set_buffer**\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_buffer>`
  5592. 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>`.
  5593. The per-instance data size and expected data order is:
  5594. .. code:: text
  5595. 2D:
  5596. - Position: 8 floats (8 floats for Transform2D)
  5597. - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
  5598. - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
  5599. - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
  5600. 3D:
  5601. - Position: 12 floats (12 floats for Transform3D)
  5602. - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
  5603. - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
  5604. - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
  5605. Instance transforms are in row-major order. Specifically:
  5606. - For :ref:`Transform2D<class_Transform2D>` the float-order is: ``(x.x, y.x, padding_float, origin.x, x.y, y.y, padding_float, origin.y)``.
  5607. - For :ref:`Transform3D<class_Transform3D>` the float-order is: ``(basis.x.x, basis.y.x, basis.z.x, origin.x, basis.x.y, basis.y.y, basis.z.y, origin.y, basis.x.z, basis.y.z, basis.z.z, origin.z)``.
  5608. .. rst-class:: classref-item-separator
  5609. ----
  5610. .. _class_RenderingServer_method_multimesh_set_buffer_interpolated:
  5611. .. rst-class:: classref-method
  5612. |void| **multimesh_set_buffer_interpolated**\ (\ multimesh\: :ref:`RID<class_RID>`, buffer\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, buffer_previous\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_buffer_interpolated>`
  5613. Alternative version of :ref:`multimesh_set_buffer()<class_RenderingServer_method_multimesh_set_buffer>` for use with physics interpolation.
  5614. Takes both an array of current data and an array of data for the previous physics tick.
  5615. .. rst-class:: classref-item-separator
  5616. ----
  5617. .. _class_RenderingServer_method_multimesh_set_custom_aabb:
  5618. .. rst-class:: classref-method
  5619. |void| **multimesh_set_custom_aabb**\ (\ multimesh\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_custom_aabb>`
  5620. Sets the custom AABB for this MultiMesh resource.
  5621. .. rst-class:: classref-item-separator
  5622. ----
  5623. .. _class_RenderingServer_method_multimesh_set_mesh:
  5624. .. rst-class:: classref-method
  5625. |void| **multimesh_set_mesh**\ (\ multimesh\: :ref:`RID<class_RID>`, mesh\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_mesh>`
  5626. Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
  5627. .. rst-class:: classref-item-separator
  5628. ----
  5629. .. _class_RenderingServer_method_multimesh_set_physics_interpolated:
  5630. .. rst-class:: classref-method
  5631. |void| **multimesh_set_physics_interpolated**\ (\ multimesh\: :ref:`RID<class_RID>`, interpolated\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_physics_interpolated>`
  5632. Turns on and off physics interpolation for this MultiMesh resource.
  5633. .. rst-class:: classref-item-separator
  5634. ----
  5635. .. _class_RenderingServer_method_multimesh_set_physics_interpolation_quality:
  5636. .. rst-class:: classref-method
  5637. |void| **multimesh_set_physics_interpolation_quality**\ (\ multimesh\: :ref:`RID<class_RID>`, quality\: :ref:`MultimeshPhysicsInterpolationQuality<enum_RenderingServer_MultimeshPhysicsInterpolationQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_physics_interpolation_quality>`
  5638. Sets the physics interpolation quality for the :ref:`MultiMesh<class_MultiMesh>`.
  5639. A value of :ref:`MULTIMESH_INTERP_QUALITY_FAST<class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_FAST>` gives fast but low quality interpolation, a value of :ref:`MULTIMESH_INTERP_QUALITY_HIGH<class_RenderingServer_constant_MULTIMESH_INTERP_QUALITY_HIGH>` gives slower but higher quality interpolation.
  5640. .. rst-class:: classref-item-separator
  5641. ----
  5642. .. _class_RenderingServer_method_multimesh_set_visible_instances:
  5643. .. rst-class:: classref-method
  5644. |void| **multimesh_set_visible_instances**\ (\ multimesh\: :ref:`RID<class_RID>`, visible\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_multimesh_set_visible_instances>`
  5645. 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>`.
  5646. .. rst-class:: classref-item-separator
  5647. ----
  5648. .. _class_RenderingServer_method_occluder_create:
  5649. .. rst-class:: classref-method
  5650. :ref:`RID<class_RID>` **occluder_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_occluder_create>`
  5651. 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.
  5652. 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.
  5653. \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
  5654. .. rst-class:: classref-item-separator
  5655. ----
  5656. .. _class_RenderingServer_method_occluder_set_mesh:
  5657. .. rst-class:: classref-method
  5658. |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>`
  5659. Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
  5660. .. rst-class:: classref-item-separator
  5661. ----
  5662. .. _class_RenderingServer_method_omni_light_create:
  5663. .. rst-class:: classref-method
  5664. :ref:`RID<class_RID>` **omni_light_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_omni_light_create>`
  5665. 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.
  5666. 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.
  5667. 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.
  5668. \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
  5669. .. rst-class:: classref-item-separator
  5670. ----
  5671. .. _class_RenderingServer_method_particles_collision_create:
  5672. .. rst-class:: classref-method
  5673. :ref:`RID<class_RID>` **particles_collision_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_collision_create>`
  5674. 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.
  5675. \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
  5676. .. rst-class:: classref-item-separator
  5677. ----
  5678. .. _class_RenderingServer_method_particles_collision_height_field_update:
  5679. .. rst-class:: classref-method
  5680. |void| **particles_collision_height_field_update**\ (\ particles_collision\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_collision_height_field_update>`
  5681. 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>`.
  5682. .. rst-class:: classref-item-separator
  5683. ----
  5684. .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
  5685. .. rst-class:: classref-method
  5686. |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>`
  5687. 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>`.
  5688. .. rst-class:: classref-item-separator
  5689. ----
  5690. .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
  5691. .. rst-class:: classref-method
  5692. |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>`
  5693. 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>`.
  5694. .. rst-class:: classref-item-separator
  5695. ----
  5696. .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
  5697. .. rst-class:: classref-method
  5698. |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>`
  5699. 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>`.
  5700. .. rst-class:: classref-item-separator
  5701. ----
  5702. .. _class_RenderingServer_method_particles_collision_set_box_extents:
  5703. .. rst-class:: classref-method
  5704. |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>`
  5705. 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.
  5706. .. rst-class:: classref-item-separator
  5707. ----
  5708. .. _class_RenderingServer_method_particles_collision_set_collision_type:
  5709. .. rst-class:: classref-method
  5710. |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>`
  5711. Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
  5712. .. rst-class:: classref-item-separator
  5713. ----
  5714. .. _class_RenderingServer_method_particles_collision_set_cull_mask:
  5715. .. rst-class:: classref-method
  5716. |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>`
  5717. 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.
  5718. .. rst-class:: classref-item-separator
  5719. ----
  5720. .. _class_RenderingServer_method_particles_collision_set_field_texture:
  5721. .. rst-class:: classref-method
  5722. |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>`
  5723. 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.
  5724. .. rst-class:: classref-item-separator
  5725. ----
  5726. .. _class_RenderingServer_method_particles_collision_set_height_field_mask:
  5727. .. rst-class:: classref-method
  5728. |void| **particles_collision_set_height_field_mask**\ (\ particles_collision\: :ref:`RID<class_RID>`, mask\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_collision_set_height_field_mask>`
  5729. Sets the heightfield ``mask`` for the 3D GPU particles heightfield collision specified by the ``particles_collision`` RID. Equivalent to :ref:`GPUParticlesCollisionHeightField3D.heightfield_mask<class_GPUParticlesCollisionHeightField3D_property_heightfield_mask>`.
  5730. .. rst-class:: classref-item-separator
  5731. ----
  5732. .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
  5733. .. rst-class:: classref-method
  5734. |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>`
  5735. 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>`.
  5736. .. rst-class:: classref-item-separator
  5737. ----
  5738. .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
  5739. .. rst-class:: classref-method
  5740. |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>`
  5741. 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.
  5742. .. rst-class:: classref-item-separator
  5743. ----
  5744. .. _class_RenderingServer_method_particles_create:
  5745. .. rst-class:: classref-method
  5746. :ref:`RID<class_RID>` **particles_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_create>`
  5747. 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.
  5748. 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.
  5749. 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.
  5750. \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
  5751. \ **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).
  5752. .. rst-class:: classref-item-separator
  5753. ----
  5754. .. _class_RenderingServer_method_particles_emit:
  5755. .. rst-class:: classref-method
  5756. |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>`
  5757. Manually emits particles from the ``particles`` instance.
  5758. .. rst-class:: classref-item-separator
  5759. ----
  5760. .. _class_RenderingServer_method_particles_get_current_aabb:
  5761. .. rst-class:: classref-method
  5762. :ref:`AABB<class_AABB>` **particles_get_current_aabb**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_get_current_aabb>`
  5763. Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb()<class_GPUParticles3D_method_capture_aabb>`.
  5764. .. rst-class:: classref-item-separator
  5765. ----
  5766. .. _class_RenderingServer_method_particles_get_emitting:
  5767. .. rst-class:: classref-method
  5768. :ref:`bool<class_bool>` **particles_get_emitting**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_get_emitting>`
  5769. Returns ``true`` if particles are currently set to emitting.
  5770. .. rst-class:: classref-item-separator
  5771. ----
  5772. .. _class_RenderingServer_method_particles_is_inactive:
  5773. .. rst-class:: classref-method
  5774. :ref:`bool<class_bool>` **particles_is_inactive**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_is_inactive>`
  5775. Returns ``true`` if particles are not emitting and particles are set to inactive.
  5776. .. rst-class:: classref-item-separator
  5777. ----
  5778. .. _class_RenderingServer_method_particles_request_process:
  5779. .. rst-class:: classref-method
  5780. |void| **particles_request_process**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_request_process>`
  5781. 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>`.
  5782. .. rst-class:: classref-item-separator
  5783. ----
  5784. .. _class_RenderingServer_method_particles_request_process_time:
  5785. .. rst-class:: classref-method
  5786. |void| **particles_request_process_time**\ (\ particles\: :ref:`RID<class_RID>`, time\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_request_process_time>`
  5787. Requests particles to process for extra process time during a single frame.
  5788. .. rst-class:: classref-item-separator
  5789. ----
  5790. .. _class_RenderingServer_method_particles_restart:
  5791. .. rst-class:: classref-method
  5792. |void| **particles_restart**\ (\ particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_restart>`
  5793. Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart()<class_GPUParticles3D_method_restart>`.
  5794. .. rst-class:: classref-item-separator
  5795. ----
  5796. .. _class_RenderingServer_method_particles_set_amount:
  5797. .. rst-class:: classref-method
  5798. |void| **particles_set_amount**\ (\ particles\: :ref:`RID<class_RID>`, amount\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_amount>`
  5799. Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
  5800. .. rst-class:: classref-item-separator
  5801. ----
  5802. .. _class_RenderingServer_method_particles_set_amount_ratio:
  5803. .. rst-class:: classref-method
  5804. |void| **particles_set_amount_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_amount_ratio>`
  5805. Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio<class_GPUParticles3D_property_amount_ratio>`.
  5806. .. rst-class:: classref-item-separator
  5807. ----
  5808. .. _class_RenderingServer_method_particles_set_collision_base_size:
  5809. .. rst-class:: classref-method
  5810. |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>`
  5811. .. container:: contribute
  5812. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5813. .. rst-class:: classref-item-separator
  5814. ----
  5815. .. _class_RenderingServer_method_particles_set_custom_aabb:
  5816. .. rst-class:: classref-method
  5817. |void| **particles_set_custom_aabb**\ (\ particles\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_custom_aabb>`
  5818. Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  5819. .. rst-class:: classref-item-separator
  5820. ----
  5821. .. _class_RenderingServer_method_particles_set_draw_order:
  5822. .. rst-class:: classref-method
  5823. |void| **particles_set_draw_order**\ (\ particles\: :ref:`RID<class_RID>`, order\: :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_draw_order>`
  5824. Sets the draw order of the particles. Equivalent to :ref:`GPUParticles3D.draw_order<class_GPUParticles3D_property_draw_order>`.
  5825. .. rst-class:: classref-item-separator
  5826. ----
  5827. .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
  5828. .. rst-class:: classref-method
  5829. |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>`
  5830. 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>`.
  5831. .. rst-class:: classref-item-separator
  5832. ----
  5833. .. _class_RenderingServer_method_particles_set_draw_passes:
  5834. .. rst-class:: classref-method
  5835. |void| **particles_set_draw_passes**\ (\ particles\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_draw_passes>`
  5836. Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
  5837. .. rst-class:: classref-item-separator
  5838. ----
  5839. .. _class_RenderingServer_method_particles_set_emission_transform:
  5840. .. rst-class:: classref-method
  5841. |void| **particles_set_emission_transform**\ (\ particles\: :ref:`RID<class_RID>`, transform\: :ref:`Transform3D<class_Transform3D>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_emission_transform>`
  5842. Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
  5843. .. rst-class:: classref-item-separator
  5844. ----
  5845. .. _class_RenderingServer_method_particles_set_emitter_velocity:
  5846. .. rst-class:: classref-method
  5847. |void| **particles_set_emitter_velocity**\ (\ particles\: :ref:`RID<class_RID>`, velocity\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_emitter_velocity>`
  5848. Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`.
  5849. .. rst-class:: classref-item-separator
  5850. ----
  5851. .. _class_RenderingServer_method_particles_set_emitting:
  5852. .. rst-class:: classref-method
  5853. |void| **particles_set_emitting**\ (\ particles\: :ref:`RID<class_RID>`, emitting\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_emitting>`
  5854. 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>`.
  5855. .. rst-class:: classref-item-separator
  5856. ----
  5857. .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
  5858. .. rst-class:: classref-method
  5859. |void| **particles_set_explosiveness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_explosiveness_ratio>`
  5860. Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
  5861. .. rst-class:: classref-item-separator
  5862. ----
  5863. .. _class_RenderingServer_method_particles_set_fixed_fps:
  5864. .. rst-class:: classref-method
  5865. |void| **particles_set_fixed_fps**\ (\ particles\: :ref:`RID<class_RID>`, fps\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_fixed_fps>`
  5866. Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
  5867. .. rst-class:: classref-item-separator
  5868. ----
  5869. .. _class_RenderingServer_method_particles_set_fractional_delta:
  5870. .. rst-class:: classref-method
  5871. |void| **particles_set_fractional_delta**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_fractional_delta>`
  5872. If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
  5873. .. rst-class:: classref-item-separator
  5874. ----
  5875. .. _class_RenderingServer_method_particles_set_interp_to_end:
  5876. .. rst-class:: classref-method
  5877. |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>`
  5878. Sets the value that informs a :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>` to rush all particles towards the end of their lifetime.
  5879. .. rst-class:: classref-item-separator
  5880. ----
  5881. .. _class_RenderingServer_method_particles_set_interpolate:
  5882. .. rst-class:: classref-method
  5883. |void| **particles_set_interpolate**\ (\ particles\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_interpolate>`
  5884. .. container:: contribute
  5885. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5886. .. rst-class:: classref-item-separator
  5887. ----
  5888. .. _class_RenderingServer_method_particles_set_lifetime:
  5889. .. rst-class:: classref-method
  5890. |void| **particles_set_lifetime**\ (\ particles\: :ref:`RID<class_RID>`, lifetime\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_lifetime>`
  5891. Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
  5892. .. rst-class:: classref-item-separator
  5893. ----
  5894. .. _class_RenderingServer_method_particles_set_mode:
  5895. .. rst-class:: classref-method
  5896. |void| **particles_set_mode**\ (\ particles\: :ref:`RID<class_RID>`, mode\: :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_mode>`
  5897. Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
  5898. .. rst-class:: classref-item-separator
  5899. ----
  5900. .. _class_RenderingServer_method_particles_set_one_shot:
  5901. .. rst-class:: classref-method
  5902. |void| **particles_set_one_shot**\ (\ particles\: :ref:`RID<class_RID>`, one_shot\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_one_shot>`
  5903. If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
  5904. .. rst-class:: classref-item-separator
  5905. ----
  5906. .. _class_RenderingServer_method_particles_set_pre_process_time:
  5907. .. rst-class:: classref-method
  5908. |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>`
  5909. 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>`.
  5910. .. rst-class:: classref-item-separator
  5911. ----
  5912. .. _class_RenderingServer_method_particles_set_process_material:
  5913. .. rst-class:: classref-method
  5914. |void| **particles_set_process_material**\ (\ particles\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_process_material>`
  5915. Sets the material for processing the particles.
  5916. \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
  5917. .. rst-class:: classref-item-separator
  5918. ----
  5919. .. _class_RenderingServer_method_particles_set_randomness_ratio:
  5920. .. rst-class:: classref-method
  5921. |void| **particles_set_randomness_ratio**\ (\ particles\: :ref:`RID<class_RID>`, ratio\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_randomness_ratio>`
  5922. Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
  5923. .. rst-class:: classref-item-separator
  5924. ----
  5925. .. _class_RenderingServer_method_particles_set_speed_scale:
  5926. .. rst-class:: classref-method
  5927. |void| **particles_set_speed_scale**\ (\ particles\: :ref:`RID<class_RID>`, scale\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_speed_scale>`
  5928. Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
  5929. .. rst-class:: classref-item-separator
  5930. ----
  5931. .. _class_RenderingServer_method_particles_set_subemitter:
  5932. .. rst-class:: classref-method
  5933. |void| **particles_set_subemitter**\ (\ particles\: :ref:`RID<class_RID>`, subemitter_particles\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_subemitter>`
  5934. .. container:: contribute
  5935. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5936. .. rst-class:: classref-item-separator
  5937. ----
  5938. .. _class_RenderingServer_method_particles_set_trail_bind_poses:
  5939. .. rst-class:: classref-method
  5940. |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>`
  5941. .. container:: contribute
  5942. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5943. .. rst-class:: classref-item-separator
  5944. ----
  5945. .. _class_RenderingServer_method_particles_set_trails:
  5946. .. rst-class:: classref-method
  5947. |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>`
  5948. 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>`.
  5949. .. rst-class:: classref-item-separator
  5950. ----
  5951. .. _class_RenderingServer_method_particles_set_transform_align:
  5952. .. rst-class:: classref-method
  5953. |void| **particles_set_transform_align**\ (\ particles\: :ref:`RID<class_RID>`, align\: :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_particles_set_transform_align>`
  5954. .. container:: contribute
  5955. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5956. .. rst-class:: classref-item-separator
  5957. ----
  5958. .. _class_RenderingServer_method_particles_set_use_local_coordinates:
  5959. .. rst-class:: classref-method
  5960. |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>`
  5961. If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
  5962. .. rst-class:: classref-item-separator
  5963. ----
  5964. .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
  5965. .. rst-class:: classref-method
  5966. |void| **positional_soft_shadow_filter_set_quality**\ (\ quality\: :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>`
  5967. 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.
  5968. .. rst-class:: classref-item-separator
  5969. ----
  5970. .. _class_RenderingServer_method_reflection_probe_create:
  5971. .. rst-class:: classref-method
  5972. :ref:`RID<class_RID>` **reflection_probe_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_reflection_probe_create>`
  5973. 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.
  5974. 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.
  5975. 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.
  5976. \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
  5977. .. rst-class:: classref-item-separator
  5978. ----
  5979. .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
  5980. .. rst-class:: classref-method
  5981. |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>`
  5982. Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
  5983. .. rst-class:: classref-item-separator
  5984. ----
  5985. .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
  5986. .. rst-class:: classref-method
  5987. |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>`
  5988. Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
  5989. .. rst-class:: classref-item-separator
  5990. ----
  5991. .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
  5992. .. rst-class:: classref-method
  5993. |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>`
  5994. Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
  5995. .. rst-class:: classref-item-separator
  5996. ----
  5997. .. _class_RenderingServer_method_reflection_probe_set_as_interior:
  5998. .. rst-class:: classref-method
  5999. |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>`
  6000. If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
  6001. .. rst-class:: classref-item-separator
  6002. ----
  6003. .. _class_RenderingServer_method_reflection_probe_set_blend_distance:
  6004. .. rst-class:: classref-method
  6005. |void| **reflection_probe_set_blend_distance**\ (\ probe\: :ref:`RID<class_RID>`, blend_distance\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_reflection_probe_set_blend_distance>`
  6006. Sets the distance in meters over which a probe blends into the scene.
  6007. .. rst-class:: classref-item-separator
  6008. ----
  6009. .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
  6010. .. rst-class:: classref-method
  6011. |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>`
  6012. 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>`.
  6013. .. rst-class:: classref-item-separator
  6014. ----
  6015. .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
  6016. .. rst-class:: classref-method
  6017. |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>`
  6018. 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>`.
  6019. .. rst-class:: classref-item-separator
  6020. ----
  6021. .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
  6022. .. rst-class:: classref-method
  6023. |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>`
  6024. 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>`.
  6025. .. rst-class:: classref-item-separator
  6026. ----
  6027. .. _class_RenderingServer_method_reflection_probe_set_intensity:
  6028. .. rst-class:: classref-method
  6029. |void| **reflection_probe_set_intensity**\ (\ probe\: :ref:`RID<class_RID>`, intensity\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_reflection_probe_set_intensity>`
  6030. Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
  6031. .. rst-class:: classref-item-separator
  6032. ----
  6033. .. _class_RenderingServer_method_reflection_probe_set_max_distance:
  6034. .. rst-class:: classref-method
  6035. |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>`
  6036. 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>`.
  6037. .. rst-class:: classref-item-separator
  6038. ----
  6039. .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
  6040. .. rst-class:: classref-method
  6041. |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>`
  6042. 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>`.
  6043. .. rst-class:: classref-item-separator
  6044. ----
  6045. .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
  6046. .. rst-class:: classref-method
  6047. |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>`
  6048. 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>`.
  6049. .. rst-class:: classref-item-separator
  6050. ----
  6051. .. _class_RenderingServer_method_reflection_probe_set_reflection_mask:
  6052. .. rst-class:: classref-method
  6053. |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>`
  6054. 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>`.
  6055. .. rst-class:: classref-item-separator
  6056. ----
  6057. .. _class_RenderingServer_method_reflection_probe_set_resolution:
  6058. .. rst-class:: classref-method
  6059. |void| **reflection_probe_set_resolution**\ (\ probe\: :ref:`RID<class_RID>`, resolution\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_reflection_probe_set_resolution>`
  6060. 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).
  6061. .. rst-class:: classref-item-separator
  6062. ----
  6063. .. _class_RenderingServer_method_reflection_probe_set_size:
  6064. .. rst-class:: classref-method
  6065. |void| **reflection_probe_set_size**\ (\ probe\: :ref:`RID<class_RID>`, size\: :ref:`Vector3<class_Vector3>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_reflection_probe_set_size>`
  6066. Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
  6067. .. rst-class:: classref-item-separator
  6068. ----
  6069. .. _class_RenderingServer_method_reflection_probe_set_update_mode:
  6070. .. rst-class:: classref-method
  6071. |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>`
  6072. Sets how often the reflection probe updates. Can either be once or every frame.
  6073. .. rst-class:: classref-item-separator
  6074. ----
  6075. .. _class_RenderingServer_method_request_frame_drawn_callback:
  6076. .. rst-class:: classref-method
  6077. |void| **request_frame_drawn_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_request_frame_drawn_callback>`
  6078. Schedules a callback to the given callable after a frame has been drawn.
  6079. .. rst-class:: classref-item-separator
  6080. ----
  6081. .. _class_RenderingServer_method_scenario_create:
  6082. .. rst-class:: classref-method
  6083. :ref:`RID<class_RID>` **scenario_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_scenario_create>`
  6084. 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.
  6085. 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.
  6086. The scenario is the 3D world that all the visual instances exist in.
  6087. .. rst-class:: classref-item-separator
  6088. ----
  6089. .. _class_RenderingServer_method_scenario_set_camera_attributes:
  6090. .. rst-class:: classref-method
  6091. |void| **scenario_set_camera_attributes**\ (\ scenario\: :ref:`RID<class_RID>`, effects\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_scenario_set_camera_attributes>`
  6092. Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
  6093. .. rst-class:: classref-item-separator
  6094. ----
  6095. .. _class_RenderingServer_method_scenario_set_compositor:
  6096. .. rst-class:: classref-method
  6097. |void| **scenario_set_compositor**\ (\ scenario\: :ref:`RID<class_RID>`, compositor\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_scenario_set_compositor>`
  6098. Sets the compositor (``compositor``) that will be used with this scenario. See also :ref:`Compositor<class_Compositor>`.
  6099. .. rst-class:: classref-item-separator
  6100. ----
  6101. .. _class_RenderingServer_method_scenario_set_environment:
  6102. .. rst-class:: classref-method
  6103. |void| **scenario_set_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_scenario_set_environment>`
  6104. Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
  6105. .. rst-class:: classref-item-separator
  6106. ----
  6107. .. _class_RenderingServer_method_scenario_set_fallback_environment:
  6108. .. rst-class:: classref-method
  6109. |void| **scenario_set_fallback_environment**\ (\ scenario\: :ref:`RID<class_RID>`, environment\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_scenario_set_fallback_environment>`
  6110. 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.
  6111. .. rst-class:: classref-item-separator
  6112. ----
  6113. .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
  6114. .. rst-class:: classref-method
  6115. |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>`
  6116. 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>`.
  6117. .. rst-class:: classref-item-separator
  6118. ----
  6119. .. _class_RenderingServer_method_set_boot_image:
  6120. .. rst-class:: classref-method
  6121. |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>`
  6122. 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.
  6123. .. rst-class:: classref-item-separator
  6124. ----
  6125. .. _class_RenderingServer_method_set_debug_generate_wireframes:
  6126. .. rst-class:: classref-method
  6127. |void| **set_debug_generate_wireframes**\ (\ generate\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_set_debug_generate_wireframes>`
  6128. If ``generate`` is ``true``, generates debug wireframes for all meshes that are loaded when using the Compatibility renderer. By default, the engine does not generate debug wireframes at runtime, since they slow down loading of assets and take up VRAM.
  6129. \ **Note:** You must call this method before loading any meshes when using the Compatibility renderer, otherwise wireframes will not be used.
  6130. .. rst-class:: classref-item-separator
  6131. ----
  6132. .. _class_RenderingServer_method_set_default_clear_color:
  6133. .. rst-class:: classref-method
  6134. |void| **set_default_clear_color**\ (\ color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_set_default_clear_color>`
  6135. 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>`.
  6136. .. rst-class:: classref-item-separator
  6137. ----
  6138. .. _class_RenderingServer_method_shader_create:
  6139. .. rst-class:: classref-method
  6140. :ref:`RID<class_RID>` **shader_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_shader_create>`
  6141. 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.
  6142. 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.
  6143. \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
  6144. .. rst-class:: classref-item-separator
  6145. ----
  6146. .. _class_RenderingServer_method_shader_get_code:
  6147. .. rst-class:: classref-method
  6148. :ref:`String<class_String>` **shader_get_code**\ (\ shader\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_shader_get_code>`
  6149. Returns a shader's source code as a string.
  6150. .. rst-class:: classref-item-separator
  6151. ----
  6152. .. _class_RenderingServer_method_shader_get_default_texture_parameter:
  6153. .. rst-class:: classref-method
  6154. :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>`
  6155. Returns a default texture from a shader searched by name.
  6156. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  6157. .. rst-class:: classref-item-separator
  6158. ----
  6159. .. _class_RenderingServer_method_shader_get_parameter_default:
  6160. .. rst-class:: classref-method
  6161. :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>`
  6162. Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
  6163. .. rst-class:: classref-item-separator
  6164. ----
  6165. .. _class_RenderingServer_method_shader_set_code:
  6166. .. rst-class:: classref-method
  6167. |void| **shader_set_code**\ (\ shader\: :ref:`RID<class_RID>`, code\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_shader_set_code>`
  6168. Sets the shader's source code (which triggers recompilation after being changed).
  6169. .. rst-class:: classref-item-separator
  6170. ----
  6171. .. _class_RenderingServer_method_shader_set_default_texture_parameter:
  6172. .. rst-class:: classref-method
  6173. |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>`
  6174. Sets a shader's default texture. Overwrites the texture given by name.
  6175. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  6176. .. rst-class:: classref-item-separator
  6177. ----
  6178. .. _class_RenderingServer_method_shader_set_path_hint:
  6179. .. rst-class:: classref-method
  6180. |void| **shader_set_path_hint**\ (\ shader\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_shader_set_path_hint>`
  6181. 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>`.
  6182. .. rst-class:: classref-item-separator
  6183. ----
  6184. .. _class_RenderingServer_method_skeleton_allocate_data:
  6185. .. rst-class:: classref-method
  6186. |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>`
  6187. .. container:: contribute
  6188. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6189. .. rst-class:: classref-item-separator
  6190. ----
  6191. .. _class_RenderingServer_method_skeleton_bone_get_transform:
  6192. .. rst-class:: classref-method
  6193. :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>`
  6194. Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
  6195. .. rst-class:: classref-item-separator
  6196. ----
  6197. .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
  6198. .. rst-class:: classref-method
  6199. :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>`
  6200. Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
  6201. .. rst-class:: classref-item-separator
  6202. ----
  6203. .. _class_RenderingServer_method_skeleton_bone_set_transform:
  6204. .. rst-class:: classref-method
  6205. |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>`
  6206. Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
  6207. .. rst-class:: classref-item-separator
  6208. ----
  6209. .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
  6210. .. rst-class:: classref-method
  6211. |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>`
  6212. Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
  6213. .. rst-class:: classref-item-separator
  6214. ----
  6215. .. _class_RenderingServer_method_skeleton_create:
  6216. .. rst-class:: classref-method
  6217. :ref:`RID<class_RID>` **skeleton_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_skeleton_create>`
  6218. 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.
  6219. 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.
  6220. .. rst-class:: classref-item-separator
  6221. ----
  6222. .. _class_RenderingServer_method_skeleton_get_bone_count:
  6223. .. rst-class:: classref-method
  6224. :ref:`int<class_int>` **skeleton_get_bone_count**\ (\ skeleton\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_skeleton_get_bone_count>`
  6225. Returns the number of bones allocated for this skeleton.
  6226. .. rst-class:: classref-item-separator
  6227. ----
  6228. .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
  6229. .. rst-class:: classref-method
  6230. |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>`
  6231. .. container:: contribute
  6232. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6233. .. rst-class:: classref-item-separator
  6234. ----
  6235. .. _class_RenderingServer_method_sky_bake_panorama:
  6236. .. rst-class:: classref-method
  6237. :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>`
  6238. 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>`.
  6239. \ **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.
  6240. \ **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.
  6241. .. rst-class:: classref-item-separator
  6242. ----
  6243. .. _class_RenderingServer_method_sky_create:
  6244. .. rst-class:: classref-method
  6245. :ref:`RID<class_RID>` **sky_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_sky_create>`
  6246. 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.
  6247. 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.
  6248. .. rst-class:: classref-item-separator
  6249. ----
  6250. .. _class_RenderingServer_method_sky_set_material:
  6251. .. rst-class:: classref-method
  6252. |void| **sky_set_material**\ (\ sky\: :ref:`RID<class_RID>`, material\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_sky_set_material>`
  6253. Sets the material that the sky uses to render the background, ambient and reflection maps.
  6254. .. rst-class:: classref-item-separator
  6255. ----
  6256. .. _class_RenderingServer_method_sky_set_mode:
  6257. .. rst-class:: classref-method
  6258. |void| **sky_set_mode**\ (\ sky\: :ref:`RID<class_RID>`, mode\: :ref:`SkyMode<enum_RenderingServer_SkyMode>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_sky_set_mode>`
  6259. Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
  6260. .. rst-class:: classref-item-separator
  6261. ----
  6262. .. _class_RenderingServer_method_sky_set_radiance_size:
  6263. .. rst-class:: classref-method
  6264. |void| **sky_set_radiance_size**\ (\ sky\: :ref:`RID<class_RID>`, radiance_size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_sky_set_radiance_size>`
  6265. 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>`.
  6266. .. rst-class:: classref-item-separator
  6267. ----
  6268. .. _class_RenderingServer_method_spot_light_create:
  6269. .. rst-class:: classref-method
  6270. :ref:`RID<class_RID>` **spot_light_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_spot_light_create>`
  6271. 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.
  6272. 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.
  6273. 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.
  6274. .. rst-class:: classref-item-separator
  6275. ----
  6276. .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
  6277. .. rst-class:: classref-method
  6278. |void| **sub_surface_scattering_set_quality**\ (\ quality\: :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_sub_surface_scattering_set_quality>`
  6279. 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.
  6280. .. rst-class:: classref-item-separator
  6281. ----
  6282. .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
  6283. .. rst-class:: classref-method
  6284. |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>`
  6285. 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.
  6286. .. rst-class:: classref-item-separator
  6287. ----
  6288. .. _class_RenderingServer_method_texture_2d_create:
  6289. .. rst-class:: classref-method
  6290. :ref:`RID<class_RID>` **texture_2d_create**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_2d_create>`
  6291. 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.
  6292. 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.
  6293. \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
  6294. \ **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.
  6295. .. rst-class:: classref-item-separator
  6296. ----
  6297. .. _class_RenderingServer_method_texture_2d_get:
  6298. .. rst-class:: classref-method
  6299. :ref:`Image<class_Image>` **texture_2d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_texture_2d_get>`
  6300. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
  6301. \ **Example:** Get the test texture from :ref:`get_test_texture()<class_RenderingServer_method_get_test_texture>` and apply it to a :ref:`Sprite2D<class_Sprite2D>` node:
  6302. ::
  6303. var texture_rid = RenderingServer.get_test_texture()
  6304. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  6305. $Sprite2D.texture = texture
  6306. .. rst-class:: classref-item-separator
  6307. ----
  6308. .. _class_RenderingServer_method_texture_2d_layer_get:
  6309. .. rst-class:: classref-method
  6310. :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>`
  6311. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
  6312. .. rst-class:: classref-item-separator
  6313. ----
  6314. .. _class_RenderingServer_method_texture_2d_layered_create:
  6315. .. rst-class:: classref-method
  6316. :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>`
  6317. 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.
  6318. 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.
  6319. \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
  6320. .. rst-class:: classref-item-separator
  6321. ----
  6322. .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
  6323. .. rst-class:: classref-method
  6324. :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>`
  6325. 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>`.
  6326. \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
  6327. .. rst-class:: classref-item-separator
  6328. ----
  6329. .. _class_RenderingServer_method_texture_2d_placeholder_create:
  6330. .. rst-class:: classref-method
  6331. :ref:`RID<class_RID>` **texture_2d_placeholder_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_2d_placeholder_create>`
  6332. 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>`.
  6333. 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.
  6334. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
  6335. .. rst-class:: classref-item-separator
  6336. ----
  6337. .. _class_RenderingServer_method_texture_2d_update:
  6338. .. rst-class:: classref-method
  6339. |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>`
  6340. 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>`).
  6341. \ **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.
  6342. .. rst-class:: classref-item-separator
  6343. ----
  6344. .. _class_RenderingServer_method_texture_3d_create:
  6345. .. rst-class:: classref-method
  6346. :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>`
  6347. **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
  6348. .. rst-class:: classref-item-separator
  6349. ----
  6350. .. _class_RenderingServer_method_texture_3d_get:
  6351. .. rst-class:: classref-method
  6352. :ref:`Array<class_Array>`\[:ref:`Image<class_Image>`\] **texture_3d_get**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_texture_3d_get>`
  6353. Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
  6354. .. rst-class:: classref-item-separator
  6355. ----
  6356. .. _class_RenderingServer_method_texture_3d_placeholder_create:
  6357. .. rst-class:: classref-method
  6358. :ref:`RID<class_RID>` **texture_3d_placeholder_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_3d_placeholder_create>`
  6359. 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.
  6360. 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.
  6361. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
  6362. .. rst-class:: classref-item-separator
  6363. ----
  6364. .. _class_RenderingServer_method_texture_3d_update:
  6365. .. rst-class:: classref-method
  6366. |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>`
  6367. 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.
  6368. \ **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.
  6369. .. rst-class:: classref-item-separator
  6370. ----
  6371. .. _class_RenderingServer_method_texture_create_from_native_handle:
  6372. .. rst-class:: classref-method
  6373. :ref:`RID<class_RID>` **texture_create_from_native_handle**\ (\ type\: :ref:`TextureType<enum_RenderingServer_TextureType>`, format\: :ref:`Format<enum_Image_Format>`, native_handle\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>` = 1, layered_type\: :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_create_from_native_handle>`
  6374. Creates a texture based on a native handle that was created outside of Godot's renderer.
  6375. \ **Note:** If using only the rendering device renderer, it's recommend to use :ref:`RenderingDevice.texture_create_from_extension()<class_RenderingDevice_method_texture_create_from_extension>` together with :ref:`texture_rd_create()<class_RenderingServer_method_texture_rd_create>`, rather than this method. It will give you much more control over the texture's format and usage.
  6376. .. rst-class:: classref-item-separator
  6377. ----
  6378. .. _class_RenderingServer_method_texture_get_format:
  6379. .. rst-class:: classref-method
  6380. :ref:`Format<enum_Image_Format>` **texture_get_format**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_texture_get_format>`
  6381. Returns the format for the texture.
  6382. .. rst-class:: classref-item-separator
  6383. ----
  6384. .. _class_RenderingServer_method_texture_get_native_handle:
  6385. .. rst-class:: classref-method
  6386. :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>`
  6387. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  6388. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  6389. .. rst-class:: classref-item-separator
  6390. ----
  6391. .. _class_RenderingServer_method_texture_get_path:
  6392. .. rst-class:: classref-method
  6393. :ref:`String<class_String>` **texture_get_path**\ (\ texture\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_texture_get_path>`
  6394. .. container:: contribute
  6395. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6396. .. rst-class:: classref-item-separator
  6397. ----
  6398. .. _class_RenderingServer_method_texture_get_rd_texture:
  6399. .. rst-class:: classref-method
  6400. :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>`
  6401. Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
  6402. .. rst-class:: classref-item-separator
  6403. ----
  6404. .. _class_RenderingServer_method_texture_proxy_create:
  6405. .. rst-class:: classref-method
  6406. :ref:`RID<class_RID>` **texture_proxy_create**\ (\ base\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_proxy_create>`
  6407. **Deprecated:** ProxyTexture was removed in Godot 4.
  6408. This method does nothing and always returns an invalid :ref:`RID<class_RID>`.
  6409. .. rst-class:: classref-item-separator
  6410. ----
  6411. .. _class_RenderingServer_method_texture_proxy_update:
  6412. .. rst-class:: classref-method
  6413. |void| **texture_proxy_update**\ (\ texture\: :ref:`RID<class_RID>`, proxy_to\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_proxy_update>`
  6414. **Deprecated:** ProxyTexture was removed in Godot 4.
  6415. This method does nothing.
  6416. .. rst-class:: classref-item-separator
  6417. ----
  6418. .. _class_RenderingServer_method_texture_rd_create:
  6419. .. rst-class:: classref-method
  6420. :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>`
  6421. 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.
  6422. .. rst-class:: classref-item-separator
  6423. ----
  6424. .. _class_RenderingServer_method_texture_replace:
  6425. .. rst-class:: classref-method
  6426. |void| **texture_replace**\ (\ texture\: :ref:`RID<class_RID>`, by_texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_replace>`
  6427. Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
  6428. .. rst-class:: classref-item-separator
  6429. ----
  6430. .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
  6431. .. rst-class:: classref-method
  6432. |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>`
  6433. .. container:: contribute
  6434. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6435. .. rst-class:: classref-item-separator
  6436. ----
  6437. .. _class_RenderingServer_method_texture_set_path:
  6438. .. rst-class:: classref-method
  6439. |void| **texture_set_path**\ (\ texture\: :ref:`RID<class_RID>`, path\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_texture_set_path>`
  6440. .. container:: contribute
  6441. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6442. .. rst-class:: classref-item-separator
  6443. ----
  6444. .. _class_RenderingServer_method_texture_set_size_override:
  6445. .. rst-class:: classref-method
  6446. |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>`
  6447. .. container:: contribute
  6448. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6449. .. rst-class:: classref-item-separator
  6450. ----
  6451. .. _class_RenderingServer_method_viewport_attach_camera:
  6452. .. rst-class:: classref-method
  6453. |void| **viewport_attach_camera**\ (\ viewport\: :ref:`RID<class_RID>`, camera\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_attach_camera>`
  6454. Sets a viewport's camera.
  6455. .. rst-class:: classref-item-separator
  6456. ----
  6457. .. _class_RenderingServer_method_viewport_attach_canvas:
  6458. .. rst-class:: classref-method
  6459. |void| **viewport_attach_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_attach_canvas>`
  6460. Sets a viewport's canvas.
  6461. .. rst-class:: classref-item-separator
  6462. ----
  6463. .. _class_RenderingServer_method_viewport_attach_to_screen:
  6464. .. rst-class:: classref-method
  6465. |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>`
  6466. 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.
  6467. For example, you can set the root viewport to not render at all with the following code:
  6468. .. tabs::
  6469. .. code-tab:: gdscript
  6470. func _ready():
  6471. RenderingServer.viewport_attach_to_screen(get_viewport().get_viewport_rid(), Rect2())
  6472. RenderingServer.viewport_attach_to_screen($Viewport.get_viewport_rid(), Rect2(0, 0, 600, 600))
  6473. 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>`.
  6474. .. rst-class:: classref-item-separator
  6475. ----
  6476. .. _class_RenderingServer_method_viewport_create:
  6477. .. rst-class:: classref-method
  6478. :ref:`RID<class_RID>` **viewport_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_create>`
  6479. 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.
  6480. 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.
  6481. \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
  6482. .. rst-class:: classref-item-separator
  6483. ----
  6484. .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
  6485. .. rst-class:: classref-method
  6486. :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>`
  6487. 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>`.
  6488. \ **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``.
  6489. .. rst-class:: classref-item-separator
  6490. ----
  6491. .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
  6492. .. rst-class:: classref-method
  6493. :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>`
  6494. Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike :ref:`Engine.get_frames_per_second()<class_Engine_method_get_frames_per_second>`, this method accurately reflects GPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps<class_Engine_property_max_fps>`. See also :ref:`viewport_get_measured_render_time_cpu()<class_RenderingServer_method_viewport_get_measured_render_time_cpu>`.
  6495. \ **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``.
  6496. \ **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.
  6497. .. rst-class:: classref-item-separator
  6498. ----
  6499. .. _class_RenderingServer_method_viewport_get_render_info:
  6500. .. rst-class:: classref-method
  6501. :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>`
  6502. 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).
  6503. See also :ref:`get_rendering_info()<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
  6504. \ **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:
  6505. ::
  6506. func _ready():
  6507. for _i in 2:
  6508. await get_tree().process_frame
  6509. print(
  6510. RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
  6511. RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  6512. RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
  6513. )
  6514. .. rst-class:: classref-item-separator
  6515. ----
  6516. .. _class_RenderingServer_method_viewport_get_render_target:
  6517. .. rst-class:: classref-method
  6518. :ref:`RID<class_RID>` **viewport_get_render_target**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_get_render_target>`
  6519. Returns the render target for the viewport.
  6520. .. rst-class:: classref-item-separator
  6521. ----
  6522. .. _class_RenderingServer_method_viewport_get_texture:
  6523. .. rst-class:: classref-method
  6524. :ref:`RID<class_RID>` **viewport_get_texture**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_get_texture>`
  6525. Returns the viewport's last rendered frame.
  6526. .. rst-class:: classref-item-separator
  6527. ----
  6528. .. _class_RenderingServer_method_viewport_get_update_mode:
  6529. .. rst-class:: classref-method
  6530. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **viewport_get_update_mode**\ (\ viewport\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_get_update_mode>`
  6531. Returns the viewport's update mode.
  6532. \ **Warning:** Calling this from any thread other than the rendering thread will be detrimental to performance.
  6533. .. rst-class:: classref-item-separator
  6534. ----
  6535. .. _class_RenderingServer_method_viewport_remove_canvas:
  6536. .. rst-class:: classref-method
  6537. |void| **viewport_remove_canvas**\ (\ viewport\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_remove_canvas>`
  6538. Detaches a viewport from a canvas.
  6539. .. rst-class:: classref-item-separator
  6540. ----
  6541. .. _class_RenderingServer_method_viewport_set_active:
  6542. .. rst-class:: classref-method
  6543. |void| **viewport_set_active**\ (\ viewport\: :ref:`RID<class_RID>`, active\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_active>`
  6544. If ``true``, sets the viewport active, else sets it inactive.
  6545. .. rst-class:: classref-item-separator
  6546. ----
  6547. .. _class_RenderingServer_method_viewport_set_anisotropic_filtering_level:
  6548. .. rst-class:: classref-method
  6549. |void| **viewport_set_anisotropic_filtering_level**\ (\ viewport\: :ref:`RID<class_RID>`, anisotropic_filtering_level\: :ref:`ViewportAnisotropicFiltering<enum_RenderingServer_ViewportAnisotropicFiltering>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_anisotropic_filtering_level>`
  6550. Sets the maximum number of samples to take when using anisotropic filtering on textures (as a power of two). A higher sample count will result in sharper textures at oblique angles, but is more expensive to compute. A value of ``0`` forcibly disables anisotropic filtering, even on materials where it is enabled.
  6551. The anisotropic filtering level also affects decals and light projectors if they are configured to use anisotropic filtering. See :ref:`ProjectSettings.rendering/textures/decals/filter<class_ProjectSettings_property_rendering/textures/decals/filter>` and :ref:`ProjectSettings.rendering/textures/light_projectors/filter<class_ProjectSettings_property_rendering/textures/light_projectors/filter>`.
  6552. \ **Note:** In 3D, for this setting to have an effect, set :ref:`BaseMaterial3D.texture_filter<class_BaseMaterial3D_property_texture_filter>` to :ref:`BaseMaterial3D.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` or :ref:`BaseMaterial3D.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` on materials.
  6553. \ **Note:** In 2D, for this setting to have an effect, set :ref:`CanvasItem.texture_filter<class_CanvasItem_property_texture_filter>` to :ref:`CanvasItem.TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>` or :ref:`CanvasItem.TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC<class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC>` on the :ref:`CanvasItem<class_CanvasItem>` node displaying the texture (or in :ref:`CanvasTexture<class_CanvasTexture>`). However, anisotropic filtering is rarely useful in 2D, so only enable it for textures in 2D if it makes a meaningful visual difference.
  6554. .. rst-class:: classref-item-separator
  6555. ----
  6556. .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
  6557. .. rst-class:: classref-method
  6558. |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>`
  6559. 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>`.
  6560. .. rst-class:: classref-item-separator
  6561. ----
  6562. .. _class_RenderingServer_method_viewport_set_canvas_stacking:
  6563. .. rst-class:: classref-method
  6564. |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>`
  6565. Sets the stacking order for a viewport's canvas.
  6566. \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
  6567. \ **Note:** ``layer`` should be between :ref:`CANVAS_LAYER_MIN<class_RenderingServer_constant_CANVAS_LAYER_MIN>` and :ref:`CANVAS_LAYER_MAX<class_RenderingServer_constant_CANVAS_LAYER_MAX>` (inclusive). Any other value will wrap around.
  6568. .. rst-class:: classref-item-separator
  6569. ----
  6570. .. _class_RenderingServer_method_viewport_set_canvas_transform:
  6571. .. rst-class:: classref-method
  6572. |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>`
  6573. Sets the transformation of a viewport's canvas.
  6574. .. rst-class:: classref-item-separator
  6575. ----
  6576. .. _class_RenderingServer_method_viewport_set_clear_mode:
  6577. .. rst-class:: classref-method
  6578. |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>`
  6579. Sets the clear mode of a viewport.
  6580. .. rst-class:: classref-item-separator
  6581. ----
  6582. .. _class_RenderingServer_method_viewport_set_debug_draw:
  6583. .. rst-class:: classref-method
  6584. |void| **viewport_set_debug_draw**\ (\ viewport\: :ref:`RID<class_RID>`, draw\: :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_debug_draw>`
  6585. Sets the debug draw mode of a viewport.
  6586. .. rst-class:: classref-item-separator
  6587. ----
  6588. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
  6589. .. rst-class:: classref-method
  6590. |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>`
  6591. Sets the default texture filtering mode for the specified ``viewport`` RID.
  6592. .. rst-class:: classref-item-separator
  6593. ----
  6594. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
  6595. .. rst-class:: classref-method
  6596. |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>`
  6597. Sets the default texture repeat mode for the specified ``viewport`` RID.
  6598. .. rst-class:: classref-item-separator
  6599. ----
  6600. .. _class_RenderingServer_method_viewport_set_disable_2d:
  6601. .. rst-class:: classref-method
  6602. |void| **viewport_set_disable_2d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_disable_2d>`
  6603. If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
  6604. .. rst-class:: classref-item-separator
  6605. ----
  6606. .. _class_RenderingServer_method_viewport_set_disable_3d:
  6607. .. rst-class:: classref-method
  6608. |void| **viewport_set_disable_3d**\ (\ viewport\: :ref:`RID<class_RID>`, disable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_disable_3d>`
  6609. If ``true``, the viewport's 3D elements are not rendered.
  6610. .. rst-class:: classref-item-separator
  6611. ----
  6612. .. _class_RenderingServer_method_viewport_set_environment_mode:
  6613. .. rst-class:: classref-method
  6614. |void| **viewport_set_environment_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_environment_mode>`
  6615. 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>`.
  6616. .. rst-class:: classref-item-separator
  6617. ----
  6618. .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
  6619. .. rst-class:: classref-method
  6620. |void| **viewport_set_fsr_sharpness**\ (\ viewport\: :ref:`RID<class_RID>`, sharpness\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_fsr_sharpness>`
  6621. 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.
  6622. .. rst-class:: classref-item-separator
  6623. ----
  6624. .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
  6625. .. rst-class:: classref-method
  6626. |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>`
  6627. Sets the viewport's global transformation matrix.
  6628. .. rst-class:: classref-item-separator
  6629. ----
  6630. .. _class_RenderingServer_method_viewport_set_measure_render_time:
  6631. .. rst-class:: classref-method
  6632. |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>`
  6633. 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``.
  6634. .. rst-class:: classref-item-separator
  6635. ----
  6636. .. _class_RenderingServer_method_viewport_set_msaa_2d:
  6637. .. rst-class:: classref-method
  6638. |void| **viewport_set_msaa_2d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_msaa_2d>`
  6639. Sets the multisample antialiasing mode for 2D/Canvas on the specified ``viewport`` RID. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_2d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d>` or :ref:`Viewport.msaa_2d<class_Viewport_property_msaa_2d>`.
  6640. .. rst-class:: classref-item-separator
  6641. ----
  6642. .. _class_RenderingServer_method_viewport_set_msaa_3d:
  6643. .. rst-class:: classref-method
  6644. |void| **viewport_set_msaa_3d**\ (\ viewport\: :ref:`RID<class_RID>`, msaa\: :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_msaa_3d>`
  6645. Sets the multisample antialiasing mode for 3D on the specified ``viewport`` RID. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/msaa_3d<class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_3d>` or :ref:`Viewport.msaa_3d<class_Viewport_property_msaa_3d>`.
  6646. .. rst-class:: classref-item-separator
  6647. ----
  6648. .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
  6649. .. rst-class:: classref-method
  6650. |void| **viewport_set_occlusion_culling_build_quality**\ (\ quality\: :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>`
  6651. 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.
  6652. .. rst-class:: classref-item-separator
  6653. ----
  6654. .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
  6655. .. rst-class:: classref-method
  6656. |void| **viewport_set_occlusion_rays_per_thread**\ (\ rays_per_thread\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>`
  6657. 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.
  6658. .. rst-class:: classref-item-separator
  6659. ----
  6660. .. _class_RenderingServer_method_viewport_set_parent_viewport:
  6661. .. rst-class:: classref-method
  6662. |void| **viewport_set_parent_viewport**\ (\ viewport\: :ref:`RID<class_RID>`, parent_viewport\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_parent_viewport>`
  6663. Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
  6664. .. rst-class:: classref-item-separator
  6665. ----
  6666. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
  6667. .. rst-class:: classref-method
  6668. |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>`
  6669. 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>`.
  6670. .. rst-class:: classref-item-separator
  6671. ----
  6672. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
  6673. .. rst-class:: classref-method
  6674. |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>`
  6675. 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.
  6676. \ **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).
  6677. .. rst-class:: classref-item-separator
  6678. ----
  6679. .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
  6680. .. rst-class:: classref-method
  6681. |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>`
  6682. 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.
  6683. .. rst-class:: classref-item-separator
  6684. ----
  6685. .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
  6686. .. rst-class:: classref-method
  6687. |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>`
  6688. 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.
  6689. .. rst-class:: classref-item-separator
  6690. ----
  6691. .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
  6692. .. rst-class:: classref-method
  6693. |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>`
  6694. 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.
  6695. 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.
  6696. .. rst-class:: classref-item-separator
  6697. ----
  6698. .. _class_RenderingServer_method_viewport_set_scenario:
  6699. .. rst-class:: classref-method
  6700. |void| **viewport_set_scenario**\ (\ viewport\: :ref:`RID<class_RID>`, scenario\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_scenario>`
  6701. Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
  6702. .. rst-class:: classref-item-separator
  6703. ----
  6704. .. _class_RenderingServer_method_viewport_set_screen_space_aa:
  6705. .. rst-class:: classref-method
  6706. |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>`
  6707. Sets the viewport's screen-space antialiasing mode. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa<class_ProjectSettings_property_rendering/anti_aliasing/quality/screen_space_aa>` or :ref:`Viewport.screen_space_aa<class_Viewport_property_screen_space_aa>`.
  6708. .. rst-class:: classref-item-separator
  6709. ----
  6710. .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
  6711. .. rst-class:: classref-method
  6712. |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>`
  6713. 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.
  6714. .. rst-class:: classref-item-separator
  6715. ----
  6716. .. _class_RenderingServer_method_viewport_set_size:
  6717. .. rst-class:: classref-method
  6718. |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>`
  6719. Sets the viewport's width and height in pixels.
  6720. .. rst-class:: classref-item-separator
  6721. ----
  6722. .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
  6723. .. rst-class:: classref-method
  6724. |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>`
  6725. 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>`.
  6726. .. rst-class:: classref-item-separator
  6727. ----
  6728. .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
  6729. .. rst-class:: classref-method
  6730. |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>`
  6731. 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>`.
  6732. .. rst-class:: classref-item-separator
  6733. ----
  6734. .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
  6735. .. rst-class:: classref-method
  6736. |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>`
  6737. 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.
  6738. \ **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``.
  6739. .. rst-class:: classref-item-separator
  6740. ----
  6741. .. _class_RenderingServer_method_viewport_set_transparent_background:
  6742. .. rst-class:: classref-method
  6743. |void| **viewport_set_transparent_background**\ (\ viewport\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_transparent_background>`
  6744. If ``true``, the viewport renders its background as transparent.
  6745. .. rst-class:: classref-item-separator
  6746. ----
  6747. .. _class_RenderingServer_method_viewport_set_update_mode:
  6748. .. rst-class:: classref-method
  6749. |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>`
  6750. Sets when the viewport should be updated.
  6751. .. rst-class:: classref-item-separator
  6752. ----
  6753. .. _class_RenderingServer_method_viewport_set_use_debanding:
  6754. .. rst-class:: classref-method
  6755. |void| **viewport_set_use_debanding**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_use_debanding>`
  6756. If ``true``, enables debanding on the specified viewport. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_debanding<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_debanding>` or :ref:`Viewport.use_debanding<class_Viewport_property_use_debanding>`.
  6757. .. rst-class:: classref-item-separator
  6758. ----
  6759. .. _class_RenderingServer_method_viewport_set_use_hdr_2d:
  6760. .. rst-class:: classref-method
  6761. |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>`
  6762. 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>`.
  6763. \ **Note:** This setting will have no effect when using the Compatibility renderer, which always renders in low dynamic range for performance reasons.
  6764. .. rst-class:: classref-item-separator
  6765. ----
  6766. .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
  6767. .. rst-class:: classref-method
  6768. |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>`
  6769. 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>`.
  6770. .. rst-class:: classref-item-separator
  6771. ----
  6772. .. _class_RenderingServer_method_viewport_set_use_taa:
  6773. .. rst-class:: classref-method
  6774. |void| **viewport_set_use_taa**\ (\ viewport\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_use_taa>`
  6775. If ``true``, use temporal antialiasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>` or :ref:`Viewport.use_taa<class_Viewport_property_use_taa>`.
  6776. .. rst-class:: classref-item-separator
  6777. ----
  6778. .. _class_RenderingServer_method_viewport_set_use_xr:
  6779. .. rst-class:: classref-method
  6780. |void| **viewport_set_use_xr**\ (\ viewport\: :ref:`RID<class_RID>`, use_xr\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_use_xr>`
  6781. If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
  6782. .. rst-class:: classref-item-separator
  6783. ----
  6784. .. _class_RenderingServer_method_viewport_set_vrs_mode:
  6785. .. rst-class:: classref-method
  6786. |void| **viewport_set_vrs_mode**\ (\ viewport\: :ref:`RID<class_RID>`, mode\: :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_vrs_mode>`
  6787. 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>`.
  6788. .. rst-class:: classref-item-separator
  6789. ----
  6790. .. _class_RenderingServer_method_viewport_set_vrs_texture:
  6791. .. rst-class:: classref-method
  6792. |void| **viewport_set_vrs_texture**\ (\ viewport\: :ref:`RID<class_RID>`, texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_viewport_set_vrs_texture>`
  6793. 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>`.
  6794. .. rst-class:: classref-item-separator
  6795. ----
  6796. .. _class_RenderingServer_method_viewport_set_vrs_update_mode:
  6797. .. rst-class:: classref-method
  6798. |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>`
  6799. 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.
  6800. 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>`.
  6801. .. rst-class:: classref-item-separator
  6802. ----
  6803. .. _class_RenderingServer_method_visibility_notifier_create:
  6804. .. rst-class:: classref-method
  6805. :ref:`RID<class_RID>` **visibility_notifier_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_visibility_notifier_create>`
  6806. 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.
  6807. 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.
  6808. To place in a scene, attach this notifier to an instance using :ref:`instance_set_base()<class_RenderingServer_method_instance_set_base>` using the returned RID.
  6809. \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
  6810. .. rst-class:: classref-item-separator
  6811. ----
  6812. .. _class_RenderingServer_method_visibility_notifier_set_aabb:
  6813. .. rst-class:: classref-method
  6814. |void| **visibility_notifier_set_aabb**\ (\ notifier\: :ref:`RID<class_RID>`, aabb\: :ref:`AABB<class_AABB>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_visibility_notifier_set_aabb>`
  6815. .. container:: contribute
  6816. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6817. .. rst-class:: classref-item-separator
  6818. ----
  6819. .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
  6820. .. rst-class:: classref-method
  6821. |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>`
  6822. .. container:: contribute
  6823. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6824. .. rst-class:: classref-item-separator
  6825. ----
  6826. .. _class_RenderingServer_method_voxel_gi_allocate_data:
  6827. .. rst-class:: classref-method
  6828. |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>`
  6829. .. container:: contribute
  6830. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6831. .. rst-class:: classref-item-separator
  6832. ----
  6833. .. _class_RenderingServer_method_voxel_gi_create:
  6834. .. rst-class:: classref-method
  6835. :ref:`RID<class_RID>` **voxel_gi_create**\ (\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_create>`
  6836. 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.
  6837. 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.
  6838. \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
  6839. .. rst-class:: classref-item-separator
  6840. ----
  6841. .. _class_RenderingServer_method_voxel_gi_get_data_cells:
  6842. .. rst-class:: classref-method
  6843. :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>`
  6844. .. container:: contribute
  6845. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6846. .. rst-class:: classref-item-separator
  6847. ----
  6848. .. _class_RenderingServer_method_voxel_gi_get_distance_field:
  6849. .. rst-class:: classref-method
  6850. :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>`
  6851. .. container:: contribute
  6852. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6853. .. rst-class:: classref-item-separator
  6854. ----
  6855. .. _class_RenderingServer_method_voxel_gi_get_level_counts:
  6856. .. rst-class:: classref-method
  6857. :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>`
  6858. .. container:: contribute
  6859. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6860. .. rst-class:: classref-item-separator
  6861. ----
  6862. .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
  6863. .. rst-class:: classref-method
  6864. :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>`
  6865. .. container:: contribute
  6866. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6867. .. rst-class:: classref-item-separator
  6868. ----
  6869. .. _class_RenderingServer_method_voxel_gi_get_octree_size:
  6870. .. rst-class:: classref-method
  6871. :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>`
  6872. .. container:: contribute
  6873. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6874. .. rst-class:: classref-item-separator
  6875. ----
  6876. .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
  6877. .. rst-class:: classref-method
  6878. :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>`
  6879. .. container:: contribute
  6880. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6881. .. rst-class:: classref-item-separator
  6882. ----
  6883. .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
  6884. .. rst-class:: classref-method
  6885. |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>`
  6886. 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>`.
  6887. .. rst-class:: classref-item-separator
  6888. ----
  6889. .. _class_RenderingServer_method_voxel_gi_set_bias:
  6890. .. rst-class:: classref-method
  6891. |void| **voxel_gi_set_bias**\ (\ voxel_gi\: :ref:`RID<class_RID>`, bias\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_set_bias>`
  6892. Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6893. .. rst-class:: classref-item-separator
  6894. ----
  6895. .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
  6896. .. rst-class:: classref-method
  6897. |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>`
  6898. Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6899. .. rst-class:: classref-item-separator
  6900. ----
  6901. .. _class_RenderingServer_method_voxel_gi_set_energy:
  6902. .. rst-class:: classref-method
  6903. |void| **voxel_gi_set_energy**\ (\ voxel_gi\: :ref:`RID<class_RID>`, energy\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_set_energy>`
  6904. Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6905. .. rst-class:: classref-item-separator
  6906. ----
  6907. .. _class_RenderingServer_method_voxel_gi_set_interior:
  6908. .. rst-class:: classref-method
  6909. |void| **voxel_gi_set_interior**\ (\ voxel_gi\: :ref:`RID<class_RID>`, enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_set_interior>`
  6910. Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6911. .. rst-class:: classref-item-separator
  6912. ----
  6913. .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
  6914. .. rst-class:: classref-method
  6915. |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>`
  6916. Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6917. .. rst-class:: classref-item-separator
  6918. ----
  6919. .. _class_RenderingServer_method_voxel_gi_set_propagation:
  6920. .. rst-class:: classref-method
  6921. |void| **voxel_gi_set_propagation**\ (\ voxel_gi\: :ref:`RID<class_RID>`, amount\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_set_propagation>`
  6922. Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6923. .. rst-class:: classref-item-separator
  6924. ----
  6925. .. _class_RenderingServer_method_voxel_gi_set_quality:
  6926. .. rst-class:: classref-method
  6927. |void| **voxel_gi_set_quality**\ (\ quality\: :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>`\ ) :ref:`๐Ÿ”—<class_RenderingServer_method_voxel_gi_set_quality>`
  6928. 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.
  6929. .. rst-class:: classref-item-separator
  6930. ----
  6931. .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
  6932. .. rst-class:: classref-method
  6933. |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>`
  6934. 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>`.
  6935. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  6936. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  6937. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  6938. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  6939. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  6940. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  6941. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  6942. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  6943. .. |void| replace:: :abbr:`void (No return value.)`