class_renderingserver.rst 1.0 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297
  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:`Image[]<class_Image>` | :ref:`bake_render_uv2<class_RenderingServer_method_bake_render_uv2>` **(** :ref:`RID<class_RID>` base, :ref:`RID[]<class_RID>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)** |
  42. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`call_on_render_thread<class_RenderingServer_method_call_on_render_thread>` **(** :ref:`Callable<class_Callable>` 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>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_sensitivity, :ref:`float<class_float>` max_sensitivity, :ref:`float<class_float>` speed, :ref:`float<class_float>` scale **)** |
  48. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`camera_attributes_set_dof_blur<class_RenderingServer_method_camera_attributes_set_dof_blur>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)** |
  50. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`camera_attributes_set_dof_blur_bokeh_shape<class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape>` **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)** |
  52. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`camera_attributes_set_dof_blur_quality<class_RenderingServer_method_camera_attributes_set_dof_blur_quality>` **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)** |
  54. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`camera_attributes_set_exposure<class_RenderingServer_method_camera_attributes_set_exposure>` **(** :ref:`RID<class_RID>` camera_attributes, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` normalization **)** |
  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>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)** |
  60. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>` **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)** |
  62. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)** |
  64. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`camera_set_frustum<class_RenderingServer_method_camera_set_frustum>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  66. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`camera_set_orthogonal<class_RenderingServer_method_camera_set_orthogonal>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  68. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`camera_set_perspective<class_RenderingServer_method_camera_set_perspective>` **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
  70. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>` **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)** |
  72. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`camera_set_use_vertical_aspect<class_RenderingServer_method_camera_set_use_vertical_aspect>` **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)** |
  74. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>` **(** **)** |
  76. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`canvas_item_add_animation_slice<class_RenderingServer_method_canvas_item_add_animation_slice>` **(** :ref:`RID<class_RID>` item, :ref:`float<class_float>` animation_length, :ref:`float<class_float>` slice_begin, :ref:`float<class_float>` slice_end, :ref:`float<class_float>` offset=0.0 **)** |
  78. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`canvas_item_add_circle<class_RenderingServer_method_canvas_item_add_circle>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)** |
  80. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`canvas_item_add_clip_ignore<class_RenderingServer_method_canvas_item_add_clip_ignore>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)** |
  82. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`canvas_item_add_lcd_texture_rect_region<class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate **)** |
  84. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`canvas_item_add_line<class_RenderingServer_method_canvas_item_add_line>` **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  86. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`canvas_item_add_mesh<class_RenderingServer_method_canvas_item_add_mesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture=RID() **)** |
  88. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`canvas_item_add_msdf_texture_rect_region<class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0, :ref:`float<class_float>` scale=1.0 **)** |
  90. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | void | :ref:`canvas_item_add_multiline<class_RenderingServer_method_canvas_item_add_multiline>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0 **)** |
  92. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`canvas_item_add_multimesh<class_RenderingServer_method_canvas_item_add_multimesh>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture=RID() **)** |
  94. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`canvas_item_add_nine_patch<class_RenderingServer_method_canvas_item_add_nine_patch>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)** |
  96. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`canvas_item_add_particles<class_RenderingServer_method_canvas_item_add_particles>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)** |
  98. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`canvas_item_add_polygon<class_RenderingServer_method_canvas_item_add_polygon>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture=RID() **)** |
  100. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`canvas_item_add_polyline<class_RenderingServer_method_canvas_item_add_polyline>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  102. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`canvas_item_add_primitive<class_RenderingServer_method_canvas_item_add_primitive>` **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture **)** |
  104. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`canvas_item_add_rect<class_RenderingServer_method_canvas_item_add_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)** |
  106. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | void | :ref:`canvas_item_add_set_transform<class_RenderingServer_method_canvas_item_add_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
  108. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | void | :ref:`canvas_item_add_texture_rect<class_RenderingServer_method_canvas_item_add_texture_rect>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)** |
  110. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | void | :ref:`canvas_item_add_texture_rect_region<class_RenderingServer_method_canvas_item_add_texture_rect_region>` **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)** |
  112. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | void | :ref:`canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture=RID(), :ref:`int<class_int>` count=-1 **)** |
  114. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | void | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>` **(** :ref:`RID<class_RID>` item **)** |
  116. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>` **(** **)** |
  118. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | void | :ref:`canvas_item_set_canvas_group_mode<class_RenderingServer_method_canvas_item_set_canvas_group_mode>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)** |
  120. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | void | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)** |
  122. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | void | :ref:`canvas_item_set_copy_to_backbuffer<class_RenderingServer_method_canvas_item_set_copy_to_backbuffer>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)** |
  124. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | void | :ref:`canvas_item_set_custom_rect<class_RenderingServer_method_canvas_item_set_custom_rect>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)** |
  126. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | void | :ref:`canvas_item_set_default_texture_filter<class_RenderingServer_method_canvas_item_set_default_texture_filter>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  128. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | void | :ref:`canvas_item_set_default_texture_repeat<class_RenderingServer_method_canvas_item_set_default_texture_repeat>` **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  130. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`canvas_item_set_distance_field_mode<class_RenderingServer_method_canvas_item_set_distance_field_mode>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  132. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`canvas_item_set_draw_behind_parent<class_RenderingServer_method_canvas_item_set_draw_behind_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  134. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`canvas_item_set_draw_index<class_RenderingServer_method_canvas_item_set_draw_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)** |
  136. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`canvas_item_set_light_mask<class_RenderingServer_method_canvas_item_set_light_mask>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)** |
  138. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)** |
  140. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
  142. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)** |
  144. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`canvas_item_set_self_modulate<class_RenderingServer_method_canvas_item_set_self_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
  146. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`canvas_item_set_sort_children_by_y<class_RenderingServer_method_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  148. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
  150. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`canvas_item_set_use_parent_material<class_RenderingServer_method_canvas_item_set_use_parent_material>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  152. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`canvas_item_set_visibility_layer<class_RenderingServer_method_canvas_item_set_visibility_layer>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` visibility_layer **)** |
  154. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`canvas_item_set_visibility_notifier<class_RenderingServer_method_canvas_item_set_visibility_notifier>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
  156. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)** |
  158. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`canvas_item_set_z_as_relative_to_parent<class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)** |
  160. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`canvas_item_set_z_index<class_RenderingServer_method_canvas_item_set_z_index>` **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)** |
  162. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`canvas_light_attach_to_canvas<class_RenderingServer_method_canvas_light_attach_to_canvas>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)** |
  164. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>` **(** **)** |
  166. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | void | :ref:`canvas_light_occluder_attach_to_canvas<class_RenderingServer_method_canvas_light_occluder_attach_to_canvas>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)** |
  168. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>` **(** **)** |
  170. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | void | :ref:`canvas_light_occluder_set_as_sdf_collision<class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)** |
  172. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | void | :ref:`canvas_light_occluder_set_enabled<class_RenderingServer_method_canvas_light_occluder_set_enabled>` **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)** |
  174. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | void | :ref:`canvas_light_occluder_set_light_mask<class_RenderingServer_method_canvas_light_occluder_set_light_mask>` **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)** |
  176. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | void | :ref:`canvas_light_occluder_set_polygon<class_RenderingServer_method_canvas_light_occluder_set_polygon>` **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)** |
  178. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`canvas_light_occluder_set_transform<class_RenderingServer_method_canvas_light_occluder_set_transform>` **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)** |
  180. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | void | :ref:`canvas_light_set_blend_mode<class_RenderingServer_method_canvas_light_set_blend_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` mode **)** |
  182. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | void | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  184. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | void | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  186. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | void | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)** |
  188. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | void | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)** |
  190. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | void | :ref:`canvas_light_set_item_cull_mask<class_RenderingServer_method_canvas_light_set_item_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  192. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | void | :ref:`canvas_light_set_item_shadow_cull_mask<class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  194. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | void | :ref:`canvas_light_set_layer_range<class_RenderingServer_method_canvas_light_set_layer_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)** |
  196. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | void | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)** |
  198. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | void | :ref:`canvas_light_set_shadow_color<class_RenderingServer_method_canvas_light_set_shadow_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  200. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`canvas_light_set_shadow_enabled<class_RenderingServer_method_canvas_light_set_shadow_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  202. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | void | :ref:`canvas_light_set_shadow_filter<class_RenderingServer_method_canvas_light_set_shadow_filter>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)** |
  204. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | void | :ref:`canvas_light_set_shadow_smooth<class_RenderingServer_method_canvas_light_set_shadow_smooth>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)** |
  206. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | void | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
  208. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | void | :ref:`canvas_light_set_texture_offset<class_RenderingServer_method_canvas_light_set_texture_offset>` **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)** |
  210. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | void | :ref:`canvas_light_set_texture_scale<class_RenderingServer_method_canvas_light_set_texture_scale>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)** |
  212. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>` **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)** |
  214. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | void | :ref:`canvas_light_set_z_range<class_RenderingServer_method_canvas_light_set_z_range>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)** |
  216. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>` **(** **)** |
  218. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | void | :ref:`canvas_occluder_polygon_set_cull_mode<class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)** |
  220. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | void | :ref:`canvas_occluder_polygon_set_shape<class_RenderingServer_method_canvas_occluder_polygon_set_shape>` **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)** |
  222. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | void | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>` **(** :ref:`bool<class_bool>` disable **)** |
  224. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | void | :ref:`canvas_set_item_mirroring<class_RenderingServer_method_canvas_set_item_mirroring>` **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)** |
  226. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | void | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>` **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)** |
  228. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | void | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>` **(** :ref:`int<class_int>` size **)** |
  230. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>` **(** **)** |
  232. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | void | :ref:`canvas_texture_set_channel<class_RenderingServer_method_canvas_texture_set_channel>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)** |
  234. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | void | :ref:`canvas_texture_set_shading_parameters<class_RenderingServer_method_canvas_texture_set_shading_parameters>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)** |
  236. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | void | :ref:`canvas_texture_set_texture_filter<class_RenderingServer_method_canvas_texture_set_texture_filter>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  238. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | void | :ref:`canvas_texture_set_texture_repeat<class_RenderingServer_method_canvas_texture_set_texture_repeat>` **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  240. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>` **(** **)** |const| |
  242. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>` **(** **)** |
  244. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | void | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)** |
  246. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | void | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>` **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)** |
  248. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | void | :ref:`decal_set_distance_fade<class_RenderingServer_method_decal_set_distance_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)** |
  250. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | void | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)** |
  252. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | void | :ref:`decal_set_fade<class_RenderingServer_method_decal_set_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)** |
  254. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | void | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>` **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)** |
  256. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | void | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)** |
  258. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | void | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>` **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)** |
  260. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | void | :ref:`decal_set_texture<class_RenderingServer_method_decal_set_texture>` **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)** |
  262. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | void | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>` **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)** |
  264. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>` **(** **)** |
  266. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | void | :ref:`directional_shadow_atlas_set_size<class_RenderingServer_method_directional_shadow_atlas_set_size>` **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)** |
  268. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | void | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
  270. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`Image<class_Image>` | :ref:`environment_bake_panorama<class_RenderingServer_method_environment_bake_panorama>` **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
  272. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>` **(** **)** |
  274. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | void | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>` **(** :ref:`bool<class_bool>` enable **)** |
  276. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | void | :ref:`environment_set_adjustment<class_RenderingServer_method_environment_set_adjustment>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)** |
  278. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | void | :ref:`environment_set_ambient_light<class_RenderingServer_method_environment_set_ambient_light>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)** |
  280. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | void | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)** |
  282. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | void | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)** |
  284. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | void | :ref:`environment_set_bg_energy<class_RenderingServer_method_environment_set_bg_energy>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` exposure_value **)** |
  286. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | void | :ref:`environment_set_canvas_max_layer<class_RenderingServer_method_environment_set_canvas_max_layer>` **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)** |
  288. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | void | :ref:`environment_set_fog<class_RenderingServer_method_environment_set_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` light_energy, :ref:`float<class_float>` sun_scatter, :ref:`float<class_float>` density, :ref:`float<class_float>` height, :ref:`float<class_float>` height_density, :ref:`float<class_float>` aerial_perspective, :ref:`float<class_float>` sky_affect **)** |
  290. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | void | :ref:`environment_set_glow<class_RenderingServer_method_environment_set_glow>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`float<class_float>` glow_map_strength, :ref:`RID<class_RID>` glow_map **)** |
  292. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | void | :ref:`environment_set_sdfgi<class_RenderingServer_method_environment_set_sdfgi>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)** |
  294. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | void | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>` **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)** |
  296. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | void | :ref:`environment_set_sdfgi_frames_to_update_light<class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light>` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)** |
  298. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | void | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>` **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)** |
  300. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | void | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
  302. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | void | :ref:`environment_set_sky_custom_fov<class_RenderingServer_method_environment_set_sky_custom_fov>` **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)** |
  304. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | void | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>` **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)** |
  306. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | void | :ref:`environment_set_ssao<class_RenderingServer_method_environment_set_ssao>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` power, :ref:`float<class_float>` detail, :ref:`float<class_float>` horizon, :ref:`float<class_float>` sharpness, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect **)** |
  308. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | void | :ref:`environment_set_ssao_quality<class_RenderingServer_method_environment_set_ssao_quality>` **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
  310. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | void | :ref:`environment_set_ssil_quality<class_RenderingServer_method_environment_set_ssil_quality>` **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)** |
  312. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | void | :ref:`environment_set_ssr<class_RenderingServer_method_environment_set_ssr>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)** |
  314. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | void | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>` **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)** |
  316. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | void | :ref:`environment_set_tonemap<class_RenderingServer_method_environment_set_tonemap>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white **)** |
  318. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | void | :ref:`environment_set_volumetric_fog<class_RenderingServer_method_environment_set_volumetric_fog>` **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` emission_energy, :ref:`float<class_float>` anisotropy, :ref:`float<class_float>` length, :ref:`float<class_float>` p_detail_spread, :ref:`float<class_float>` gi_inject, :ref:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject, :ref:`float<class_float>` sky_affect **)** |
  320. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | void | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>` **(** :ref:`bool<class_bool>` active **)** |
  322. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | void | :ref:`environment_set_volumetric_fog_volume_size<class_RenderingServer_method_environment_set_volumetric_fog_volume_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)** |
  324. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>` **(** **)** |
  326. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | void | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)** |
  328. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | void | :ref:`fog_volume_set_shape<class_RenderingServer_method_fog_volume_set_shape>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)** |
  330. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | void | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)** |
  332. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | void | :ref:`force_draw<class_RenderingServer_method_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
  334. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | void | :ref:`force_sync<class_RenderingServer_method_force_sync>` **(** **)** |
  336. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | void | :ref:`free_rid<class_RenderingServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  338. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>` **(** **)** |
  340. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>` **(** **)** |const| |
  342. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>` **(** **)** |const| |
  344. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>` **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)** |
  346. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`get_shader_parameter_list<class_RenderingServer_method_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` shader **)** |const| |
  348. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>` **(** **)** |
  350. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` **(** **)** |
  352. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>` **(** **)** |const| |
  354. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>` **(** **)** |const| |
  356. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>` **(** **)** |const| |
  358. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>` **(** **)** |const| |
  360. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>` **(** **)** |
  362. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | void | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>` **(** :ref:`bool<class_bool>` half_resolution **)** |
  364. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | void | :ref:`global_shader_parameter_add<class_RenderingServer_method_global_shader_parameter_add>` **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` type, :ref:`Variant<class_Variant>` default_value **)** |
  366. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  368. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`StringName[]<class_StringName>` | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>` **(** **)** |const| |
  370. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` | :ref:`global_shader_parameter_get_type<class_RenderingServer_method_global_shader_parameter_get_type>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  372. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | void | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>` **(** :ref:`StringName<class_StringName>` name **)** |
  374. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | void | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
  376. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | void | :ref:`global_shader_parameter_set_override<class_RenderingServer_method_global_shader_parameter_set_override>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
  378. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>` **(** **)** |const| |
  380. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>` **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const| |
  382. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>` **(** :ref:`String<class_String>` feature **)** |const| |
  384. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | void | :ref:`instance_attach_object_instance_id<class_RenderingServer_method_instance_attach_object_instance_id>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)** |
  386. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | void | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)** |
  388. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>` **(** **)** |
  390. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>` **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)** |
  392. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter<class_RenderingServer_method_instance_geometry_get_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
  394. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`Variant<class_Variant>` | :ref:`instance_geometry_get_shader_parameter_default_value<class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const| |
  396. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`instance_geometry_get_shader_parameter_list<class_RenderingServer_method_instance_geometry_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` instance **)** |const| |
  398. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | void | :ref:`instance_geometry_set_cast_shadows_setting<class_RenderingServer_method_instance_geometry_set_cast_shadows_setting>` **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)** |
  400. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | void | :ref:`instance_geometry_set_flag<class_RenderingServer_method_instance_geometry_set_flag>` **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)** |
  402. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | void | :ref:`instance_geometry_set_lightmap<class_RenderingServer_method_instance_geometry_set_lightmap>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)** |
  404. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | void | :ref:`instance_geometry_set_lod_bias<class_RenderingServer_method_instance_geometry_set_lod_bias>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)** |
  406. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | void | :ref:`instance_geometry_set_material_overlay<class_RenderingServer_method_instance_geometry_set_material_overlay>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
  408. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | void | :ref:`instance_geometry_set_material_override<class_RenderingServer_method_instance_geometry_set_material_override>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)** |
  410. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | void | :ref:`instance_geometry_set_shader_parameter<class_RenderingServer_method_instance_geometry_set_shader_parameter>` **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
  412. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | void | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)** |
  414. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | void | :ref:`instance_geometry_set_visibility_range<class_RenderingServer_method_instance_geometry_set_visibility_range>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)** |
  416. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | void | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)** |
  418. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | void | :ref:`instance_set_blend_shape_weight<class_RenderingServer_method_instance_set_blend_shape_weight>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)** |
  420. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | void | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>` **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)** |
  422. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | void | :ref:`instance_set_extra_visibility_margin<class_RenderingServer_method_instance_set_extra_visibility_margin>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)** |
  424. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | void | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)** |
  426. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | void | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)** |
  428. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | void | :ref:`instance_set_pivot_data<class_RenderingServer_method_instance_set_pivot_data>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` sorting_offset, :ref:`bool<class_bool>` use_aabb_center **)** |
  430. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | void | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)** |
  432. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | void | :ref:`instance_set_surface_override_material<class_RenderingServer_method_instance_set_surface_override_material>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
  434. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | void | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>` **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)** |
  436. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | void | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)** |
  438. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | void | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)** |
  440. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_aabb<class_RenderingServer_method_instances_cull_aabb>` **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  442. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_convex<class_RenderingServer_method_instances_cull_convex>` **(** :ref:`Plane[]<class_Plane>` convex, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  444. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`instances_cull_ray<class_RenderingServer_method_instances_cull_ray>` **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario=RID() **)** |const| |
  446. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | void | :ref:`light_directional_set_blend_splits<class_RenderingServer_method_light_directional_set_blend_splits>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
  448. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | void | :ref:`light_directional_set_shadow_mode<class_RenderingServer_method_light_directional_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)** |
  450. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | void | :ref:`light_directional_set_sky_mode<class_RenderingServer_method_light_directional_set_sky_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` mode **)** |
  452. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | void | :ref:`light_omni_set_shadow_mode<class_RenderingServer_method_light_omni_set_shadow_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)** |
  454. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | void | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>` **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)** |
  456. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | void | :ref:`light_set_bake_mode<class_RenderingServer_method_light_set_bake_mode>` **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)** |
  458. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | void | :ref:`light_set_color<class_RenderingServer_method_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
  460. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | void | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
  462. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | void | :ref:`light_set_distance_fade<class_RenderingServer_method_light_set_distance_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` shadow, :ref:`float<class_float>` length **)** |
  464. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | void | :ref:`light_set_max_sdfgi_cascade<class_RenderingServer_method_light_set_max_sdfgi_cascade>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)** |
  466. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | void | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
  468. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | void | :ref:`light_set_param<class_RenderingServer_method_light_set_param>` **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)** |
  470. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | void | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
  472. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | void | :ref:`light_set_reverse_cull_face_mode<class_RenderingServer_method_light_set_reverse_cull_face_mode>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  474. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | void | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
  476. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>` **(** **)** |
  478. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_bsp_tree<class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  480. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  482. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  484. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
  486. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | void | :ref:`lightmap_set_baked_exposure_normalization<class_RenderingServer_method_lightmap_set_baked_exposure_normalization>` **(** :ref:`RID<class_RID>` lightmap, :ref:`float<class_float>` baked_exposure **)** |
  488. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | void | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>` **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)** |
  490. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | void | :ref:`lightmap_set_probe_capture_data<class_RenderingServer_method_lightmap_set_probe_capture_data>` **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)** |
  492. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | void | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>` **(** :ref:`float<class_float>` speed **)** |
  494. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | void | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>` **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)** |
  496. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | void | :ref:`lightmap_set_textures<class_RenderingServer_method_lightmap_set_textures>` **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)** |
  498. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. | :ref:`RID<class_RID>` | :ref:`make_sphere_mesh<class_RenderingServer_method_make_sphere_mesh>` **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)** |
  500. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  501. | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>` **(** **)** |
  502. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  503. | :ref:`Variant<class_Variant>` | :ref:`material_get_param<class_RenderingServer_method_material_get_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const| |
  504. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  505. | void | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>` **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)** |
  506. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  507. | void | :ref:`material_set_param<class_RenderingServer_method_material_set_param>` **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)** |
  508. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  509. | void | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>` **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)** |
  510. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  511. | void | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>` **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)** |
  512. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  513. | void | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)** |
  514. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  515. | void | :ref:`mesh_add_surface_from_arrays<class_RenderingServer_method_mesh_add_surface_from_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> compress_format=0 **)** |
  516. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  517. | void | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>` **(** :ref:`RID<class_RID>` mesh **)** |
  518. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  519. | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>` **(** **)** |
  520. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  521. | :ref:`RID<class_RID>` | :ref:`mesh_create_from_surfaces<class_RenderingServer_method_mesh_create_from_surfaces>` **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)** |
  522. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  523. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  524. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  525. | :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` | :ref:`mesh_get_blend_shape_mode<class_RenderingServer_method_mesh_get_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  526. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  527. | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  528. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  529. | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |
  530. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  531. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
  532. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  533. | void | :ref:`mesh_set_blend_shape_mode<class_RenderingServer_method_mesh_set_blend_shape_mode>` **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)** |
  534. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  535. | void | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)** |
  536. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  537. | void | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>` **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)** |
  538. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  539. | :ref:`Array<class_Array>` | :ref:`mesh_surface_get_arrays<class_RenderingServer_method_mesh_surface_get_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  540. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  541. | :ref:`Array[]<class_Array>` | :ref:`mesh_surface_get_blend_shape_arrays<class_RenderingServer_method_mesh_surface_get_blend_shape_arrays>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  542. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  543. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_attribute_stride<class_RenderingServer_method_mesh_surface_get_format_attribute_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  544. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  545. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_offset<class_RenderingServer_method_mesh_surface_get_format_offset>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const| |
  546. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  547. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_skin_stride<class_RenderingServer_method_mesh_surface_get_format_skin_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  548. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  549. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_vertex_stride<class_RenderingServer_method_mesh_surface_get_format_vertex_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
  550. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  551. | :ref:`RID<class_RID>` | :ref:`mesh_surface_get_material<class_RenderingServer_method_mesh_surface_get_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const| |
  552. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  553. | void | :ref:`mesh_surface_set_material<class_RenderingServer_method_mesh_surface_set_material>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)** |
  554. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  555. | void | :ref:`mesh_surface_update_attribute_region<class_RenderingServer_method_mesh_surface_update_attribute_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  556. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  557. | void | :ref:`mesh_surface_update_skin_region<class_RenderingServer_method_mesh_surface_update_skin_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  558. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  559. | void | :ref:`mesh_surface_update_vertex_region<class_RenderingServer_method_mesh_surface_update_vertex_region>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  560. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  561. | void | :ref:`multimesh_allocate_data<class_RenderingServer_method_multimesh_allocate_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)** |
  562. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  563. | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>` **(** **)** |
  564. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  565. | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  566. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  567. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  568. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  569. | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  570. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  571. | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  572. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  573. | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
  574. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  575. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_color<class_RenderingServer_method_multimesh_instance_get_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  576. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  577. | :ref:`Color<class_Color>` | :ref:`multimesh_instance_get_custom_data<class_RenderingServer_method_multimesh_instance_get_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  578. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  579. | :ref:`Transform3D<class_Transform3D>` | :ref:`multimesh_instance_get_transform<class_RenderingServer_method_multimesh_instance_get_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  580. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  581. | :ref:`Transform2D<class_Transform2D>` | :ref:`multimesh_instance_get_transform_2d<class_RenderingServer_method_multimesh_instance_get_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const| |
  582. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  583. | void | :ref:`multimesh_instance_set_color<class_RenderingServer_method_multimesh_instance_set_color>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |
  584. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  585. | void | :ref:`multimesh_instance_set_custom_data<class_RenderingServer_method_multimesh_instance_set_custom_data>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)** |
  586. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  587. | void | :ref:`multimesh_instance_set_transform<class_RenderingServer_method_multimesh_instance_set_transform>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)** |
  588. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  589. | void | :ref:`multimesh_instance_set_transform_2d<class_RenderingServer_method_multimesh_instance_set_transform_2d>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)** |
  590. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  591. | void | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)** |
  592. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  593. | void | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>` **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)** |
  594. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  595. | void | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)** |
  596. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  597. | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>` **(** **)** |
  598. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  599. | void | :ref:`occluder_set_mesh<class_RenderingServer_method_occluder_set_mesh>` **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)** |
  600. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  601. | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>` **(** **)** |
  602. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  603. | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>` **(** **)** |
  604. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  605. | void | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>` **(** :ref:`RID<class_RID>` particles_collision **)** |
  606. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  607. | void | :ref:`particles_collision_set_attractor_attenuation<class_RenderingServer_method_particles_collision_set_attractor_attenuation>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)** |
  608. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  609. | void | :ref:`particles_collision_set_attractor_directionality<class_RenderingServer_method_particles_collision_set_attractor_directionality>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)** |
  610. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  611. | void | :ref:`particles_collision_set_attractor_strength<class_RenderingServer_method_particles_collision_set_attractor_strength>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` strength **)** |
  612. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  613. | void | :ref:`particles_collision_set_box_extents<class_RenderingServer_method_particles_collision_set_box_extents>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)** |
  614. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  615. | void | :ref:`particles_collision_set_collision_type<class_RenderingServer_method_particles_collision_set_collision_type>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)** |
  616. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  617. | void | :ref:`particles_collision_set_cull_mask<class_RenderingServer_method_particles_collision_set_cull_mask>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)** |
  618. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  619. | void | :ref:`particles_collision_set_field_texture<class_RenderingServer_method_particles_collision_set_field_texture>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)** |
  620. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  621. | void | :ref:`particles_collision_set_height_field_resolution<class_RenderingServer_method_particles_collision_set_height_field_resolution>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)** |
  622. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  623. | void | :ref:`particles_collision_set_sphere_radius<class_RenderingServer_method_particles_collision_set_sphere_radius>` **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)** |
  624. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  625. | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>` **(** **)** |
  626. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  627. | void | :ref:`particles_emit<class_RenderingServer_method_particles_emit>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)** |
  628. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  629. | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>` **(** :ref:`RID<class_RID>` particles **)** |
  630. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  631. | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
  632. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  633. | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
  634. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  635. | void | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
  636. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  637. | void | :ref:`particles_restart<class_RenderingServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
  638. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  639. | void | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
  640. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  641. | void | :ref:`particles_set_collision_base_size<class_RenderingServer_method_particles_set_collision_base_size>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)** |
  642. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  643. | void | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>` **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)** |
  644. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  645. | void | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)** |
  646. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  647. | void | :ref:`particles_set_draw_pass_mesh<class_RenderingServer_method_particles_set_draw_pass_mesh>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)** |
  648. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  649. | void | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)** |
  650. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  651. | void | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)** |
  652. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  653. | void | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)** |
  654. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  655. | void | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
  656. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  657. | void | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)** |
  658. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  659. | void | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  660. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  661. | void | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  662. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  663. | void | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)** |
  664. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  665. | void | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)** |
  666. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  667. | void | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)** |
  668. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  669. | void | :ref:`particles_set_pre_process_time<class_RenderingServer_method_particles_set_pre_process_time>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)** |
  670. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  671. | void | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)** |
  672. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  673. | void | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
  674. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  675. | void | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)** |
  676. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  677. | void | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)** |
  678. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  679. | void | :ref:`particles_set_trail_bind_poses<class_RenderingServer_method_particles_set_trail_bind_poses>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)** |
  680. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  681. | void | :ref:`particles_set_trails<class_RenderingServer_method_particles_set_trails>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)** |
  682. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  683. | void | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)** |
  684. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  685. | void | :ref:`particles_set_use_local_coordinates<class_RenderingServer_method_particles_set_use_local_coordinates>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
  686. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  687. | void | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
  688. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  689. | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>` **(** **)** |
  690. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  691. | void | :ref:`reflection_probe_set_ambient_color<class_RenderingServer_method_reflection_probe_set_ambient_color>` **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)** |
  692. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  693. | void | :ref:`reflection_probe_set_ambient_energy<class_RenderingServer_method_reflection_probe_set_ambient_energy>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)** |
  694. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  695. | void | :ref:`reflection_probe_set_ambient_mode<class_RenderingServer_method_reflection_probe_set_ambient_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)** |
  696. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  697. | void | :ref:`reflection_probe_set_as_interior<class_RenderingServer_method_reflection_probe_set_as_interior>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  698. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  699. | void | :ref:`reflection_probe_set_cull_mask<class_RenderingServer_method_reflection_probe_set_cull_mask>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)** |
  700. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  701. | void | :ref:`reflection_probe_set_enable_box_projection<class_RenderingServer_method_reflection_probe_set_enable_box_projection>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  702. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  703. | void | :ref:`reflection_probe_set_enable_shadows<class_RenderingServer_method_reflection_probe_set_enable_shadows>` **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)** |
  704. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  705. | void | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)** |
  706. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  707. | void | :ref:`reflection_probe_set_max_distance<class_RenderingServer_method_reflection_probe_set_max_distance>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)** |
  708. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  709. | void | :ref:`reflection_probe_set_mesh_lod_threshold<class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)** |
  710. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  711. | void | :ref:`reflection_probe_set_origin_offset<class_RenderingServer_method_reflection_probe_set_origin_offset>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)** |
  712. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  713. | void | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)** |
  714. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  715. | void | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)** |
  716. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  717. | void | :ref:`reflection_probe_set_update_mode<class_RenderingServer_method_reflection_probe_set_update_mode>` **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)** |
  718. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  719. | void | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>` **(** :ref:`Callable<class_Callable>` callable **)** |
  720. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  721. | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>` **(** **)** |
  722. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  723. | void | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)** |
  724. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  725. | void | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
  726. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  727. | void | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
  728. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  729. | void | :ref:`screen_space_roughness_limiter_set_active<class_RenderingServer_method_screen_space_roughness_limiter_set_active>` **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)** |
  730. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  731. | void | :ref:`set_boot_image<class_RenderingServer_method_set_boot_image>` **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)** |
  732. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  733. | void | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
  734. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  735. | void | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>` **(** :ref:`Color<class_Color>` color **)** |
  736. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  737. | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>` **(** **)** |
  738. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  739. | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>` **(** :ref:`RID<class_RID>` shader **)** |const| |
  740. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  741. | :ref:`RID<class_RID>` | :ref:`shader_get_default_texture_parameter<class_RenderingServer_method_shader_get_default_texture_parameter>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` index=0 **)** |const| |
  742. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  743. | :ref:`Variant<class_Variant>` | :ref:`shader_get_parameter_default<class_RenderingServer_method_shader_get_parameter_default>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name **)** |const| |
  744. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  745. | void | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)** |
  746. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  747. | void | :ref:`shader_set_default_texture_parameter<class_RenderingServer_method_shader_set_default_texture_parameter>` **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)** |
  748. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  749. | void | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)** |
  750. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  751. | void | :ref:`skeleton_allocate_data<class_RenderingServer_method_skeleton_allocate_data>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)** |
  752. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  753. | :ref:`Transform3D<class_Transform3D>` | :ref:`skeleton_bone_get_transform<class_RenderingServer_method_skeleton_bone_get_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
  754. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  755. | :ref:`Transform2D<class_Transform2D>` | :ref:`skeleton_bone_get_transform_2d<class_RenderingServer_method_skeleton_bone_get_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const| |
  756. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  757. | void | :ref:`skeleton_bone_set_transform<class_RenderingServer_method_skeleton_bone_set_transform>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)** |
  758. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  759. | void | :ref:`skeleton_bone_set_transform_2d<class_RenderingServer_method_skeleton_bone_set_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)** |
  760. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  761. | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>` **(** **)** |
  762. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  763. | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>` **(** :ref:`RID<class_RID>` skeleton **)** |const| |
  764. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  765. | void | :ref:`skeleton_set_base_transform_2d<class_RenderingServer_method_skeleton_set_base_transform_2d>` **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)** |
  766. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  767. | :ref:`Image<class_Image>` | :ref:`sky_bake_panorama<class_RenderingServer_method_sky_bake_panorama>` **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)** |
  768. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  769. | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>` **(** **)** |
  770. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  771. | void | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>` **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)** |
  772. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  773. | void | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>` **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)** |
  774. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  775. | void | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>` **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)** |
  776. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  777. | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>` **(** **)** |
  778. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  779. | void | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>` **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)** |
  780. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  781. | void | :ref:`sub_surface_scattering_set_scale<class_RenderingServer_method_sub_surface_scattering_set_scale>` **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)** |
  782. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  783. | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>` **(** :ref:`Image<class_Image>` image **)** |
  784. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  785. | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  786. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  787. | :ref:`Image<class_Image>` | :ref:`texture_2d_layer_get<class_RenderingServer_method_texture_2d_layer_get>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const| |
  788. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  789. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_create<class_RenderingServer_method_texture_2d_layered_create>` **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
  790. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  791. | :ref:`RID<class_RID>` | :ref:`texture_2d_layered_placeholder_create<class_RenderingServer_method_texture_2d_layered_placeholder_create>` **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)** |
  792. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  793. | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>` **(** **)** |
  794. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  795. | void | :ref:`texture_2d_update<class_RenderingServer_method_texture_2d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)** |
  796. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  797. | :ref:`RID<class_RID>` | :ref:`texture_3d_create<class_RenderingServer_method_texture_3d_create>` **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)** |
  798. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  799. | :ref:`Image[]<class_Image>` | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  800. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  801. | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>` **(** **)** |
  802. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  803. | void | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)** |
  804. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  805. | :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_RenderingServer_method_texture_get_format>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  806. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  807. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingServer_method_texture_get_native_handle>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const| |
  808. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  809. | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>` **(** :ref:`RID<class_RID>` texture **)** |const| |
  810. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  811. | :ref:`RID<class_RID>` | :ref:`texture_get_rd_texture<class_RenderingServer_method_texture_get_rd_texture>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const| |
  812. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  813. | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>` **(** :ref:`RID<class_RID>` base **)** |
  814. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  815. | void | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)** |
  816. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  817. | :ref:`RID<class_RID>` | :ref:`texture_rd_create<class_RenderingServer_method_texture_rd_create>` **(** :ref:`RID<class_RID>` rd_texture, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layer_type=0 **)** |
  818. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  819. | void | :ref:`texture_replace<class_RenderingServer_method_texture_replace>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)** |
  820. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  821. | void | :ref:`texture_set_force_redraw_if_visible<class_RenderingServer_method_texture_set_force_redraw_if_visible>` **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)** |
  822. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  823. | void | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>` **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)** |
  824. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  825. | void | :ref:`texture_set_size_override<class_RenderingServer_method_texture_set_size_override>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  826. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  827. | void | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)** |
  828. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  829. | void | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
  830. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  831. | void | :ref:`viewport_attach_to_screen<class_RenderingServer_method_viewport_attach_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)** |
  832. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  833. | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>` **(** **)** |
  834. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  835. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_cpu<class_RenderingServer_method_viewport_get_measured_render_time_cpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  836. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  837. | :ref:`float<class_float>` | :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  838. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  839. | :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)** |
  840. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  841. | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  842. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  843. | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
  844. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  845. | void | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
  846. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  847. | void | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)** |
  848. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  849. | void | :ref:`viewport_set_canvas_cull_mask<class_RenderingServer_method_viewport_set_canvas_cull_mask>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` canvas_cull_mask **)** |
  850. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  851. | void | :ref:`viewport_set_canvas_stacking<class_RenderingServer_method_viewport_set_canvas_stacking>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)** |
  852. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  853. | void | :ref:`viewport_set_canvas_transform<class_RenderingServer_method_viewport_set_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)** |
  854. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  855. | void | :ref:`viewport_set_clear_mode<class_RenderingServer_method_viewport_set_clear_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)** |
  856. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  857. | void | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)** |
  858. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  859. | void | :ref:`viewport_set_default_canvas_item_texture_filter<class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)** |
  860. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  861. | void | :ref:`viewport_set_default_canvas_item_texture_repeat<class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat>` **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)** |
  862. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  863. | void | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
  864. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  865. | void | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
  866. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  867. | void | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)** |
  868. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  869. | void | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)** |
  870. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  871. | void | :ref:`viewport_set_global_canvas_transform<class_RenderingServer_method_viewport_set_global_canvas_transform>` **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)** |
  872. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  873. | void | :ref:`viewport_set_measure_render_time<class_RenderingServer_method_viewport_set_measure_render_time>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  874. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  875. | void | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
  876. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  877. | void | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
  878. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  879. | void | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>` **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)** |
  880. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  881. | void | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>` **(** :ref:`int<class_int>` rays_per_thread **)** |
  882. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  883. | void | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)** |
  884. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  885. | void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision<class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)** |
  886. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  887. | void | :ref:`viewport_set_positional_shadow_atlas_size<class_RenderingServer_method_viewport_set_positional_shadow_atlas_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)** |
  888. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  889. | void | :ref:`viewport_set_render_direct_to_screen<class_RenderingServer_method_viewport_set_render_direct_to_screen>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  890. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  891. | void | :ref:`viewport_set_scaling_3d_mode<class_RenderingServer_method_viewport_set_scaling_3d_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)** |
  892. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  893. | void | :ref:`viewport_set_scaling_3d_scale<class_RenderingServer_method_viewport_set_scaling_3d_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)** |
  894. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  895. | void | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)** |
  896. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  897. | void | :ref:`viewport_set_screen_space_aa<class_RenderingServer_method_viewport_set_screen_space_aa>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)** |
  898. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  899. | void | :ref:`viewport_set_sdf_oversize_and_scale<class_RenderingServer_method_viewport_set_sdf_oversize_and_scale>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)** |
  900. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  901. | void | :ref:`viewport_set_size<class_RenderingServer_method_viewport_set_size>` **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  902. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  903. | void | :ref:`viewport_set_snap_2d_transforms_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  904. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  905. | void | :ref:`viewport_set_snap_2d_vertices_to_pixel<class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  906. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  907. | void | :ref:`viewport_set_texture_mipmap_bias<class_RenderingServer_method_viewport_set_texture_mipmap_bias>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)** |
  908. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  909. | void | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  910. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  911. | void | :ref:`viewport_set_update_mode<class_RenderingServer_method_viewport_set_update_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)** |
  912. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  913. | void | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  914. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  915. | void | :ref:`viewport_set_use_hdr_2d<class_RenderingServer_method_viewport_set_use_hdr_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
  916. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  917. | void | :ref:`viewport_set_use_occlusion_culling<class_RenderingServer_method_viewport_set_use_occlusion_culling>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  918. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  919. | void | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
  920. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  921. | void | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)** |
  922. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  923. | void | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)** |
  924. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  925. | void | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)** |
  926. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  927. | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>` **(** **)** |
  928. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  929. | void | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>` **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)** |
  930. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  931. | void | :ref:`visibility_notifier_set_callbacks<class_RenderingServer_method_visibility_notifier_set_callbacks>` **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)** |
  932. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  933. | void | :ref:`voxel_gi_allocate_data<class_RenderingServer_method_voxel_gi_allocate_data>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)** |
  934. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  935. | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>` **(** **)** |
  936. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  937. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_data_cells<class_RenderingServer_method_voxel_gi_get_data_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  938. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  939. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_distance_field<class_RenderingServer_method_voxel_gi_get_distance_field>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  940. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  941. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`voxel_gi_get_level_counts<class_RenderingServer_method_voxel_gi_get_level_counts>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  942. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  943. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`voxel_gi_get_octree_cells<class_RenderingServer_method_voxel_gi_get_octree_cells>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  944. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  945. | :ref:`Vector3i<class_Vector3i>` | :ref:`voxel_gi_get_octree_size<class_RenderingServer_method_voxel_gi_get_octree_size>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  946. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  947. | :ref:`Transform3D<class_Transform3D>` | :ref:`voxel_gi_get_to_cell_xform<class_RenderingServer_method_voxel_gi_get_to_cell_xform>` **(** :ref:`RID<class_RID>` voxel_gi **)** |const| |
  948. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  949. | void | :ref:`voxel_gi_set_baked_exposure_normalization<class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` baked_exposure **)** |
  950. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  951. | void | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
  952. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  953. | void | :ref:`voxel_gi_set_dynamic_range<class_RenderingServer_method_voxel_gi_set_dynamic_range>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)** |
  954. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  955. | void | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)** |
  956. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  957. | void | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
  958. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  959. | void | :ref:`voxel_gi_set_normal_bias<class_RenderingServer_method_voxel_gi_set_normal_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
  960. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  961. | void | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)** |
  962. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  963. | void | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>` **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)** |
  964. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  965. | void | :ref:`voxel_gi_set_use_two_bounces<class_RenderingServer_method_voxel_gi_set_use_two_bounces>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
  966. +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  967. .. rst-class:: classref-section-separator
  968. ----
  969. .. rst-class:: classref-descriptions-group
  970. Signals
  971. -------
  972. .. _class_RenderingServer_signal_frame_post_draw:
  973. .. rst-class:: classref-signal
  974. **frame_post_draw** **(** **)**
  975. Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
  976. .. rst-class:: classref-item-separator
  977. ----
  978. .. _class_RenderingServer_signal_frame_pre_draw:
  979. .. rst-class:: classref-signal
  980. **frame_pre_draw** **(** **)**
  981. Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
  982. .. rst-class:: classref-section-separator
  983. ----
  984. .. rst-class:: classref-descriptions-group
  985. Enumerations
  986. ------------
  987. .. _enum_RenderingServer_TextureLayeredType:
  988. .. rst-class:: classref-enumeration
  989. enum **TextureLayeredType**:
  990. .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
  993. Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
  994. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
  995. .. rst-class:: classref-enumeration-constant
  996. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
  997. Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
  998. .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
  999. .. rst-class:: classref-enumeration-constant
  1000. :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
  1001. Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
  1002. .. rst-class:: classref-item-separator
  1003. ----
  1004. .. _enum_RenderingServer_CubeMapLayer:
  1005. .. rst-class:: classref-enumeration
  1006. enum **CubeMapLayer**:
  1007. .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
  1008. .. rst-class:: classref-enumeration-constant
  1009. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
  1010. Left face of a :ref:`Cubemap<class_Cubemap>`.
  1011. .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
  1012. .. rst-class:: classref-enumeration-constant
  1013. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
  1014. Right face of a :ref:`Cubemap<class_Cubemap>`.
  1015. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
  1016. .. rst-class:: classref-enumeration-constant
  1017. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
  1018. Bottom face of a :ref:`Cubemap<class_Cubemap>`.
  1019. .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
  1020. .. rst-class:: classref-enumeration-constant
  1021. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
  1022. Top face of a :ref:`Cubemap<class_Cubemap>`.
  1023. .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
  1024. .. rst-class:: classref-enumeration-constant
  1025. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
  1026. Front face of a :ref:`Cubemap<class_Cubemap>`.
  1027. .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
  1028. .. rst-class:: classref-enumeration-constant
  1029. :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
  1030. Back face of a :ref:`Cubemap<class_Cubemap>`.
  1031. .. rst-class:: classref-item-separator
  1032. ----
  1033. .. _enum_RenderingServer_ShaderMode:
  1034. .. rst-class:: classref-enumeration
  1035. enum **ShaderMode**:
  1036. .. _class_RenderingServer_constant_SHADER_SPATIAL:
  1037. .. rst-class:: classref-enumeration-constant
  1038. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
  1039. Shader is a 3D shader.
  1040. .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
  1041. .. rst-class:: classref-enumeration-constant
  1042. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
  1043. Shader is a 2D shader.
  1044. .. _class_RenderingServer_constant_SHADER_PARTICLES:
  1045. .. rst-class:: classref-enumeration-constant
  1046. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
  1047. Shader is a particle shader (can be used in both 2D and 3D).
  1048. .. _class_RenderingServer_constant_SHADER_SKY:
  1049. .. rst-class:: classref-enumeration-constant
  1050. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
  1051. Shader is a 3D sky shader.
  1052. .. _class_RenderingServer_constant_SHADER_FOG:
  1053. .. rst-class:: classref-enumeration-constant
  1054. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
  1055. Shader is a 3D fog shader.
  1056. .. _class_RenderingServer_constant_SHADER_MAX:
  1057. .. rst-class:: classref-enumeration-constant
  1058. :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
  1059. Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
  1060. .. rst-class:: classref-item-separator
  1061. ----
  1062. .. _enum_RenderingServer_ArrayType:
  1063. .. rst-class:: classref-enumeration
  1064. enum **ArrayType**:
  1065. .. _class_RenderingServer_constant_ARRAY_VERTEX:
  1066. .. rst-class:: classref-enumeration-constant
  1067. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
  1068. Array is a vertex position array.
  1069. .. _class_RenderingServer_constant_ARRAY_NORMAL:
  1070. .. rst-class:: classref-enumeration-constant
  1071. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
  1072. Array is a normal array.
  1073. .. _class_RenderingServer_constant_ARRAY_TANGENT:
  1074. .. rst-class:: classref-enumeration-constant
  1075. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
  1076. Array is a tangent array.
  1077. .. _class_RenderingServer_constant_ARRAY_COLOR:
  1078. .. rst-class:: classref-enumeration-constant
  1079. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
  1080. Array is a vertex color array.
  1081. .. _class_RenderingServer_constant_ARRAY_TEX_UV:
  1082. .. rst-class:: classref-enumeration-constant
  1083. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
  1084. Array is a UV coordinates array.
  1085. .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
  1086. .. rst-class:: classref-enumeration-constant
  1087. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
  1088. Array is a UV coordinates array for the second set of UV coordinates.
  1089. .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
  1090. .. rst-class:: classref-enumeration-constant
  1091. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
  1092. Array is a custom data array for the first set of custom data.
  1093. .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
  1094. .. rst-class:: classref-enumeration-constant
  1095. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
  1096. Array is a custom data array for the second set of custom data.
  1097. .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
  1098. .. rst-class:: classref-enumeration-constant
  1099. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
  1100. Array is a custom data array for the third set of custom data.
  1101. .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
  1102. .. rst-class:: classref-enumeration-constant
  1103. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
  1104. Array is a custom data array for the fourth set of custom data.
  1105. .. _class_RenderingServer_constant_ARRAY_BONES:
  1106. .. rst-class:: classref-enumeration-constant
  1107. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
  1108. Array contains bone information.
  1109. .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
  1110. .. rst-class:: classref-enumeration-constant
  1111. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
  1112. Array is weight information.
  1113. .. _class_RenderingServer_constant_ARRAY_INDEX:
  1114. .. rst-class:: classref-enumeration-constant
  1115. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
  1116. Array is an index array.
  1117. .. _class_RenderingServer_constant_ARRAY_MAX:
  1118. .. rst-class:: classref-enumeration-constant
  1119. :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
  1120. Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
  1121. .. rst-class:: classref-item-separator
  1122. ----
  1123. .. _enum_RenderingServer_ArrayCustomFormat:
  1124. .. rst-class:: classref-enumeration
  1125. enum **ArrayCustomFormat**:
  1126. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
  1127. .. rst-class:: classref-enumeration-constant
  1128. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
  1129. 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.
  1130. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
  1131. .. rst-class:: classref-enumeration-constant
  1132. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
  1133. 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.
  1134. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
  1135. .. rst-class:: classref-enumeration-constant
  1136. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
  1137. Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
  1138. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
  1139. .. rst-class:: classref-enumeration-constant
  1140. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
  1141. Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
  1142. .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
  1143. .. rst-class:: classref-enumeration-constant
  1144. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
  1145. Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
  1146. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
  1147. .. rst-class:: classref-enumeration-constant
  1148. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
  1149. Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
  1150. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
  1151. .. rst-class:: classref-enumeration-constant
  1152. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
  1153. Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
  1154. .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
  1155. .. rst-class:: classref-enumeration-constant
  1156. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
  1157. Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
  1158. .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
  1159. .. rst-class:: classref-enumeration-constant
  1160. :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
  1161. Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
  1162. .. rst-class:: classref-item-separator
  1163. ----
  1164. .. _enum_RenderingServer_ArrayFormat:
  1165. .. rst-class:: classref-enumeration
  1166. flags **ArrayFormat**:
  1167. .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
  1168. .. rst-class:: classref-enumeration-constant
  1169. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
  1170. Flag used to mark a vertex position array.
  1171. .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
  1172. .. rst-class:: classref-enumeration-constant
  1173. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
  1174. Flag used to mark a normal array.
  1175. .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
  1176. .. rst-class:: classref-enumeration-constant
  1177. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
  1178. Flag used to mark a tangent array.
  1179. .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
  1180. .. rst-class:: classref-enumeration-constant
  1181. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
  1182. Flag used to mark a vertex color array.
  1183. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
  1184. .. rst-class:: classref-enumeration-constant
  1185. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
  1186. Flag used to mark a UV coordinates array.
  1187. .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
  1188. .. rst-class:: classref-enumeration-constant
  1189. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
  1190. Flag used to mark a UV coordinates array for the second UV coordinates.
  1191. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
  1192. .. rst-class:: classref-enumeration-constant
  1193. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
  1194. Flag used to mark an array of custom per-vertex data for the first set of custom data.
  1195. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
  1196. .. rst-class:: classref-enumeration-constant
  1197. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
  1198. Flag used to mark an array of custom per-vertex data for the second set of custom data.
  1199. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
  1200. .. rst-class:: classref-enumeration-constant
  1201. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
  1202. Flag used to mark an array of custom per-vertex data for the third set of custom data.
  1203. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
  1204. .. rst-class:: classref-enumeration-constant
  1205. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
  1206. Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
  1207. .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
  1208. .. rst-class:: classref-enumeration-constant
  1209. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
  1210. Flag used to mark a bone information array.
  1211. .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
  1212. .. rst-class:: classref-enumeration-constant
  1213. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
  1214. Flag used to mark a weights array.
  1215. .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
  1216. .. rst-class:: classref-enumeration-constant
  1217. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
  1218. Flag used to mark an index array.
  1219. .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
  1220. .. rst-class:: classref-enumeration-constant
  1221. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
  1222. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
  1223. .. rst-class:: classref-enumeration-constant
  1224. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
  1225. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
  1226. .. rst-class:: classref-enumeration-constant
  1227. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
  1228. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
  1229. .. rst-class:: classref-enumeration-constant
  1230. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
  1231. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
  1232. .. rst-class:: classref-enumeration-constant
  1233. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
  1234. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
  1235. .. rst-class:: classref-enumeration-constant
  1236. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
  1237. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
  1238. .. rst-class:: classref-enumeration-constant
  1239. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
  1240. .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
  1241. .. rst-class:: classref-enumeration-constant
  1242. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
  1243. .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
  1244. .. rst-class:: classref-enumeration-constant
  1245. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
  1246. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
  1247. .. rst-class:: classref-enumeration-constant
  1248. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
  1249. Flag used to mark that the array contains 2D vertices.
  1250. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
  1251. .. rst-class:: classref-enumeration-constant
  1252. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
  1253. .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
  1254. .. rst-class:: classref-enumeration-constant
  1255. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
  1256. Flag used to mark that the array uses 8 bone weighs instead of 4.
  1257. .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
  1258. .. rst-class:: classref-enumeration-constant
  1259. :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
  1260. .. rst-class:: classref-item-separator
  1261. ----
  1262. .. _enum_RenderingServer_PrimitiveType:
  1263. .. rst-class:: classref-enumeration
  1264. enum **PrimitiveType**:
  1265. .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
  1266. .. rst-class:: classref-enumeration-constant
  1267. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
  1268. Primitive to draw consists of points.
  1269. .. _class_RenderingServer_constant_PRIMITIVE_LINES:
  1270. .. rst-class:: classref-enumeration-constant
  1271. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
  1272. Primitive to draw consists of lines.
  1273. .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
  1274. .. rst-class:: classref-enumeration-constant
  1275. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
  1276. Primitive to draw consists of a line strip from start to end.
  1277. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
  1278. .. rst-class:: classref-enumeration-constant
  1279. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
  1280. Primitive to draw consists of triangles.
  1281. .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
  1282. .. rst-class:: classref-enumeration-constant
  1283. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
  1284. Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  1285. .. _class_RenderingServer_constant_PRIMITIVE_MAX:
  1286. .. rst-class:: classref-enumeration-constant
  1287. :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
  1288. Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _enum_RenderingServer_BlendShapeMode:
  1292. .. rst-class:: classref-enumeration
  1293. enum **BlendShapeMode**:
  1294. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
  1295. .. rst-class:: classref-enumeration-constant
  1296. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
  1297. Blend shapes are normalized.
  1298. .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
  1299. .. rst-class:: classref-enumeration-constant
  1300. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
  1301. Blend shapes are relative to base weight.
  1302. .. rst-class:: classref-item-separator
  1303. ----
  1304. .. _enum_RenderingServer_MultimeshTransformFormat:
  1305. .. rst-class:: classref-enumeration
  1306. enum **MultimeshTransformFormat**:
  1307. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
  1308. .. rst-class:: classref-enumeration-constant
  1309. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
  1310. Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
  1311. .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
  1312. .. rst-class:: classref-enumeration-constant
  1313. :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
  1314. Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _enum_RenderingServer_LightProjectorFilter:
  1318. .. rst-class:: classref-enumeration
  1319. enum **LightProjectorFilter**:
  1320. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
  1321. .. rst-class:: classref-enumeration-constant
  1322. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
  1323. 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.
  1324. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
  1325. .. rst-class:: classref-enumeration-constant
  1326. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
  1327. 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.
  1328. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
  1329. .. rst-class:: classref-enumeration-constant
  1330. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
  1331. 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.
  1332. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
  1335. 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.
  1336. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1337. .. rst-class:: classref-enumeration-constant
  1338. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1339. 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>`.
  1340. .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1341. .. rst-class:: classref-enumeration-constant
  1342. :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1343. 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>`.
  1344. .. rst-class:: classref-item-separator
  1345. ----
  1346. .. _enum_RenderingServer_LightType:
  1347. .. rst-class:: classref-enumeration
  1348. enum **LightType**:
  1349. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
  1350. .. rst-class:: classref-enumeration-constant
  1351. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
  1352. Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
  1353. .. _class_RenderingServer_constant_LIGHT_OMNI:
  1354. .. rst-class:: classref-enumeration-constant
  1355. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
  1356. Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
  1357. .. _class_RenderingServer_constant_LIGHT_SPOT:
  1358. .. rst-class:: classref-enumeration-constant
  1359. :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
  1360. Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _enum_RenderingServer_LightParam:
  1364. .. rst-class:: classref-enumeration
  1365. enum **LightParam**:
  1366. .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
  1367. .. rst-class:: classref-enumeration-constant
  1368. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
  1369. The light's energy multiplier.
  1370. .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
  1371. .. rst-class:: classref-enumeration-constant
  1372. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
  1373. 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>`).
  1374. .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
  1375. .. rst-class:: classref-enumeration-constant
  1376. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
  1377. 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>`).
  1378. .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
  1379. .. rst-class:: classref-enumeration-constant
  1380. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
  1381. The light's influence on specularity.
  1382. .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
  1383. .. rst-class:: classref-enumeration-constant
  1384. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
  1385. The light's range.
  1386. .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
  1387. .. rst-class:: classref-enumeration-constant
  1388. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
  1389. The size of the light when using spot light or omni light. The angular size of the light when using directional light.
  1390. .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
  1391. .. rst-class:: classref-enumeration-constant
  1392. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
  1393. The light's attenuation.
  1394. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
  1395. .. rst-class:: classref-enumeration-constant
  1396. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
  1397. The spotlight's angle.
  1398. .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
  1399. .. rst-class:: classref-enumeration-constant
  1400. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
  1401. The spotlight's attenuation.
  1402. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
  1403. .. rst-class:: classref-enumeration-constant
  1404. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
  1405. 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).
  1406. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
  1407. .. rst-class:: classref-enumeration-constant
  1408. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
  1409. Proportion of shadow atlas occupied by the first split.
  1410. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
  1411. .. rst-class:: classref-enumeration-constant
  1412. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
  1413. Proportion of shadow atlas occupied by the second split.
  1414. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
  1417. Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
  1418. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
  1421. Proportion of shadow max distance where the shadow will start to fade out.
  1422. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
  1423. .. rst-class:: classref-enumeration-constant
  1424. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
  1425. Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
  1426. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
  1427. .. rst-class:: classref-enumeration-constant
  1428. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
  1429. Bias the shadow lookup to fix self-shadowing artifacts.
  1430. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
  1431. .. rst-class:: classref-enumeration-constant
  1432. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
  1433. 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.
  1434. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
  1435. .. rst-class:: classref-enumeration-constant
  1436. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
  1437. 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.
  1438. .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
  1439. .. rst-class:: classref-enumeration-constant
  1440. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
  1441. 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.
  1442. .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
  1443. .. rst-class:: classref-enumeration-constant
  1444. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
  1445. .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
  1446. .. rst-class:: classref-enumeration-constant
  1447. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
  1448. 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``.
  1449. .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
  1450. .. rst-class:: classref-enumeration-constant
  1451. :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
  1452. Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _enum_RenderingServer_LightBakeMode:
  1456. .. rst-class:: classref-enumeration
  1457. enum **LightBakeMode**:
  1458. .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
  1459. .. rst-class:: classref-enumeration-constant
  1460. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
  1461. 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.
  1462. .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
  1463. .. rst-class:: classref-enumeration-constant
  1464. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
  1465. 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.
  1466. .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
  1467. .. rst-class:: classref-enumeration-constant
  1468. :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
  1469. 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>`.
  1470. .. rst-class:: classref-item-separator
  1471. ----
  1472. .. _enum_RenderingServer_LightOmniShadowMode:
  1473. .. rst-class:: classref-enumeration
  1474. enum **LightOmniShadowMode**:
  1475. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
  1476. .. rst-class:: classref-enumeration-constant
  1477. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
  1478. Use a dual paraboloid shadow map for omni lights.
  1479. .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
  1480. .. rst-class:: classref-enumeration-constant
  1481. :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
  1482. Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _enum_RenderingServer_LightDirectionalShadowMode:
  1486. .. rst-class:: classref-enumeration
  1487. enum **LightDirectionalShadowMode**:
  1488. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
  1489. .. rst-class:: classref-enumeration-constant
  1490. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
  1491. Use orthogonal shadow projection for directional light.
  1492. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
  1493. .. rst-class:: classref-enumeration-constant
  1494. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
  1495. Use 2 splits for shadow projection when using directional light.
  1496. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
  1497. .. rst-class:: classref-enumeration-constant
  1498. :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
  1499. Use 4 splits for shadow projection when using directional light.
  1500. .. rst-class:: classref-item-separator
  1501. ----
  1502. .. _enum_RenderingServer_LightDirectionalSkyMode:
  1503. .. rst-class:: classref-enumeration
  1504. enum **LightDirectionalSkyMode**:
  1505. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
  1506. .. rst-class:: classref-enumeration-constant
  1507. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
  1508. Use DirectionalLight3D in both sky rendering and scene lighting.
  1509. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
  1510. .. rst-class:: classref-enumeration-constant
  1511. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
  1512. Only use DirectionalLight3D in scene lighting.
  1513. .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
  1514. .. rst-class:: classref-enumeration-constant
  1515. :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
  1516. Only use DirectionalLight3D in sky rendering.
  1517. .. rst-class:: classref-item-separator
  1518. ----
  1519. .. _enum_RenderingServer_ShadowQuality:
  1520. .. rst-class:: classref-enumeration
  1521. enum **ShadowQuality**:
  1522. .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
  1523. .. rst-class:: classref-enumeration-constant
  1524. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
  1525. 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``.
  1526. \ **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.
  1527. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
  1528. .. rst-class:: classref-enumeration-constant
  1529. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
  1530. 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``).
  1531. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
  1532. .. rst-class:: classref-enumeration-constant
  1533. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
  1534. Low shadow filtering quality (fast).
  1535. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
  1536. .. rst-class:: classref-enumeration-constant
  1537. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
  1538. Medium low shadow filtering quality (average).
  1539. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
  1540. .. rst-class:: classref-enumeration-constant
  1541. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
  1542. 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``).
  1543. .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
  1544. .. rst-class:: classref-enumeration-constant
  1545. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
  1546. 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``).
  1547. .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
  1548. .. rst-class:: classref-enumeration-constant
  1549. :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
  1550. Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
  1551. .. rst-class:: classref-item-separator
  1552. ----
  1553. .. _enum_RenderingServer_ReflectionProbeUpdateMode:
  1554. .. rst-class:: classref-enumeration
  1555. enum **ReflectionProbeUpdateMode**:
  1556. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
  1557. .. rst-class:: classref-enumeration-constant
  1558. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
  1559. Reflection probe will update reflections once and then stop.
  1560. .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
  1561. .. rst-class:: classref-enumeration-constant
  1562. :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
  1563. Reflection probe will update each frame. This mode is necessary to capture moving objects.
  1564. .. rst-class:: classref-item-separator
  1565. ----
  1566. .. _enum_RenderingServer_ReflectionProbeAmbientMode:
  1567. .. rst-class:: classref-enumeration
  1568. enum **ReflectionProbeAmbientMode**:
  1569. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
  1570. .. rst-class:: classref-enumeration-constant
  1571. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
  1572. Do not apply any ambient lighting inside the reflection probe's box defined by its size.
  1573. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
  1574. .. rst-class:: classref-enumeration-constant
  1575. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
  1576. Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
  1577. .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
  1578. .. rst-class:: classref-enumeration-constant
  1579. :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
  1580. 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>`.
  1581. .. rst-class:: classref-item-separator
  1582. ----
  1583. .. _enum_RenderingServer_DecalTexture:
  1584. .. rst-class:: classref-enumeration
  1585. enum **DecalTexture**:
  1586. .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
  1587. .. rst-class:: classref-enumeration-constant
  1588. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
  1589. Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
  1590. .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
  1591. .. rst-class:: classref-enumeration-constant
  1592. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
  1593. Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
  1594. .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
  1595. .. rst-class:: classref-enumeration-constant
  1596. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
  1597. Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
  1598. .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
  1599. .. rst-class:: classref-enumeration-constant
  1600. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
  1601. Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
  1602. .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
  1603. .. rst-class:: classref-enumeration-constant
  1604. :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
  1605. Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
  1606. .. rst-class:: classref-item-separator
  1607. ----
  1608. .. _enum_RenderingServer_DecalFilter:
  1609. .. rst-class:: classref-enumeration
  1610. enum **DecalFilter**:
  1611. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
  1612. .. rst-class:: classref-enumeration-constant
  1613. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
  1614. 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.
  1615. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
  1616. .. rst-class:: classref-enumeration-constant
  1617. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
  1618. 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.
  1619. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
  1620. .. rst-class:: classref-enumeration-constant
  1621. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
  1622. 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.
  1623. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
  1624. .. rst-class:: classref-enumeration-constant
  1625. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
  1626. 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.
  1627. .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
  1628. .. rst-class:: classref-enumeration-constant
  1629. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
  1630. 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>`.
  1631. .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
  1632. .. rst-class:: classref-enumeration-constant
  1633. :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
  1634. 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>`.
  1635. .. rst-class:: classref-item-separator
  1636. ----
  1637. .. _enum_RenderingServer_VoxelGIQuality:
  1638. .. rst-class:: classref-enumeration
  1639. enum **VoxelGIQuality**:
  1640. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
  1641. .. rst-class:: classref-enumeration-constant
  1642. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
  1643. Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
  1644. .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
  1645. .. rst-class:: classref-enumeration-constant
  1646. :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
  1647. High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
  1648. .. rst-class:: classref-item-separator
  1649. ----
  1650. .. _enum_RenderingServer_ParticlesMode:
  1651. .. rst-class:: classref-enumeration
  1652. enum **ParticlesMode**:
  1653. .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
  1654. .. rst-class:: classref-enumeration-constant
  1655. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
  1656. 2D particles.
  1657. .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
  1658. .. rst-class:: classref-enumeration-constant
  1659. :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
  1660. 3D particles.
  1661. .. rst-class:: classref-item-separator
  1662. ----
  1663. .. _enum_RenderingServer_ParticlesTransformAlign:
  1664. .. rst-class:: classref-enumeration
  1665. enum **ParticlesTransformAlign**:
  1666. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
  1667. .. rst-class:: classref-enumeration-constant
  1668. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
  1669. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
  1670. .. rst-class:: classref-enumeration-constant
  1671. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
  1672. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
  1673. .. rst-class:: classref-enumeration-constant
  1674. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
  1675. .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
  1676. .. rst-class:: classref-enumeration-constant
  1677. :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
  1678. .. rst-class:: classref-item-separator
  1679. ----
  1680. .. _enum_RenderingServer_ParticlesDrawOrder:
  1681. .. rst-class:: classref-enumeration
  1682. enum **ParticlesDrawOrder**:
  1683. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
  1684. .. rst-class:: classref-enumeration-constant
  1685. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
  1686. Draw particles in the order that they appear in the particles array.
  1687. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
  1688. .. rst-class:: classref-enumeration-constant
  1689. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
  1690. Sort particles based on their lifetime.
  1691. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
  1692. .. rst-class:: classref-enumeration-constant
  1693. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
  1694. .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
  1695. .. rst-class:: classref-enumeration-constant
  1696. :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
  1697. Sort particles based on their distance to the camera.
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _enum_RenderingServer_ParticlesCollisionType:
  1701. .. rst-class:: classref-enumeration
  1702. enum **ParticlesCollisionType**:
  1703. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
  1704. .. rst-class:: classref-enumeration-constant
  1705. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
  1706. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
  1707. .. rst-class:: classref-enumeration-constant
  1708. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
  1709. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
  1710. .. rst-class:: classref-enumeration-constant
  1711. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
  1712. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
  1713. .. rst-class:: classref-enumeration-constant
  1714. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
  1715. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
  1716. .. rst-class:: classref-enumeration-constant
  1717. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
  1718. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
  1719. .. rst-class:: classref-enumeration-constant
  1720. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
  1721. .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
  1722. .. rst-class:: classref-enumeration-constant
  1723. :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
  1724. .. rst-class:: classref-item-separator
  1725. ----
  1726. .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
  1727. .. rst-class:: classref-enumeration
  1728. enum **ParticlesCollisionHeightfieldResolution**:
  1729. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
  1730. .. rst-class:: classref-enumeration-constant
  1731. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
  1732. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
  1733. .. rst-class:: classref-enumeration-constant
  1734. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
  1735. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
  1736. .. rst-class:: classref-enumeration-constant
  1737. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
  1738. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
  1739. .. rst-class:: classref-enumeration-constant
  1740. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
  1741. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
  1742. .. rst-class:: classref-enumeration-constant
  1743. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
  1744. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
  1745. .. rst-class:: classref-enumeration-constant
  1746. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
  1747. .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
  1748. .. rst-class:: classref-enumeration-constant
  1749. :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
  1750. Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
  1751. .. rst-class:: classref-item-separator
  1752. ----
  1753. .. _enum_RenderingServer_FogVolumeShape:
  1754. .. rst-class:: classref-enumeration
  1755. enum **FogVolumeShape**:
  1756. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
  1757. .. rst-class:: classref-enumeration-constant
  1758. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
  1759. :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
  1760. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
  1761. .. rst-class:: classref-enumeration-constant
  1762. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
  1763. :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).
  1764. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
  1765. .. rst-class:: classref-enumeration-constant
  1766. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
  1767. :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).
  1768. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
  1769. .. rst-class:: classref-enumeration-constant
  1770. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
  1771. :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
  1772. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
  1773. .. rst-class:: classref-enumeration-constant
  1774. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
  1775. :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
  1776. .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
  1777. .. rst-class:: classref-enumeration-constant
  1778. :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
  1779. Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
  1780. .. rst-class:: classref-item-separator
  1781. ----
  1782. .. _enum_RenderingServer_ViewportScaling3DMode:
  1783. .. rst-class:: classref-enumeration
  1784. enum **ViewportScaling3DMode**:
  1785. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
  1786. .. rst-class:: classref-enumeration-constant
  1787. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
  1788. 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.
  1789. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
  1790. .. rst-class:: classref-enumeration-constant
  1791. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
  1792. Use AMD FidelityFX Super Resolution 1.0 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` disables scaling.
  1793. .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
  1794. .. rst-class:: classref-enumeration-constant
  1795. :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``2``
  1796. Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
  1797. .. rst-class:: classref-item-separator
  1798. ----
  1799. .. _enum_RenderingServer_ViewportUpdateMode:
  1800. .. rst-class:: classref-enumeration
  1801. enum **ViewportUpdateMode**:
  1802. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
  1803. .. rst-class:: classref-enumeration-constant
  1804. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
  1805. Do not update the viewport's render target.
  1806. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
  1807. .. rst-class:: classref-enumeration-constant
  1808. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
  1809. Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
  1810. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
  1811. .. rst-class:: classref-enumeration-constant
  1812. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
  1813. Update the viewport's render target only when it is visible. This is the default value.
  1814. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
  1815. .. rst-class:: classref-enumeration-constant
  1816. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
  1817. Update the viewport's render target only when its parent is visible.
  1818. .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
  1819. .. rst-class:: classref-enumeration-constant
  1820. :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
  1821. Always update the viewport's render target.
  1822. .. rst-class:: classref-item-separator
  1823. ----
  1824. .. _enum_RenderingServer_ViewportClearMode:
  1825. .. rst-class:: classref-enumeration
  1826. enum **ViewportClearMode**:
  1827. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
  1828. .. rst-class:: classref-enumeration-constant
  1829. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
  1830. Always clear the viewport's render target before drawing.
  1831. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
  1832. .. rst-class:: classref-enumeration-constant
  1833. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
  1834. Never clear the viewport's render target.
  1835. .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
  1836. .. rst-class:: classref-enumeration-constant
  1837. :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
  1838. Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
  1839. .. rst-class:: classref-item-separator
  1840. ----
  1841. .. _enum_RenderingServer_ViewportEnvironmentMode:
  1842. .. rst-class:: classref-enumeration
  1843. enum **ViewportEnvironmentMode**:
  1844. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
  1845. .. rst-class:: classref-enumeration-constant
  1846. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
  1847. Disable rendering of 3D environment over 2D canvas.
  1848. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
  1849. .. rst-class:: classref-enumeration-constant
  1850. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
  1851. Enable rendering of 3D environment over 2D canvas.
  1852. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
  1853. .. rst-class:: classref-enumeration-constant
  1854. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
  1855. 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>`.
  1856. .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
  1857. .. rst-class:: classref-enumeration-constant
  1858. :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
  1859. Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
  1860. .. rst-class:: classref-item-separator
  1861. ----
  1862. .. _enum_RenderingServer_ViewportSDFOversize:
  1863. .. rst-class:: classref-enumeration
  1864. enum **ViewportSDFOversize**:
  1865. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
  1866. .. rst-class:: classref-enumeration-constant
  1867. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
  1868. 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.
  1869. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
  1870. .. rst-class:: classref-enumeration-constant
  1871. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
  1872. 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  1873. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
  1874. .. rst-class:: classref-enumeration-constant
  1875. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
  1876. 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
  1877. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
  1878. .. rst-class:: classref-enumeration-constant
  1879. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
  1880. 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.
  1881. .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
  1882. .. rst-class:: classref-enumeration-constant
  1883. :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
  1884. Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
  1885. .. rst-class:: classref-item-separator
  1886. ----
  1887. .. _enum_RenderingServer_ViewportSDFScale:
  1888. .. rst-class:: classref-enumeration
  1889. enum **ViewportSDFScale**:
  1890. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
  1891. .. rst-class:: classref-enumeration-constant
  1892. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
  1893. Full resolution 2D signed distance field scale. This has the highest GPU requirements.
  1894. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
  1895. .. rst-class:: classref-enumeration-constant
  1896. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
  1897. Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
  1898. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
  1899. .. rst-class:: classref-enumeration-constant
  1900. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
  1901. Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
  1902. .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
  1903. .. rst-class:: classref-enumeration-constant
  1904. :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
  1905. Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
  1906. .. rst-class:: classref-item-separator
  1907. ----
  1908. .. _enum_RenderingServer_ViewportMSAA:
  1909. .. rst-class:: classref-enumeration
  1910. enum **ViewportMSAA**:
  1911. .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
  1912. .. rst-class:: classref-enumeration-constant
  1913. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
  1914. Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
  1915. .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
  1916. .. rst-class:: classref-enumeration-constant
  1917. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
  1918. Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
  1919. .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
  1920. .. rst-class:: classref-enumeration-constant
  1921. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
  1922. Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
  1923. .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
  1924. .. rst-class:: classref-enumeration-constant
  1925. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
  1926. 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.
  1927. .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
  1928. .. rst-class:: classref-enumeration-constant
  1929. :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
  1930. Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
  1931. .. rst-class:: classref-item-separator
  1932. ----
  1933. .. _enum_RenderingServer_ViewportScreenSpaceAA:
  1934. .. rst-class:: classref-enumeration
  1935. enum **ViewportScreenSpaceAA**:
  1936. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
  1937. .. rst-class:: classref-enumeration-constant
  1938. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
  1939. Do not perform any antialiasing in the full screen post-process.
  1940. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
  1941. .. rst-class:: classref-enumeration-constant
  1942. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
  1943. 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.
  1944. .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
  1945. .. rst-class:: classref-enumeration-constant
  1946. :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2``
  1947. Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
  1948. .. rst-class:: classref-item-separator
  1949. ----
  1950. .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
  1951. .. rst-class:: classref-enumeration
  1952. enum **ViewportOcclusionCullingBuildQuality**:
  1953. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
  1954. .. rst-class:: classref-enumeration-constant
  1955. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
  1956. Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
  1957. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
  1958. .. rst-class:: classref-enumeration-constant
  1959. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
  1960. Medium occlusion culling BVH build quality (as defined by Embree).
  1961. .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
  1962. .. rst-class:: classref-enumeration-constant
  1963. :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
  1964. High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
  1965. .. rst-class:: classref-item-separator
  1966. ----
  1967. .. _enum_RenderingServer_ViewportRenderInfo:
  1968. .. rst-class:: classref-enumeration
  1969. enum **ViewportRenderInfo**:
  1970. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
  1971. .. rst-class:: classref-enumeration-constant
  1972. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
  1973. Number of objects drawn in a single frame.
  1974. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
  1975. .. rst-class:: classref-enumeration-constant
  1976. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
  1977. Number of points, lines, or triangles drawn in a single frame.
  1978. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
  1979. .. rst-class:: classref-enumeration-constant
  1980. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
  1981. Number of draw calls during this frame.
  1982. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
  1983. .. rst-class:: classref-enumeration-constant
  1984. :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
  1985. Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
  1986. .. rst-class:: classref-item-separator
  1987. ----
  1988. .. _enum_RenderingServer_ViewportRenderInfoType:
  1989. .. rst-class:: classref-enumeration
  1990. enum **ViewportRenderInfoType**:
  1991. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
  1992. .. rst-class:: classref-enumeration-constant
  1993. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
  1994. Visible render pass (excluding shadows).
  1995. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
  1996. .. rst-class:: classref-enumeration-constant
  1997. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
  1998. 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.
  1999. .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
  2000. .. rst-class:: classref-enumeration-constant
  2001. :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``2``
  2002. Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _enum_RenderingServer_ViewportDebugDraw:
  2006. .. rst-class:: classref-enumeration
  2007. enum **ViewportDebugDraw**:
  2008. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
  2009. .. rst-class:: classref-enumeration-constant
  2010. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
  2011. Debug draw is disabled. Default setting.
  2012. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
  2013. .. rst-class:: classref-enumeration-constant
  2014. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
  2015. Objects are displayed without light information.
  2016. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
  2017. .. rst-class:: classref-enumeration-constant
  2018. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
  2019. Objects are displayed with only light information.
  2020. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
  2021. .. rst-class:: classref-enumeration-constant
  2022. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
  2023. 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.
  2024. \ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
  2025. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
  2026. .. rst-class:: classref-enumeration-constant
  2027. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
  2028. Debug draw draws objects in wireframe.
  2029. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
  2030. .. rst-class:: classref-enumeration-constant
  2031. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
  2032. Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
  2033. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
  2034. .. rst-class:: classref-enumeration-constant
  2035. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
  2036. Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2037. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
  2038. .. rst-class:: classref-enumeration-constant
  2039. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
  2040. Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2041. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
  2042. .. rst-class:: classref-enumeration-constant
  2043. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
  2044. Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
  2045. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
  2046. .. rst-class:: classref-enumeration-constant
  2047. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
  2048. 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>`.
  2049. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
  2050. .. rst-class:: classref-enumeration-constant
  2051. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
  2052. Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
  2053. 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.
  2054. The last cascade shows all frustum slices to illustrate the coverage of all slices.
  2055. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
  2056. .. rst-class:: classref-enumeration-constant
  2057. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
  2058. Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
  2059. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
  2060. .. rst-class:: classref-enumeration-constant
  2061. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
  2062. 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>`.
  2063. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
  2064. .. rst-class:: classref-enumeration-constant
  2065. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
  2066. 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>`.
  2067. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
  2068. .. rst-class:: classref-enumeration-constant
  2069. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
  2070. Colors each PSSM split for the :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the scene a different color so you can see where the splits are. In order they will be colored red, green, blue, yellow.
  2071. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
  2072. .. rst-class:: classref-enumeration-constant
  2073. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
  2074. Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
  2075. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
  2076. .. rst-class:: classref-enumeration-constant
  2077. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
  2078. Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
  2079. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
  2080. .. rst-class:: classref-enumeration-constant
  2081. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
  2082. Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
  2083. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
  2084. .. rst-class:: classref-enumeration-constant
  2085. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
  2086. Draws the global illumination buffer (:ref:`VoxelGI<class_VoxelGI>` or SDFGI).
  2087. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
  2088. .. rst-class:: classref-enumeration-constant
  2089. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
  2090. Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
  2091. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
  2092. .. rst-class:: classref-enumeration-constant
  2093. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
  2094. 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.
  2095. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
  2096. .. rst-class:: classref-enumeration-constant
  2097. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
  2098. 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.
  2099. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
  2100. .. rst-class:: classref-enumeration-constant
  2101. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
  2102. 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.
  2103. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
  2104. .. rst-class:: classref-enumeration-constant
  2105. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
  2106. 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.
  2107. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
  2108. .. rst-class:: classref-enumeration-constant
  2109. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
  2110. 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.
  2111. .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
  2112. .. rst-class:: classref-enumeration-constant
  2113. :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
  2114. Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
  2115. .. rst-class:: classref-item-separator
  2116. ----
  2117. .. _enum_RenderingServer_ViewportVRSMode:
  2118. .. rst-class:: classref-enumeration
  2119. enum **ViewportVRSMode**:
  2120. .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
  2121. .. rst-class:: classref-enumeration-constant
  2122. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
  2123. Variable rate shading is disabled.
  2124. .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
  2125. .. rst-class:: classref-enumeration-constant
  2126. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
  2127. Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
  2128. .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
  2129. .. rst-class:: classref-enumeration-constant
  2130. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
  2131. Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`.
  2132. .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
  2133. .. rst-class:: classref-enumeration-constant
  2134. :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
  2135. Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _enum_RenderingServer_SkyMode:
  2139. .. rst-class:: classref-enumeration
  2140. enum **SkyMode**:
  2141. .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
  2142. .. rst-class:: classref-enumeration-constant
  2143. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
  2144. 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>`.
  2145. .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
  2146. .. rst-class:: classref-enumeration-constant
  2147. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
  2148. 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>`.
  2149. .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
  2150. .. rst-class:: classref-enumeration-constant
  2151. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
  2152. 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.
  2153. .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
  2154. .. rst-class:: classref-enumeration-constant
  2155. :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
  2156. 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>`.
  2157. \ **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.
  2158. .. rst-class:: classref-item-separator
  2159. ----
  2160. .. _enum_RenderingServer_EnvironmentBG:
  2161. .. rst-class:: classref-enumeration
  2162. enum **EnvironmentBG**:
  2163. .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
  2164. .. rst-class:: classref-enumeration-constant
  2165. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
  2166. Use the clear color as background.
  2167. .. _class_RenderingServer_constant_ENV_BG_COLOR:
  2168. .. rst-class:: classref-enumeration-constant
  2169. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
  2170. Use a specified color as the background.
  2171. .. _class_RenderingServer_constant_ENV_BG_SKY:
  2172. .. rst-class:: classref-enumeration-constant
  2173. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
  2174. Use a sky resource for the background.
  2175. .. _class_RenderingServer_constant_ENV_BG_CANVAS:
  2176. .. rst-class:: classref-enumeration-constant
  2177. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
  2178. Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
  2179. .. _class_RenderingServer_constant_ENV_BG_KEEP:
  2180. .. rst-class:: classref-enumeration-constant
  2181. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
  2182. Do not clear the background, use whatever was rendered last frame as the background.
  2183. .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
  2184. .. rst-class:: classref-enumeration-constant
  2185. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
  2186. Displays a camera feed in the background.
  2187. .. _class_RenderingServer_constant_ENV_BG_MAX:
  2188. .. rst-class:: classref-enumeration-constant
  2189. :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
  2190. Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
  2191. .. rst-class:: classref-item-separator
  2192. ----
  2193. .. _enum_RenderingServer_EnvironmentAmbientSource:
  2194. .. rst-class:: classref-enumeration
  2195. enum **EnvironmentAmbientSource**:
  2196. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
  2197. .. rst-class:: classref-enumeration-constant
  2198. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
  2199. Gather ambient light from whichever source is specified as the background.
  2200. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
  2201. .. rst-class:: classref-enumeration-constant
  2202. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
  2203. Disable ambient light.
  2204. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
  2205. .. rst-class:: classref-enumeration-constant
  2206. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
  2207. Specify a specific :ref:`Color<class_Color>` for ambient light.
  2208. .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
  2209. .. rst-class:: classref-enumeration-constant
  2210. :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
  2211. Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
  2212. .. rst-class:: classref-item-separator
  2213. ----
  2214. .. _enum_RenderingServer_EnvironmentReflectionSource:
  2215. .. rst-class:: classref-enumeration
  2216. enum **EnvironmentReflectionSource**:
  2217. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
  2218. .. rst-class:: classref-enumeration-constant
  2219. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
  2220. Use the background for reflections.
  2221. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
  2222. .. rst-class:: classref-enumeration-constant
  2223. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
  2224. Disable reflections.
  2225. .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
  2226. .. rst-class:: classref-enumeration-constant
  2227. :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
  2228. Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
  2229. .. rst-class:: classref-item-separator
  2230. ----
  2231. .. _enum_RenderingServer_EnvironmentGlowBlendMode:
  2232. .. rst-class:: classref-enumeration
  2233. enum **EnvironmentGlowBlendMode**:
  2234. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
  2235. .. rst-class:: classref-enumeration-constant
  2236. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
  2237. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  2238. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
  2239. .. rst-class:: classref-enumeration-constant
  2240. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
  2241. Screen glow blending mode. Increases brightness, used frequently with bloom.
  2242. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
  2243. .. rst-class:: classref-enumeration-constant
  2244. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
  2245. Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
  2246. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
  2247. .. rst-class:: classref-enumeration-constant
  2248. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
  2249. 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.
  2250. .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
  2251. .. rst-class:: classref-enumeration-constant
  2252. :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
  2253. Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
  2254. .. rst-class:: classref-item-separator
  2255. ----
  2256. .. _enum_RenderingServer_EnvironmentToneMapper:
  2257. .. rst-class:: classref-enumeration
  2258. enum **EnvironmentToneMapper**:
  2259. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
  2260. .. rst-class:: classref-enumeration-constant
  2261. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
  2262. Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
  2263. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
  2264. .. rst-class:: classref-enumeration-constant
  2265. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
  2266. Use the Reinhard tonemapper. Performs a variation on rendered pixels' colors by this formula: ``color = color / (1 + color)``. This avoids clipping bright highlights, but the resulting image can look a bit dull.
  2267. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
  2268. .. rst-class:: classref-enumeration-constant
  2269. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
  2270. Use the filmic tonemapper. This avoids clipping bright highlights, with a resulting image that usually looks more vivid than :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>`.
  2271. .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
  2272. .. rst-class:: classref-enumeration-constant
  2273. :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
  2274. Use the Academy Color Encoding System tonemapper. ACES is slightly more expensive than other options, but it handles bright lighting in a more realistic fashion by desaturating it as it becomes brighter. ACES typically has a more contrasted output compared to :ref:`ENV_TONE_MAPPER_REINHARD<class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD>` and :ref:`ENV_TONE_MAPPER_FILMIC<class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC>`.
  2275. \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
  2276. .. rst-class:: classref-item-separator
  2277. ----
  2278. .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
  2279. .. rst-class:: classref-enumeration
  2280. enum **EnvironmentSSRRoughnessQuality**:
  2281. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
  2282. .. rst-class:: classref-enumeration-constant
  2283. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
  2284. 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.
  2285. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
  2286. .. rst-class:: classref-enumeration-constant
  2287. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
  2288. Low quality of roughness filter for screen-space reflections.
  2289. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
  2290. .. rst-class:: classref-enumeration-constant
  2291. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
  2292. Medium quality of roughness filter for screen-space reflections.
  2293. .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
  2294. .. rst-class:: classref-enumeration-constant
  2295. :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
  2296. High quality of roughness filter for screen-space reflections. This is the slowest option.
  2297. .. rst-class:: classref-item-separator
  2298. ----
  2299. .. _enum_RenderingServer_EnvironmentSSAOQuality:
  2300. .. rst-class:: classref-enumeration
  2301. enum **EnvironmentSSAOQuality**:
  2302. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
  2303. .. rst-class:: classref-enumeration-constant
  2304. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
  2305. Lowest quality of screen-space ambient occlusion.
  2306. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
  2307. .. rst-class:: classref-enumeration-constant
  2308. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
  2309. Low quality screen-space ambient occlusion.
  2310. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
  2311. .. rst-class:: classref-enumeration-constant
  2312. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
  2313. Medium quality screen-space ambient occlusion.
  2314. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
  2315. .. rst-class:: classref-enumeration-constant
  2316. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
  2317. High quality screen-space ambient occlusion.
  2318. .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
  2319. .. rst-class:: classref-enumeration-constant
  2320. :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
  2321. Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2322. .. rst-class:: classref-item-separator
  2323. ----
  2324. .. _enum_RenderingServer_EnvironmentSSILQuality:
  2325. .. rst-class:: classref-enumeration
  2326. enum **EnvironmentSSILQuality**:
  2327. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
  2328. .. rst-class:: classref-enumeration-constant
  2329. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
  2330. Lowest quality of screen-space indirect lighting.
  2331. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
  2332. .. rst-class:: classref-enumeration-constant
  2333. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
  2334. Low quality screen-space indirect lighting.
  2335. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
  2336. .. rst-class:: classref-enumeration-constant
  2337. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
  2338. High quality screen-space indirect lighting.
  2339. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
  2340. .. rst-class:: classref-enumeration-constant
  2341. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
  2342. High quality screen-space indirect lighting.
  2343. .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
  2344. .. rst-class:: classref-enumeration-constant
  2345. :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
  2346. Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
  2347. .. rst-class:: classref-item-separator
  2348. ----
  2349. .. _enum_RenderingServer_EnvironmentSDFGIYScale:
  2350. .. rst-class:: classref-enumeration
  2351. enum **EnvironmentSDFGIYScale**:
  2352. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
  2353. .. rst-class:: classref-enumeration-constant
  2354. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
  2355. 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.
  2356. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
  2357. .. rst-class:: classref-enumeration-constant
  2358. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
  2359. Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
  2360. .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
  2361. .. rst-class:: classref-enumeration-constant
  2362. :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
  2363. 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.
  2364. .. rst-class:: classref-item-separator
  2365. ----
  2366. .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
  2367. .. rst-class:: classref-enumeration
  2368. enum **EnvironmentSDFGIRayCount**:
  2369. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
  2370. .. rst-class:: classref-enumeration-constant
  2371. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
  2372. Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
  2373. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
  2374. .. rst-class:: classref-enumeration-constant
  2375. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
  2376. Throw 8 rays per frame when converging SDFGI.
  2377. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
  2378. .. rst-class:: classref-enumeration-constant
  2379. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
  2380. Throw 16 rays per frame when converging SDFGI.
  2381. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
  2382. .. rst-class:: classref-enumeration-constant
  2383. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
  2384. Throw 32 rays per frame when converging SDFGI.
  2385. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
  2386. .. rst-class:: classref-enumeration-constant
  2387. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
  2388. Throw 64 rays per frame when converging SDFGI.
  2389. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
  2390. .. rst-class:: classref-enumeration-constant
  2391. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
  2392. Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
  2393. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
  2394. .. rst-class:: classref-enumeration-constant
  2395. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
  2396. Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
  2397. .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
  2398. .. rst-class:: classref-enumeration-constant
  2399. :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
  2400. Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
  2401. .. rst-class:: classref-item-separator
  2402. ----
  2403. .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
  2404. .. rst-class:: classref-enumeration
  2405. enum **EnvironmentSDFGIFramesToConverge**:
  2406. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
  2407. .. rst-class:: classref-enumeration-constant
  2408. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
  2409. Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
  2410. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
  2411. .. rst-class:: classref-enumeration-constant
  2412. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
  2413. Configure SDFGI to fully converge over 10 frames.
  2414. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
  2415. .. rst-class:: classref-enumeration-constant
  2416. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
  2417. Configure SDFGI to fully converge over 15 frames.
  2418. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
  2419. .. rst-class:: classref-enumeration-constant
  2420. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
  2421. Configure SDFGI to fully converge over 20 frames.
  2422. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
  2423. .. rst-class:: classref-enumeration-constant
  2424. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
  2425. Configure SDFGI to fully converge over 25 frames.
  2426. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
  2427. .. rst-class:: classref-enumeration-constant
  2428. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
  2429. Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
  2430. .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
  2431. .. rst-class:: classref-enumeration-constant
  2432. :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
  2433. Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
  2434. .. rst-class:: classref-item-separator
  2435. ----
  2436. .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
  2437. .. rst-class:: classref-enumeration
  2438. enum **EnvironmentSDFGIFramesToUpdateLight**:
  2439. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
  2440. .. rst-class:: classref-enumeration-constant
  2441. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
  2442. Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
  2443. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
  2444. .. rst-class:: classref-enumeration-constant
  2445. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
  2446. Update indirect light from dynamic lights in SDFGI over 2 frames.
  2447. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
  2448. .. rst-class:: classref-enumeration-constant
  2449. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
  2450. Update indirect light from dynamic lights in SDFGI over 4 frames.
  2451. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
  2452. .. rst-class:: classref-enumeration-constant
  2453. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
  2454. Update indirect light from dynamic lights in SDFGI over 8 frames.
  2455. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
  2456. .. rst-class:: classref-enumeration-constant
  2457. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
  2458. Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
  2459. .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
  2460. .. rst-class:: classref-enumeration-constant
  2461. :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
  2462. Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
  2463. .. rst-class:: classref-item-separator
  2464. ----
  2465. .. _enum_RenderingServer_SubSurfaceScatteringQuality:
  2466. .. rst-class:: classref-enumeration
  2467. enum **SubSurfaceScatteringQuality**:
  2468. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
  2469. .. rst-class:: classref-enumeration-constant
  2470. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
  2471. 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.
  2472. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
  2473. .. rst-class:: classref-enumeration-constant
  2474. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
  2475. Low subsurface scattering quality.
  2476. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
  2477. .. rst-class:: classref-enumeration-constant
  2478. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
  2479. Medium subsurface scattering quality.
  2480. .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
  2481. .. rst-class:: classref-enumeration-constant
  2482. :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
  2483. High subsurface scattering quality. This has the highest GPU requirements.
  2484. .. rst-class:: classref-item-separator
  2485. ----
  2486. .. _enum_RenderingServer_DOFBokehShape:
  2487. .. rst-class:: classref-enumeration
  2488. enum **DOFBokehShape**:
  2489. .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
  2490. .. rst-class:: classref-enumeration-constant
  2491. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
  2492. Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
  2493. .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
  2494. .. rst-class:: classref-enumeration-constant
  2495. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
  2496. Calculates DOF blur using a hexagon shaped filter.
  2497. .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
  2498. .. rst-class:: classref-enumeration-constant
  2499. :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
  2500. 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).
  2501. .. rst-class:: classref-item-separator
  2502. ----
  2503. .. _enum_RenderingServer_DOFBlurQuality:
  2504. .. rst-class:: classref-enumeration
  2505. enum **DOFBlurQuality**:
  2506. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
  2507. .. rst-class:: classref-enumeration-constant
  2508. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
  2509. Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
  2510. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
  2511. .. rst-class:: classref-enumeration-constant
  2512. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
  2513. Low quality DOF blur.
  2514. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
  2515. .. rst-class:: classref-enumeration-constant
  2516. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
  2517. Medium quality DOF blur.
  2518. .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
  2519. .. rst-class:: classref-enumeration-constant
  2520. :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
  2521. Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
  2522. .. rst-class:: classref-item-separator
  2523. ----
  2524. .. _enum_RenderingServer_InstanceType:
  2525. .. rst-class:: classref-enumeration
  2526. enum **InstanceType**:
  2527. .. _class_RenderingServer_constant_INSTANCE_NONE:
  2528. .. rst-class:: classref-enumeration-constant
  2529. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
  2530. The instance does not have a type.
  2531. .. _class_RenderingServer_constant_INSTANCE_MESH:
  2532. .. rst-class:: classref-enumeration-constant
  2533. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
  2534. The instance is a mesh.
  2535. .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
  2536. .. rst-class:: classref-enumeration-constant
  2537. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
  2538. The instance is a multimesh.
  2539. .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
  2540. .. rst-class:: classref-enumeration-constant
  2541. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
  2542. The instance is a particle emitter.
  2543. .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
  2544. .. rst-class:: classref-enumeration-constant
  2545. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
  2546. The instance is a GPUParticles collision shape.
  2547. .. _class_RenderingServer_constant_INSTANCE_LIGHT:
  2548. .. rst-class:: classref-enumeration-constant
  2549. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
  2550. The instance is a light.
  2551. .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
  2552. .. rst-class:: classref-enumeration-constant
  2553. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
  2554. The instance is a reflection probe.
  2555. .. _class_RenderingServer_constant_INSTANCE_DECAL:
  2556. .. rst-class:: classref-enumeration-constant
  2557. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
  2558. The instance is a decal.
  2559. .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
  2560. .. rst-class:: classref-enumeration-constant
  2561. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
  2562. The instance is a VoxelGI.
  2563. .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
  2564. .. rst-class:: classref-enumeration-constant
  2565. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
  2566. The instance is a lightmap.
  2567. .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
  2568. .. rst-class:: classref-enumeration-constant
  2569. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
  2570. The instance is an occlusion culling occluder.
  2571. .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
  2572. .. rst-class:: classref-enumeration-constant
  2573. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
  2574. The instance is a visible on-screen notifier.
  2575. .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
  2576. .. rst-class:: classref-enumeration-constant
  2577. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
  2578. The instance is a fog volume.
  2579. .. _class_RenderingServer_constant_INSTANCE_MAX:
  2580. .. rst-class:: classref-enumeration-constant
  2581. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
  2582. Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
  2583. .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
  2584. .. rst-class:: classref-enumeration-constant
  2585. :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
  2586. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  2587. .. rst-class:: classref-item-separator
  2588. ----
  2589. .. _enum_RenderingServer_InstanceFlags:
  2590. .. rst-class:: classref-enumeration
  2591. enum **InstanceFlags**:
  2592. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
  2593. .. rst-class:: classref-enumeration-constant
  2594. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
  2595. Allows the instance to be used in baked lighting.
  2596. .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
  2597. .. rst-class:: classref-enumeration-constant
  2598. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
  2599. Allows the instance to be used with dynamic global illumination.
  2600. .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
  2601. .. rst-class:: classref-enumeration-constant
  2602. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
  2603. When set, manually requests to draw geometry on next frame.
  2604. .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
  2605. .. rst-class:: classref-enumeration-constant
  2606. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
  2607. Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
  2608. .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
  2609. .. rst-class:: classref-enumeration-constant
  2610. :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
  2611. Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
  2612. .. rst-class:: classref-item-separator
  2613. ----
  2614. .. _enum_RenderingServer_ShadowCastingSetting:
  2615. .. rst-class:: classref-enumeration
  2616. enum **ShadowCastingSetting**:
  2617. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
  2618. .. rst-class:: classref-enumeration-constant
  2619. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
  2620. Disable shadows from this instance.
  2621. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
  2622. .. rst-class:: classref-enumeration-constant
  2623. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
  2624. Cast shadows from this instance.
  2625. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
  2626. .. rst-class:: classref-enumeration-constant
  2627. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
  2628. Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
  2629. .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
  2630. .. rst-class:: classref-enumeration-constant
  2631. :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
  2632. Only render the shadows from the object. The object itself will not be drawn.
  2633. .. rst-class:: classref-item-separator
  2634. ----
  2635. .. _enum_RenderingServer_VisibilityRangeFadeMode:
  2636. .. rst-class:: classref-enumeration
  2637. enum **VisibilityRangeFadeMode**:
  2638. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
  2639. .. rst-class:: classref-enumeration-constant
  2640. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
  2641. Disable visibility range fading for the given instance.
  2642. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
  2643. .. rst-class:: classref-enumeration-constant
  2644. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
  2645. Fade-out the given instance when it approaches its visibility range limits.
  2646. .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
  2647. .. rst-class:: classref-enumeration-constant
  2648. :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
  2649. Fade-in the given instance's dependencies when reaching its visibility range limits.
  2650. .. rst-class:: classref-item-separator
  2651. ----
  2652. .. _enum_RenderingServer_BakeChannels:
  2653. .. rst-class:: classref-enumeration
  2654. enum **BakeChannels**:
  2655. .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
  2656. .. rst-class:: classref-enumeration-constant
  2657. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
  2658. 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.
  2659. .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
  2660. .. rst-class:: classref-enumeration-constant
  2661. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
  2662. 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``.
  2663. .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
  2664. .. rst-class:: classref-enumeration-constant
  2665. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
  2666. 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.
  2667. .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
  2668. .. rst-class:: classref-enumeration-constant
  2669. :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
  2670. 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.
  2671. .. rst-class:: classref-item-separator
  2672. ----
  2673. .. _enum_RenderingServer_CanvasTextureChannel:
  2674. .. rst-class:: classref-enumeration
  2675. enum **CanvasTextureChannel**:
  2676. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
  2677. .. rst-class:: classref-enumeration-constant
  2678. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
  2679. Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
  2680. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
  2681. .. rst-class:: classref-enumeration-constant
  2682. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
  2683. Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
  2684. .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
  2685. .. rst-class:: classref-enumeration-constant
  2686. :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
  2687. Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
  2688. .. rst-class:: classref-item-separator
  2689. ----
  2690. .. _enum_RenderingServer_NinePatchAxisMode:
  2691. .. rst-class:: classref-enumeration
  2692. enum **NinePatchAxisMode**:
  2693. .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
  2694. .. rst-class:: classref-enumeration-constant
  2695. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
  2696. The nine patch gets stretched where needed.
  2697. .. _class_RenderingServer_constant_NINE_PATCH_TILE:
  2698. .. rst-class:: classref-enumeration-constant
  2699. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
  2700. The nine patch gets filled with tiles where needed.
  2701. .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
  2702. .. rst-class:: classref-enumeration-constant
  2703. :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
  2704. The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  2705. .. rst-class:: classref-item-separator
  2706. ----
  2707. .. _enum_RenderingServer_CanvasItemTextureFilter:
  2708. .. rst-class:: classref-enumeration
  2709. enum **CanvasItemTextureFilter**:
  2710. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
  2711. .. rst-class:: classref-enumeration-constant
  2712. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
  2713. Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
  2714. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
  2715. .. rst-class:: classref-enumeration-constant
  2716. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
  2717. The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
  2718. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
  2719. .. rst-class:: classref-enumeration-constant
  2720. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
  2721. The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
  2722. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
  2723. .. rst-class:: classref-enumeration-constant
  2724. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
  2725. The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
  2726. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
  2727. .. rst-class:: classref-enumeration-constant
  2728. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
  2729. The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps.
  2730. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
  2731. .. rst-class:: classref-enumeration-constant
  2732. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
  2733. The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera.
  2734. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
  2735. .. rst-class:: classref-enumeration-constant
  2736. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
  2737. The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing.
  2738. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
  2739. .. rst-class:: classref-enumeration-constant
  2740. :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
  2741. Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
  2742. .. rst-class:: classref-item-separator
  2743. ----
  2744. .. _enum_RenderingServer_CanvasItemTextureRepeat:
  2745. .. rst-class:: classref-enumeration
  2746. enum **CanvasItemTextureRepeat**:
  2747. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
  2748. .. rst-class:: classref-enumeration-constant
  2749. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
  2750. Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
  2751. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
  2752. .. rst-class:: classref-enumeration-constant
  2753. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
  2754. 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.
  2755. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
  2756. .. rst-class:: classref-enumeration-constant
  2757. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
  2758. 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.
  2759. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
  2760. .. rst-class:: classref-enumeration-constant
  2761. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
  2762. Flip the texture when repeating so that the edge lines up instead of abruptly changing.
  2763. .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
  2764. .. rst-class:: classref-enumeration-constant
  2765. :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
  2766. Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
  2767. .. rst-class:: classref-item-separator
  2768. ----
  2769. .. _enum_RenderingServer_CanvasGroupMode:
  2770. .. rst-class:: classref-enumeration
  2771. enum **CanvasGroupMode**:
  2772. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
  2773. .. rst-class:: classref-enumeration-constant
  2774. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
  2775. Child draws over parent and is not clipped.
  2776. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
  2777. .. rst-class:: classref-enumeration-constant
  2778. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
  2779. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
  2780. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
  2781. .. rst-class:: classref-enumeration-constant
  2782. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
  2783. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
  2784. .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
  2785. .. rst-class:: classref-enumeration-constant
  2786. :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
  2787. .. rst-class:: classref-item-separator
  2788. ----
  2789. .. _enum_RenderingServer_CanvasLightMode:
  2790. .. rst-class:: classref-enumeration
  2791. enum **CanvasLightMode**:
  2792. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
  2793. .. rst-class:: classref-enumeration-constant
  2794. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
  2795. 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
  2796. .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
  2797. .. rst-class:: classref-enumeration-constant
  2798. :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
  2799. 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
  2800. .. rst-class:: classref-item-separator
  2801. ----
  2802. .. _enum_RenderingServer_CanvasLightBlendMode:
  2803. .. rst-class:: classref-enumeration
  2804. enum **CanvasLightBlendMode**:
  2805. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
  2806. .. rst-class:: classref-enumeration-constant
  2807. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
  2808. Adds light color additive to the canvas.
  2809. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
  2810. .. rst-class:: classref-enumeration-constant
  2811. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
  2812. Adds light color subtractive to the canvas.
  2813. .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
  2814. .. rst-class:: classref-enumeration-constant
  2815. :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
  2816. The light adds color depending on transparency.
  2817. .. rst-class:: classref-item-separator
  2818. ----
  2819. .. _enum_RenderingServer_CanvasLightShadowFilter:
  2820. .. rst-class:: classref-enumeration
  2821. enum **CanvasLightShadowFilter**:
  2822. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
  2823. .. rst-class:: classref-enumeration-constant
  2824. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
  2825. Do not apply a filter to canvas light shadows.
  2826. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
  2827. .. rst-class:: classref-enumeration-constant
  2828. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
  2829. Use PCF5 filtering to filter canvas light shadows.
  2830. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
  2831. .. rst-class:: classref-enumeration-constant
  2832. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
  2833. Use PCF13 filtering to filter canvas light shadows.
  2834. .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
  2835. .. rst-class:: classref-enumeration-constant
  2836. :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
  2837. Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
  2838. .. rst-class:: classref-item-separator
  2839. ----
  2840. .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
  2841. .. rst-class:: classref-enumeration
  2842. enum **CanvasOccluderPolygonCullMode**:
  2843. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
  2844. .. rst-class:: classref-enumeration-constant
  2845. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
  2846. Culling of the canvas occluder is disabled.
  2847. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
  2848. .. rst-class:: classref-enumeration-constant
  2849. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
  2850. Culling of the canvas occluder is clockwise.
  2851. .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
  2852. .. rst-class:: classref-enumeration-constant
  2853. :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
  2854. Culling of the canvas occluder is counterclockwise.
  2855. .. rst-class:: classref-item-separator
  2856. ----
  2857. .. _enum_RenderingServer_GlobalShaderParameterType:
  2858. .. rst-class:: classref-enumeration
  2859. enum **GlobalShaderParameterType**:
  2860. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
  2861. .. rst-class:: classref-enumeration-constant
  2862. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
  2863. Boolean global shader parameter (``global uniform bool ...``).
  2864. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
  2865. .. rst-class:: classref-enumeration-constant
  2866. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
  2867. 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
  2868. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
  2869. .. rst-class:: classref-enumeration-constant
  2870. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
  2871. 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
  2872. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
  2873. .. rst-class:: classref-enumeration-constant
  2874. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
  2875. 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
  2876. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
  2877. .. rst-class:: classref-enumeration-constant
  2878. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
  2879. Integer global shader parameter (``global uniform int ...``).
  2880. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
  2881. .. rst-class:: classref-enumeration-constant
  2882. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
  2883. 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
  2884. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
  2885. .. rst-class:: classref-enumeration-constant
  2886. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
  2887. 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
  2888. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
  2889. .. rst-class:: classref-enumeration-constant
  2890. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
  2891. 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
  2892. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
  2893. .. rst-class:: classref-enumeration-constant
  2894. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
  2895. 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.
  2896. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
  2897. .. rst-class:: classref-enumeration-constant
  2898. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
  2899. Unsigned integer global shader parameter (``global uniform uint ...``).
  2900. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
  2901. .. rst-class:: classref-enumeration-constant
  2902. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
  2903. 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
  2904. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
  2905. .. rst-class:: classref-enumeration-constant
  2906. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
  2907. 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
  2908. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
  2909. .. rst-class:: classref-enumeration-constant
  2910. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
  2911. 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
  2912. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
  2913. .. rst-class:: classref-enumeration-constant
  2914. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
  2915. Single-precision floating-point global shader parameter (``global uniform float ...``).
  2916. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
  2917. .. rst-class:: classref-enumeration-constant
  2918. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
  2919. 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
  2920. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
  2921. .. rst-class:: classref-enumeration-constant
  2922. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
  2923. 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
  2924. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
  2925. .. rst-class:: classref-enumeration-constant
  2926. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
  2927. 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
  2928. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
  2929. .. rst-class:: classref-enumeration-constant
  2930. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
  2931. 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.
  2932. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
  2933. .. rst-class:: classref-enumeration-constant
  2934. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
  2935. 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.
  2936. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
  2937. .. rst-class:: classref-enumeration-constant
  2938. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
  2939. 2×2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
  2940. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
  2941. .. rst-class:: classref-enumeration-constant
  2942. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
  2943. 3×3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
  2944. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
  2945. .. rst-class:: classref-enumeration-constant
  2946. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
  2947. 4×4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
  2948. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
  2949. .. rst-class:: classref-enumeration-constant
  2950. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
  2951. 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
  2952. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
  2953. .. rst-class:: classref-enumeration-constant
  2954. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
  2955. 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
  2956. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
  2957. .. rst-class:: classref-enumeration-constant
  2958. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
  2959. 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
  2960. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
  2961. .. rst-class:: classref-enumeration-constant
  2962. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
  2963. 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
  2964. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
  2965. .. rst-class:: classref-enumeration-constant
  2966. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
  2967. 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
  2968. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
  2969. .. rst-class:: classref-enumeration-constant
  2970. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
  2971. Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
  2972. .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
  2973. .. rst-class:: classref-enumeration-constant
  2974. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``28``
  2975. Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
  2976. .. rst-class:: classref-item-separator
  2977. ----
  2978. .. _enum_RenderingServer_RenderingInfo:
  2979. .. rst-class:: classref-enumeration
  2980. enum **RenderingInfo**:
  2981. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
  2982. .. rst-class:: classref-enumeration-constant
  2983. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
  2984. Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
  2985. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
  2986. .. rst-class:: classref-enumeration-constant
  2987. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
  2988. Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
  2989. .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
  2990. .. rst-class:: classref-enumeration-constant
  2991. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
  2992. Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
  2993. .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
  2994. .. rst-class:: classref-enumeration-constant
  2995. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
  2996. Texture memory used (in bytes).
  2997. .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
  2998. .. rst-class:: classref-enumeration-constant
  2999. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
  3000. Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
  3001. .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
  3002. .. rst-class:: classref-enumeration-constant
  3003. :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
  3004. Video memory used (in bytes). When using the Forward+ or mobile rendering backends, this is always greater than the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`, since there is miscellaneous data not accounted for by those two metrics. When using the GL Compatibility backend, this is equal to the sum of :ref:`RENDERING_INFO_TEXTURE_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED>` and :ref:`RENDERING_INFO_BUFFER_MEM_USED<class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED>`.
  3005. .. rst-class:: classref-item-separator
  3006. ----
  3007. .. _enum_RenderingServer_Features:
  3008. .. rst-class:: classref-enumeration
  3009. enum **Features**:
  3010. .. _class_RenderingServer_constant_FEATURE_SHADERS:
  3011. .. rst-class:: classref-enumeration-constant
  3012. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
  3013. Hardware supports shaders. This enum is currently unused in Godot 3.x.
  3014. .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
  3015. .. rst-class:: classref-enumeration-constant
  3016. :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
  3017. Hardware supports multithreading. This enum is currently unused in Godot 3.x.
  3018. .. rst-class:: classref-section-separator
  3019. ----
  3020. .. rst-class:: classref-descriptions-group
  3021. Constants
  3022. ---------
  3023. .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
  3024. .. rst-class:: classref-constant
  3025. **NO_INDEX_ARRAY** = ``-1``
  3026. Marks an error that shows that the index array is empty.
  3027. .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
  3028. .. rst-class:: classref-constant
  3029. **ARRAY_WEIGHTS_SIZE** = ``4``
  3030. Number of weights/bones per vertex.
  3031. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
  3032. .. rst-class:: classref-constant
  3033. **CANVAS_ITEM_Z_MIN** = ``-4096``
  3034. The minimum Z-layer for canvas items.
  3035. .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
  3036. .. rst-class:: classref-constant
  3037. **CANVAS_ITEM_Z_MAX** = ``4096``
  3038. The maximum Z-layer for canvas items.
  3039. .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
  3040. .. rst-class:: classref-constant
  3041. **MAX_GLOW_LEVELS** = ``7``
  3042. The maximum number of glow levels that can be used with the glow post-processing effect.
  3043. .. _class_RenderingServer_constant_MAX_CURSORS:
  3044. .. rst-class:: classref-constant
  3045. **MAX_CURSORS** = ``8``
  3046. *Deprecated.* This constant is unused internally.
  3047. .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
  3048. .. rst-class:: classref-constant
  3049. **MAX_2D_DIRECTIONAL_LIGHTS** = ``8``
  3050. The maximum number of directional lights that can be rendered at a given time in 2D.
  3051. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
  3052. .. rst-class:: classref-constant
  3053. **MATERIAL_RENDER_PRIORITY_MIN** = ``-128``
  3054. The minimum renderpriority of all materials.
  3055. .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
  3056. .. rst-class:: classref-constant
  3057. **MATERIAL_RENDER_PRIORITY_MAX** = ``127``
  3058. The maximum renderpriority of all materials.
  3059. .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
  3060. .. rst-class:: classref-constant
  3061. **ARRAY_CUSTOM_COUNT** = ``4``
  3062. 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>`).
  3063. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
  3064. .. rst-class:: classref-constant
  3065. **PARTICLES_EMIT_FLAG_POSITION** = ``1``
  3066. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
  3067. .. rst-class:: classref-constant
  3068. **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2``
  3069. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
  3070. .. rst-class:: classref-constant
  3071. **PARTICLES_EMIT_FLAG_VELOCITY** = ``4``
  3072. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
  3073. .. rst-class:: classref-constant
  3074. **PARTICLES_EMIT_FLAG_COLOR** = ``8``
  3075. .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
  3076. .. rst-class:: classref-constant
  3077. **PARTICLES_EMIT_FLAG_CUSTOM** = ``16``
  3078. .. rst-class:: classref-section-separator
  3079. ----
  3080. .. rst-class:: classref-descriptions-group
  3081. Property Descriptions
  3082. ---------------------
  3083. .. _class_RenderingServer_property_render_loop_enabled:
  3084. .. rst-class:: classref-property
  3085. :ref:`bool<class_bool>` **render_loop_enabled**
  3086. .. rst-class:: classref-property-setget
  3087. - void **set_render_loop_enabled** **(** :ref:`bool<class_bool>` value **)**
  3088. - :ref:`bool<class_bool>` **is_render_loop_enabled** **(** **)**
  3089. 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.
  3090. .. rst-class:: classref-section-separator
  3091. ----
  3092. .. rst-class:: classref-descriptions-group
  3093. Method Descriptions
  3094. -------------------
  3095. .. _class_RenderingServer_method_bake_render_uv2:
  3096. .. rst-class:: classref-method
  3097. :ref:`Image[]<class_Image>` **bake_render_uv2** **(** :ref:`RID<class_RID>` base, :ref:`RID[]<class_RID>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)**
  3098. 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>`.
  3099. .. rst-class:: classref-item-separator
  3100. ----
  3101. .. _class_RenderingServer_method_call_on_render_thread:
  3102. .. rst-class:: classref-method
  3103. void **call_on_render_thread** **(** :ref:`Callable<class_Callable>` callable **)**
  3104. As the RenderingServer actual logic may run on an separate thread, accessing its internals from the main (or any other) thread will result in errors. To make it easier to run code that can safely access the rendering internals (such as :ref:`RenderingDevice<class_RenderingDevice>` and similar RD classes), push a callable via this function so it will be executed on the render thread.
  3105. .. rst-class:: classref-item-separator
  3106. ----
  3107. .. _class_RenderingServer_method_camera_attributes_create:
  3108. .. rst-class:: classref-method
  3109. :ref:`RID<class_RID>` **camera_attributes_create** **(** **)**
  3110. 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.
  3111. 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.
  3112. \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
  3113. .. rst-class:: classref-item-separator
  3114. ----
  3115. .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
  3116. .. rst-class:: classref-method
  3117. void **camera_attributes_set_auto_exposure** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` min_sensitivity, :ref:`float<class_float>` max_sensitivity, :ref:`float<class_float>` speed, :ref:`float<class_float>` scale **)**
  3118. 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>`.
  3119. .. rst-class:: classref-item-separator
  3120. ----
  3121. .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
  3122. .. rst-class:: classref-method
  3123. void **camera_attributes_set_dof_blur** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`bool<class_bool>` far_enable, :ref:`float<class_float>` far_distance, :ref:`float<class_float>` far_transition, :ref:`bool<class_bool>` near_enable, :ref:`float<class_float>` near_distance, :ref:`float<class_float>` near_transition, :ref:`float<class_float>` amount **)**
  3124. 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>`.
  3125. .. rst-class:: classref-item-separator
  3126. ----
  3127. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
  3128. .. rst-class:: classref-method
  3129. void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)**
  3130. Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>`.
  3131. .. rst-class:: classref-item-separator
  3132. ----
  3133. .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
  3134. .. rst-class:: classref-method
  3135. void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)**
  3136. Sets the quality level of the DOF blur effect to one of the options in :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>`. ``use_jitter`` can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
  3137. .. rst-class:: classref-item-separator
  3138. ----
  3139. .. _class_RenderingServer_method_camera_attributes_set_exposure:
  3140. .. rst-class:: classref-method
  3141. void **camera_attributes_set_exposure** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` normalization **)**
  3142. 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.
  3143. The normalization factor can be calculated from exposure value (EV100) as follows:
  3144. ::
  3145. func get_exposure_normalization(float ev100):
  3146. return 1.0 / (pow(2.0, ev100) * 1.2)
  3147. The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
  3148. ::
  3149. func get_exposure(float aperture, float shutter_speed, float sensitivity):
  3150. return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity))
  3151. .. rst-class:: classref-item-separator
  3152. ----
  3153. .. _class_RenderingServer_method_camera_create:
  3154. .. rst-class:: classref-method
  3155. :ref:`RID<class_RID>` **camera_create** **(** **)**
  3156. 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.
  3157. 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.
  3158. \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
  3159. .. rst-class:: classref-item-separator
  3160. ----
  3161. .. _class_RenderingServer_method_camera_set_camera_attributes:
  3162. .. rst-class:: classref-method
  3163. void **camera_set_camera_attributes** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)**
  3164. Sets the camera_attributes created with :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` to the given camera.
  3165. .. rst-class:: classref-item-separator
  3166. ----
  3167. .. _class_RenderingServer_method_camera_set_cull_mask:
  3168. .. rst-class:: classref-method
  3169. void **camera_set_cull_mask** **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)**
  3170. 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>`.
  3171. .. rst-class:: classref-item-separator
  3172. ----
  3173. .. _class_RenderingServer_method_camera_set_environment:
  3174. .. rst-class:: classref-method
  3175. void **camera_set_environment** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)**
  3176. Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
  3177. .. rst-class:: classref-item-separator
  3178. ----
  3179. .. _class_RenderingServer_method_camera_set_frustum:
  3180. .. rst-class:: classref-method
  3181. void **camera_set_frustum** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`Vector2<class_Vector2>` offset, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3182. Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
  3183. .. rst-class:: classref-item-separator
  3184. ----
  3185. .. _class_RenderingServer_method_camera_set_orthogonal:
  3186. .. rst-class:: classref-method
  3187. void **camera_set_orthogonal** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3188. 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.
  3189. .. rst-class:: classref-item-separator
  3190. ----
  3191. .. _class_RenderingServer_method_camera_set_perspective:
  3192. .. rst-class:: classref-method
  3193. void **camera_set_perspective** **(** :ref:`RID<class_RID>` camera, :ref:`float<class_float>` fovy_degrees, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
  3194. Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
  3195. .. rst-class:: classref-item-separator
  3196. ----
  3197. .. _class_RenderingServer_method_camera_set_transform:
  3198. .. rst-class:: classref-method
  3199. void **camera_set_transform** **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)**
  3200. Sets :ref:`Transform3D<class_Transform3D>` of camera.
  3201. .. rst-class:: classref-item-separator
  3202. ----
  3203. .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
  3204. .. rst-class:: classref-method
  3205. void **camera_set_use_vertical_aspect** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)**
  3206. 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>`.
  3207. .. rst-class:: classref-item-separator
  3208. ----
  3209. .. _class_RenderingServer_method_canvas_create:
  3210. .. rst-class:: classref-method
  3211. :ref:`RID<class_RID>` **canvas_create** **(** **)**
  3212. 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.
  3213. 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.
  3214. Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
  3215. .. rst-class:: classref-item-separator
  3216. ----
  3217. .. _class_RenderingServer_method_canvas_item_add_animation_slice:
  3218. .. rst-class:: classref-method
  3219. void **canvas_item_add_animation_slice** **(** :ref:`RID<class_RID>` item, :ref:`float<class_float>` animation_length, :ref:`float<class_float>` slice_begin, :ref:`float<class_float>` slice_end, :ref:`float<class_float>` offset=0.0 **)**
  3220. 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.
  3221. .. rst-class:: classref-item-separator
  3222. ----
  3223. .. _class_RenderingServer_method_canvas_item_add_circle:
  3224. .. rst-class:: classref-method
  3225. void **canvas_item_add_circle** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_Color>` color **)**
  3226. 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>`.
  3227. .. rst-class:: classref-item-separator
  3228. ----
  3229. .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
  3230. .. rst-class:: classref-method
  3231. void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)**
  3232. If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false.
  3233. .. rst-class:: classref-item-separator
  3234. ----
  3235. .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
  3236. .. rst-class:: classref-method
  3237. void **canvas_item_add_lcd_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate **)**
  3238. See also :ref:`CanvasItem.draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
  3239. .. rst-class:: classref-item-separator
  3240. ----
  3241. .. _class_RenderingServer_method_canvas_item_add_line:
  3242. .. rst-class:: classref-method
  3243. void **canvas_item_add_line** **(** :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` from, :ref:`Vector2<class_Vector2>` to, :ref:`Color<class_Color>` color, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)**
  3244. 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>`.
  3245. .. rst-class:: classref-item-separator
  3246. ----
  3247. .. _class_RenderingServer_method_canvas_item_add_mesh:
  3248. .. rst-class:: classref-method
  3249. void **canvas_item_add_mesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`Transform2D<class_Transform2D>` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`RID<class_RID>` texture=RID() **)**
  3250. 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>`.
  3251. .. rst-class:: classref-item-separator
  3252. ----
  3253. .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
  3254. .. rst-class:: classref-method
  3255. void **canvas_item_add_msdf_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`int<class_int>` outline_size=0, :ref:`float<class_float>` px_range=1.0, :ref:`float<class_float>` scale=1.0 **)**
  3256. See also :ref:`CanvasItem.draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
  3257. .. rst-class:: classref-item-separator
  3258. ----
  3259. .. _class_RenderingServer_method_canvas_item_add_multiline:
  3260. .. rst-class:: classref-method
  3261. void **canvas_item_add_multiline** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0 **)**
  3262. 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>`.
  3263. .. rst-class:: classref-item-separator
  3264. ----
  3265. .. _class_RenderingServer_method_canvas_item_add_multimesh:
  3266. .. rst-class:: classref-method
  3267. void **canvas_item_add_multimesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture=RID() **)**
  3268. 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>`.
  3269. .. rst-class:: classref-item-separator
  3270. ----
  3271. .. _class_RenderingServer_method_canvas_item_add_nine_patch:
  3272. .. rst-class:: classref-method
  3273. void **canvas_item_add_nine_patch** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Rect2<class_Rect2>` source, :ref:`RID<class_RID>` texture, :ref:`Vector2<class_Vector2>` topleft, :ref:`Vector2<class_Vector2>` bottomright, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` x_axis_mode=0, :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1) **)**
  3274. Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3275. .. rst-class:: classref-item-separator
  3276. ----
  3277. .. _class_RenderingServer_method_canvas_item_add_particles:
  3278. .. rst-class:: classref-method
  3279. void **canvas_item_add_particles** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)**
  3280. Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
  3281. .. rst-class:: classref-item-separator
  3282. ----
  3283. .. _class_RenderingServer_method_canvas_item_add_polygon:
  3284. .. rst-class:: classref-method
  3285. void **canvas_item_add_polygon** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`RID<class_RID>` texture=RID() **)**
  3286. 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>`.
  3287. .. rst-class:: classref-item-separator
  3288. ----
  3289. .. _class_RenderingServer_method_canvas_item_add_polyline:
  3290. .. rst-class:: classref-method
  3291. void **canvas_item_add_polyline** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`float<class_float>` width=-1.0, :ref:`bool<class_bool>` antialiased=false **)**
  3292. 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>`.
  3293. .. rst-class:: classref-item-separator
  3294. ----
  3295. .. _class_RenderingServer_method_canvas_item_add_primitive:
  3296. .. rst-class:: classref-method
  3297. void **canvas_item_add_primitive** **(** :ref:`RID<class_RID>` item, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs, :ref:`RID<class_RID>` texture **)**
  3298. 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>`.
  3299. .. rst-class:: classref-item-separator
  3300. ----
  3301. .. _class_RenderingServer_method_canvas_item_add_rect:
  3302. .. rst-class:: classref-method
  3303. void **canvas_item_add_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**
  3304. 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>`.
  3305. .. rst-class:: classref-item-separator
  3306. ----
  3307. .. _class_RenderingServer_method_canvas_item_add_set_transform:
  3308. .. rst-class:: classref-method
  3309. void **canvas_item_add_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
  3310. Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
  3311. .. rst-class:: classref-item-separator
  3312. ----
  3313. .. _class_RenderingServer_method_canvas_item_add_texture_rect:
  3314. .. rst-class:: classref-method
  3315. void **canvas_item_add_texture_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false **)**
  3316. 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>`.
  3317. .. rst-class:: classref-item-separator
  3318. ----
  3319. .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
  3320. .. rst-class:: classref-method
  3321. void **canvas_item_add_texture_rect_region** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`RID<class_RID>` texture, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Color<class_Color>` modulate=Color(1, 1, 1, 1), :ref:`bool<class_bool>` transpose=false, :ref:`bool<class_bool>` clip_uv=true **)**
  3322. 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>`.
  3323. .. rst-class:: classref-item-separator
  3324. ----
  3325. .. _class_RenderingServer_method_canvas_item_add_triangle_array:
  3326. .. rst-class:: classref-method
  3327. void **canvas_item_add_triangle_array** **(** :ref:`RID<class_RID>` item, :ref:`PackedInt32Array<class_PackedInt32Array>` indices, :ref:`PackedVector2Array<class_PackedVector2Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` colors, :ref:`PackedVector2Array<class_PackedVector2Array>` uvs=PackedVector2Array(), :ref:`PackedInt32Array<class_PackedInt32Array>` bones=PackedInt32Array(), :ref:`PackedFloat32Array<class_PackedFloat32Array>` weights=PackedFloat32Array(), :ref:`RID<class_RID>` texture=RID(), :ref:`int<class_int>` count=-1 **)**
  3328. 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>`.
  3329. \ **Note:** ``count`` is unused and can be left unspecified.
  3330. .. rst-class:: classref-item-separator
  3331. ----
  3332. .. _class_RenderingServer_method_canvas_item_clear:
  3333. .. rst-class:: classref-method
  3334. void **canvas_item_clear** **(** :ref:`RID<class_RID>` item **)**
  3335. Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
  3336. .. rst-class:: classref-item-separator
  3337. ----
  3338. .. _class_RenderingServer_method_canvas_item_create:
  3339. .. rst-class:: classref-method
  3340. :ref:`RID<class_RID>` **canvas_item_create** **(** **)**
  3341. 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.
  3342. 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.
  3343. \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
  3344. .. rst-class:: classref-item-separator
  3345. ----
  3346. .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
  3347. .. rst-class:: classref-method
  3348. void **canvas_item_set_canvas_group_mode** **(** :ref:`RID<class_RID>` item, :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` mode, :ref:`float<class_float>` clear_margin=5.0, :ref:`bool<class_bool>` fit_empty=false, :ref:`float<class_float>` fit_margin=0.0, :ref:`bool<class_bool>` blur_mipmaps=false **)**
  3349. 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.
  3350. \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
  3351. .. rst-class:: classref-item-separator
  3352. ----
  3353. .. _class_RenderingServer_method_canvas_item_set_clip:
  3354. .. rst-class:: classref-method
  3355. void **canvas_item_set_clip** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)**
  3356. 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.
  3357. \ **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.
  3358. .. rst-class:: classref-item-separator
  3359. ----
  3360. .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
  3361. .. rst-class:: classref-method
  3362. void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)**
  3363. Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
  3364. .. rst-class:: classref-item-separator
  3365. ----
  3366. .. _class_RenderingServer_method_canvas_item_set_custom_rect:
  3367. .. rst-class:: classref-method
  3368. void **canvas_item_set_custom_rect** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
  3369. 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.
  3370. .. rst-class:: classref-item-separator
  3371. ----
  3372. .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
  3373. .. rst-class:: classref-method
  3374. void **canvas_item_set_default_texture_filter** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  3375. 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>`.
  3376. .. rst-class:: classref-item-separator
  3377. ----
  3378. .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
  3379. .. rst-class:: classref-method
  3380. void **canvas_item_set_default_texture_repeat** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  3381. 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>`.
  3382. .. rst-class:: classref-item-separator
  3383. ----
  3384. .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
  3385. .. rst-class:: classref-method
  3386. void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3387. 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>`__.
  3388. .. rst-class:: classref-item-separator
  3389. ----
  3390. .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
  3391. .. rst-class:: classref-method
  3392. void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3393. 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>`.
  3394. .. rst-class:: classref-item-separator
  3395. ----
  3396. .. _class_RenderingServer_method_canvas_item_set_draw_index:
  3397. .. rst-class:: classref-method
  3398. void **canvas_item_set_draw_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)**
  3399. Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
  3400. .. rst-class:: classref-item-separator
  3401. ----
  3402. .. _class_RenderingServer_method_canvas_item_set_light_mask:
  3403. .. rst-class:: classref-method
  3404. void **canvas_item_set_light_mask** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)**
  3405. Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
  3406. .. rst-class:: classref-item-separator
  3407. ----
  3408. .. _class_RenderingServer_method_canvas_item_set_material:
  3409. .. rst-class:: classref-method
  3410. void **canvas_item_set_material** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)**
  3411. Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
  3412. .. rst-class:: classref-item-separator
  3413. ----
  3414. .. _class_RenderingServer_method_canvas_item_set_modulate:
  3415. .. rst-class:: classref-method
  3416. void **canvas_item_set_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
  3417. 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>`.
  3418. .. rst-class:: classref-item-separator
  3419. ----
  3420. .. _class_RenderingServer_method_canvas_item_set_parent:
  3421. .. rst-class:: classref-method
  3422. void **canvas_item_set_parent** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)**
  3423. 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.
  3424. .. rst-class:: classref-item-separator
  3425. ----
  3426. .. _class_RenderingServer_method_canvas_item_set_self_modulate:
  3427. .. rst-class:: classref-method
  3428. void **canvas_item_set_self_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
  3429. 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>`.
  3430. .. rst-class:: classref-item-separator
  3431. ----
  3432. .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
  3433. .. rst-class:: classref-method
  3434. void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3435. 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>`.
  3436. .. rst-class:: classref-item-separator
  3437. ----
  3438. .. _class_RenderingServer_method_canvas_item_set_transform:
  3439. .. rst-class:: classref-method
  3440. void **canvas_item_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
  3441. 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>`.
  3442. .. rst-class:: classref-item-separator
  3443. ----
  3444. .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
  3445. .. rst-class:: classref-method
  3446. void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3447. Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
  3448. .. rst-class:: classref-item-separator
  3449. ----
  3450. .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
  3451. .. rst-class:: classref-method
  3452. void **canvas_item_set_visibility_layer** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` visibility_layer **)**
  3453. 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>`.
  3454. .. rst-class:: classref-item-separator
  3455. ----
  3456. .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
  3457. .. rst-class:: classref-method
  3458. void **canvas_item_set_visibility_notifier** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enable, :ref:`Rect2<class_Rect2>` area, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
  3459. 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.
  3460. This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
  3461. .. rst-class:: classref-item-separator
  3462. ----
  3463. .. _class_RenderingServer_method_canvas_item_set_visible:
  3464. .. rst-class:: classref-method
  3465. void **canvas_item_set_visible** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)**
  3466. Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
  3467. .. rst-class:: classref-item-separator
  3468. ----
  3469. .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
  3470. .. rst-class:: classref-method
  3471. void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
  3472. If this is enabled, the Z index of the parent will be added to the children's Z index.
  3473. .. rst-class:: classref-item-separator
  3474. ----
  3475. .. _class_RenderingServer_method_canvas_item_set_z_index:
  3476. .. rst-class:: classref-method
  3477. void **canvas_item_set_z_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)**
  3478. Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
  3479. .. rst-class:: classref-item-separator
  3480. ----
  3481. .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
  3482. .. rst-class:: classref-method
  3483. void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)**
  3484. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  3485. .. rst-class:: classref-item-separator
  3486. ----
  3487. .. _class_RenderingServer_method_canvas_light_create:
  3488. .. rst-class:: classref-method
  3489. :ref:`RID<class_RID>` **canvas_light_create** **(** **)**
  3490. 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.
  3491. 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.
  3492. \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
  3493. .. rst-class:: classref-item-separator
  3494. ----
  3495. .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
  3496. .. rst-class:: classref-method
  3497. void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)**
  3498. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  3499. .. rst-class:: classref-item-separator
  3500. ----
  3501. .. _class_RenderingServer_method_canvas_light_occluder_create:
  3502. .. rst-class:: classref-method
  3503. :ref:`RID<class_RID>` **canvas_light_occluder_create** **(** **)**
  3504. 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.
  3505. 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.
  3506. \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
  3507. .. rst-class:: classref-item-separator
  3508. ----
  3509. .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
  3510. .. rst-class:: classref-method
  3511. void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)**
  3512. .. container:: contribute
  3513. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3514. .. rst-class:: classref-item-separator
  3515. ----
  3516. .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
  3517. .. rst-class:: classref-method
  3518. void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)**
  3519. Enables or disables light occluder.
  3520. .. rst-class:: classref-item-separator
  3521. ----
  3522. .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
  3523. .. rst-class:: classref-method
  3524. void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)**
  3525. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3526. .. rst-class:: classref-item-separator
  3527. ----
  3528. .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
  3529. .. rst-class:: classref-method
  3530. void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)**
  3531. Sets a light occluder's polygon.
  3532. .. rst-class:: classref-item-separator
  3533. ----
  3534. .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
  3535. .. rst-class:: classref-method
  3536. void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)**
  3537. Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
  3538. .. rst-class:: classref-item-separator
  3539. ----
  3540. .. _class_RenderingServer_method_canvas_light_set_blend_mode:
  3541. .. rst-class:: classref-method
  3542. void **canvas_light_set_blend_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` mode **)**
  3543. Sets the blend mode for the given canvas light. See :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` for options. Equivalent to :ref:`Light2D.blend_mode<class_Light2D_property_blend_mode>`.
  3544. .. rst-class:: classref-item-separator
  3545. ----
  3546. .. _class_RenderingServer_method_canvas_light_set_color:
  3547. .. rst-class:: classref-method
  3548. void **canvas_light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  3549. Sets the color for a light.
  3550. .. rst-class:: classref-item-separator
  3551. ----
  3552. .. _class_RenderingServer_method_canvas_light_set_enabled:
  3553. .. rst-class:: classref-method
  3554. void **canvas_light_set_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  3555. Enables or disables a canvas light.
  3556. .. rst-class:: classref-item-separator
  3557. ----
  3558. .. _class_RenderingServer_method_canvas_light_set_energy:
  3559. .. rst-class:: classref-method
  3560. void **canvas_light_set_energy** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)**
  3561. Sets a canvas light's energy.
  3562. .. rst-class:: classref-item-separator
  3563. ----
  3564. .. _class_RenderingServer_method_canvas_light_set_height:
  3565. .. rst-class:: classref-method
  3566. void **canvas_light_set_height** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)**
  3567. Sets a canvas light's height.
  3568. .. rst-class:: classref-item-separator
  3569. ----
  3570. .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
  3571. .. rst-class:: classref-method
  3572. void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  3573. The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
  3574. .. rst-class:: classref-item-separator
  3575. ----
  3576. .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
  3577. .. rst-class:: classref-method
  3578. void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  3579. 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.
  3580. .. rst-class:: classref-item-separator
  3581. ----
  3582. .. _class_RenderingServer_method_canvas_light_set_layer_range:
  3583. .. rst-class:: classref-method
  3584. void **canvas_light_set_layer_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
  3585. The layer range that gets rendered with this light.
  3586. .. rst-class:: classref-item-separator
  3587. ----
  3588. .. _class_RenderingServer_method_canvas_light_set_mode:
  3589. .. rst-class:: classref-method
  3590. void **canvas_light_set_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)**
  3591. The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
  3592. .. rst-class:: classref-item-separator
  3593. ----
  3594. .. _class_RenderingServer_method_canvas_light_set_shadow_color:
  3595. .. rst-class:: classref-method
  3596. void **canvas_light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  3597. Sets the color of the canvas light's shadow.
  3598. .. rst-class:: classref-item-separator
  3599. ----
  3600. .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
  3601. .. rst-class:: classref-method
  3602. void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  3603. Enables or disables the canvas light's shadow.
  3604. .. rst-class:: classref-item-separator
  3605. ----
  3606. .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
  3607. .. rst-class:: classref-method
  3608. void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)**
  3609. Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
  3610. .. rst-class:: classref-item-separator
  3611. ----
  3612. .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
  3613. .. rst-class:: classref-method
  3614. void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)**
  3615. Smoothens the shadow. The lower, the smoother.
  3616. .. rst-class:: classref-item-separator
  3617. ----
  3618. .. _class_RenderingServer_method_canvas_light_set_texture:
  3619. .. rst-class:: classref-method
  3620. void **canvas_light_set_texture** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
  3621. Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
  3622. .. rst-class:: classref-item-separator
  3623. ----
  3624. .. _class_RenderingServer_method_canvas_light_set_texture_offset:
  3625. .. rst-class:: classref-method
  3626. void **canvas_light_set_texture_offset** **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)**
  3627. Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
  3628. .. rst-class:: classref-item-separator
  3629. ----
  3630. .. _class_RenderingServer_method_canvas_light_set_texture_scale:
  3631. .. rst-class:: classref-method
  3632. void **canvas_light_set_texture_scale** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)**
  3633. Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
  3634. .. rst-class:: classref-item-separator
  3635. ----
  3636. .. _class_RenderingServer_method_canvas_light_set_transform:
  3637. .. rst-class:: classref-method
  3638. void **canvas_light_set_transform** **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)**
  3639. Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
  3640. .. rst-class:: classref-item-separator
  3641. ----
  3642. .. _class_RenderingServer_method_canvas_light_set_z_range:
  3643. .. rst-class:: classref-method
  3644. void **canvas_light_set_z_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
  3645. 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>`.
  3646. .. rst-class:: classref-item-separator
  3647. ----
  3648. .. _class_RenderingServer_method_canvas_occluder_polygon_create:
  3649. .. rst-class:: classref-method
  3650. :ref:`RID<class_RID>` **canvas_occluder_polygon_create** **(** **)**
  3651. 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.
  3652. 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.
  3653. \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
  3654. .. rst-class:: classref-item-separator
  3655. ----
  3656. .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
  3657. .. rst-class:: classref-method
  3658. void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)**
  3659. Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
  3660. .. rst-class:: classref-item-separator
  3661. ----
  3662. .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
  3663. .. rst-class:: classref-method
  3664. void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)**
  3665. Sets the shape of the occluder polygon.
  3666. .. rst-class:: classref-item-separator
  3667. ----
  3668. .. _class_RenderingServer_method_canvas_set_disable_scale:
  3669. .. rst-class:: classref-method
  3670. void **canvas_set_disable_scale** **(** :ref:`bool<class_bool>` disable **)**
  3671. .. container:: contribute
  3672. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3673. .. rst-class:: classref-item-separator
  3674. ----
  3675. .. _class_RenderingServer_method_canvas_set_item_mirroring:
  3676. .. rst-class:: classref-method
  3677. void **canvas_set_item_mirroring** **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)**
  3678. A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_Vector2>`.
  3679. .. rst-class:: classref-item-separator
  3680. ----
  3681. .. _class_RenderingServer_method_canvas_set_modulate:
  3682. .. rst-class:: classref-method
  3683. void **canvas_set_modulate** **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)**
  3684. Modulates all colors in the given canvas.
  3685. .. rst-class:: classref-item-separator
  3686. ----
  3687. .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
  3688. .. rst-class:: classref-method
  3689. void **canvas_set_shadow_texture_size** **(** :ref:`int<class_int>` size **)**
  3690. 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.
  3691. .. rst-class:: classref-item-separator
  3692. ----
  3693. .. _class_RenderingServer_method_canvas_texture_create:
  3694. .. rst-class:: classref-method
  3695. :ref:`RID<class_RID>` **canvas_texture_create** **(** **)**
  3696. 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.
  3697. 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>`.
  3698. \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
  3699. .. rst-class:: classref-item-separator
  3700. ----
  3701. .. _class_RenderingServer_method_canvas_texture_set_channel:
  3702. .. rst-class:: classref-method
  3703. void **canvas_texture_set_channel** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)**
  3704. 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>`.
  3705. .. rst-class:: classref-item-separator
  3706. ----
  3707. .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
  3708. .. rst-class:: classref-method
  3709. void **canvas_texture_set_shading_parameters** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)**
  3710. 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>`.
  3711. .. rst-class:: classref-item-separator
  3712. ----
  3713. .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
  3714. .. rst-class:: classref-method
  3715. void **canvas_texture_set_texture_filter** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  3716. Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  3717. .. rst-class:: classref-item-separator
  3718. ----
  3719. .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
  3720. .. rst-class:: classref-method
  3721. void **canvas_texture_set_texture_repeat** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  3722. Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
  3723. .. rst-class:: classref-item-separator
  3724. ----
  3725. .. _class_RenderingServer_method_create_local_rendering_device:
  3726. .. rst-class:: classref-method
  3727. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device** **(** **)** |const|
  3728. 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.
  3729. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  3730. .. rst-class:: classref-item-separator
  3731. ----
  3732. .. _class_RenderingServer_method_decal_create:
  3733. .. rst-class:: classref-method
  3734. :ref:`RID<class_RID>` **decal_create** **(** **)**
  3735. 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.
  3736. 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.
  3737. 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.
  3738. \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
  3739. .. rst-class:: classref-item-separator
  3740. ----
  3741. .. _class_RenderingServer_method_decal_set_albedo_mix:
  3742. .. rst-class:: classref-method
  3743. void **decal_set_albedo_mix** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)**
  3744. Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
  3745. .. rst-class:: classref-item-separator
  3746. ----
  3747. .. _class_RenderingServer_method_decal_set_cull_mask:
  3748. .. rst-class:: classref-method
  3749. void **decal_set_cull_mask** **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)**
  3750. Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
  3751. .. rst-class:: classref-item-separator
  3752. ----
  3753. .. _class_RenderingServer_method_decal_set_distance_fade:
  3754. .. rst-class:: classref-method
  3755. void **decal_set_distance_fade** **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` length **)**
  3756. 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>`.
  3757. .. rst-class:: classref-item-separator
  3758. ----
  3759. .. _class_RenderingServer_method_decal_set_emission_energy:
  3760. .. rst-class:: classref-method
  3761. void **decal_set_emission_energy** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)**
  3762. Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
  3763. .. rst-class:: classref-item-separator
  3764. ----
  3765. .. _class_RenderingServer_method_decal_set_fade:
  3766. .. rst-class:: classref-method
  3767. void **decal_set_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)**
  3768. 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>`.
  3769. .. rst-class:: classref-item-separator
  3770. ----
  3771. .. _class_RenderingServer_method_decal_set_modulate:
  3772. .. rst-class:: classref-method
  3773. void **decal_set_modulate** **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)**
  3774. Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
  3775. .. rst-class:: classref-item-separator
  3776. ----
  3777. .. _class_RenderingServer_method_decal_set_normal_fade:
  3778. .. rst-class:: classref-method
  3779. void **decal_set_normal_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)**
  3780. Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
  3781. .. rst-class:: classref-item-separator
  3782. ----
  3783. .. _class_RenderingServer_method_decal_set_size:
  3784. .. rst-class:: classref-method
  3785. void **decal_set_size** **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)**
  3786. Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
  3787. .. rst-class:: classref-item-separator
  3788. ----
  3789. .. _class_RenderingServer_method_decal_set_texture:
  3790. .. rst-class:: classref-method
  3791. void **decal_set_texture** **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)**
  3792. Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture<class_Decal_method_set_texture>`.
  3793. .. rst-class:: classref-item-separator
  3794. ----
  3795. .. _class_RenderingServer_method_decals_set_filter:
  3796. .. rst-class:: classref-method
  3797. void **decals_set_filter** **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)**
  3798. Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
  3799. .. rst-class:: classref-item-separator
  3800. ----
  3801. .. _class_RenderingServer_method_directional_light_create:
  3802. .. rst-class:: classref-method
  3803. :ref:`RID<class_RID>` **directional_light_create** **(** **)**
  3804. 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.
  3805. 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.
  3806. 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.
  3807. \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
  3808. .. rst-class:: classref-item-separator
  3809. ----
  3810. .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
  3811. .. rst-class:: classref-method
  3812. void **directional_shadow_atlas_set_size** **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)**
  3813. 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.
  3814. .. rst-class:: classref-item-separator
  3815. ----
  3816. .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
  3817. .. rst-class:: classref-method
  3818. void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
  3819. 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.
  3820. .. rst-class:: classref-item-separator
  3821. ----
  3822. .. _class_RenderingServer_method_environment_bake_panorama:
  3823. .. rst-class:: classref-method
  3824. :ref:`Image<class_Image>` **environment_bake_panorama** **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
  3825. 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>`.
  3826. \ **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.
  3827. \ **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.
  3828. .. rst-class:: classref-item-separator
  3829. ----
  3830. .. _class_RenderingServer_method_environment_create:
  3831. .. rst-class:: classref-method
  3832. :ref:`RID<class_RID>` **environment_create** **(** **)**
  3833. 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.
  3834. 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.
  3835. \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
  3836. .. rst-class:: classref-item-separator
  3837. ----
  3838. .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
  3839. .. rst-class:: classref-method
  3840. void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool<class_bool>` enable **)**
  3841. 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>`.
  3842. .. rst-class:: classref-item-separator
  3843. ----
  3844. .. _class_RenderingServer_method_environment_set_adjustment:
  3845. .. rst-class:: classref-method
  3846. void **environment_set_adjustment** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation, :ref:`bool<class_bool>` use_1d_color_correction, :ref:`RID<class_RID>` color_correction **)**
  3847. Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3848. .. rst-class:: classref-item-separator
  3849. ----
  3850. .. _class_RenderingServer_method_environment_set_ambient_light:
  3851. .. rst-class:: classref-method
  3852. void **environment_set_ambient_light** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color, :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` ambient=0, :ref:`float<class_float>` energy=1.0, :ref:`float<class_float>` sky_contibution=0.0, :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` reflection_source=0 **)**
  3853. Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
  3854. .. rst-class:: classref-item-separator
  3855. ----
  3856. .. _class_RenderingServer_method_environment_set_background:
  3857. .. rst-class:: classref-method
  3858. void **environment_set_background** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)**
  3859. Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
  3860. .. rst-class:: classref-item-separator
  3861. ----
  3862. .. _class_RenderingServer_method_environment_set_bg_color:
  3863. .. rst-class:: classref-method
  3864. void **environment_set_bg_color** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)**
  3865. 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.
  3866. .. rst-class:: classref-item-separator
  3867. ----
  3868. .. _class_RenderingServer_method_environment_set_bg_energy:
  3869. .. rst-class:: classref-method
  3870. void **environment_set_bg_energy** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` exposure_value **)**
  3871. Sets the intensity of the background color.
  3872. .. rst-class:: classref-item-separator
  3873. ----
  3874. .. _class_RenderingServer_method_environment_set_canvas_max_layer:
  3875. .. rst-class:: classref-method
  3876. void **environment_set_canvas_max_layer** **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)**
  3877. Sets the maximum layer to use if using Canvas background mode.
  3878. .. rst-class:: classref-item-separator
  3879. ----
  3880. .. _class_RenderingServer_method_environment_set_fog:
  3881. .. rst-class:: classref-method
  3882. void **environment_set_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`Color<class_Color>` light_color, :ref:`float<class_float>` light_energy, :ref:`float<class_float>` sun_scatter, :ref:`float<class_float>` density, :ref:`float<class_float>` height, :ref:`float<class_float>` height_density, :ref:`float<class_float>` aerial_perspective, :ref:`float<class_float>` sky_affect **)**
  3883. Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3884. .. rst-class:: classref-item-separator
  3885. ----
  3886. .. _class_RenderingServer_method_environment_set_glow:
  3887. .. rst-class:: classref-method
  3888. void **environment_set_glow** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`PackedFloat32Array<class_PackedFloat32Array>` levels, :ref:`float<class_float>` intensity, :ref:`float<class_float>` strength, :ref:`float<class_float>` mix, :ref:`float<class_float>` bloom_threshold, :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` blend_mode, :ref:`float<class_float>` hdr_bleed_threshold, :ref:`float<class_float>` hdr_bleed_scale, :ref:`float<class_float>` hdr_luminance_cap, :ref:`float<class_float>` glow_map_strength, :ref:`RID<class_RID>` glow_map **)**
  3889. Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3890. .. rst-class:: classref-item-separator
  3891. ----
  3892. .. _class_RenderingServer_method_environment_set_sdfgi:
  3893. .. rst-class:: classref-method
  3894. void **environment_set_sdfgi** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` cascades, :ref:`float<class_float>` min_cell_size, :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` y_scale, :ref:`bool<class_bool>` use_occlusion, :ref:`float<class_float>` bounce_feedback, :ref:`bool<class_bool>` read_sky, :ref:`float<class_float>` energy, :ref:`float<class_float>` normal_bias, :ref:`float<class_float>` probe_bias **)**
  3895. Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
  3896. .. rst-class:: classref-item-separator
  3897. ----
  3898. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
  3899. .. rst-class:: classref-method
  3900. void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)**
  3901. 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>`.
  3902. .. rst-class:: classref-item-separator
  3903. ----
  3904. .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
  3905. .. rst-class:: classref-method
  3906. void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)**
  3907. 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>`.
  3908. .. rst-class:: classref-item-separator
  3909. ----
  3910. .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
  3911. .. rst-class:: classref-method
  3912. void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)**
  3913. 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>`.
  3914. .. rst-class:: classref-item-separator
  3915. ----
  3916. .. _class_RenderingServer_method_environment_set_sky:
  3917. .. rst-class:: classref-method
  3918. void **environment_set_sky** **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)**
  3919. 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>`.
  3920. .. rst-class:: classref-item-separator
  3921. ----
  3922. .. _class_RenderingServer_method_environment_set_sky_custom_fov:
  3923. .. rst-class:: classref-method
  3924. void **environment_set_sky_custom_fov** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)**
  3925. 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>`.
  3926. .. rst-class:: classref-item-separator
  3927. ----
  3928. .. _class_RenderingServer_method_environment_set_sky_orientation:
  3929. .. rst-class:: classref-method
  3930. void **environment_set_sky_orientation** **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)**
  3931. 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>`.
  3932. .. rst-class:: classref-item-separator
  3933. ----
  3934. .. _class_RenderingServer_method_environment_set_ssao:
  3935. .. rst-class:: classref-method
  3936. void **environment_set_ssao** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` radius, :ref:`float<class_float>` intensity, :ref:`float<class_float>` power, :ref:`float<class_float>` detail, :ref:`float<class_float>` horizon, :ref:`float<class_float>` sharpness, :ref:`float<class_float>` light_affect, :ref:`float<class_float>` ao_channel_affect **)**
  3937. Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3938. .. rst-class:: classref-item-separator
  3939. ----
  3940. .. _class_RenderingServer_method_environment_set_ssao_quality:
  3941. .. rst-class:: classref-method
  3942. void **environment_set_ssao_quality** **(** :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
  3943. Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3944. .. rst-class:: classref-item-separator
  3945. ----
  3946. .. _class_RenderingServer_method_environment_set_ssil_quality:
  3947. .. rst-class:: classref-method
  3948. void **environment_set_ssil_quality** **(** :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` quality, :ref:`bool<class_bool>` half_size, :ref:`float<class_float>` adaptive_target, :ref:`int<class_int>` blur_passes, :ref:`float<class_float>` fadeout_from, :ref:`float<class_float>` fadeout_to **)**
  3949. Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3950. .. rst-class:: classref-item-separator
  3951. ----
  3952. .. _class_RenderingServer_method_environment_set_ssr:
  3953. .. rst-class:: classref-method
  3954. void **environment_set_ssr** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`int<class_int>` max_steps, :ref:`float<class_float>` fade_in, :ref:`float<class_float>` fade_out, :ref:`float<class_float>` depth_tolerance **)**
  3955. Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3956. .. rst-class:: classref-item-separator
  3957. ----
  3958. .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
  3959. .. rst-class:: classref-method
  3960. void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)**
  3961. .. container:: contribute
  3962. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  3963. .. rst-class:: classref-item-separator
  3964. ----
  3965. .. _class_RenderingServer_method_environment_set_tonemap:
  3966. .. rst-class:: classref-method
  3967. void **environment_set_tonemap** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` tone_mapper, :ref:`float<class_float>` exposure, :ref:`float<class_float>` white **)**
  3968. Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3969. .. rst-class:: classref-item-separator
  3970. ----
  3971. .. _class_RenderingServer_method_environment_set_volumetric_fog:
  3972. .. rst-class:: classref-method
  3973. void **environment_set_volumetric_fog** **(** :ref:`RID<class_RID>` env, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` density, :ref:`Color<class_Color>` albedo, :ref:`Color<class_Color>` emission, :ref:`float<class_float>` emission_energy, :ref:`float<class_float>` anisotropy, :ref:`float<class_float>` length, :ref:`float<class_float>` p_detail_spread, :ref:`float<class_float>` gi_inject, :ref:`bool<class_bool>` temporal_reprojection, :ref:`float<class_float>` temporal_reprojection_amount, :ref:`float<class_float>` ambient_inject, :ref:`float<class_float>` sky_affect **)**
  3974. Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
  3975. .. rst-class:: classref-item-separator
  3976. ----
  3977. .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
  3978. .. rst-class:: classref-method
  3979. void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool<class_bool>` active **)**
  3980. Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
  3981. .. rst-class:: classref-item-separator
  3982. ----
  3983. .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
  3984. .. rst-class:: classref-method
  3985. void **environment_set_volumetric_fog_volume_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)**
  3986. 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.
  3987. .. rst-class:: classref-item-separator
  3988. ----
  3989. .. _class_RenderingServer_method_fog_volume_create:
  3990. .. rst-class:: classref-method
  3991. :ref:`RID<class_RID>` **fog_volume_create** **(** **)**
  3992. 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.
  3993. 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.
  3994. \ **Note:** The equivalent node is :ref:`FogVolume<class_FogVolume>`.
  3995. .. rst-class:: classref-item-separator
  3996. ----
  3997. .. _class_RenderingServer_method_fog_volume_set_material:
  3998. .. rst-class:: classref-method
  3999. void **fog_volume_set_material** **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)**
  4000. 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>`.
  4001. .. rst-class:: classref-item-separator
  4002. ----
  4003. .. _class_RenderingServer_method_fog_volume_set_shape:
  4004. .. rst-class:: classref-method
  4005. void **fog_volume_set_shape** **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)**
  4006. 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>`.
  4007. .. rst-class:: classref-item-separator
  4008. ----
  4009. .. _class_RenderingServer_method_fog_volume_set_size:
  4010. .. rst-class:: classref-method
  4011. void **fog_volume_set_size** **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)**
  4012. 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>`.
  4013. .. rst-class:: classref-item-separator
  4014. ----
  4015. .. _class_RenderingServer_method_force_draw:
  4016. .. rst-class:: classref-method
  4017. void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
  4018. Forces redrawing of all viewports at once.
  4019. .. rst-class:: classref-item-separator
  4020. ----
  4021. .. _class_RenderingServer_method_force_sync:
  4022. .. rst-class:: classref-method
  4023. void **force_sync** **(** **)**
  4024. 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.
  4025. .. rst-class:: classref-item-separator
  4026. ----
  4027. .. _class_RenderingServer_method_free_rid:
  4028. .. rst-class:: classref-method
  4029. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  4030. 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.
  4031. .. rst-class:: classref-item-separator
  4032. ----
  4033. .. _class_RenderingServer_method_get_default_clear_color:
  4034. .. rst-class:: classref-method
  4035. :ref:`Color<class_Color>` **get_default_clear_color** **(** **)**
  4036. 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>`.
  4037. .. rst-class:: classref-item-separator
  4038. ----
  4039. .. _class_RenderingServer_method_get_frame_setup_time_cpu:
  4040. .. rst-class:: classref-method
  4041. :ref:`float<class_float>` **get_frame_setup_time_cpu** **(** **)** |const|
  4042. 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>`.
  4043. .. rst-class:: classref-item-separator
  4044. ----
  4045. .. _class_RenderingServer_method_get_rendering_device:
  4046. .. rst-class:: classref-method
  4047. :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device** **(** **)** |const|
  4048. Returns the global RenderingDevice.
  4049. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
  4050. .. rst-class:: classref-item-separator
  4051. ----
  4052. .. _class_RenderingServer_method_get_rendering_info:
  4053. .. rst-class:: classref-method
  4054. :ref:`int<class_int>` **get_rendering_info** **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)**
  4055. Returns a statistic about the rendering engine which can be used for performance profiling. See :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` for a list of values that can be queried. See also :ref:`viewport_get_render_info<class_RenderingServer_method_viewport_get_render_info>`, which returns information specific to a viewport.
  4056. \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
  4057. \ **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:
  4058. ::
  4059. func _ready():
  4060. for _i in 2:
  4061. await get_tree().process_frame
  4062. print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
  4063. .. rst-class:: classref-item-separator
  4064. ----
  4065. .. _class_RenderingServer_method_get_shader_parameter_list:
  4066. .. rst-class:: classref-method
  4067. :ref:`Dictionary[]<class_Dictionary>` **get_shader_parameter_list** **(** :ref:`RID<class_RID>` shader **)** |const|
  4068. Returns the parameters of a shader.
  4069. .. rst-class:: classref-item-separator
  4070. ----
  4071. .. _class_RenderingServer_method_get_test_cube:
  4072. .. rst-class:: classref-method
  4073. :ref:`RID<class_RID>` **get_test_cube** **(** **)**
  4074. 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>`.
  4075. .. rst-class:: classref-item-separator
  4076. ----
  4077. .. _class_RenderingServer_method_get_test_texture:
  4078. .. rst-class:: classref-method
  4079. :ref:`RID<class_RID>` **get_test_texture** **(** **)**
  4080. 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>`.
  4081. Example of getting the test texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4082. ::
  4083. var texture_rid = RenderingServer.get_test_texture()
  4084. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4085. $Sprite2D.texture = texture
  4086. .. rst-class:: classref-item-separator
  4087. ----
  4088. .. _class_RenderingServer_method_get_video_adapter_api_version:
  4089. .. rst-class:: classref-method
  4090. :ref:`String<class_String>` **get_video_adapter_api_version** **(** **)** |const|
  4091. 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>`.
  4092. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4093. .. rst-class:: classref-item-separator
  4094. ----
  4095. .. _class_RenderingServer_method_get_video_adapter_name:
  4096. .. rst-class:: classref-method
  4097. :ref:`String<class_String>` **get_video_adapter_name** **(** **)** |const|
  4098. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
  4099. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4100. .. rst-class:: classref-item-separator
  4101. ----
  4102. .. _class_RenderingServer_method_get_video_adapter_type:
  4103. .. rst-class:: classref-method
  4104. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type** **(** **)** |const|
  4105. 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.
  4106. \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns :ref:`RenderingDevice.DEVICE_TYPE_OTHER<class_RenderingDevice_constant_DEVICE_TYPE_OTHER>`.
  4107. .. rst-class:: classref-item-separator
  4108. ----
  4109. .. _class_RenderingServer_method_get_video_adapter_vendor:
  4110. .. rst-class:: classref-method
  4111. :ref:`String<class_String>` **get_video_adapter_vendor** **(** **)** |const|
  4112. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
  4113. \ **Note:** When running a headless or server binary, this function returns an empty string.
  4114. .. rst-class:: classref-item-separator
  4115. ----
  4116. .. _class_RenderingServer_method_get_white_texture:
  4117. .. rst-class:: classref-method
  4118. :ref:`RID<class_RID>` **get_white_texture** **(** **)**
  4119. 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>`.
  4120. Example of getting the white texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  4121. ::
  4122. var texture_rid = RenderingServer.get_white_texture()
  4123. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  4124. $Sprite2D.texture = texture
  4125. .. rst-class:: classref-item-separator
  4126. ----
  4127. .. _class_RenderingServer_method_gi_set_use_half_resolution:
  4128. .. rst-class:: classref-method
  4129. void **gi_set_use_half_resolution** **(** :ref:`bool<class_bool>` half_resolution **)**
  4130. 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>`.
  4131. .. rst-class:: classref-item-separator
  4132. ----
  4133. .. _class_RenderingServer_method_global_shader_parameter_add:
  4134. .. rst-class:: classref-method
  4135. void **global_shader_parameter_add** **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` type, :ref:`Variant<class_Variant>` default_value **)**
  4136. Creates a new global shader uniform.
  4137. \ **Note:** Global shader parameter names are case-sensitive.
  4138. .. rst-class:: classref-item-separator
  4139. ----
  4140. .. _class_RenderingServer_method_global_shader_parameter_get:
  4141. .. rst-class:: classref-method
  4142. :ref:`Variant<class_Variant>` **global_shader_parameter_get** **(** :ref:`StringName<class_StringName>` name **)** |const|
  4143. Returns the value of the global shader uniform specified by ``name``.
  4144. \ **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.
  4145. .. rst-class:: classref-item-separator
  4146. ----
  4147. .. _class_RenderingServer_method_global_shader_parameter_get_list:
  4148. .. rst-class:: classref-method
  4149. :ref:`StringName[]<class_StringName>` **global_shader_parameter_get_list** **(** **)** |const|
  4150. Returns the list of global shader uniform names.
  4151. \ **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.
  4152. .. rst-class:: classref-item-separator
  4153. ----
  4154. .. _class_RenderingServer_method_global_shader_parameter_get_type:
  4155. .. rst-class:: classref-method
  4156. :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **global_shader_parameter_get_type** **(** :ref:`StringName<class_StringName>` name **)** |const|
  4157. Returns the type associated to the global shader uniform specified by ``name``.
  4158. \ **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.
  4159. .. rst-class:: classref-item-separator
  4160. ----
  4161. .. _class_RenderingServer_method_global_shader_parameter_remove:
  4162. .. rst-class:: classref-method
  4163. void **global_shader_parameter_remove** **(** :ref:`StringName<class_StringName>` name **)**
  4164. Removes the global shader uniform specified by ``name``.
  4165. .. rst-class:: classref-item-separator
  4166. ----
  4167. .. _class_RenderingServer_method_global_shader_parameter_set:
  4168. .. rst-class:: classref-method
  4169. void **global_shader_parameter_set** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
  4170. Sets the global shader uniform ``name`` to ``value``.
  4171. .. rst-class:: classref-item-separator
  4172. ----
  4173. .. _class_RenderingServer_method_global_shader_parameter_set_override:
  4174. .. rst-class:: classref-method
  4175. void **global_shader_parameter_set_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
  4176. Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
  4177. .. rst-class:: classref-item-separator
  4178. ----
  4179. .. _class_RenderingServer_method_has_changed:
  4180. .. rst-class:: classref-method
  4181. :ref:`bool<class_bool>` **has_changed** **(** **)** |const|
  4182. 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.
  4183. .. rst-class:: classref-item-separator
  4184. ----
  4185. .. _class_RenderingServer_method_has_feature:
  4186. .. rst-class:: classref-method
  4187. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const|
  4188. Not yet implemented. Always returns ``false``.
  4189. .. rst-class:: classref-item-separator
  4190. ----
  4191. .. _class_RenderingServer_method_has_os_feature:
  4192. .. rst-class:: classref-method
  4193. :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_String>` feature **)** |const|
  4194. Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
  4195. .. rst-class:: classref-item-separator
  4196. ----
  4197. .. _class_RenderingServer_method_instance_attach_object_instance_id:
  4198. .. rst-class:: classref-method
  4199. void **instance_attach_object_instance_id** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)**
  4200. 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>`.
  4201. .. rst-class:: classref-item-separator
  4202. ----
  4203. .. _class_RenderingServer_method_instance_attach_skeleton:
  4204. .. rst-class:: classref-method
  4205. void **instance_attach_skeleton** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)**
  4206. Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
  4207. .. rst-class:: classref-item-separator
  4208. ----
  4209. .. _class_RenderingServer_method_instance_create:
  4210. .. rst-class:: classref-method
  4211. :ref:`RID<class_RID>` **instance_create** **(** **)**
  4212. 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.
  4213. 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.
  4214. 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>`.
  4215. \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
  4216. .. rst-class:: classref-item-separator
  4217. ----
  4218. .. _class_RenderingServer_method_instance_create2:
  4219. .. rst-class:: classref-method
  4220. :ref:`RID<class_RID>` **instance_create2** **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)**
  4221. 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.
  4222. 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.
  4223. .. rst-class:: classref-item-separator
  4224. ----
  4225. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
  4226. .. rst-class:: classref-method
  4227. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
  4228. 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>`.
  4229. \ **Note:** Per-instance shader parameter names are case-sensitive.
  4230. .. rst-class:: classref-item-separator
  4231. ----
  4232. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
  4233. .. rst-class:: classref-method
  4234. :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
  4235. 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>`.
  4236. .. rst-class:: classref-item-separator
  4237. ----
  4238. .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
  4239. .. rst-class:: classref-method
  4240. :ref:`Dictionary[]<class_Dictionary>` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID<class_RID>` instance **)** |const|
  4241. 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>`.
  4242. .. rst-class:: classref-item-separator
  4243. ----
  4244. .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
  4245. .. rst-class:: classref-method
  4246. void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)**
  4247. Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
  4248. .. rst-class:: classref-item-separator
  4249. ----
  4250. .. _class_RenderingServer_method_instance_geometry_set_flag:
  4251. .. rst-class:: classref-method
  4252. void **instance_geometry_set_flag** **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)**
  4253. Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
  4254. .. rst-class:: classref-item-separator
  4255. ----
  4256. .. _class_RenderingServer_method_instance_geometry_set_lightmap:
  4257. .. rst-class:: classref-method
  4258. void **instance_geometry_set_lightmap** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` lightmap, :ref:`Rect2<class_Rect2>` lightmap_uv_scale, :ref:`int<class_int>` lightmap_slice **)**
  4259. 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.
  4260. .. rst-class:: classref-item-separator
  4261. ----
  4262. .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
  4263. .. rst-class:: classref-method
  4264. void **instance_geometry_set_lod_bias** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)**
  4265. 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>`.
  4266. .. rst-class:: classref-item-separator
  4267. ----
  4268. .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
  4269. .. rst-class:: classref-method
  4270. void **instance_geometry_set_material_overlay** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
  4271. 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>`.
  4272. .. rst-class:: classref-item-separator
  4273. ----
  4274. .. _class_RenderingServer_method_instance_geometry_set_material_override:
  4275. .. rst-class:: classref-method
  4276. void **instance_geometry_set_material_override** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
  4277. 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>`.
  4278. .. rst-class:: classref-item-separator
  4279. ----
  4280. .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
  4281. .. rst-class:: classref-method
  4282. void **instance_geometry_set_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
  4283. 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>`.
  4284. .. rst-class:: classref-item-separator
  4285. ----
  4286. .. _class_RenderingServer_method_instance_geometry_set_transparency:
  4287. .. rst-class:: classref-method
  4288. void **instance_geometry_set_transparency** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)**
  4289. Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
  4290. 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.
  4291. In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
  4292. \ **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.
  4293. .. rst-class:: classref-item-separator
  4294. ----
  4295. .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
  4296. .. rst-class:: classref-method
  4297. void **instance_geometry_set_visibility_range** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` min, :ref:`float<class_float>` max, :ref:`float<class_float>` min_margin, :ref:`float<class_float>` max_margin, :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` fade_mode **)**
  4298. 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.
  4299. .. rst-class:: classref-item-separator
  4300. ----
  4301. .. _class_RenderingServer_method_instance_set_base:
  4302. .. rst-class:: classref-method
  4303. void **instance_set_base** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)**
  4304. 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.
  4305. .. rst-class:: classref-item-separator
  4306. ----
  4307. .. _class_RenderingServer_method_instance_set_blend_shape_weight:
  4308. .. rst-class:: classref-method
  4309. void **instance_set_blend_shape_weight** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)**
  4310. Sets the weight for a given blend shape associated with this instance.
  4311. .. rst-class:: classref-item-separator
  4312. ----
  4313. .. _class_RenderingServer_method_instance_set_custom_aabb:
  4314. .. rst-class:: classref-method
  4315. void **instance_set_custom_aabb** **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)**
  4316. 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>`.
  4317. .. rst-class:: classref-item-separator
  4318. ----
  4319. .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
  4320. .. rst-class:: classref-method
  4321. void **instance_set_extra_visibility_margin** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)**
  4322. 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>`.
  4323. .. rst-class:: classref-item-separator
  4324. ----
  4325. .. _class_RenderingServer_method_instance_set_ignore_culling:
  4326. .. rst-class:: classref-method
  4327. void **instance_set_ignore_culling** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)**
  4328. 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.
  4329. .. rst-class:: classref-item-separator
  4330. ----
  4331. .. _class_RenderingServer_method_instance_set_layer_mask:
  4332. .. rst-class:: classref-method
  4333. void **instance_set_layer_mask** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)**
  4334. Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
  4335. .. rst-class:: classref-item-separator
  4336. ----
  4337. .. _class_RenderingServer_method_instance_set_pivot_data:
  4338. .. rst-class:: classref-method
  4339. void **instance_set_pivot_data** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` sorting_offset, :ref:`bool<class_bool>` use_aabb_center **)**
  4340. Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
  4341. .. rst-class:: classref-item-separator
  4342. ----
  4343. .. _class_RenderingServer_method_instance_set_scenario:
  4344. .. rst-class:: classref-method
  4345. void **instance_set_scenario** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)**
  4346. Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
  4347. .. rst-class:: classref-item-separator
  4348. ----
  4349. .. _class_RenderingServer_method_instance_set_surface_override_material:
  4350. .. rst-class:: classref-method
  4351. void **instance_set_surface_override_material** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
  4352. Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
  4353. .. rst-class:: classref-item-separator
  4354. ----
  4355. .. _class_RenderingServer_method_instance_set_transform:
  4356. .. rst-class:: classref-method
  4357. void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)**
  4358. Sets the world space transform of the instance. Equivalent to :ref:`Node3D.transform<class_Node3D_property_transform>`.
  4359. .. rst-class:: classref-item-separator
  4360. ----
  4361. .. _class_RenderingServer_method_instance_set_visibility_parent:
  4362. .. rst-class:: classref-method
  4363. void **instance_set_visibility_parent** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)**
  4364. Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
  4365. .. rst-class:: classref-item-separator
  4366. ----
  4367. .. _class_RenderingServer_method_instance_set_visible:
  4368. .. rst-class:: classref-method
  4369. void **instance_set_visible** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)**
  4370. Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
  4371. .. rst-class:: classref-item-separator
  4372. ----
  4373. .. _class_RenderingServer_method_instances_cull_aabb:
  4374. .. rst-class:: classref-method
  4375. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_aabb** **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4376. 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.
  4377. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4378. .. rst-class:: classref-item-separator
  4379. ----
  4380. .. _class_RenderingServer_method_instances_cull_convex:
  4381. .. rst-class:: classref-method
  4382. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_convex** **(** :ref:`Plane[]<class_Plane>` convex, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4383. 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.
  4384. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4385. .. rst-class:: classref-item-separator
  4386. ----
  4387. .. _class_RenderingServer_method_instances_cull_ray:
  4388. .. rst-class:: classref-method
  4389. :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario=RID() **)** |const|
  4390. 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.
  4391. \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
  4392. .. rst-class:: classref-item-separator
  4393. ----
  4394. .. _class_RenderingServer_method_light_directional_set_blend_splits:
  4395. .. rst-class:: classref-method
  4396. void **light_directional_set_blend_splits** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
  4397. 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>`.
  4398. .. rst-class:: classref-item-separator
  4399. ----
  4400. .. _class_RenderingServer_method_light_directional_set_shadow_mode:
  4401. .. rst-class:: classref-method
  4402. void **light_directional_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)**
  4403. Sets the shadow mode for this directional light. Equivalent to :ref:`DirectionalLight3D.directional_shadow_mode<class_DirectionalLight3D_property_directional_shadow_mode>`. See :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` for options.
  4404. .. rst-class:: classref-item-separator
  4405. ----
  4406. .. _class_RenderingServer_method_light_directional_set_sky_mode:
  4407. .. rst-class:: classref-method
  4408. void **light_directional_set_sky_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` mode **)**
  4409. 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.
  4410. .. rst-class:: classref-item-separator
  4411. ----
  4412. .. _class_RenderingServer_method_light_omni_set_shadow_mode:
  4413. .. rst-class:: classref-method
  4414. void **light_omni_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)**
  4415. 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>`.
  4416. .. rst-class:: classref-item-separator
  4417. ----
  4418. .. _class_RenderingServer_method_light_projectors_set_filter:
  4419. .. rst-class:: classref-method
  4420. void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)**
  4421. Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
  4422. .. rst-class:: classref-item-separator
  4423. ----
  4424. .. _class_RenderingServer_method_light_set_bake_mode:
  4425. .. rst-class:: classref-method
  4426. void **light_set_bake_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)**
  4427. Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
  4428. .. rst-class:: classref-item-separator
  4429. ----
  4430. .. _class_RenderingServer_method_light_set_color:
  4431. .. rst-class:: classref-method
  4432. void **light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
  4433. Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
  4434. .. rst-class:: classref-item-separator
  4435. ----
  4436. .. _class_RenderingServer_method_light_set_cull_mask:
  4437. .. rst-class:: classref-method
  4438. void **light_set_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
  4439. 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>`.
  4440. .. rst-class:: classref-item-separator
  4441. ----
  4442. .. _class_RenderingServer_method_light_set_distance_fade:
  4443. .. rst-class:: classref-method
  4444. void **light_set_distance_fade** **(** :ref:`RID<class_RID>` decal, :ref:`bool<class_bool>` enabled, :ref:`float<class_float>` begin, :ref:`float<class_float>` shadow, :ref:`float<class_float>` length **)**
  4445. 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>`.
  4446. .. rst-class:: classref-item-separator
  4447. ----
  4448. .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
  4449. .. rst-class:: classref-method
  4450. void **light_set_max_sdfgi_cascade** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)**
  4451. 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.
  4452. .. rst-class:: classref-item-separator
  4453. ----
  4454. .. _class_RenderingServer_method_light_set_negative:
  4455. .. rst-class:: classref-method
  4456. void **light_set_negative** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
  4457. If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
  4458. .. rst-class:: classref-item-separator
  4459. ----
  4460. .. _class_RenderingServer_method_light_set_param:
  4461. .. rst-class:: classref-method
  4462. void **light_set_param** **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)**
  4463. Sets the specified 3D light parameter. See :ref:`LightParam<enum_RenderingServer_LightParam>` for options. Equivalent to :ref:`Light3D.set_param<class_Light3D_method_set_param>`.
  4464. .. rst-class:: classref-item-separator
  4465. ----
  4466. .. _class_RenderingServer_method_light_set_projector:
  4467. .. rst-class:: classref-method
  4468. void **light_set_projector** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
  4469. Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
  4470. .. rst-class:: classref-item-separator
  4471. ----
  4472. .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
  4473. .. rst-class:: classref-method
  4474. void **light_set_reverse_cull_face_mode** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  4475. 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>`.
  4476. .. rst-class:: classref-item-separator
  4477. ----
  4478. .. _class_RenderingServer_method_light_set_shadow:
  4479. .. rst-class:: classref-method
  4480. void **light_set_shadow** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
  4481. If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
  4482. .. rst-class:: classref-item-separator
  4483. ----
  4484. .. _class_RenderingServer_method_lightmap_create:
  4485. .. rst-class:: classref-method
  4486. :ref:`RID<class_RID>` **lightmap_create** **(** **)**
  4487. 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.
  4488. 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.
  4489. \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
  4490. .. rst-class:: classref-item-separator
  4491. ----
  4492. .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
  4493. .. rst-class:: classref-method
  4494. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4495. .. container:: contribute
  4496. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4497. .. rst-class:: classref-item-separator
  4498. ----
  4499. .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
  4500. .. rst-class:: classref-method
  4501. :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4502. .. container:: contribute
  4503. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4504. .. rst-class:: classref-item-separator
  4505. ----
  4506. .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
  4507. .. rst-class:: classref-method
  4508. :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4509. .. container:: contribute
  4510. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4511. .. rst-class:: classref-item-separator
  4512. ----
  4513. .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
  4514. .. rst-class:: classref-method
  4515. :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID<class_RID>` lightmap **)** |const|
  4516. .. container:: contribute
  4517. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4518. .. rst-class:: classref-item-separator
  4519. ----
  4520. .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
  4521. .. rst-class:: classref-method
  4522. void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` lightmap, :ref:`float<class_float>` baked_exposure **)**
  4523. 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>`.
  4524. .. rst-class:: classref-item-separator
  4525. ----
  4526. .. _class_RenderingServer_method_lightmap_set_probe_bounds:
  4527. .. rst-class:: classref-method
  4528. void **lightmap_set_probe_bounds** **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)**
  4529. .. container:: contribute
  4530. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4531. .. rst-class:: classref-item-separator
  4532. ----
  4533. .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
  4534. .. rst-class:: classref-method
  4535. void **lightmap_set_probe_capture_data** **(** :ref:`RID<class_RID>` lightmap, :ref:`PackedVector3Array<class_PackedVector3Array>` points, :ref:`PackedColorArray<class_PackedColorArray>` point_sh, :ref:`PackedInt32Array<class_PackedInt32Array>` tetrahedra, :ref:`PackedInt32Array<class_PackedInt32Array>` bsp_tree **)**
  4536. .. container:: contribute
  4537. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4538. .. rst-class:: classref-item-separator
  4539. ----
  4540. .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
  4541. .. rst-class:: classref-method
  4542. void **lightmap_set_probe_capture_update_speed** **(** :ref:`float<class_float>` speed **)**
  4543. .. container:: contribute
  4544. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4545. .. rst-class:: classref-item-separator
  4546. ----
  4547. .. _class_RenderingServer_method_lightmap_set_probe_interior:
  4548. .. rst-class:: classref-method
  4549. void **lightmap_set_probe_interior** **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)**
  4550. .. container:: contribute
  4551. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4552. .. rst-class:: classref-item-separator
  4553. ----
  4554. .. _class_RenderingServer_method_lightmap_set_textures:
  4555. .. rst-class:: classref-method
  4556. void **lightmap_set_textures** **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)**
  4557. 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``.
  4558. .. rst-class:: classref-item-separator
  4559. ----
  4560. .. _class_RenderingServer_method_make_sphere_mesh:
  4561. .. rst-class:: classref-method
  4562. :ref:`RID<class_RID>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
  4563. 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>`.
  4564. .. rst-class:: classref-item-separator
  4565. ----
  4566. .. _class_RenderingServer_method_material_create:
  4567. .. rst-class:: classref-method
  4568. :ref:`RID<class_RID>` **material_create** **(** **)**
  4569. 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.
  4570. 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.
  4571. \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
  4572. .. rst-class:: classref-item-separator
  4573. ----
  4574. .. _class_RenderingServer_method_material_get_param:
  4575. .. rst-class:: classref-method
  4576. :ref:`Variant<class_Variant>` **material_get_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const|
  4577. Returns the value of a certain material's parameter.
  4578. .. rst-class:: classref-item-separator
  4579. ----
  4580. .. _class_RenderingServer_method_material_set_next_pass:
  4581. .. rst-class:: classref-method
  4582. void **material_set_next_pass** **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)**
  4583. Sets an object's next material.
  4584. .. rst-class:: classref-item-separator
  4585. ----
  4586. .. _class_RenderingServer_method_material_set_param:
  4587. .. rst-class:: classref-method
  4588. void **material_set_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
  4589. Sets a material's parameter.
  4590. .. rst-class:: classref-item-separator
  4591. ----
  4592. .. _class_RenderingServer_method_material_set_render_priority:
  4593. .. rst-class:: classref-method
  4594. void **material_set_render_priority** **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)**
  4595. Sets a material's render priority.
  4596. .. rst-class:: classref-item-separator
  4597. ----
  4598. .. _class_RenderingServer_method_material_set_shader:
  4599. .. rst-class:: classref-method
  4600. void **material_set_shader** **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)**
  4601. Sets a shader material's shader.
  4602. .. rst-class:: classref-item-separator
  4603. ----
  4604. .. _class_RenderingServer_method_mesh_add_surface:
  4605. .. rst-class:: classref-method
  4606. void **mesh_add_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)**
  4607. .. container:: contribute
  4608. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4609. .. rst-class:: classref-item-separator
  4610. ----
  4611. .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
  4612. .. rst-class:: classref-method
  4613. void **mesh_add_surface_from_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[], :ref:`Dictionary<class_Dictionary>` lods={}, |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> compress_format=0 **)**
  4614. .. container:: contribute
  4615. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4616. .. rst-class:: classref-item-separator
  4617. ----
  4618. .. _class_RenderingServer_method_mesh_clear:
  4619. .. rst-class:: classref-method
  4620. void **mesh_clear** **(** :ref:`RID<class_RID>` mesh **)**
  4621. Removes all surfaces from a mesh.
  4622. .. rst-class:: classref-item-separator
  4623. ----
  4624. .. _class_RenderingServer_method_mesh_create:
  4625. .. rst-class:: classref-method
  4626. :ref:`RID<class_RID>` **mesh_create** **(** **)**
  4627. 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.
  4628. 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.
  4629. 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.
  4630. \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
  4631. .. rst-class:: classref-item-separator
  4632. ----
  4633. .. _class_RenderingServer_method_mesh_create_from_surfaces:
  4634. .. rst-class:: classref-method
  4635. :ref:`RID<class_RID>` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)**
  4636. .. container:: contribute
  4637. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4638. .. rst-class:: classref-item-separator
  4639. ----
  4640. .. _class_RenderingServer_method_mesh_get_blend_shape_count:
  4641. .. rst-class:: classref-method
  4642. :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4643. Returns a mesh's blend shape count.
  4644. .. rst-class:: classref-item-separator
  4645. ----
  4646. .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
  4647. .. rst-class:: classref-method
  4648. :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4649. Returns a mesh's blend shape mode.
  4650. .. rst-class:: classref-item-separator
  4651. ----
  4652. .. _class_RenderingServer_method_mesh_get_custom_aabb:
  4653. .. rst-class:: classref-method
  4654. :ref:`AABB<class_AABB>` **mesh_get_custom_aabb** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4655. Returns a mesh's custom aabb.
  4656. .. rst-class:: classref-item-separator
  4657. ----
  4658. .. _class_RenderingServer_method_mesh_get_surface:
  4659. .. rst-class:: classref-method
  4660. :ref:`Dictionary<class_Dictionary>` **mesh_get_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)**
  4661. .. container:: contribute
  4662. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4663. .. rst-class:: classref-item-separator
  4664. ----
  4665. .. _class_RenderingServer_method_mesh_get_surface_count:
  4666. .. rst-class:: classref-method
  4667. :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
  4668. Returns a mesh's number of surfaces.
  4669. .. rst-class:: classref-item-separator
  4670. ----
  4671. .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
  4672. .. rst-class:: classref-method
  4673. void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)**
  4674. Sets a mesh's blend shape mode.
  4675. .. rst-class:: classref-item-separator
  4676. ----
  4677. .. _class_RenderingServer_method_mesh_set_custom_aabb:
  4678. .. rst-class:: classref-method
  4679. void **mesh_set_custom_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)**
  4680. Sets a mesh's custom aabb.
  4681. .. rst-class:: classref-item-separator
  4682. ----
  4683. .. _class_RenderingServer_method_mesh_set_shadow_mesh:
  4684. .. rst-class:: classref-method
  4685. void **mesh_set_shadow_mesh** **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)**
  4686. .. container:: contribute
  4687. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4688. .. rst-class:: classref-item-separator
  4689. ----
  4690. .. _class_RenderingServer_method_mesh_surface_get_arrays:
  4691. .. rst-class:: classref-method
  4692. :ref:`Array<class_Array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4693. Returns a mesh's surface's buffer arrays.
  4694. .. rst-class:: classref-item-separator
  4695. ----
  4696. .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
  4697. .. rst-class:: classref-method
  4698. :ref:`Array[]<class_Array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4699. Returns a mesh's surface's arrays for blend shapes.
  4700. .. rst-class:: classref-item-separator
  4701. ----
  4702. .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
  4703. .. rst-class:: classref-method
  4704. :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4705. .. container:: contribute
  4706. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4707. .. rst-class:: classref-item-separator
  4708. ----
  4709. .. _class_RenderingServer_method_mesh_surface_get_format_offset:
  4710. .. rst-class:: classref-method
  4711. :ref:`int<class_int>` **mesh_surface_get_format_offset** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` array_index **)** |const|
  4712. .. container:: contribute
  4713. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4714. .. rst-class:: classref-item-separator
  4715. ----
  4716. .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
  4717. .. rst-class:: classref-method
  4718. :ref:`int<class_int>` **mesh_surface_get_format_skin_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4719. .. container:: contribute
  4720. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4721. .. rst-class:: classref-item-separator
  4722. ----
  4723. .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
  4724. .. rst-class:: classref-method
  4725. :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
  4726. .. container:: contribute
  4727. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4728. .. rst-class:: classref-item-separator
  4729. ----
  4730. .. _class_RenderingServer_method_mesh_surface_get_material:
  4731. .. rst-class:: classref-method
  4732. :ref:`RID<class_RID>` **mesh_surface_get_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
  4733. Returns a mesh's surface's material.
  4734. .. rst-class:: classref-item-separator
  4735. ----
  4736. .. _class_RenderingServer_method_mesh_surface_set_material:
  4737. .. rst-class:: classref-method
  4738. void **mesh_surface_set_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
  4739. Sets a mesh's surface's material.
  4740. .. rst-class:: classref-item-separator
  4741. ----
  4742. .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
  4743. .. rst-class:: classref-method
  4744. void **mesh_surface_update_attribute_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4745. .. container:: contribute
  4746. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4747. .. rst-class:: classref-item-separator
  4748. ----
  4749. .. _class_RenderingServer_method_mesh_surface_update_skin_region:
  4750. .. rst-class:: classref-method
  4751. void **mesh_surface_update_skin_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4752. .. container:: contribute
  4753. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4754. .. rst-class:: classref-item-separator
  4755. ----
  4756. .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
  4757. .. rst-class:: classref-method
  4758. void **mesh_surface_update_vertex_region** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  4759. .. container:: contribute
  4760. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4761. .. rst-class:: classref-item-separator
  4762. ----
  4763. .. _class_RenderingServer_method_multimesh_allocate_data:
  4764. .. rst-class:: classref-method
  4765. void **multimesh_allocate_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` instances, :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` transform_format, :ref:`bool<class_bool>` color_format=false, :ref:`bool<class_bool>` custom_data_format=false **)**
  4766. .. container:: contribute
  4767. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  4768. .. rst-class:: classref-item-separator
  4769. ----
  4770. .. _class_RenderingServer_method_multimesh_create:
  4771. .. rst-class:: classref-method
  4772. :ref:`RID<class_RID>` **multimesh_create** **(** **)**
  4773. 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.
  4774. 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.
  4775. 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.
  4776. \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
  4777. .. rst-class:: classref-item-separator
  4778. ----
  4779. .. _class_RenderingServer_method_multimesh_get_aabb:
  4780. .. rst-class:: classref-method
  4781. :ref:`AABB<class_AABB>` **multimesh_get_aabb** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4782. Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
  4783. .. rst-class:: classref-item-separator
  4784. ----
  4785. .. _class_RenderingServer_method_multimesh_get_buffer:
  4786. .. rst-class:: classref-method
  4787. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4788. Returns the MultiMesh data (such as instance transforms, colors, etc). See :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` for a description of the returned data.
  4789. \ **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.
  4790. .. rst-class:: classref-item-separator
  4791. ----
  4792. .. _class_RenderingServer_method_multimesh_get_instance_count:
  4793. .. rst-class:: classref-method
  4794. :ref:`int<class_int>` **multimesh_get_instance_count** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4795. Returns the number of instances allocated for this multimesh.
  4796. .. rst-class:: classref-item-separator
  4797. ----
  4798. .. _class_RenderingServer_method_multimesh_get_mesh:
  4799. .. rst-class:: classref-method
  4800. :ref:`RID<class_RID>` **multimesh_get_mesh** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4801. Returns the RID of the mesh that will be used in drawing this multimesh.
  4802. .. rst-class:: classref-item-separator
  4803. ----
  4804. .. _class_RenderingServer_method_multimesh_get_visible_instances:
  4805. .. rst-class:: classref-method
  4806. :ref:`int<class_int>` **multimesh_get_visible_instances** **(** :ref:`RID<class_RID>` multimesh **)** |const|
  4807. Returns the number of visible instances for this multimesh.
  4808. .. rst-class:: classref-item-separator
  4809. ----
  4810. .. _class_RenderingServer_method_multimesh_instance_get_color:
  4811. .. rst-class:: classref-method
  4812. :ref:`Color<class_Color>` **multimesh_instance_get_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4813. Returns the color by which the specified instance will be modulated.
  4814. .. rst-class:: classref-item-separator
  4815. ----
  4816. .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
  4817. .. rst-class:: classref-method
  4818. :ref:`Color<class_Color>` **multimesh_instance_get_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4819. Returns the custom data associated with the specified instance.
  4820. .. rst-class:: classref-item-separator
  4821. ----
  4822. .. _class_RenderingServer_method_multimesh_instance_get_transform:
  4823. .. rst-class:: classref-method
  4824. :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4825. Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
  4826. .. rst-class:: classref-item-separator
  4827. ----
  4828. .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
  4829. .. rst-class:: classref-method
  4830. :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
  4831. Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
  4832. .. rst-class:: classref-item-separator
  4833. ----
  4834. .. _class_RenderingServer_method_multimesh_instance_set_color:
  4835. .. rst-class:: classref-method
  4836. void **multimesh_instance_set_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)**
  4837. Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
  4838. .. rst-class:: classref-item-separator
  4839. ----
  4840. .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
  4841. .. rst-class:: classref-method
  4842. void **multimesh_instance_set_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)**
  4843. 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>`.
  4844. .. rst-class:: classref-item-separator
  4845. ----
  4846. .. _class_RenderingServer_method_multimesh_instance_set_transform:
  4847. .. rst-class:: classref-method
  4848. void **multimesh_instance_set_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)**
  4849. Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
  4850. .. rst-class:: classref-item-separator
  4851. ----
  4852. .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
  4853. .. rst-class:: classref-method
  4854. void **multimesh_instance_set_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)**
  4855. 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>`.
  4856. .. rst-class:: classref-item-separator
  4857. ----
  4858. .. _class_RenderingServer_method_multimesh_set_buffer:
  4859. .. rst-class:: classref-method
  4860. void **multimesh_set_buffer** **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)**
  4861. 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>`.
  4862. The per-instance data size and expected data order is:
  4863. ::
  4864. 2D:
  4865. - Position: 8 floats (8 floats for Transform2D)
  4866. - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
  4867. - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
  4868. - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
  4869. 3D:
  4870. - Position: 12 floats (12 floats for Transform3D)
  4871. - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
  4872. - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
  4873. - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
  4874. .. rst-class:: classref-item-separator
  4875. ----
  4876. .. _class_RenderingServer_method_multimesh_set_mesh:
  4877. .. rst-class:: classref-method
  4878. void **multimesh_set_mesh** **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)**
  4879. Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
  4880. .. rst-class:: classref-item-separator
  4881. ----
  4882. .. _class_RenderingServer_method_multimesh_set_visible_instances:
  4883. .. rst-class:: classref-method
  4884. void **multimesh_set_visible_instances** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)**
  4885. 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>`.
  4886. .. rst-class:: classref-item-separator
  4887. ----
  4888. .. _class_RenderingServer_method_occluder_create:
  4889. .. rst-class:: classref-method
  4890. :ref:`RID<class_RID>` **occluder_create** **(** **)**
  4891. 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.
  4892. 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.
  4893. \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
  4894. .. rst-class:: classref-item-separator
  4895. ----
  4896. .. _class_RenderingServer_method_occluder_set_mesh:
  4897. .. rst-class:: classref-method
  4898. void **occluder_set_mesh** **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
  4899. Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
  4900. .. rst-class:: classref-item-separator
  4901. ----
  4902. .. _class_RenderingServer_method_omni_light_create:
  4903. .. rst-class:: classref-method
  4904. :ref:`RID<class_RID>` **omni_light_create** **(** **)**
  4905. 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.
  4906. 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.
  4907. 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.
  4908. \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
  4909. .. rst-class:: classref-item-separator
  4910. ----
  4911. .. _class_RenderingServer_method_particles_collision_create:
  4912. .. rst-class:: classref-method
  4913. :ref:`RID<class_RID>` **particles_collision_create** **(** **)**
  4914. 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.
  4915. \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
  4916. .. rst-class:: classref-item-separator
  4917. ----
  4918. .. _class_RenderingServer_method_particles_collision_height_field_update:
  4919. .. rst-class:: classref-method
  4920. void **particles_collision_height_field_update** **(** :ref:`RID<class_RID>` particles_collision **)**
  4921. 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>`.
  4922. .. rst-class:: classref-item-separator
  4923. ----
  4924. .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
  4925. .. rst-class:: classref-method
  4926. void **particles_collision_set_attractor_attenuation** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)**
  4927. 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>`.
  4928. .. rst-class:: classref-item-separator
  4929. ----
  4930. .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
  4931. .. rst-class:: classref-method
  4932. void **particles_collision_set_attractor_directionality** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)**
  4933. 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>`.
  4934. .. rst-class:: classref-item-separator
  4935. ----
  4936. .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
  4937. .. rst-class:: classref-method
  4938. void **particles_collision_set_attractor_strength** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` strength **)**
  4939. 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>`.
  4940. .. rst-class:: classref-item-separator
  4941. ----
  4942. .. _class_RenderingServer_method_particles_collision_set_box_extents:
  4943. .. rst-class:: classref-method
  4944. void **particles_collision_set_box_extents** **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)**
  4945. 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.
  4946. .. rst-class:: classref-item-separator
  4947. ----
  4948. .. _class_RenderingServer_method_particles_collision_set_collision_type:
  4949. .. rst-class:: classref-method
  4950. void **particles_collision_set_collision_type** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)**
  4951. Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
  4952. .. rst-class:: classref-item-separator
  4953. ----
  4954. .. _class_RenderingServer_method_particles_collision_set_cull_mask:
  4955. .. rst-class:: classref-method
  4956. void **particles_collision_set_cull_mask** **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)**
  4957. 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.
  4958. .. rst-class:: classref-item-separator
  4959. ----
  4960. .. _class_RenderingServer_method_particles_collision_set_field_texture:
  4961. .. rst-class:: classref-method
  4962. void **particles_collision_set_field_texture** **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)**
  4963. 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.
  4964. .. rst-class:: classref-item-separator
  4965. ----
  4966. .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
  4967. .. rst-class:: classref-method
  4968. void **particles_collision_set_height_field_resolution** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)**
  4969. 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>`.
  4970. .. rst-class:: classref-item-separator
  4971. ----
  4972. .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
  4973. .. rst-class:: classref-method
  4974. void **particles_collision_set_sphere_radius** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)**
  4975. 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.
  4976. .. rst-class:: classref-item-separator
  4977. ----
  4978. .. _class_RenderingServer_method_particles_create:
  4979. .. rst-class:: classref-method
  4980. :ref:`RID<class_RID>` **particles_create** **(** **)**
  4981. 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.
  4982. 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.
  4983. 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.
  4984. \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
  4985. \ **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).
  4986. .. rst-class:: classref-item-separator
  4987. ----
  4988. .. _class_RenderingServer_method_particles_emit:
  4989. .. rst-class:: classref-method
  4990. void **particles_emit** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform, :ref:`Vector3<class_Vector3>` velocity, :ref:`Color<class_Color>` color, :ref:`Color<class_Color>` custom, :ref:`int<class_int>` emit_flags **)**
  4991. Manually emits particles from the ``particles`` instance.
  4992. .. rst-class:: classref-item-separator
  4993. ----
  4994. .. _class_RenderingServer_method_particles_get_current_aabb:
  4995. .. rst-class:: classref-method
  4996. :ref:`AABB<class_AABB>` **particles_get_current_aabb** **(** :ref:`RID<class_RID>` particles **)**
  4997. Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
  4998. .. rst-class:: classref-item-separator
  4999. ----
  5000. .. _class_RenderingServer_method_particles_get_emitting:
  5001. .. rst-class:: classref-method
  5002. :ref:`bool<class_bool>` **particles_get_emitting** **(** :ref:`RID<class_RID>` particles **)**
  5003. Returns ``true`` if particles are currently set to emitting.
  5004. .. rst-class:: classref-item-separator
  5005. ----
  5006. .. _class_RenderingServer_method_particles_is_inactive:
  5007. .. rst-class:: classref-method
  5008. :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
  5009. Returns ``true`` if particles are not emitting and particles are set to inactive.
  5010. .. rst-class:: classref-item-separator
  5011. ----
  5012. .. _class_RenderingServer_method_particles_request_process:
  5013. .. rst-class:: classref-method
  5014. void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
  5015. 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>`.
  5016. .. rst-class:: classref-item-separator
  5017. ----
  5018. .. _class_RenderingServer_method_particles_restart:
  5019. .. rst-class:: classref-method
  5020. void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
  5021. Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
  5022. .. rst-class:: classref-item-separator
  5023. ----
  5024. .. _class_RenderingServer_method_particles_set_amount:
  5025. .. rst-class:: classref-method
  5026. void **particles_set_amount** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)**
  5027. Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
  5028. .. rst-class:: classref-item-separator
  5029. ----
  5030. .. _class_RenderingServer_method_particles_set_collision_base_size:
  5031. .. rst-class:: classref-method
  5032. void **particles_set_collision_base_size** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)**
  5033. .. container:: contribute
  5034. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5035. .. rst-class:: classref-item-separator
  5036. ----
  5037. .. _class_RenderingServer_method_particles_set_custom_aabb:
  5038. .. rst-class:: classref-method
  5039. void **particles_set_custom_aabb** **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)**
  5040. Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
  5041. .. rst-class:: classref-item-separator
  5042. ----
  5043. .. _class_RenderingServer_method_particles_set_draw_order:
  5044. .. rst-class:: classref-method
  5045. void **particles_set_draw_order** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)**
  5046. Sets the draw order of the particles to one of the named enums from :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>`. See :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` for options. Equivalent to :ref:`GPUParticles3D.draw_order<class_GPUParticles3D_property_draw_order>`.
  5047. .. rst-class:: classref-item-separator
  5048. ----
  5049. .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
  5050. .. rst-class:: classref-method
  5051. void **particles_set_draw_pass_mesh** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)**
  5052. 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>`.
  5053. .. rst-class:: classref-item-separator
  5054. ----
  5055. .. _class_RenderingServer_method_particles_set_draw_passes:
  5056. .. rst-class:: classref-method
  5057. void **particles_set_draw_passes** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)**
  5058. Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
  5059. .. rst-class:: classref-item-separator
  5060. ----
  5061. .. _class_RenderingServer_method_particles_set_emission_transform:
  5062. .. rst-class:: classref-method
  5063. void **particles_set_emission_transform** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)**
  5064. Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
  5065. .. rst-class:: classref-item-separator
  5066. ----
  5067. .. _class_RenderingServer_method_particles_set_emitting:
  5068. .. rst-class:: classref-method
  5069. void **particles_set_emitting** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)**
  5070. 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>`.
  5071. .. rst-class:: classref-item-separator
  5072. ----
  5073. .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
  5074. .. rst-class:: classref-method
  5075. void **particles_set_explosiveness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
  5076. Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
  5077. .. rst-class:: classref-item-separator
  5078. ----
  5079. .. _class_RenderingServer_method_particles_set_fixed_fps:
  5080. .. rst-class:: classref-method
  5081. void **particles_set_fixed_fps** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)**
  5082. Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
  5083. .. rst-class:: classref-item-separator
  5084. ----
  5085. .. _class_RenderingServer_method_particles_set_fractional_delta:
  5086. .. rst-class:: classref-method
  5087. void **particles_set_fractional_delta** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5088. If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
  5089. .. rst-class:: classref-item-separator
  5090. ----
  5091. .. _class_RenderingServer_method_particles_set_interpolate:
  5092. .. rst-class:: classref-method
  5093. void **particles_set_interpolate** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5094. .. container:: contribute
  5095. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5096. .. rst-class:: classref-item-separator
  5097. ----
  5098. .. _class_RenderingServer_method_particles_set_lifetime:
  5099. .. rst-class:: classref-method
  5100. void **particles_set_lifetime** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)**
  5101. Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
  5102. .. rst-class:: classref-item-separator
  5103. ----
  5104. .. _class_RenderingServer_method_particles_set_mode:
  5105. .. rst-class:: classref-method
  5106. void **particles_set_mode** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)**
  5107. Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
  5108. .. rst-class:: classref-item-separator
  5109. ----
  5110. .. _class_RenderingServer_method_particles_set_one_shot:
  5111. .. rst-class:: classref-method
  5112. void **particles_set_one_shot** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)**
  5113. If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
  5114. .. rst-class:: classref-item-separator
  5115. ----
  5116. .. _class_RenderingServer_method_particles_set_pre_process_time:
  5117. .. rst-class:: classref-method
  5118. void **particles_set_pre_process_time** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)**
  5119. 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>`.
  5120. .. rst-class:: classref-item-separator
  5121. ----
  5122. .. _class_RenderingServer_method_particles_set_process_material:
  5123. .. rst-class:: classref-method
  5124. void **particles_set_process_material** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)**
  5125. Sets the material for processing the particles.
  5126. \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
  5127. .. rst-class:: classref-item-separator
  5128. ----
  5129. .. _class_RenderingServer_method_particles_set_randomness_ratio:
  5130. .. rst-class:: classref-method
  5131. void **particles_set_randomness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
  5132. Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
  5133. .. rst-class:: classref-item-separator
  5134. ----
  5135. .. _class_RenderingServer_method_particles_set_speed_scale:
  5136. .. rst-class:: classref-method
  5137. void **particles_set_speed_scale** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)**
  5138. Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
  5139. .. rst-class:: classref-item-separator
  5140. ----
  5141. .. _class_RenderingServer_method_particles_set_subemitter:
  5142. .. rst-class:: classref-method
  5143. void **particles_set_subemitter** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)**
  5144. .. container:: contribute
  5145. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5146. .. rst-class:: classref-item-separator
  5147. ----
  5148. .. _class_RenderingServer_method_particles_set_trail_bind_poses:
  5149. .. rst-class:: classref-method
  5150. void **particles_set_trail_bind_poses** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)**
  5151. .. container:: contribute
  5152. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5153. .. rst-class:: classref-item-separator
  5154. ----
  5155. .. _class_RenderingServer_method_particles_set_trails:
  5156. .. rst-class:: classref-method
  5157. void **particles_set_trails** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)**
  5158. 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>`.
  5159. .. rst-class:: classref-item-separator
  5160. ----
  5161. .. _class_RenderingServer_method_particles_set_transform_align:
  5162. .. rst-class:: classref-method
  5163. void **particles_set_transform_align** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)**
  5164. .. container:: contribute
  5165. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5166. .. rst-class:: classref-item-separator
  5167. ----
  5168. .. _class_RenderingServer_method_particles_set_use_local_coordinates:
  5169. .. rst-class:: classref-method
  5170. void **particles_set_use_local_coordinates** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
  5171. If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
  5172. .. rst-class:: classref-item-separator
  5173. ----
  5174. .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
  5175. .. rst-class:: classref-method
  5176. void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
  5177. 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.
  5178. .. rst-class:: classref-item-separator
  5179. ----
  5180. .. _class_RenderingServer_method_reflection_probe_create:
  5181. .. rst-class:: classref-method
  5182. :ref:`RID<class_RID>` **reflection_probe_create** **(** **)**
  5183. 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.
  5184. 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.
  5185. 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.
  5186. \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
  5187. .. rst-class:: classref-item-separator
  5188. ----
  5189. .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
  5190. .. rst-class:: classref-method
  5191. void **reflection_probe_set_ambient_color** **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)**
  5192. Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
  5193. .. rst-class:: classref-item-separator
  5194. ----
  5195. .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
  5196. .. rst-class:: classref-method
  5197. void **reflection_probe_set_ambient_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
  5198. Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
  5199. .. rst-class:: classref-item-separator
  5200. ----
  5201. .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
  5202. .. rst-class:: classref-method
  5203. void **reflection_probe_set_ambient_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)**
  5204. Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
  5205. .. rst-class:: classref-item-separator
  5206. ----
  5207. .. _class_RenderingServer_method_reflection_probe_set_as_interior:
  5208. .. rst-class:: classref-method
  5209. void **reflection_probe_set_as_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5210. If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
  5211. .. rst-class:: classref-item-separator
  5212. ----
  5213. .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
  5214. .. rst-class:: classref-method
  5215. void **reflection_probe_set_cull_mask** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)**
  5216. Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to :ref:`ReflectionProbe.cull_mask<class_ReflectionProbe_property_cull_mask>`.
  5217. .. rst-class:: classref-item-separator
  5218. ----
  5219. .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
  5220. .. rst-class:: classref-method
  5221. void **reflection_probe_set_enable_box_projection** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5222. 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>`.
  5223. .. rst-class:: classref-item-separator
  5224. ----
  5225. .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
  5226. .. rst-class:: classref-method
  5227. void **reflection_probe_set_enable_shadows** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
  5228. 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>`.
  5229. .. rst-class:: classref-item-separator
  5230. ----
  5231. .. _class_RenderingServer_method_reflection_probe_set_intensity:
  5232. .. rst-class:: classref-method
  5233. void **reflection_probe_set_intensity** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)**
  5234. Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
  5235. .. rst-class:: classref-item-separator
  5236. ----
  5237. .. _class_RenderingServer_method_reflection_probe_set_max_distance:
  5238. .. rst-class:: classref-method
  5239. void **reflection_probe_set_max_distance** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)**
  5240. 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>`.
  5241. .. rst-class:: classref-item-separator
  5242. ----
  5243. .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
  5244. .. rst-class:: classref-method
  5245. void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)**
  5246. 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>`.
  5247. .. rst-class:: classref-item-separator
  5248. ----
  5249. .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
  5250. .. rst-class:: classref-method
  5251. void **reflection_probe_set_origin_offset** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)**
  5252. 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>`.
  5253. .. rst-class:: classref-item-separator
  5254. ----
  5255. .. _class_RenderingServer_method_reflection_probe_set_resolution:
  5256. .. rst-class:: classref-method
  5257. void **reflection_probe_set_resolution** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)**
  5258. 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).
  5259. .. rst-class:: classref-item-separator
  5260. ----
  5261. .. _class_RenderingServer_method_reflection_probe_set_size:
  5262. .. rst-class:: classref-method
  5263. void **reflection_probe_set_size** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)**
  5264. Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
  5265. .. rst-class:: classref-item-separator
  5266. ----
  5267. .. _class_RenderingServer_method_reflection_probe_set_update_mode:
  5268. .. rst-class:: classref-method
  5269. void **reflection_probe_set_update_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)**
  5270. Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
  5271. .. rst-class:: classref-item-separator
  5272. ----
  5273. .. _class_RenderingServer_method_request_frame_drawn_callback:
  5274. .. rst-class:: classref-method
  5275. void **request_frame_drawn_callback** **(** :ref:`Callable<class_Callable>` callable **)**
  5276. Schedules a callback to the given callable after a frame has been drawn.
  5277. .. rst-class:: classref-item-separator
  5278. ----
  5279. .. _class_RenderingServer_method_scenario_create:
  5280. .. rst-class:: classref-method
  5281. :ref:`RID<class_RID>` **scenario_create** **(** **)**
  5282. 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.
  5283. 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.
  5284. The scenario is the 3D world that all the visual instances exist in.
  5285. .. rst-class:: classref-item-separator
  5286. ----
  5287. .. _class_RenderingServer_method_scenario_set_camera_attributes:
  5288. .. rst-class:: classref-method
  5289. void **scenario_set_camera_attributes** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)**
  5290. Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
  5291. .. rst-class:: classref-item-separator
  5292. ----
  5293. .. _class_RenderingServer_method_scenario_set_environment:
  5294. .. rst-class:: classref-method
  5295. void **scenario_set_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
  5296. Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
  5297. .. rst-class:: classref-item-separator
  5298. ----
  5299. .. _class_RenderingServer_method_scenario_set_fallback_environment:
  5300. .. rst-class:: classref-method
  5301. void **scenario_set_fallback_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
  5302. 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.
  5303. .. rst-class:: classref-item-separator
  5304. ----
  5305. .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
  5306. .. rst-class:: classref-method
  5307. void **screen_space_roughness_limiter_set_active** **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)**
  5308. 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>`.
  5309. .. rst-class:: classref-item-separator
  5310. ----
  5311. .. _class_RenderingServer_method_set_boot_image:
  5312. .. rst-class:: classref-method
  5313. void **set_boot_image** **(** :ref:`Image<class_Image>` image, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` scale, :ref:`bool<class_bool>` use_filter=true **)**
  5314. 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.
  5315. .. rst-class:: classref-item-separator
  5316. ----
  5317. .. _class_RenderingServer_method_set_debug_generate_wireframes:
  5318. .. rst-class:: classref-method
  5319. void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
  5320. This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``.
  5321. .. rst-class:: classref-item-separator
  5322. ----
  5323. .. _class_RenderingServer_method_set_default_clear_color:
  5324. .. rst-class:: classref-method
  5325. void **set_default_clear_color** **(** :ref:`Color<class_Color>` color **)**
  5326. 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>`.
  5327. .. rst-class:: classref-item-separator
  5328. ----
  5329. .. _class_RenderingServer_method_shader_create:
  5330. .. rst-class:: classref-method
  5331. :ref:`RID<class_RID>` **shader_create** **(** **)**
  5332. 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.
  5333. 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.
  5334. \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
  5335. .. rst-class:: classref-item-separator
  5336. ----
  5337. .. _class_RenderingServer_method_shader_get_code:
  5338. .. rst-class:: classref-method
  5339. :ref:`String<class_String>` **shader_get_code** **(** :ref:`RID<class_RID>` shader **)** |const|
  5340. Returns a shader's source code as a string.
  5341. .. rst-class:: classref-item-separator
  5342. ----
  5343. .. _class_RenderingServer_method_shader_get_default_texture_parameter:
  5344. .. rst-class:: classref-method
  5345. :ref:`RID<class_RID>` **shader_get_default_texture_parameter** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`int<class_int>` index=0 **)** |const|
  5346. Returns a default texture from a shader searched by name.
  5347. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5348. .. rst-class:: classref-item-separator
  5349. ----
  5350. .. _class_RenderingServer_method_shader_get_parameter_default:
  5351. .. rst-class:: classref-method
  5352. :ref:`Variant<class_Variant>` **shader_get_parameter_default** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name **)** |const|
  5353. Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
  5354. .. rst-class:: classref-item-separator
  5355. ----
  5356. .. _class_RenderingServer_method_shader_set_code:
  5357. .. rst-class:: classref-method
  5358. void **shader_set_code** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)**
  5359. Sets the shader's source code (which triggers recompilation after being changed).
  5360. .. rst-class:: classref-item-separator
  5361. ----
  5362. .. _class_RenderingServer_method_shader_set_default_texture_parameter:
  5363. .. rst-class:: classref-method
  5364. void **shader_set_default_texture_parameter** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name, :ref:`RID<class_RID>` texture, :ref:`int<class_int>` index=0 **)**
  5365. Sets a shader's default texture. Overwrites the texture given by name.
  5366. \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
  5367. .. rst-class:: classref-item-separator
  5368. ----
  5369. .. _class_RenderingServer_method_shader_set_path_hint:
  5370. .. rst-class:: classref-method
  5371. void **shader_set_path_hint** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)**
  5372. 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>`.
  5373. .. rst-class:: classref-item-separator
  5374. ----
  5375. .. _class_RenderingServer_method_skeleton_allocate_data:
  5376. .. rst-class:: classref-method
  5377. void **skeleton_allocate_data** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)**
  5378. .. container:: contribute
  5379. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5380. .. rst-class:: classref-item-separator
  5381. ----
  5382. .. _class_RenderingServer_method_skeleton_bone_get_transform:
  5383. .. rst-class:: classref-method
  5384. :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
  5385. Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
  5386. .. rst-class:: classref-item-separator
  5387. ----
  5388. .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
  5389. .. rst-class:: classref-method
  5390. :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
  5391. Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
  5392. .. rst-class:: classref-item-separator
  5393. ----
  5394. .. _class_RenderingServer_method_skeleton_bone_set_transform:
  5395. .. rst-class:: classref-method
  5396. void **skeleton_bone_set_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)**
  5397. Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
  5398. .. rst-class:: classref-item-separator
  5399. ----
  5400. .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
  5401. .. rst-class:: classref-method
  5402. void **skeleton_bone_set_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)**
  5403. Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
  5404. .. rst-class:: classref-item-separator
  5405. ----
  5406. .. _class_RenderingServer_method_skeleton_create:
  5407. .. rst-class:: classref-method
  5408. :ref:`RID<class_RID>` **skeleton_create** **(** **)**
  5409. 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.
  5410. 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.
  5411. .. rst-class:: classref-item-separator
  5412. ----
  5413. .. _class_RenderingServer_method_skeleton_get_bone_count:
  5414. .. rst-class:: classref-method
  5415. :ref:`int<class_int>` **skeleton_get_bone_count** **(** :ref:`RID<class_RID>` skeleton **)** |const|
  5416. Returns the number of bones allocated for this skeleton.
  5417. .. rst-class:: classref-item-separator
  5418. ----
  5419. .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
  5420. .. rst-class:: classref-method
  5421. void **skeleton_set_base_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)**
  5422. .. container:: contribute
  5423. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5424. .. rst-class:: classref-item-separator
  5425. ----
  5426. .. _class_RenderingServer_method_sky_bake_panorama:
  5427. .. rst-class:: classref-method
  5428. :ref:`Image<class_Image>` **sky_bake_panorama** **(** :ref:`RID<class_RID>` sky, :ref:`float<class_float>` energy, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
  5429. 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>`.
  5430. \ **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.
  5431. \ **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.
  5432. .. rst-class:: classref-item-separator
  5433. ----
  5434. .. _class_RenderingServer_method_sky_create:
  5435. .. rst-class:: classref-method
  5436. :ref:`RID<class_RID>` **sky_create** **(** **)**
  5437. 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.
  5438. 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.
  5439. .. rst-class:: classref-item-separator
  5440. ----
  5441. .. _class_RenderingServer_method_sky_set_material:
  5442. .. rst-class:: classref-method
  5443. void **sky_set_material** **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)**
  5444. Sets the material that the sky uses to render the background, ambient and reflection maps.
  5445. .. rst-class:: classref-item-separator
  5446. ----
  5447. .. _class_RenderingServer_method_sky_set_mode:
  5448. .. rst-class:: classref-method
  5449. void **sky_set_mode** **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)**
  5450. Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
  5451. .. rst-class:: classref-item-separator
  5452. ----
  5453. .. _class_RenderingServer_method_sky_set_radiance_size:
  5454. .. rst-class:: classref-method
  5455. void **sky_set_radiance_size** **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)**
  5456. 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>`.
  5457. .. rst-class:: classref-item-separator
  5458. ----
  5459. .. _class_RenderingServer_method_spot_light_create:
  5460. .. rst-class:: classref-method
  5461. :ref:`RID<class_RID>` **spot_light_create** **(** **)**
  5462. 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.
  5463. 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.
  5464. 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.
  5465. .. rst-class:: classref-item-separator
  5466. ----
  5467. .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
  5468. .. rst-class:: classref-method
  5469. void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)**
  5470. 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.
  5471. .. rst-class:: classref-item-separator
  5472. ----
  5473. .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
  5474. .. rst-class:: classref-method
  5475. void **sub_surface_scattering_set_scale** **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)**
  5476. 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.
  5477. .. rst-class:: classref-item-separator
  5478. ----
  5479. .. _class_RenderingServer_method_texture_2d_create:
  5480. .. rst-class:: classref-method
  5481. :ref:`RID<class_RID>` **texture_2d_create** **(** :ref:`Image<class_Image>` image **)**
  5482. 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.
  5483. 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.
  5484. \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
  5485. \ **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.
  5486. .. rst-class:: classref-item-separator
  5487. ----
  5488. .. _class_RenderingServer_method_texture_2d_get:
  5489. .. rst-class:: classref-method
  5490. :ref:`Image<class_Image>` **texture_2d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
  5491. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
  5492. Example of getting the test texture from :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
  5493. ::
  5494. var texture_rid = RenderingServer.get_test_texture()
  5495. var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
  5496. $Sprite2D.texture = texture
  5497. .. rst-class:: classref-item-separator
  5498. ----
  5499. .. _class_RenderingServer_method_texture_2d_layer_get:
  5500. .. rst-class:: classref-method
  5501. :ref:`Image<class_Image>` **texture_2d_layer_get** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const|
  5502. Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
  5503. .. rst-class:: classref-item-separator
  5504. ----
  5505. .. _class_RenderingServer_method_texture_2d_layered_create:
  5506. .. rst-class:: classref-method
  5507. :ref:`RID<class_RID>` **texture_2d_layered_create** **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
  5508. 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.
  5509. 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.
  5510. \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
  5511. .. rst-class:: classref-item-separator
  5512. ----
  5513. .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
  5514. .. rst-class:: classref-method
  5515. :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
  5516. 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>`.
  5517. \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
  5518. .. rst-class:: classref-item-separator
  5519. ----
  5520. .. _class_RenderingServer_method_texture_2d_placeholder_create:
  5521. .. rst-class:: classref-method
  5522. :ref:`RID<class_RID>` **texture_2d_placeholder_create** **(** **)**
  5523. 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>`\
  5524. 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.
  5525. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
  5526. .. rst-class:: classref-item-separator
  5527. ----
  5528. .. _class_RenderingServer_method_texture_2d_update:
  5529. .. rst-class:: classref-method
  5530. void **texture_2d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**
  5531. 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>`).
  5532. \ **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.
  5533. .. rst-class:: classref-item-separator
  5534. ----
  5535. .. _class_RenderingServer_method_texture_3d_create:
  5536. .. rst-class:: classref-method
  5537. :ref:`RID<class_RID>` **texture_3d_create** **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` mipmaps, :ref:`Image[]<class_Image>` data **)**
  5538. **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
  5539. .. rst-class:: classref-item-separator
  5540. ----
  5541. .. _class_RenderingServer_method_texture_3d_get:
  5542. .. rst-class:: classref-method
  5543. :ref:`Image[]<class_Image>` **texture_3d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
  5544. Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
  5545. .. rst-class:: classref-item-separator
  5546. ----
  5547. .. _class_RenderingServer_method_texture_3d_placeholder_create:
  5548. .. rst-class:: classref-method
  5549. :ref:`RID<class_RID>` **texture_3d_placeholder_create** **(** **)**
  5550. 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.
  5551. 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.
  5552. \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
  5553. .. rst-class:: classref-item-separator
  5554. ----
  5555. .. _class_RenderingServer_method_texture_3d_update:
  5556. .. rst-class:: classref-method
  5557. void **texture_3d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)**
  5558. 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.
  5559. \ **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.
  5560. .. rst-class:: classref-item-separator
  5561. ----
  5562. .. _class_RenderingServer_method_texture_get_format:
  5563. .. rst-class:: classref-method
  5564. :ref:`Format<enum_Image_Format>` **texture_get_format** **(** :ref:`RID<class_RID>` texture **)** |const|
  5565. Returns the :ref:`Format<enum_Image_Format>` for the texture.
  5566. .. rst-class:: classref-item-separator
  5567. ----
  5568. .. _class_RenderingServer_method_texture_get_native_handle:
  5569. .. rst-class:: classref-method
  5570. :ref:`int<class_int>` **texture_get_native_handle** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
  5571. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  5572. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  5573. .. rst-class:: classref-item-separator
  5574. ----
  5575. .. _class_RenderingServer_method_texture_get_path:
  5576. .. rst-class:: classref-method
  5577. :ref:`String<class_String>` **texture_get_path** **(** :ref:`RID<class_RID>` texture **)** |const|
  5578. .. container:: contribute
  5579. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5580. .. rst-class:: classref-item-separator
  5581. ----
  5582. .. _class_RenderingServer_method_texture_get_rd_texture:
  5583. .. rst-class:: classref-method
  5584. :ref:`RID<class_RID>` **texture_get_rd_texture** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
  5585. Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
  5586. .. rst-class:: classref-item-separator
  5587. ----
  5588. .. _class_RenderingServer_method_texture_proxy_create:
  5589. .. rst-class:: classref-method
  5590. :ref:`RID<class_RID>` **texture_proxy_create** **(** :ref:`RID<class_RID>` base **)**
  5591. *Deprecated.* ProxyTexture was removed in Godot 4, so this method does nothing when called and always returns a null :ref:`RID<class_RID>`.
  5592. .. rst-class:: classref-item-separator
  5593. ----
  5594. .. _class_RenderingServer_method_texture_proxy_update:
  5595. .. rst-class:: classref-method
  5596. void **texture_proxy_update** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)**
  5597. *Deprecated.* ProxyTexture was removed in Godot 4, so this method cannot be used anymore.
  5598. .. rst-class:: classref-item-separator
  5599. ----
  5600. .. _class_RenderingServer_method_texture_rd_create:
  5601. .. rst-class:: classref-method
  5602. :ref:`RID<class_RID>` **texture_rd_create** **(** :ref:`RID<class_RID>` rd_texture, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layer_type=0 **)**
  5603. 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.
  5604. .. rst-class:: classref-item-separator
  5605. ----
  5606. .. _class_RenderingServer_method_texture_replace:
  5607. .. rst-class:: classref-method
  5608. void **texture_replace** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)**
  5609. Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
  5610. .. rst-class:: classref-item-separator
  5611. ----
  5612. .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
  5613. .. rst-class:: classref-method
  5614. void **texture_set_force_redraw_if_visible** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)**
  5615. .. container:: contribute
  5616. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5617. .. rst-class:: classref-item-separator
  5618. ----
  5619. .. _class_RenderingServer_method_texture_set_path:
  5620. .. rst-class:: classref-method
  5621. void **texture_set_path** **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)**
  5622. .. container:: contribute
  5623. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5624. .. rst-class:: classref-item-separator
  5625. ----
  5626. .. _class_RenderingServer_method_texture_set_size_override:
  5627. .. rst-class:: classref-method
  5628. void **texture_set_size_override** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  5629. .. container:: contribute
  5630. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5631. .. rst-class:: classref-item-separator
  5632. ----
  5633. .. _class_RenderingServer_method_viewport_attach_camera:
  5634. .. rst-class:: classref-method
  5635. void **viewport_attach_camera** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)**
  5636. Sets a viewport's camera.
  5637. .. rst-class:: classref-item-separator
  5638. ----
  5639. .. _class_RenderingServer_method_viewport_attach_canvas:
  5640. .. rst-class:: classref-method
  5641. void **viewport_attach_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
  5642. Sets a viewport's canvas.
  5643. .. rst-class:: classref-item-separator
  5644. ----
  5645. .. _class_RenderingServer_method_viewport_attach_to_screen:
  5646. .. rst-class:: classref-method
  5647. void **viewport_attach_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0), :ref:`int<class_int>` screen=0 **)**
  5648. 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.
  5649. For example, you can set the root viewport to not render at all with the following code:
  5650. FIXME: The method seems to be non-existent.
  5651. .. tabs::
  5652. .. code-tab:: gdscript
  5653. func _ready():
  5654. get_viewport().set_attach_to_screen_rect(Rect2())
  5655. $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
  5656. 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>`.
  5657. .. rst-class:: classref-item-separator
  5658. ----
  5659. .. _class_RenderingServer_method_viewport_create:
  5660. .. rst-class:: classref-method
  5661. :ref:`RID<class_RID>` **viewport_create** **(** **)**
  5662. 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.
  5663. 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.
  5664. \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
  5665. .. rst-class:: classref-item-separator
  5666. ----
  5667. .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
  5668. .. rst-class:: classref-method
  5669. :ref:`float<class_float>` **viewport_get_measured_render_time_cpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5670. 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>`.
  5671. \ **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``.
  5672. .. rst-class:: classref-item-separator
  5673. ----
  5674. .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
  5675. .. rst-class:: classref-method
  5676. :ref:`float<class_float>` **viewport_get_measured_render_time_gpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5677. Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike :ref:`Engine.get_frames_per_second<class_Engine_method_get_frames_per_second>`, this method accurately reflects GPU utilization even if framerate is capped via V-Sync or :ref:`Engine.max_fps<class_Engine_property_max_fps>`. See also :ref:`viewport_get_measured_render_time_gpu<class_RenderingServer_method_viewport_get_measured_render_time_gpu>`.
  5678. \ **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``.
  5679. \ **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.
  5680. .. rst-class:: classref-item-separator
  5681. ----
  5682. .. _class_RenderingServer_method_viewport_get_render_info:
  5683. .. rst-class:: classref-method
  5684. :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` type, :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` info **)**
  5685. Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass ``type``\ s, each of them having the same ``info``\ s you can query (different passes will return different values). See :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` for a list of render pass types and :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` for a list of information that can be queried.
  5686. See also :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
  5687. \ **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:
  5688. ::
  5689. func _ready():
  5690. for _i in 2:
  5691. await get_tree().process_frame
  5692. print(
  5693. RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
  5694. RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
  5695. RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
  5696. )
  5697. .. rst-class:: classref-item-separator
  5698. ----
  5699. .. _class_RenderingServer_method_viewport_get_render_target:
  5700. .. rst-class:: classref-method
  5701. :ref:`RID<class_RID>` **viewport_get_render_target** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5702. Returns the render target for the viewport.
  5703. .. rst-class:: classref-item-separator
  5704. ----
  5705. .. _class_RenderingServer_method_viewport_get_texture:
  5706. .. rst-class:: classref-method
  5707. :ref:`RID<class_RID>` **viewport_get_texture** **(** :ref:`RID<class_RID>` viewport **)** |const|
  5708. Returns the viewport's last rendered frame.
  5709. .. rst-class:: classref-item-separator
  5710. ----
  5711. .. _class_RenderingServer_method_viewport_remove_canvas:
  5712. .. rst-class:: classref-method
  5713. void **viewport_remove_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
  5714. Detaches a viewport from a canvas and vice versa.
  5715. .. rst-class:: classref-item-separator
  5716. ----
  5717. .. _class_RenderingServer_method_viewport_set_active:
  5718. .. rst-class:: classref-method
  5719. void **viewport_set_active** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)**
  5720. If ``true``, sets the viewport active, else sets it inactive.
  5721. .. rst-class:: classref-item-separator
  5722. ----
  5723. .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
  5724. .. rst-class:: classref-method
  5725. void **viewport_set_canvas_cull_mask** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` canvas_cull_mask **)**
  5726. 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>`.
  5727. .. rst-class:: classref-item-separator
  5728. ----
  5729. .. _class_RenderingServer_method_viewport_set_canvas_stacking:
  5730. .. rst-class:: classref-method
  5731. void **viewport_set_canvas_stacking** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` layer, :ref:`int<class_int>` sublayer **)**
  5732. Sets the stacking order for a viewport's canvas.
  5733. \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
  5734. .. rst-class:: classref-item-separator
  5735. ----
  5736. .. _class_RenderingServer_method_viewport_set_canvas_transform:
  5737. .. rst-class:: classref-method
  5738. void **viewport_set_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)**
  5739. Sets the transformation of a viewport's canvas.
  5740. .. rst-class:: classref-item-separator
  5741. ----
  5742. .. _class_RenderingServer_method_viewport_set_clear_mode:
  5743. .. rst-class:: classref-method
  5744. void **viewport_set_clear_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)**
  5745. Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
  5746. .. rst-class:: classref-item-separator
  5747. ----
  5748. .. _class_RenderingServer_method_viewport_set_debug_draw:
  5749. .. rst-class:: classref-method
  5750. void **viewport_set_debug_draw** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)**
  5751. Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
  5752. .. rst-class:: classref-item-separator
  5753. ----
  5754. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
  5755. .. rst-class:: classref-method
  5756. void **viewport_set_default_canvas_item_texture_filter** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
  5757. Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` for options.
  5758. .. rst-class:: classref-item-separator
  5759. ----
  5760. .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
  5761. .. rst-class:: classref-method
  5762. void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
  5763. Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` for options.
  5764. .. rst-class:: classref-item-separator
  5765. ----
  5766. .. _class_RenderingServer_method_viewport_set_disable_2d:
  5767. .. rst-class:: classref-method
  5768. void **viewport_set_disable_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
  5769. If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
  5770. .. rst-class:: classref-item-separator
  5771. ----
  5772. .. _class_RenderingServer_method_viewport_set_disable_3d:
  5773. .. rst-class:: classref-method
  5774. void **viewport_set_disable_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
  5775. If ``true``, the viewport's 3D elements are not rendered.
  5776. .. rst-class:: classref-item-separator
  5777. ----
  5778. .. _class_RenderingServer_method_viewport_set_environment_mode:
  5779. .. rst-class:: classref-method
  5780. void **viewport_set_environment_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)**
  5781. 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>`.
  5782. .. rst-class:: classref-item-separator
  5783. ----
  5784. .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
  5785. .. rst-class:: classref-method
  5786. void **viewport_set_fsr_sharpness** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)**
  5787. 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.
  5788. .. rst-class:: classref-item-separator
  5789. ----
  5790. .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
  5791. .. rst-class:: classref-method
  5792. void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)**
  5793. Sets the viewport's global transformation matrix.
  5794. .. rst-class:: classref-item-separator
  5795. ----
  5796. .. _class_RenderingServer_method_viewport_set_measure_render_time:
  5797. .. rst-class:: classref-method
  5798. void **viewport_set_measure_render_time** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5799. 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``.
  5800. .. rst-class:: classref-item-separator
  5801. ----
  5802. .. _class_RenderingServer_method_viewport_set_msaa_2d:
  5803. .. rst-class:: classref-method
  5804. void **viewport_set_msaa_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
  5805. Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  5806. .. rst-class:: classref-item-separator
  5807. ----
  5808. .. _class_RenderingServer_method_viewport_set_msaa_3d:
  5809. .. rst-class:: classref-method
  5810. void **viewport_set_msaa_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
  5811. Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
  5812. .. rst-class:: classref-item-separator
  5813. ----
  5814. .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
  5815. .. rst-class:: classref-method
  5816. void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)**
  5817. 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.
  5818. .. rst-class:: classref-item-separator
  5819. ----
  5820. .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
  5821. .. rst-class:: classref-method
  5822. void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int<class_int>` rays_per_thread **)**
  5823. 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.
  5824. .. rst-class:: classref-item-separator
  5825. ----
  5826. .. _class_RenderingServer_method_viewport_set_parent_viewport:
  5827. .. rst-class:: classref-method
  5828. void **viewport_set_parent_viewport** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)**
  5829. Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
  5830. .. rst-class:: classref-item-separator
  5831. ----
  5832. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
  5833. .. rst-class:: classref-method
  5834. void **viewport_set_positional_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
  5835. 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>`.
  5836. .. rst-class:: classref-item-separator
  5837. ----
  5838. .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
  5839. .. rst-class:: classref-method
  5840. void **viewport_set_positional_shadow_atlas_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` size, :ref:`bool<class_bool>` use_16_bits=false **)**
  5841. 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.
  5842. \ **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).
  5843. .. rst-class:: classref-item-separator
  5844. ----
  5845. .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
  5846. .. rst-class:: classref-method
  5847. void **viewport_set_render_direct_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5848. 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.
  5849. .. rst-class:: classref-item-separator
  5850. ----
  5851. .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
  5852. .. rst-class:: classref-method
  5853. void **viewport_set_scaling_3d_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)**
  5854. 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.
  5855. .. rst-class:: classref-item-separator
  5856. ----
  5857. .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
  5858. .. rst-class:: classref-method
  5859. void **viewport_set_scaling_3d_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)**
  5860. 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.
  5861. 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.
  5862. .. rst-class:: classref-item-separator
  5863. ----
  5864. .. _class_RenderingServer_method_viewport_set_scenario:
  5865. .. rst-class:: classref-method
  5866. void **viewport_set_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)**
  5867. Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
  5868. .. rst-class:: classref-item-separator
  5869. ----
  5870. .. _class_RenderingServer_method_viewport_set_screen_space_aa:
  5871. .. rst-class:: classref-method
  5872. void **viewport_set_screen_space_aa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)**
  5873. Sets the viewport's screen-space antialiasing mode.
  5874. .. rst-class:: classref-item-separator
  5875. ----
  5876. .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
  5877. .. rst-class:: classref-method
  5878. void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)**
  5879. 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.
  5880. .. rst-class:: classref-item-separator
  5881. ----
  5882. .. _class_RenderingServer_method_viewport_set_size:
  5883. .. rst-class:: classref-method
  5884. void **viewport_set_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  5885. Sets the viewport's width and height in pixels.
  5886. .. rst-class:: classref-item-separator
  5887. ----
  5888. .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
  5889. .. rst-class:: classref-method
  5890. void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5891. 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>`.
  5892. .. rst-class:: classref-item-separator
  5893. ----
  5894. .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
  5895. .. rst-class:: classref-method
  5896. void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5897. 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>`.
  5898. .. rst-class:: classref-item-separator
  5899. ----
  5900. .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
  5901. .. rst-class:: classref-method
  5902. void **viewport_set_texture_mipmap_bias** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)**
  5903. 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.
  5904. \ **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``.
  5905. .. rst-class:: classref-item-separator
  5906. ----
  5907. .. _class_RenderingServer_method_viewport_set_transparent_background:
  5908. .. rst-class:: classref-method
  5909. void **viewport_set_transparent_background** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5910. If ``true``, the viewport renders its background as transparent.
  5911. .. rst-class:: classref-item-separator
  5912. ----
  5913. .. _class_RenderingServer_method_viewport_set_update_mode:
  5914. .. rst-class:: classref-method
  5915. void **viewport_set_update_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)**
  5916. Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
  5917. .. rst-class:: classref-item-separator
  5918. ----
  5919. .. _class_RenderingServer_method_viewport_set_use_debanding:
  5920. .. rst-class:: classref-method
  5921. void **viewport_set_use_debanding** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5922. 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>`.
  5923. .. rst-class:: classref-item-separator
  5924. ----
  5925. .. _class_RenderingServer_method_viewport_set_use_hdr_2d:
  5926. .. rst-class:: classref-method
  5927. void **viewport_set_use_hdr_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
  5928. 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 a ``RGBA16`` framebuffer, while when using the Mobile renderer it will be a ``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>`.
  5929. \ **Note:** This setting will have no effect when using the GL Compatibility renderer as the GL Compatibility renderer always renders in low dynamic range for performance reasons.
  5930. .. rst-class:: classref-item-separator
  5931. ----
  5932. .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
  5933. .. rst-class:: classref-method
  5934. void **viewport_set_use_occlusion_culling** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5935. 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>`.
  5936. .. rst-class:: classref-item-separator
  5937. ----
  5938. .. _class_RenderingServer_method_viewport_set_use_taa:
  5939. .. rst-class:: classref-method
  5940. void **viewport_set_use_taa** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
  5941. If ``true``, use Temporal Anti-Aliasing. Equivalent to :ref:`ProjectSettings.rendering/anti_aliasing/quality/use_taa<class_ProjectSettings_property_rendering/anti_aliasing/quality/use_taa>`.
  5942. .. rst-class:: classref-item-separator
  5943. ----
  5944. .. _class_RenderingServer_method_viewport_set_use_xr:
  5945. .. rst-class:: classref-method
  5946. void **viewport_set_use_xr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)**
  5947. If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
  5948. .. rst-class:: classref-item-separator
  5949. ----
  5950. .. _class_RenderingServer_method_viewport_set_vrs_mode:
  5951. .. rst-class:: classref-method
  5952. void **viewport_set_vrs_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)**
  5953. 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>`.
  5954. .. rst-class:: classref-item-separator
  5955. ----
  5956. .. _class_RenderingServer_method_viewport_set_vrs_texture:
  5957. .. rst-class:: classref-method
  5958. void **viewport_set_vrs_texture** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)**
  5959. 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>`.
  5960. .. rst-class:: classref-item-separator
  5961. ----
  5962. .. _class_RenderingServer_method_visibility_notifier_create:
  5963. .. rst-class:: classref-method
  5964. :ref:`RID<class_RID>` **visibility_notifier_create** **(** **)**
  5965. 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.
  5966. 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.
  5967. 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.
  5968. \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
  5969. .. rst-class:: classref-item-separator
  5970. ----
  5971. .. _class_RenderingServer_method_visibility_notifier_set_aabb:
  5972. .. rst-class:: classref-method
  5973. void **visibility_notifier_set_aabb** **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)**
  5974. .. container:: contribute
  5975. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5976. .. rst-class:: classref-item-separator
  5977. ----
  5978. .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
  5979. .. rst-class:: classref-method
  5980. void **visibility_notifier_set_callbacks** **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
  5981. .. container:: contribute
  5982. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5983. .. rst-class:: classref-item-separator
  5984. ----
  5985. .. _class_RenderingServer_method_voxel_gi_allocate_data:
  5986. .. rst-class:: classref-method
  5987. void **voxel_gi_allocate_data** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`Transform3D<class_Transform3D>` to_cell_xform, :ref:`AABB<class_AABB>` aabb, :ref:`Vector3i<class_Vector3i>` octree_size, :ref:`PackedByteArray<class_PackedByteArray>` octree_cells, :ref:`PackedByteArray<class_PackedByteArray>` data_cells, :ref:`PackedByteArray<class_PackedByteArray>` distance_field, :ref:`PackedInt32Array<class_PackedInt32Array>` level_counts **)**
  5988. .. container:: contribute
  5989. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  5990. .. rst-class:: classref-item-separator
  5991. ----
  5992. .. _class_RenderingServer_method_voxel_gi_create:
  5993. .. rst-class:: classref-method
  5994. :ref:`RID<class_RID>` **voxel_gi_create** **(** **)**
  5995. 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.
  5996. 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.
  5997. \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
  5998. .. rst-class:: classref-item-separator
  5999. ----
  6000. .. _class_RenderingServer_method_voxel_gi_get_data_cells:
  6001. .. rst-class:: classref-method
  6002. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6003. .. container:: contribute
  6004. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6005. .. rst-class:: classref-item-separator
  6006. ----
  6007. .. _class_RenderingServer_method_voxel_gi_get_distance_field:
  6008. .. rst-class:: classref-method
  6009. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6010. .. container:: contribute
  6011. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6012. .. rst-class:: classref-item-separator
  6013. ----
  6014. .. _class_RenderingServer_method_voxel_gi_get_level_counts:
  6015. .. rst-class:: classref-method
  6016. :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6017. .. container:: contribute
  6018. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6019. .. rst-class:: classref-item-separator
  6020. ----
  6021. .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
  6022. .. rst-class:: classref-method
  6023. :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6024. .. container:: contribute
  6025. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6026. .. rst-class:: classref-item-separator
  6027. ----
  6028. .. _class_RenderingServer_method_voxel_gi_get_octree_size:
  6029. .. rst-class:: classref-method
  6030. :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6031. .. container:: contribute
  6032. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6033. .. rst-class:: classref-item-separator
  6034. ----
  6035. .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
  6036. .. rst-class:: classref-method
  6037. :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
  6038. .. container:: contribute
  6039. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  6040. .. rst-class:: classref-item-separator
  6041. ----
  6042. .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
  6043. .. rst-class:: classref-method
  6044. void **voxel_gi_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` baked_exposure **)**
  6045. 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>`.
  6046. .. rst-class:: classref-item-separator
  6047. ----
  6048. .. _class_RenderingServer_method_voxel_gi_set_bias:
  6049. .. rst-class:: classref-method
  6050. void **voxel_gi_set_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
  6051. Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6052. .. rst-class:: classref-item-separator
  6053. ----
  6054. .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
  6055. .. rst-class:: classref-method
  6056. void **voxel_gi_set_dynamic_range** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)**
  6057. Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6058. .. rst-class:: classref-item-separator
  6059. ----
  6060. .. _class_RenderingServer_method_voxel_gi_set_energy:
  6061. .. rst-class:: classref-method
  6062. void **voxel_gi_set_energy** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)**
  6063. Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6064. .. rst-class:: classref-item-separator
  6065. ----
  6066. .. _class_RenderingServer_method_voxel_gi_set_interior:
  6067. .. rst-class:: classref-method
  6068. void **voxel_gi_set_interior** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
  6069. Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6070. .. rst-class:: classref-item-separator
  6071. ----
  6072. .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
  6073. .. rst-class:: classref-method
  6074. void **voxel_gi_set_normal_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
  6075. Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6076. .. rst-class:: classref-item-separator
  6077. ----
  6078. .. _class_RenderingServer_method_voxel_gi_set_propagation:
  6079. .. rst-class:: classref-method
  6080. void **voxel_gi_set_propagation** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)**
  6081. Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
  6082. .. rst-class:: classref-item-separator
  6083. ----
  6084. .. _class_RenderingServer_method_voxel_gi_set_quality:
  6085. .. rst-class:: classref-method
  6086. void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)**
  6087. 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.
  6088. .. rst-class:: classref-item-separator
  6089. ----
  6090. .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
  6091. .. rst-class:: classref-method
  6092. void **voxel_gi_set_use_two_bounces** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
  6093. 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>`.
  6094. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  6095. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  6096. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  6097. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  6098. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  6099. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  6100. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`